From c2e77c55c4c898899772f296a7c650c2f1f2a0e0 Mon Sep 17 00:00:00 2001
From: Stefano Pigozzi <me@steffo.eu>
Date: Sun, 28 Apr 2024 17:06:44 +0200
Subject: [PATCH] Rename and document some bits of `SacrificeStone`

---
 entities/sacrifice_stone.gd  | 24 ++++++++++++++----------
 entities/summoning_circle.gd |  2 +-
 2 files changed, 15 insertions(+), 11 deletions(-)

diff --git a/entities/sacrifice_stone.gd b/entities/sacrifice_stone.gd
index 52c94e6..c5365b9 100644
--- a/entities/sacrifice_stone.gd
+++ b/entities/sacrifice_stone.gd
@@ -1,26 +1,30 @@
 extends Node2D
 class_name SacrificeStone
 
+## The sacrificial stone where entities can be placed on.  
+##
+## Entities use [MovementHunter] to move towards the center of the stone.
+
 
 ## Emitted when the sacrifice on top of the stone changes.
 signal sacrifice_changed(entity: PhysicsBody2D, type: Enums.MonsterType)
 
-
-var current_monster: PhysicsBody2D
+## The entity currently on top of the stone.
+var entity: PhysicsBody2D
 
 
 func _on_tracked(body: PhysicsBody2D):
-	# If a monster is dragged on top of the SacrificeStone while another monster is already on top of it, ignore the capture and let the collision resolve instead
-	if current_monster != null:
+	# If a entity is dragged on top of the SacrificeStone while another entity is already on top of it, ignore the capture and let the collision resolve instead
+	if entity != null:
 		return
-	# Make sure the monster is sacrificable, and if it is, lock it in and emit [signal sacrifice_changed].
+	# Make sure the entity is sacrificable, and if it is, lock it in and emit [signal sacrifice_changed].
 	var types: Array = body.find_children("*", "Sacrificable", false, false)
 	for type in types:
-		current_monster = body
-		sacrifice_changed.emit(current_monster)
+		entity = body
+		sacrifice_changed.emit(body)
 		break
 
 func _on_untracked(body: PhysicsBody2D):
-	if body == current_monster:
-		current_monster = null
-		sacrifice_changed.emit(current_monster)
+	if body == entity:
+		entity = null
+		sacrifice_changed.emit(null)
diff --git a/entities/summoning_circle.gd b/entities/summoning_circle.gd
index 71d519d..271da97 100644
--- a/entities/summoning_circle.gd
+++ b/entities/summoning_circle.gd
@@ -41,7 +41,7 @@ func spawn(type: PackedScene) -> void:
 	spawner.spawn()
 
 	for s in stones:
-		s.current_monster.queue_free()
+		s.entity.queue_free()
 
 func _on_sacrifice_changed(_entity: Node2D, _type: Enums.MonsterType):
 	refresh_sacrifices()