feat: add tier system

For now it is based on the number of moves per second the player manages
to achieve. This should make unlucky shuffles a non-issue.

Author: danielzting

levels/comparison_sort.gd

@@ -15,6 +15,7 @@ const DISABLE_TIME = 1.0
 var array: ArrayModel
 var active = true
 var done = false
+var moves = 0
 
 var _timer = Timer.new()
 
@@ -32,6 +33,7 @@ func _input(event):
     if done or not active:
         return
     if event.is_pressed():
+        moves += 1
         return next(event.as_text())
 
 func next(action):

project.godot

@@ -54,6 +54,11 @@ _global_script_classes=[ {
 "language": "GDScript",
 "path": "res://levels/quick_sort.gd"
 }, {
+"base": "Reference",
+"class": "Score",
+"language": "GDScript",
+"path": "res://scripts/score.gd"
+}, {
 "base": "ComparisonSort",
 "class": "SelectionSort",
 "language": "GDScript",
@@ -69,6 +74,7 @@ _global_script_class_icons={
 "InsertionSort": "",
 "MergeSort": "",
 "QuickSort": "",
+"Score": "",
 "SelectionSort": ""
 }
 
@@ -137,22 +143,22 @@ ui_down={
 }
 faster={
 "deadzone": 0.5,
-"events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":46,"unicode":0,"echo":false,"script":null)
+"events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":68,"unicode":0,"echo":false,"script":null)
  ]
 }
 slower={
 "deadzone": 0.5,
-"events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":44,"unicode":0,"echo":false,"script":null)
+"events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":65,"unicode":0,"echo":false,"script":null)
  ]
 }
 bigger={
 "deadzone": 0.5,
-"events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":61,"unicode":0,"echo":false,"script":null)
+"events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":87,"unicode":0,"echo":false,"script":null)
  ]
 }
 smaller={
 "deadzone": 0.5,
-"events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":45,"unicode":0,"echo":false,"script":null)
+"events": [ Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"alt":false,"shift":false,"control":false,"meta":false,"command":false,"pressed":false,"scancode":83,"unicode":0,"echo":false,"script":null)
  ]
 }
 

scenes/levels.tscn

@@ -52,7 +52,7 @@ margin_top = 577.0
 margin_right = 283.0
 margin_bottom = 640.0
 size_flags_vertical = 8
-text = "Use +/- and </> to adjust the size and speed of the simulation, respectively."
+text = "Use the WASD keys to adjust the size and speed of the simulation."
 autowrap = true
 
 [node name="Preview" type="VBoxContainer" parent="LevelSelect"]

scenes/play.tscn

@@ -48,14 +48,14 @@ size_flags_horizontal = 3
 text = "0.000"
 align = 2
 
-[node name="DisplayBorder" type="MarginContainer" parent="GameDisplay"]
+[node name="Display" type="MarginContainer" parent="GameDisplay"]
 margin_top = 67.0
 margin_right = 1220.0
 margin_bottom = 660.0
 size_flags_vertical = 3
 script = ExtResource( 3 )
 
-[node name="Label" type="Label" parent="GameDisplay/DisplayBorder"]
+[node name="Label" type="Label" parent="GameDisplay/Display"]
 margin_left = 20.0
 margin_top = 287.0
 margin_right = 1200.0

scripts/levels.gd

@@ -12,21 +12,28 @@ const MAX_WAIT = 4
 const MIN_SIZE = 8
 const MAX_SIZE = 256
 
-var _level = LEVELS[0].new(ArrayModel.new(
+var _level = GlobalScene.get_param("level", LEVELS[0]).new(ArrayModel.new(
     GlobalScene.get_param("size", ArrayModel.DEFAULT_SIZE)))
 
 func _ready():
     var buttons = $LevelsBorder/Levels/LevelsContainer/Buttons
+    var scores = $LevelsBorder/Levels/LevelsContainer/Scores
     for level in LEVELS:
         var button = Button.new()
         button.text = level.NAME
         button.align = Button.ALIGN_LEFT
         button.connect("focus_entered", self, "_on_Button_focus_entered")
         button.connect("pressed", self, "_on_Button_pressed", [level])
         buttons.add_child(button)
-        var score = Label.new()
-        score.align = Label.ALIGN_RIGHT
-        $LevelsBorder/Levels/LevelsContainer/Scores.add_child(score)
+        var score = HBoxContainer.new()
+        var time = Label.new()
+        time.align = Label.ALIGN_RIGHT
+        time.size_flags_horizontal = Control.SIZE_EXPAND_FILL
+        var tier = Label.new()
+#        tier.align = Label.ALIGN_RIGHT
+        score.add_child(time)
+        score.add_child(tier)
+        scores.add_child(score)
     # Autofocus last played level
     for button in buttons.get_children():
         if button.text == _level.NAME:
@@ -40,14 +47,22 @@ func _ready():
 func _on_Button_focus_entered(size=_level.array.size):
     # Update high scores
     var buttons = $LevelsBorder/Levels/LevelsContainer/Buttons
-    var scores = $LevelsBorder/Levels/LevelsContainer/Scores
     var save = GlobalScene.read_save()
     for i in range(LEVELS.size()):
+        var score = $LevelsBorder/Levels/LevelsContainer/Scores.get_child(i)
         var name = buttons.get_child(i).text
         if name in save and str(size) in save[name]:
-            scores.get_child(i).text = "%.3f" % save[name][str(size)]
+            var moves = save[name][str(size)][0]
+            var time = save[name][str(size)][1]
+            score.get_child(0).text = "%.3f" % time
+            score.get_child(1).text = Score.get_tier(moves, time)
+            score.get_child(1).add_color_override(
+                "font_color", Score.get_color(moves, time))
         else:
-            scores.get_child(i).text = "INF"
+            score.get_child(0).text = ""
+            score.get_child(1).text = "INF"
+            score.get_child(1).add_color_override(
+                "font_color", GlobalTheme.GREEN)
     # Pause a bit to show completely sorted array
     if _level.array.is_sorted():
         $Timer.stop()

scripts/play.gd

@@ -13,11 +13,11 @@ func _process(delta):
 
 func _on_Timer_timeout():
     _start_time = OS.get_ticks_msec()
-    $DisplayBorder/Label.queue_free() # Delete ready text
+    $Display/Label.queue_free() # Delete ready text
     var level = _level.new(ArrayModel.new(
         GlobalScene.get_param("size", ArrayModel.DEFAULT_SIZE)))
-    level.connect("done", self, "_on_Level_done")
-    $DisplayBorder.add_child(ArrayView.new(level))
+    level.connect("done", self, "_on_Level_done", [level])
+    $Display.add_child(ArrayView.new(level))
 
 func get_score():
     return stepify((OS.get_ticks_msec() - _start_time) / 1000.0, 0.001)
@@ -26,7 +26,9 @@ func _input(event):
     if event.is_action_pressed("ui_cancel"):
         _on_Button_pressed("levels")
 
-func _on_Level_done():
+func _on_Level_done(level):
+    var moves = level.moves
+    var score = get_score()
     var restart = Button.new()
     restart.text = "RESTART LEVEL"
     restart.connect("pressed", self, "_on_Button_pressed", ["play"])
@@ -35,26 +37,31 @@ func _on_Level_done():
     var back = Button.new()
     back.text = "BACK TO LEVEL SELECT"
     back.connect("pressed", self, "_on_Button_pressed", ["levels"])
-    var result = Label.new()
-    result.text = "%.3f" % get_score()
-    result.size_flags_horizontal = Control.SIZE_EXPAND_FILL
-    result.align = Label.ALIGN_RIGHT
+    var time = Label.new()
+    time.text = "%.3f" % get_score()
+    time.align = Label.ALIGN_RIGHT
+    time.size_flags_horizontal = Control.SIZE_EXPAND_FILL
     _start_time = -1
+    var tier = Label.new()
+    tier.text = Score.get_tier(moves, score)
+    tier.align = Label.ALIGN_RIGHT
+    tier.add_color_override("font_color", Score.get_color(moves, score))
     $HUDBorder/HUD/Level.queue_free()
     $HUDBorder/HUD/Score.queue_free()
     $HUDBorder/HUD.add_child(restart)
     $HUDBorder/HUD.add_child(separator)
     $HUDBorder/HUD.add_child(back)
-    $HUDBorder/HUD.add_child(result)
+    $HUDBorder/HUD.add_child(time)
+    $HUDBorder/HUD.add_child(tier)
     restart.grab_focus()
     var save = GlobalScene.read_save()
     var name = _level.NAME
     var size = str(GlobalScene.get_param("size", ArrayModel.DEFAULT_SIZE))
     if not name in save:
         save[name] = {}
     if not size in save[name]:
-        save[name][size] = INF
-    save[name][size] = min(float(result.text), save[name][size])
+        save[name][size] = [-1, INF]
+    save[name][size] = [moves, min(float(time.text), save[name][size][1])]
     GlobalScene.write_save(save)
 
 func _on_Button_pressed(scene):

scripts/scene.gd

@@ -11,7 +11,7 @@ func change_scene(next_scene, params=null):
     get_tree().change_scene(next_scene)
 
 func get_param(name, default=null):
-    if _params != null and _params.has(name):
+    if _params != null and _params.get(name) != null:
         return _params[name]
     return default
 

scripts/score.gd

@@ -0,0 +1,21 @@
+"""
+Common helper library for scoring functions.
+"""
+class_name Score
+extends Reference
+
+const TIERS = ["F", "D", "C", "B", "A", "S"]
+const COLORS = [
+    Color("f44336"),
+    Color("ff9800"),
+    Color("ffeb3b"),
+    Color("4caf50"),
+    Color("03a9f4"),
+    Color("e040fb"),
+]
+
+static func get_tier(moves, seconds):
+    return TIERS[min(moves / seconds, TIERS.size() - 1)]
+
+static func get_color(moves, seconds):
+    return COLORS[min(moves / seconds, COLORS.size() - 1)]