Enforce code ordering guidelines and add TODOs

Add docstrings as well.

List of guidelines : https://docs.godotengine.org/en/stable/getting_started/scripting/gdscript/gdscript_styleguide.html

Scenes/Game.tscn

@@ -5,9 +5,6 @@
 [ext_resource path="res://Scripts/Game.gd" type="Script" id=3]
 [ext_resource path="res://Scenes/Hub.tscn" type="PackedScene" id=4]
 
-
-
-
 [node name="Game" type="Node2D"]
 script = ExtResource( 3 )
 levelNames = [ "Square", "Lab", "Focus", "Atom", "template" ]

Scenes/Player.tscn

@@ -1,10 +1,8 @@
 [gd_scene load_steps=5 format=2]
 
 [ext_resource path="res://Scripts/Player.gd" type="Script" id=1]
-[ext_resource path="res://Resources/Images/player.png" type="Texture" id=2]
-[ext_resource path="res://Scripts/CharTween.gd" type="Script" id=3]
-
-
+[ext_resource path="res://Scripts/CharTween.gd" type="Script" id=2]
+[ext_resource path="res://Resources/Images/player.png" type="Texture" id=3]
 
 [sub_resource type="RectangleShape2D" id=1]
 extents = Vector2( 16, 16 )
@@ -16,7 +14,7 @@ script = ExtResource( 1 )
 
 [node name="Sprite" type="Sprite" parent="."]
 z_index = 1
-texture = ExtResource( 2 )
+texture = ExtResource( 3 )
 __meta__ = {
 "_edit_lock_": true
 }
@@ -28,5 +26,5 @@ __meta__ = {
 }
 
 [node name="Tween" type="Tween" parent="."]
-script = ExtResource( 3 )
+script = ExtResource( 2 )
 [connection signal="body_entered" from="." to="." method="_on_crash"]

Scripts/CharTween.gd

@@ -1,4 +1,5 @@
 extends Tween
+# Drive moves for player
 
 export var default_duration = 0.1
 

Scripts/Game.gd

@@ -1,28 +1,29 @@
 extends Node2D
+# Game orchestrator
 
-onready var cam = $MainCamera
-onready var start_timer = $StartTimer
-
-var is_round_won
 signal round_won
 signal arena_removed
 
-# Used to test a level in creation
 export (String) var levelToLoop
-var levelSceneToLoop
-
 export (Array, String) var levelNames = ["Square"]
+
+var levelSceneToLoop
 var levelScenes = []
 var levelOldNode
 var levelCurrentNode
 var levelIndex = -1
 
+var is_round_won
+
 var _players_connected = false
 
+onready var cam = $MainCamera
+onready var start_timer = $StartTimer
 onready var levelSwap = $LevelSwap
 onready var hub = $Hub
 onready var ui = $Ui
 
+
 func _ready():
 	# Prepare levels
 	for _k in range(levelNames.size()):
@@ -37,6 +38,15 @@ func _ready():
 	levelSwap.connect("tween_completed", self, "_on_swap_completed")
 	hub.connect("hub_finished", self, "_on_hub_finished")
 
+
+func _unhandled_input(event):
+	if event.is_action("ui_accept") and event.is_pressed():
+		if is_round_won:
+			is_round_won = false
+			create_game()
+			get_tree().set_input_as_handled()
+
+
 func connect_players():
 	if _players_connected:
 		push_error("Players are already connected!")
@@ -52,16 +62,11 @@ func connect_players():
 
 		_players_connected = true
 
+
 func load_level(name):
 	var fullName = "res://Levels/" + name + ".tscn"
 	return load(fullName)
 
-func _unhandled_input(event):
-	if event.is_action("ui_accept") and event.is_pressed():
-		if is_round_won:
-			is_round_won = false
-			create_game()
-			get_tree().set_input_as_handled()
 
 func create_game():
 	# Clear if required
@@ -92,10 +97,12 @@ func create_game():
 
 	# Manually spawn players for the first game
 	if levelOldNode == null:
+		# TODO : remove duplicated code with func _on_swap_completed
 		add_child(levelCurrentNode)
 		spawn_players()
 		levelSwap.swap_in(levelCurrentNode)
 
+
 func spawn_players():
 	var spawners = get_tree().get_nodes_in_group("spawn")
 	spawners.shuffle()
@@ -105,14 +112,17 @@ func spawn_players():
 	for k in p.size():
 		p[k].spawn(levelCurrentNode, spawners[k].position, spawners[k].rotation_degrees)
 
+
 func _on_player_crash():
 	if get_tree().get_nodes_in_group("running").size() <= 1 and !is_round_won:
 		emit_signal("round_won")
 		is_round_won = true
 
+
 func _on_start_game():
 	is_round_won = false
 
+
 func _on_swap_completed(object, _k):
 	if object == levelOldNode:
 		remove_child(levelOldNode)
@@ -126,10 +136,7 @@ func _on_swap_completed(object, _k):
 	elif object == levelCurrentNode:
 		start_timer.start()
 
+
 func _on_hub_finished():
 	connect_players()
-
-#	hub.remove_and_skip()
-	hub = null # TODO : add an argument in connect and remove temporary attribute
-
 	create_game()

Scripts/Hub.gd

@@ -26,9 +26,11 @@ var _playerActionsRight
 
 var _hub_enabled = true
 
+
 func _ready():
 	_fill_action_arrays()
 
+
 func _unhandled_input(event):
 	if event.is_pressed() and _hub_enabled:
 		if event.is_action("ui_accept"):
@@ -54,6 +56,7 @@ func _unhandled_input(event):
 
 					get_tree().set_input_as_handled()
 
+
 func _fill_action_arrays():
 	_playerActionsLeft = []
 	_playerActionsRight = []

Scripts/LevelSwap.gd

@@ -1,12 +1,16 @@
 extends Tween
+# Drive animation during level switching
+
+const FAR_AWAY = 4000
 
 export var duration = 1
-const far_away = 4000
+
 
 func swap_out(node):
-	interpolate_property(node, "position:x", null, far_away, duration, Tween.TRANS_QUAD, Tween.EASE_IN)
+	interpolate_property(node, "position:x", null, FAR_AWAY, duration, Tween.TRANS_QUAD, Tween.EASE_IN)
 	start()
 
+
 func swap_in(node):
 	interpolate_property(node, "position:y", null, 0, duration, Tween.TRANS_QUAD, Tween.EASE_OUT)
 	start()

Scripts/MainCamera.gd

@@ -1,20 +1,23 @@
 extends Camera2D
+# Handle zoom and move for player tracking
 
 export var zoom_border = 100
 
 var zoom_rate:float
-
-var view:Viewport
 var dist_max:float
+var view:Viewport
+
 
 func _ready():
 	view = get_tree().root
 	view.connect("size_changed", self, "_on_size_changed")
 	update_zoom_reference()
 
+
 func _process(_d):
 	move()
 
+
 func move():
 	if !get_tree().has_group("players"):
 		return
@@ -31,6 +34,7 @@ func move():
 		# Show remaining players only
 		center_on(running)
 
+
 func center_on(players):
 	var position_accumulator = Vector2(0.0, 0.0)
 	for p in players:
@@ -38,6 +42,7 @@ func center_on(players):
 
 	position = position_accumulator / players.size()
 
+	# TODO : compute axis aligned distance instead
 	var dist = 0
 	for i in range(players.size() - 1):
 		for j in range(i + 1, players.size()):
@@ -50,10 +55,12 @@ func center_on(players):
 
 	zoom = Vector2(new_zoom, new_zoom)
 
+
 func update_zoom_reference():
 	var ref_length = min(view.size.x, view.size.y)
 	dist_max = ref_length - 2 * zoom_border
 	zoom_rate = 1.0 / dist_max
 
+
 func _on_size_changed():
 	update_zoom_reference()

Scripts/Player.gd

@@ -1,21 +1,8 @@
 extends Area2D
+# Handle player logic and events
 
-# Nodes
-var grid:TileMap
-onready var tween = $Tween
-
-# Signals
 signal crash
 
-# Misc
-const cell_size = 64
-const cell_half_size = 32
-
-# State
-var running = false
-var landed = false
-
-# Enum
 enum Direction {
 	UP = 0
 	RIGHT = 1
@@ -28,9 +15,18 @@ enum Side {
 	RIGHT = 1
 }
 
+const cell_size = 64
+const cell_half_size = 32
+const LEVEL_SPAWN_DURATION = 2
+
+# State
+var running = false
+var landed = false
+
 # Movement
 var posix
 var posiy
+
 var dirx = 0
 var diry = 0
 
@@ -39,11 +35,14 @@ var dire_delta = 0
 
 var target_pos
 
-const LEVEL_SPAWN_DURATION = 2
-
 # Controls
-export var turn_left_action:String
-export var turn_right_action:String
+var turn_left_action:String
+var turn_right_action:String
+
+var grid:TileMap
+
+onready var tween = $Tween
+
 
 func _ready():
 	assert(turn_left_action)
@@ -51,6 +50,7 @@ func _ready():
 
 	tween.connect_into(self)
 
+
 func _unhandled_input(event):
 	if event.is_pressed():
 		if event.is_action(turn_left_action):
@@ -60,37 +60,26 @@ func _unhandled_input(event):
 			prepare_turn(Side.RIGHT)
 			get_tree().set_input_as_handled()
 
-func spawn(newGrid, newPosition, newOrientation):
-	# Update arena
-	grid = newGrid
-
-	# Adjust spawn situation
-	dire_delta = 0
-	posix = int (newPosition.x / cell_size)
-	posiy = int (newPosition.y / cell_size)
-	dire = int((newOrientation + 45) / 90)
-	apply_turn()
-
-	# Animate spawning
-	tween.rotate_char(self, rotation_degrees, newOrientation, LEVEL_SPAWN_DURATION)
-	tween.move_char(self, newPosition, LEVEL_SPAWN_DURATION)
-	tween.start()
 
 func _on_round_start():
 	assert(grid)
 	run()
 
+
 func _on_round_won():
 	stop()
 
+
 func _on_arena_removed():
 	grid = null
 	landed = false
 
+
 func _on_tween_completed(_o, key):
 	if (key == ":position"):
 		move()
 
+
 func _on_crash(body):
 	if landed and running:
 		stop()
@@ -98,10 +87,29 @@ func _on_crash(body):
 		grid.set_cell(posix, posiy, 2)
 		emit_signal("crash")
 
+
+func spawn(newGrid, newPosition, newOrientation):
+	# Update arena
+	grid = newGrid
+
+	# Adjust spawn situation
+	dire_delta = 0
+	posix = int (newPosition.x / cell_size)
+	posiy = int (newPosition.y / cell_size)
+	dire = int((newOrientation + 45) / 90)
+	apply_turn()
+
+	# Animate spawning
+	tween.rotate_char(self, rotation_degrees, newOrientation, LEVEL_SPAWN_DURATION)
+	tween.move_char(self, newPosition, LEVEL_SPAWN_DURATION)
+	tween.start()
+
+
 func generate_wall():
 	# TODO : use enum for blocks
 	grid.set_cell(posix - dirx, posiy - diry, 1)
 
+
 func prepare_turn(left_or_right:int):
 	if !running:
 		return
@@ -121,9 +129,11 @@ func prepare_turn(left_or_right:int):
 	tween.rotate_char(self, current_angle, aim_angle)
 	tween.start()
 
+
 func can_turn():
 	return dire_delta != 0 and !has_block_on(dire_delta)
 
+
 func apply_turn():
 	dire += dire_delta
 	dire_delta = 0
@@ -146,6 +156,7 @@ func apply_turn():
 	else:
 		push_error("dire out of range")
 
+
 func move():
 	if !running:
 		return
@@ -157,6 +168,7 @@ func move():
 
 	go_forward()
 
+
 func go_forward():
 	posix += dirx
 	posiy += diry
@@ -165,6 +177,7 @@ func go_forward():
 	tween.move_char(self, target_pos)
 	tween.start()
 
+
 func has_block_on(left_or_right:int):
 	var bposx:int = posix - diry * left_or_right
 	var bposy:int = posiy + dirx * left_or_right
@@ -172,17 +185,20 @@ func has_block_on(left_or_right:int):
 	# TODO : use enum for blocks
 	return grid.get_cell(bposx, bposy) == 1
 
+
 func stop():
 	if running:
 		remove_from_group("running")
 		generate_wall()
 	running = false
 
+
 func run():
 	landed = true # TODO : land at game signal `land`
 	running = true
 	add_to_group("running")
 	move()
 
+
 func is_running():
 	return running

Scripts/Spawner.gd

@@ -1,4 +1,9 @@
 extends Sprite
+# Handle spawn points graphics
+
 
 func _ready():
 	pass
+
+
+# TODO : make spawners disappear at game start