refactor: consolidate scoring logic into singleton

Author: danielzting

models/array_model.gd

@@ -1,5 +1,4 @@
 class_name ArrayModel
-extends Reference
 
 # For all parameterized signals, i <= j
 signal removed(i)

models/binary_tree_model.gd

@@ -1,5 +1,4 @@
 class_name BinaryTreeModel
-extends Reference
 
 var left: BinaryTreeModel setget set_left
 var right: BinaryTreeModel setget set_right

project.godot

@@ -64,11 +64,6 @@ _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",
@@ -91,7 +86,6 @@ _global_script_class_icons={
 "InsertionSort": "",
 "MergeSort": "",
 "QuickSort": "",
-"Score": "",
 "SelectionSort": "",
 "ShellSort": ""
 }
@@ -107,6 +101,7 @@ config/icon="res://assets/icon.png"
 
 GlobalScene="*res://scripts/scene.gd"
 GlobalTheme="*res://scripts/theme.gd"
+GlobalScore="*res://scripts/score.gd"
 
 [display]
 

scripts/levels.gd

@@ -49,22 +49,20 @@ func _ready():
 func _on_Button_focus_entered(size=_level.array.size):
     # Update high scores
     var buttons = $LevelsBorder/Levels/LevelsContainer/Buttons
-    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]:
-            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:
+        var time = GlobalScore.get_time(name, size)
+        if time == INF:
             score.get_child(0).text = ""
             score.get_child(1).text = "INF"
             score.get_child(1).add_color_override(
                 "font_color", GlobalTheme.GREEN)
+        else:
+            score.get_child(0).text = "%.3f" % time
+            score.get_child(1).text = GlobalScore.get_tier(name, size)
+            score.get_child(1).add_color_override(
+                "font_color", GlobalScore.get_color(name, size))
     # Pause a bit to show completely sorted array
     if _level.array.is_sorted():
         # Prevent race condition caused by keyboard input during pause

scripts/play.gd

@@ -5,13 +5,14 @@ var _level = GlobalScene.get_param(
     "level", preload("res://scripts/levels.gd").LEVELS[0])
 
 func _ready():
+    set_process(false)
     $HUDBorder/HUD/Level.text = _level.new(ArrayModel.new()).NAME
 
 func _process(delta):
-    if _start_time >= 0:
-        $HUDBorder/HUD/Score.text = "%.3f" % get_score()
+    $HUDBorder/HUD/Score.text = "%.3f" % get_score()
 
 func _on_Timer_timeout():
+    set_process(true)
     _start_time = OS.get_ticks_msec()
     $Display/Label.queue_free() # Delete ready text
     var level = _level.new(ArrayModel.new(
@@ -28,8 +29,11 @@ func _input(event):
         _on_Button_pressed("levels")
 
 func _on_Level_done(level):
-    var moves = level.moves
+    set_process(false)
+    var name = level.NAME
+    var size = level.array.size
     var score = get_score()
+    var moves = level.moves
     var restart = Button.new()
     restart.text = "RESTART LEVEL"
     restart.connect("pressed", self, "_on_Button_pressed", ["play"])
@@ -42,11 +46,11 @@ func _on_Level_done(level):
     time.text = "%.3f" % 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.text = GlobalScore.calculate_tier(score, moves)
     tier.align = Label.ALIGN_RIGHT
-    tier.add_color_override("font_color", Score.get_color(moves, score))
+    tier.add_color_override(
+        "font_color", GlobalScore.calculate_color(score, moves))
     $HUDBorder/HUD/Level.queue_free()
     $HUDBorder/HUD/Score.queue_free()
     $HUDBorder/HUD.add_child(restart)
@@ -55,18 +59,7 @@ func _on_Level_done(level):
     $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] = [-1, INF]
-    var mps1 = Score.get_mps_int(moves, score)
-    var mps2 = Score.get_mps_int(save[name][size][0], save[name][size][1])
-    if mps1 > mps2 or mps1 == mps2 and score < save[name][size][1]:
-        save[name][size] = [moves, score]
-    GlobalScene.write_save(save)
+    GlobalScore.save_score(name, size, score, moves)
 
 func _on_Button_pressed(scene):
     GlobalScene.change_scene("res://scenes/" + scene + ".tscn",

scripts/scene.gd

@@ -14,15 +14,3 @@ func get_param(name, default=null):
     if _params != null and _params.get(name) != null:
         return _params[name]
     return default
-
-func read_save():
-    var file = File.new()
-    file.open("user://save.json", File.READ)
-    return {} if not file.is_open() else parse_json(file.get_as_text())
-    file.close()
-
-func write_save(save):
-    var file = File.new()
-    file.open("user://save.json", File.WRITE)
-    file.store_line(to_json(save))
-    file.close()

scripts/score.gd

@@ -1,8 +1,8 @@
 """
 Common helper library for scoring functions.
 """
-class_name Score
-extends Reference
+
+extends Node
 
 const TIERS = ["F", "D", "C", "B", "A", "S"]
 const COLORS = [
@@ -14,11 +14,50 @@ const COLORS = [
     Color("e040fb"),
 ]
 
-static func get_tier(moves, seconds):
-    return TIERS[get_mps_int(moves, seconds)]
+var _save: Dictionary
+
+func _init():
+    var file = File.new()
+    file.open("user://save.json", File.READ)
+    _save = {} if not file.is_open() else parse_json(file.get_as_text())
+    file.close()
+
+func get_time(name, size):
+    if name in _save and str(size) in _save[name]:
+        return _save[name][str(size)][0]
+    return INF
+
+func get_tier(name, size):
+    if name in _save and str(size) in _save[name]:
+        return _save[name][str(size)][1]
+    return ""
+
+func get_color(name, size):
+    var tier = get_tier(name, size)
+    return Color.black if tier.empty() else COLORS[TIERS.find(tier)]
+
+func calculate_tier(time, moves):
+    return TIERS[min(int(moves / time), TIERS.size() - 1)]
+
+func calculate_color(time, moves):
+    return COLORS[TIERS.find(calculate_tier(time, moves))]
 
-static func get_mps_int(moves, seconds):
-    return int(min(moves / seconds, TIERS.size() - 1))
+func save_score(name, size, time, moves):
+    if not name in _save:
+        _save[name] = {}
+    if not str(size) in _save[name]:
+        _save[name][str(size)] = [INF, ""]
+    var prev_time = get_time(name, size)
+    var prev_tier = get_tier(name, size)
+    var tier = calculate_tier(time, moves)
+    var tier_index = TIERS.find(tier)
+    if (prev_tier.empty() or tier_index > TIERS.find(prev_tier)
+        or tier_index == TIERS.find(prev_tier) and time < prev_time):
+        _save[name][str(size)] = [time, tier]
+    _save()
 
-static func get_color(moves, seconds):
-    return COLORS[min(moves / seconds, COLORS.size() - 1)]
+func _save():
+    var file = File.new()
+    file.open("user://save.json", File.WRITE)
+    file.store_line(to_json(_save))
+    file.close()