document public API

1 files changed, 6 insertions, 2 deletions

diff --git a/Piece.gd b/Piece.gd
index 50baa43..1a9e357 100644
--- a/Piece.gd
+++ b/Piece.gd
@@ -3,18 +3,22 @@ extends Node2D
 
 class_name Piece, "res://godot/Piece.png"
 
+# movement points
 func get_mp() -> int:
 	print("Piece#get_mp() must be overriden in a subclass")
 	return 0
 
+# movement point bonus if you start your movement on a road and follow it
 func road_march_bonus() -> int:
 	print("Piece#road_march_bonus() must be overriden in a subclass")
 	return 0
 
-func move_cost(src : Tile, dst : Tile, a : int) -> int:
+# movement cost from a Tile to another adjacent Tile
+func move_cost(src : Tile, dst : Tile, orientation : int) -> int:
 	print("Piece#move_cost() must be overriden in a subclass")
 	return -1 # impracticable
 
-func at_least_one_tile() -> bool:
+# are you allowed to move into that Tile as only move even if you don't have enough movement points
+func at_least_one_tile(dst : Tile) -> bool:
 	print("Piece#at_least_one_tile() must be overriden in a subclass")
 	return true