Merge pull request #49 from Sparrowworks/documentation

Added documentation

Author: SP4R0W

src/Game/Enemies/Barnacle/barnacle.gd

@@ -23,13 +23,17 @@ func collision_check(body: Node2D) -> void:
 			kill()
 			return
 
+		# The barnacle can only be killed while rising from or lowering to the ground.
 		if animated_sprite_2d.animation == "open":
 			player_hit.emit(true)
 			hide_timer.paused = true
 			animated_sprite_2d.play("bite")
+
 			await animated_sprite_2d.animation_finished
+
 			hide_timer.paused = false
 			animated_sprite_2d.play("open")
+
 		elif animated_sprite_2d.animation == "close":
 			if Globals.player.velocity.y == 0:
 				player_hit.emit(true)

src/Game/Enemies/Bat/bat.gd

@@ -18,8 +18,10 @@ func kill() -> void:
 	super()
 
 func move(delta: float) -> void:
+	# Move the bat towards the player when detected
 	if player_ray.is_colliding():
 		var collider: Node = player_ray.get_collider() as Node
+
 		if ray_collider != collider:
 			if collider.is_in_group("Player"):
 				player_tracked.emit()
@@ -30,6 +32,7 @@ func move(delta: float) -> void:
 			ray_collider = collider
 	elif player_ray_2.is_colliding():
 		var collider: Node = player_ray_2.get_collider() as Node
+
 		if ray2_collider != collider:
 			if collider.is_in_group("Player"):
 				player_tracked.emit()
@@ -64,6 +67,7 @@ func _on_player_tracked() -> void:
 	if not is_chasing:
 		is_chasing = true
 
+		# Calculate the bat's target position and flight time.
 		var desired_pos: Vector2 = Vector2(Globals.player.global_position.x, Globals.player.global_position.y)
 		var fly_time: float = clampf((desired_pos.y - initial_pos.y)/2000, 1, 1.5)
 		animated_sprite_2d.play("fly")

src/Game/Enemies/Bee/bee.gd

@@ -34,6 +34,7 @@ func _on_player_tracked() -> void:
 	if not is_chasing:
 		is_chasing = true
 
+		# Calculate the bee's target position and flight time.
 		var initial_pos: Vector2 = global_position
 		var desired_pos: Vector2 = Vector2(Globals.player.global_position.x, Globals.player.global_position.y)
 		var fly_time: float = clampf((desired_pos.y - initial_pos.y)/2000, 1, 1.5)

src/Game/Enemies/Ghost/ghost.gd

@@ -4,6 +4,7 @@ func _ready() -> void:
 	animated_sprite_2d.play("normal")
 
 func collision_check(body: Node2D) -> void:
+	# A ghost is killable only if the player has immunity
 	if body.is_in_group("Player"):
 		if Globals.player.is_immune:
 			player_hit.emit(false)

src/Game/Enemies/Piranha/piranha.gd

@@ -21,18 +21,22 @@ func _ready() -> void:
 func move(delta: float) -> void:
 	super(delta)
 
+	# Use trigonometric functions to smooth the fish's jump and fall.
 	if is_jumping:
 		animated_sprite_2d.play("jump")
 		time += delta
 		y_direction = -abs(cos(time) * jump_power)
+
 		if abs(y_direction) < 0.2:
 			y_direction = 0.0
 			is_jumping = false
 			is_falling = true
+
 	elif is_falling:
 		animated_sprite_2d.play("fall")
 		time += delta
 		y_direction = abs(cos(time) * jump_power * 2)
+
 		if global_position.y - init_pos.y > -1.0:
 			collision_shape_2d.set_deferred("disabled", true)
 			y_direction = 0.0

src/Game/Enemies/Spider/spider.gd

@@ -12,12 +12,11 @@ func kill() -> void:
 	animated_sprite_2d.play("dead")
 	super()
 
-
+# Speeden up the spider if its tracking the player
 func _on_player_tracked() -> void:
 	actual_speed = chase_speed
 	animated_sprite_2d.speed_scale = 2
 
-
 func _on_player_tracked_stopped() -> void:
 	actual_speed = speed
 	animated_sprite_2d.speed_scale = 1

src/Game/Enemies/Spinner/spinner.gd

@@ -37,6 +37,7 @@ func turn_left() -> void:
 	animated_sprite_2d.flip_h = false
 
 func move(delta: float) -> void:
+	# Change the direction of the enemy if reached a wall
 	if wall_ray.is_colliding():
 		var collider: Node = wall_ray.get_collider() as Node2D
 		if not collider.is_in_group("Player"):
@@ -45,6 +46,7 @@ func move(delta: float) -> void:
 			else:
 				turn_right()
 
+	# Code for player raycast used to check if an enemy spotted the player
 	if player_ray.is_colliding():
 		var collider: Node = player_ray.get_collider() as Node
 		if ray_collider != collider:
@@ -81,6 +83,7 @@ func collision_check(body: Node2D) -> void:
 		else:
 			player_hit.emit(true)
 
+# Make the spinner jump with the player when its tracking them
 func _physics_process(delta: float) -> void:
 	if ray_collider != null:
 		if ray_collider.is_in_group("Player"):
@@ -89,6 +92,7 @@ func _physics_process(delta: float) -> void:
 
 	move(delta)
 
+# Speeden up the spinner if its tracking the player
 func _on_player_tracked() -> void:
 	actual_speed = chase_speed
 	animated_sprite_2d.speed_scale = 2
@@ -97,6 +101,5 @@ func _on_player_tracked_stopped() -> void:
 	actual_speed = speed
 	animated_sprite_2d.speed_scale = 1
 
-
 func _on_hit_box_body_entered(body: Node2D) -> void:
 	collision_check(body)

src/Game/Enemies/enemy.gd

@@ -31,12 +31,14 @@ func turn_left() -> void:
 	player_ray.rotation = deg_to_rad(0)
 
 func move(delta: float) -> void:
+	# Change the direction of the enemy if trying to move off a platform or a cliff
 	if not left_ray.is_colliding():
 		turn_right()
 
 	if not right_ray.is_colliding():
 		turn_left()
 
+	# Code for player raycast used to check if an enemy spotted the player
 	if player_ray.is_colliding():
 		var collider: Node = player_ray.get_collider() as Node
 		if ray_collider != collider:
@@ -62,14 +64,17 @@ func kill() -> void:
 
 func collision_check(area: Area2D) -> void:
 	if area.is_in_group("Player"):
+		# Kill the enemy by default if a player has immunity
 		if Globals.player.is_immune:
 			player_hit.emit(false)
 			kill()
 			return
 
+		# If a player isn't jumping, hurt them
 		if Globals.player.velocity.y == 0:
 			player_hit.emit(true)
 		else:
+			# If a player's position is higher than the enemy's, kill the enemy, else hurt the player
 			if Globals.player.feet_pos.global_position.y >= top_pos.global_position.y:
 				player_hit.emit(true)
 			else:
@@ -84,6 +89,7 @@ func _on_area_entered(area: Area2D) -> void:
 	collision_check(area)
 
 func _on_body_entered(body: Node2D) -> void:
+	# Change the direction if an enemy hit something (that is not the player)
 	if not body.is_in_group("Player"):
 		if direction == Vector2.RIGHT:
 			turn_left()

src/Game/Level/level.gd

@@ -8,8 +8,10 @@ signal level_end()
 @export var level_time: int = 200
 
 func _ready() -> void:
+	# Calculate the camera limit of the level (so that the player doesn't see beyond the boundaries)
 	player.camera_limit_x = (tiles.get_used_rect().size.x * 128) - 128
 
+	# Connect all signals of objects in the level to player
 	for pickup: Pickup in get_tree().get_nodes_in_group("PickupInternal"):
 		pickup.pickup_collected.connect(player._on_pickup_collected)
 

src/Game/Objects/LevelEnd/level_end.gd

@@ -9,6 +9,7 @@ func _on_body_entered(body: Node2D) -> void:
 	if not body.is_in_group("Player"):
 		return
 
+	# Signal the end of the level when crossed by the player
 	end_reached.emit()
 
 	collision_shape_2d.set_deferred("disabled", true)