Merge pull request #933 from endlessm/grappling-hook

Add grappling hook mechanic and intro level

Author: manuq

project.godot

@@ -73,6 +73,7 @@ filling_barrels=""
 projectiles=""
 guard_enemy=""
 sequence_object=""
+hook_listener=""
 
 [input]
 
@@ -181,6 +182,7 @@ sokoban_skip={
 2d_physics/layer_8="enemies hitbox"
 2d_physics/layer_9="projectiles"
 2d_physics/layer_10="non_walkable_floor"
+2d_physics/layer_13="hookable"
 
 [rendering]
 

scenes/game_elements/characters/player/components/animation_player.gd

@@ -7,11 +7,13 @@ const REPEL_ANTICIPATION_TIME: float = 0.3
 @onready var player: Player = owner
 @onready var player_sprite: AnimatedSprite2D = %PlayerSprite
 @onready var player_fighting: Node2D = %PlayerFighting
+@onready var player_hook: Node2D = %PlayerHook
 @onready var original_speed_scale: float = speed_scale
 
 
 func _ready() -> void:
 	player.mode_changed.connect(_on_player_mode_changed)
+	player_hook.string_thrown.connect(_on_player_hook_string_thrown)
 
 
 func _process(_delta: float) -> void:
@@ -20,6 +22,8 @@ func _process(_delta: float) -> void:
 			_process_walk_idle(_delta)
 		Player.Mode.FIGHTING:
 			_process_fighting(_delta)
+		Player.Mode.HOOKING:
+			_process_hooking(_delta)
 
 	var double_speed: bool = current_animation == &"walk" and player.is_running()
 	speed_scale = original_speed_scale * (2.0 if double_speed else 1.0)
@@ -58,7 +62,20 @@ func _process_fighting(delta: float) -> void:
 		seek(REPEL_ANTICIPATION_TIME, false, false)
 
 
+func _process_hooking(delta: float) -> void:
+	if current_animation == &"throw_string":
+		return
+
+	_process_walk_idle(delta)
+
+
 func _on_player_mode_changed(mode: Player.Mode) -> void:
 	match player.mode:
 		Player.Mode.DEFEATED:
 			play(&"defeated")
+
+
+func _on_player_hook_string_thrown() -> void:
+	if current_animation == &"throw_string":
+		stop()
+	play(&"throw_string")

scenes/game_elements/characters/player/components/hook-string.aseprite

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:25e494f91925ca29ad0480fee0805446df204d0142e3a2ddd99d54b32726c02f
+size 387

scenes/game_elements/characters/player/components/hook-string.png

@@ -0,0 +1,34 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://q3c2qavtccvu"
+path="res://.godot/imported/hook-string.png-e8e2f9d47f895dcaf787c3a257fd7d67.ctex"
+metadata={
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://scenes/game_elements/characters/player/components/hook-string.png"
+dest_files=["res://.godot/imported/hook-string.png-e8e2f9d47f895dcaf787c3a257fd7d67.ctex"]
+
+[params]
+
+compress/mode=0
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/hdr_compression=1
+compress/normal_map=0
+compress/channel_pack=0
+mipmaps/generate=false
+mipmaps/limit=-1
+roughness/mode=0
+roughness/src_normal=""
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/normal_map_invert_y=false
+process/hdr_as_srgb=false
+process/hdr_clamp_exposure=false
+process/size_limit=0
+detect_3d/compress_to=1

scenes/game_elements/characters/player/components/hook-string.png.import

@@ -13,6 +13,8 @@ enum Mode {
 	COZY,
 	## Player is engaged in combat. Player can use combat actions.
 	FIGHTING,
+	## Player is using the grappling hook.
+	HOOKING,
 	## Player can't be controlled anymore.
 	DEFEATED,
 }
@@ -44,6 +46,7 @@ const DEFAULT_SPRITE_FRAME: SpriteFrames = preload("uid://vwf8e1v8brdp")
 	set = _set_mode
 @export_range(10, 100000, 10) var walk_speed: float = 300.0
 @export_range(10, 100000, 10) var run_speed: float = 500.0
+@export_range(10, 100000, 10) var aiming_speed: float = 100.0
 @export_range(10, 100000, 10) var stopping_step: float = 1500.0
 @export_range(10, 100000, 10) var moving_step: float = 4000.0
 
@@ -61,6 +64,7 @@ var input_vector: Vector2
 
 @onready var player_interaction: PlayerInteraction = %PlayerInteraction
 @onready var player_fighting: Node2D = %PlayerFighting
+@onready var player_hook: PlayerHook = %PlayerHook
 @onready var player_sprite: AnimatedSprite2D = %PlayerSprite
 @onready var _walk_sound: AudioStreamPlayer2D = %WalkSound
 
@@ -74,12 +78,19 @@ func _set_mode(new_mode: Mode) -> void:
 		Mode.COZY:
 			_toggle_player_behavior(player_interaction, true)
 			_toggle_player_behavior(player_fighting, false)
+			_toggle_player_behavior(player_hook, false)
 		Mode.FIGHTING:
 			_toggle_player_behavior(player_interaction, false)
 			_toggle_player_behavior(player_fighting, true)
+			_toggle_player_behavior(player_hook, false)
+		Mode.HOOKING:
+			_toggle_player_behavior(player_interaction, false)
+			_toggle_player_behavior(player_fighting, false)
+			_toggle_player_behavior(player_hook, true)
 		Mode.DEFEATED:
 			_toggle_player_behavior(player_interaction, false)
 			_toggle_player_behavior(player_fighting, false)
+			_toggle_player_behavior(player_hook, false)
 	if mode != previous_mode:
 		mode_changed.emit(mode)
 
@@ -138,7 +149,9 @@ func _unhandled_input(_event: InputEvent) -> void:
 	var axis: Vector2 = Input.get_vector(&"ui_left", &"ui_right", &"ui_up", &"ui_down")
 
 	var speed: float
-	if Input.is_action_pressed(&"running"):
+	if player_hook.is_throwing_or_aiming():
+		speed = aiming_speed
+	elif Input.is_action_pressed(&"running"):
 		speed = run_speed
 	else:
 		speed = walk_speed
@@ -159,6 +172,10 @@ func _process(delta: float) -> void:
 	if Engine.is_editor_hint():
 		return
 
+	# While pulling the grappling hook, the movement is handled in PlayerHook._process.
+	if player_hook.pulling:
+		return
+
 	if player_interaction.is_interacting or mode == Mode.DEFEATED:
 		velocity = Vector2.ZERO
 		return