Add a tile-based troll that moves between cells

idbrii · idbrii · commit 1cd3b6a59f23 · 2025-10-05T11:03:42.000-07:00
Games with hexagonal maps usually want characters to stay within the
grid, so add another movement option. This troll has no physics and uses
tweens to move. Instead of collision, it uses tile values to determine
where they're allowed to go.
diff --git a/2d/hexagonal_map/README.md b/2d/hexagonal_map/README.md
@@ -1,6 +1,8 @@
 # Hexagonal Game
 
-Very simple demo showing a hexagonal TileMap and TileSet.
+Very simple demo showing a hexagonal TileMap and TileSet. Has two movement modes:
+* Moving from one hex tile to another.
+* Freely moving without snapping to tiles.
 
 Language: GDScript
 
diff --git a/2d/hexagonal_map/arrow.png b/2d/hexagonal_map/arrow.png
diff --git a/2d/hexagonal_map/arrow.png.import b/2d/hexagonal_map/arrow.png.import
@@ -0,0 +1,40 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://c72pk3msag483"
+path="res://.godot/imported/arrow.png-9a52328c9c8f79a188b7fabb13b1f3fc.ctex"
+metadata={
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://arrow.png"
+dest_files=["res://.godot/imported/arrow.png-9a52328c9c8f79a188b7fabb13b1f3fc.ctex"]
+
+[params]
+
+compress/mode=0
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/uastc_level=0
+compress/rdo_quality_loss=0.0
+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/channel_remap/red=0
+process/channel_remap/green=1
+process/channel_remap/blue=2
+process/channel_remap/alpha=3
+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
diff --git a/2d/hexagonal_map/grid_layer.gd b/2d/hexagonal_map/grid_layer.gd
@@ -0,0 +1,29 @@
+extends TileMapLayer
+
+
+# Returns a global position that's the bottom corner of a tile.
+# https://www.reddit.com/r/godot/comments/fuejci/having_trouble_with_snapping_to_isometric_grid/fmcl07f/
+func snap_global_to_cell(world_pos: Vector2) -> Vector2:
+	# map_to_local says it's the center, but it ignores texture_origin.
+	return to_global(map_to_local(local_to_map(to_local(world_pos))))
+
+
+func global_to_cell_pos(world_pos: Vector2) -> Vector2i:
+	return local_to_map(to_local(world_pos))
+
+
+func cell_to_global_pos(cell_pos: Vector2i) -> Vector2:
+	return to_global(map_to_local(cell_pos))
+
+
+# Change the visual appearance of tile at position world_pos. Select a TileMapLayer and
+# view TileSet > Tile Sources. Use the ID field in Setup to select that tile.
+func set_world_tile(world_pos: Vector2, id: int) -> void:
+	var cell_space: Vector2i = global_to_cell_pos(world_pos)
+	set_cell(cell_space, id)
+
+
+func get_world_tile(world_pos: Vector2) -> int:
+	var cell_space: Vector2i = global_to_cell_pos(world_pos)
+	var id: int = get_cell_source_id(cell_space)
+	return id
diff --git a/2d/hexagonal_map/grid_layer.gd.uid b/2d/hexagonal_map/grid_layer.gd.uid
@@ -0,0 +1 @@
+uid://dfr4hpa3ar62a
diff --git a/2d/hexagonal_map/map.tscn b/2d/hexagonal_map/map.tscn
@@ -1,7 +1,10 @@
-[gd_scene load_steps=3 format=3 uid="uid://4ug0kqe00j8g"]
+[gd_scene load_steps=6 format=4 uid="uid://4ug0kqe00j8g"]
 
 [ext_resource type="TileSet" uid="uid://bgao55br0duys" path="res://tileset.tres" id="1"]
-[ext_resource type="PackedScene" uid="uid://bhgyilxufjioq" path="res://troll.tscn" id="2"]
+[ext_resource type="PackedScene" uid="uid://bhgyilxufjioq" path="res://troll_free.tscn" id="2"]
+[ext_resource type="Script" path="res://grid_layer.gd" id="2_p5pve"]
+[ext_resource type="PackedScene" uid="uid://guyl5tp23ex5" path="res://troll_tile.tscn" id="3_e0an3"]
+[ext_resource type="Script" path="res://troll_toggler.gd" id="3_urblq"]
 
 [node name="Map" type="Node2D"]
 
@@ -11,7 +14,23 @@
 use_parent_material = true
 tile_map_data = PackedByteArray("AAAFAPn/AAAAAAAAAAAGAPn/AAAAAAAAAAAEAPr/AAAAAAAAAAAFAPr/AAAAAAAAAAAGAPr/AAAAAAAAAAAHAPr/AAAAAAAAAAAIAPr/AAAAAAAAAAAJAPr/AAAAAAAAAAACAPv/AAAAAAAAAAADAPv/AAAAAAAAAAAEAPv/AAAAAAAAAAAFAPv/BgAAAAAAAAAGAPv/BgAAAAAAAAAHAPv/BgAAAAAAAAAIAPv/BgAAAAAAAAAJAPv/AAAAAAAAAAAKAPv/AAAAAAAAAAALAPv/AAAAAAAAAAACAPz/AAAAAAAAAAADAPz/AAAAAAAAAAAEAPz/BgAAAAAAAAAFAPz/BgAAAAAAAAAGAPz/BgAAAAAAAAAHAPz/BgAAAAAAAAAIAPz/BgAAAAAAAAAJAPz/AAAAAAAAAAAKAPz/AAAAAAAAAAALAPz/AAAAAAAAAAAMAPz/AAAAAAAAAAANAPz/AAAAAAAAAAACAP3/AAAAAAAAAAADAP3/AAAAAAAAAAAEAP3/BgAAAAAAAAAFAP3/BgAAAAAAAAAGAP3/BgAAAAAAAAAHAP3/BgAAAAAAAAAIAP3/AQAAAAAAAAAJAP3/AAAAAAAAAAAKAP3/AQAAAAAAAAALAP3/AQAAAAAAAAAMAP3/AAAAAAAAAAANAP3/AAAAAAAAAAAOAP3/AAAAAAAAAAABAP7/CQAAAAAAAAACAP7/AAAAAAAAAAADAP7/AAAAAAAAAAAEAP7/AgAAAAAAAAAFAP7/AgAAAAAAAAAGAP7/AAAAAAAAAAAHAP7/FQAAAAAAAAAIAP7/EwAAAAAAAAAJAP7/AAAAAAAAAAAKAP7/AAAAAAAAAAALAP7/EAAAAAAAAAAMAP7/AAAAAAAAAAANAP7/AAAAAAAAAAAOAP7/AAAAAAAAAAAPAP7/AAAAAAAAAAAQAP7/AAAAAAAAAAACAP//AAAAAAAAAAADAP//AQAAAAAAAAAEAP//AAAAAAAAAAAFAP//AAAAAAAAAAAGAP//FAAAAAAAAAAHAP//EwAAAAAAAAAIAP//AgAAAAAAAAAJAP//AAAAAAAAAAAKAP//DgAAAAAAAAALAP//AAAAAAAAAAAMAP//AAAAAAAAAAANAP//AAAAAAAAAAAOAP//FwAAAAAAAAAPAP//AAAAAAAAAAAQAP//AAAAAAAAAAARAP//AAAAAAAAAAADAAAAAQAAAAAAAAAEAAAAAgAAAAAAAAAFAAAAAAAAAAAAAAAGAAAAAQAAAAAAAAAHAAAAAQAAAAAAAAAIAAAAAAAAAAAAAAAJAAAACgAAAAAAAAAKAAAADAAAAAAAAAALAAAAAAAAAAAAAAAMAAAAAAAAAAAAAAANAAAACAAAAAAAAAAOAAAAAAAAAAAAAAAPAAAAAAAAAAAAAAAQAAAAAAAAAAAAAAARAAAAAAAAAAAAAAACAAEAAAAAAAAAAAADAAEAAAAAAAAAAAAEAAEAAgAAAAAAAAAFAAEAAAAAAAAAAAAGAAEAAQAAAAAAAAAHAAEADwAAAAAAAAAIAAEAAAAAAAAAAAAJAAEAAAAAAAAAAAAKAAEAAAAAAAAAAAALAAEAAAAAAAAAAAAMAAEAAAAAAAAAAAANAAEAGQAAAAAAAAAOAAEACAAAAAAAAAAPAAEAAAAAAAAAAAAQAAEAFQAAAAAAAAARAAEAAAAAAAAAAAACAAIAAAAAAAAAAAADAAIAAQAAAAAAAAAEAAIAAAAAAAAAAAAFAAIAAQAAAAAAAAAGAAIAAAAAAAAAAAAHAAIAAAAAAAAAAAAIAAIAAAAAAAAAAAAJAAIABQAAAAAAAAAKAAIAAAAAAAAAAAALAAIAAAAAAAAAAAAMAAIAAAAAAAAAAAANAAIAAAAAAAAAAAAOAAIAAAAAAAAAAAAPAAIAAAAAAAAAAAAQAAIAAAAAAAAAAAARAAIAAAAAAAAAAAACAAMAAAAAAAAAAAADAAMAAAAAAAAAAAAEAAMAAAAAAAAAAAAFAAMAFwAAAAAAAAAGAAMAAAAAAAAAAAAHAAMAAAAAAAAAAAAIAAMAAAAAAAAAAAAJAAMABQAAAAAAAAAKAAMABQAAAAAAAAALAAMAAAAAAAAAAAAMAAMAAAAAAAAAAAANAAMAAAAAAAAAAAAOAAMAAAAAAAAAAAAPAAMAFwAAAAAAAAAQAAMAAAAAAAAAAAAEAAQAAAAAAAAAAAAFAAQAAAAAAAAAAAAGAAQAAAAAAAAAAAAHAAQAAAAAAAAAAAAIAAQACAAAAAAAAAAJAAQABQAAAAAAAAAKAAQABQAAAAAAAAALAAQAAAAAAAAAAAAMAAQAAAAAAAAAAAANAAQAFQAAAAAAAAAOAAQAAAAAAAAAAAAPAAQAAAAAAAAAAAAQAAQAAAAAAAAAAAAGAAUAAAAAAAAAAAAHAAUAAAAAAAAAAAAIAAUAAAAAAAAAAAAJAAUAAAAAAAAAAAAKAAUAAAAAAAAAAAALAAUAAAAAAAAAAAAMAAUAAAAAAAAAAAANAAUAAAAAAAAAAAAOAAUAAAAAAAAAAAA=")
 tile_set = ExtResource("1")
+script = ExtResource("2_p5pve")
 
-[node name="Troll" parent="." instance=ExtResource("2")]
+[node name="TrollSpawner" type="Node2D" parent="."]
+position = Vector2(599, 98)
+script = ExtResource("3_urblq")
+
+[node name="TileMovementTroll" parent="TrollSpawner" node_paths=PackedStringArray("grid") instance=ExtResource("3_e0an3")]
+position = Vector2(-174, 28)
+grid = NodePath("../../Tiles/Layer0")
+
+[node name="FreeMovementTroll" parent="TrollSpawner" instance=ExtResource("2")]
 modulate = Color(1.5, 1.5, 1.5, 1)
-position = Vector2(602.819, -39.2876)
+position = Vector2(3.81897, -137.288)
+
+[node name="CanvasLayer" type="CanvasLayer" parent="."]
+
+[node name="Label" type="Label" parent="CanvasLayer"]
+offset_right = 40.0
+offset_bottom = 23.0
+text = "Press Enter/Start to toggle between Free and Tile-Based Movement."
diff --git a/2d/hexagonal_map/project.godot b/2d/hexagonal_map/project.godot
@@ -60,6 +60,12 @@ move_up={
 , Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194320,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
 ]
 }
+toggle_movement_method={
+"deadzone": 0.2,
+"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194309,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)
+, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":6,"pressure":0.0,"pressed":true,"script":null)
+]
+}
 
 [physics]
 
diff --git a/2d/hexagonal_map/troll_free.gd b/2d/hexagonal_map/troll_free.gd
@@ -4,6 +4,11 @@ const MOTION_SPEED = 30
 const FRICTION_FACTOR = 0.89
 const TAN30DEG = tan(deg_to_rad(30))
 
+
+func become_active_troll() -> void:
+	pass
+
+
 func _physics_process(_delta: float) -> void:
 	var motion := Vector2()
 	motion.x = Input.get_axis(&"move_left", &"move_right")
diff --git a/2d/hexagonal_map/troll_free.gd.uid b/2d/hexagonal_map/troll_free.gd.uid
diff --git a/2d/hexagonal_map/troll_free.tscn b/2d/hexagonal_map/troll_free.tscn
@@ -1,6 +1,6 @@
 [gd_scene load_steps=4 format=3 uid="uid://bhgyilxufjioq"]
 
-[ext_resource type="Script" uid="uid://qcncmx710eij" path="res://troll.gd" id="1"]
+[ext_resource type="Script" uid="uid://qcncmx710eij" path="res://troll_free.gd" id="1"]
 [ext_resource type="Texture2D" uid="uid://bhkphpfidntnn" path="res://troll.png" id="2"]
 
 [sub_resource type="CircleShape2D" id="1"]
diff --git a/2d/hexagonal_map/troll_tile.gd b/2d/hexagonal_map/troll_tile.gd
@@ -0,0 +1,124 @@
+extends Node2D
+
+const CELL_NEIGHBOR_INVALID: int = -1
+
+@export var grid: TileMapLayer
+@export var move_duration: float = 0.5
+
+
+var block_input: bool = false
+var current_facing_flip: bool = false
+
+
+@onready var destination_pointer: Node2D = $DestinationPointer
+
+
+func become_active_troll() -> void:
+	# Ensure we start trolling in the middle of our grid cell.
+	global_position = grid.snap_global_to_cell(global_position)
+
+
+# Map the input to a world-space position.
+func _input_dir_to_dest(input_dir: Vector2) -> Vector2:
+	var neighbor: int = _input_dir_to_neighbor(input_dir)
+	if neighbor != CELL_NEIGHBOR_INVALID:
+		# neighbor is a CellNeighbor.
+		var current_cell: Vector2i = grid.global_to_cell_pos(global_position)
+		var cell: Vector2i = grid.get_neighbor_cell(current_cell, neighbor)
+		return grid.cell_to_global_pos(cell)
+
+	return global_position
+
+
+func _matches_grid_angle(input_dir: Vector2, direction: Vector2) -> bool:
+	# Divide circle of possible inputs into one segment for each side of our
+	# grid shape.
+	const SEGMENT: float = TAU / 6.0 * 0.5
+	var angle: float = input_dir.angle_to(direction)
+	return abs(angle) < SEGMENT
+
+
+func _input_dir_to_neighbor(input_dir: Vector2) -> int:
+	const HEX_DELTA: float = TAU / 6.0
+
+	# For our overhead hexmap, check the input angle against a wedge at each of
+	# the 6 sides of the hex. Pick out each neighbor starting with DOWN
+	# because our hexes have a flat top and bottom.
+	# NOTE: For hexes with flat sides and pointy tops, we'd use a different set
+	# of neighbors and use RIGHT instead of DOWN.
+	var neighbors: Array[TileSet.CellNeighbor] = [
+		TileSet.CellNeighbor.CELL_NEIGHBOR_BOTTOM_SIDE,  # First corresponds to base Vector2.DOWN below.
+		TileSet.CellNeighbor.CELL_NEIGHBOR_BOTTOM_LEFT_SIDE,
+		TileSet.CellNeighbor.CELL_NEIGHBOR_TOP_LEFT_SIDE,
+		TileSet.CellNeighbor.CELL_NEIGHBOR_TOP_SIDE,
+		TileSet.CellNeighbor.CELL_NEIGHBOR_TOP_RIGHT_SIDE,
+		TileSet.CellNeighbor.CELL_NEIGHBOR_BOTTOM_RIGHT_SIDE,
+	]
+
+	# Each neighbour specifies an additional HEX_DELTA rotation from
+	# base_direction.
+	for i in neighbors.size():
+		if _matches_grid_angle(input_dir, Vector2.DOWN.rotated(HEX_DELTA * i)):
+			return neighbors[i]
+
+	print("_input_dir_to_neighbor: Failed to find a match.")
+	return CELL_NEIGHBOR_INVALID
+
+
+func _process(_dt: float) -> void:
+	var motion: Vector2 = Input.get_vector(&"move_left", &"move_right", &"move_up", &"move_down")
+
+	# If your perspective was closer to isometric, you should rotate the input
+	# to match the iso projection so you correctly interpret diagonal inputs:
+	#var iso_motion: Vector2 = motion.rotated(TAU * 1.0 / 10.0)
+	var iso_motion: Vector2 = motion
+	# Use a hefty deadzone since movement is discrete.
+	const DEADZONE_SQ = 0.3 * 0.3
+	var want_movement: bool = iso_motion.length_squared() > DEADZONE_SQ
+	destination_pointer.visible = want_movement
+	if want_movement:
+		var destination: Vector2 = _input_dir_to_dest(iso_motion)
+		var displacement: Vector2 = destination - global_position
+
+		destination_pointer.rotation = displacement.angle()
+
+		if block_input:
+			return
+
+		destination = grid.snap_global_to_cell(destination)
+		var destination_tile: int = grid.get_world_tile(destination)
+		var has_tile: bool = destination_tile >= 0
+
+		var flip_h: bool = displacement.x <= 0
+		if absf(displacement.x) > 0 and flip_h != current_facing_flip:
+			current_facing_flip = flip_h
+			for sprite in $Visual.get_children():
+				sprite.flip_h = flip_h
+
+		block_input = true
+
+		var tween: Tween = create_tween()
+		if has_tile:
+			var t: PropertyTweener = tween.tween_property(self, "global_position", displacement, move_duration)
+			t = t.from_current()
+			t = t.as_relative()
+			t = t.set_ease(Tween.EASE_IN_OUT)
+			t = t.set_trans(Tween.TRANS_SINE)
+
+		else:
+			# Bounce off collision to give feedback that we recognized the input but it was invalid.
+			var duration: float = move_duration * 0.1
+			var current_pos: Vector2 = global_position
+			var t: PropertyTweener = tween.tween_property(self, "global_position", displacement * 0.1, duration)
+			t = t.from_current()
+			t = t.as_relative()
+			t = t.set_ease(Tween.EASE_IN_OUT)
+			t = t.set_trans(Tween.TRANS_SINE)
+			t = tween.chain().tween_property(self, "global_position", current_pos, duration)
+			t = t.from_current()
+			t = t.set_ease(Tween.EASE_IN_OUT)
+			t = t.set_trans(Tween.TRANS_SINE)
+
+		await tween.finished
+
+		block_input = false
diff --git a/2d/hexagonal_map/troll_tile.gd.uid b/2d/hexagonal_map/troll_tile.gd.uid
@@ -0,0 +1 @@
+uid://crpoxv2am8c2m
diff --git a/2d/hexagonal_map/troll_tile.tscn b/2d/hexagonal_map/troll_tile.tscn
@@ -0,0 +1,33 @@
+[gd_scene load_steps=4 format=3 uid="uid://guyl5tp23ex5"]
+
+[ext_resource type="Script" uid="uid://crpoxv2am8c2m" path="res://troll_tile.gd" id="1_87qsy"]
+[ext_resource type="Texture2D" uid="uid://bhkphpfidntnn" path="res://troll.png" id="2_34a22"]
+[ext_resource type="Texture2D" uid="uid://c72pk3msag483" path="res://arrow.png" id="3_34a22"]
+
+[node name="TileMovementTroll" type="Node2D"]
+script = ExtResource("1_87qsy")
+
+[node name="DestinationPointer" type="Node2D" parent="."]
+
+[node name="PointerVisual" type="Sprite2D" parent="DestinationPointer"]
+position = Vector2(42, 0)
+texture = ExtResource("3_34a22")
+
+[node name="Visual" type="Node2D" parent="."]
+
+[node name="Sprite2D" type="Sprite2D" parent="Visual"]
+modulate = Color(1.5, 1.5, 1.5, 1)
+position = Vector2(-3.74084, -19.5)
+texture = ExtResource("2_34a22")
+
+[node name="Shadow" type="Sprite2D" parent="Visual"]
+modulate = Color(0, 0, 0, 0.501961)
+show_behind_parent = true
+position = Vector2(12.7014, -14.6056)
+scale = Vector2(0.794259, 1.04505)
+skew = 0.523599
+texture = ExtResource("2_34a22")
+
+[node name="Camera2D" type="Camera2D" parent="."]
+position = Vector2(-3.74084, -19.5)
+process_callback = 0
diff --git a/2d/hexagonal_map/troll_toggler.gd b/2d/hexagonal_map/troll_toggler.gd
@@ -0,0 +1,29 @@
+extends Node2D
+
+var next_index: int = 0
+var troll: Node2D
+
+@onready var troll_list: Array[Node] = get_children()
+
+
+func _ready() -> void:
+    for t in troll_list:
+        remove_child(t)
+    spawn_next_troll()
+    troll.become_active_troll()
+
+
+func spawn_next_troll() -> void:
+    troll = troll_list[next_index]
+    add_child(troll)
+    next_index += 1
+    next_index = next_index % troll_list.size()
+
+
+func _process(_delta: float) -> void:
+    if Input.is_action_just_pressed(&"toggle_movement_method"):
+        var pos: Vector2 = troll.global_position
+        remove_child(troll)
+        spawn_next_troll()
+        troll.global_position = pos
+        troll.become_active_troll()
diff --git a/2d/hexagonal_map/troll_toggler.gd.uid b/2d/hexagonal_map/troll_toggler.gd.uid
@@ -0,0 +1 @@
+uid://cwx0fhe3dq7bl

Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,12 @@ move_up={`
`60`	`60`	`, Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194320,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)`
`61`	`61`	`]`
`62`	`62`	`}`
	`63`	`+toggle_movement_method={`
	`64`	`+"deadzone": 0.2,`
	`65`	`+"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194309,"key_label":0,"unicode":0,"location":0,"echo":false,"script":null)`
	`66`	`+, Object(InputEventJoypadButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"button_index":6,"pressure":0.0,"pressed":true,"script":null)`
	`67`	`+]`
	`68`	`+}`
`63`	`69`
`64`	`70`	`[physics]`
`65`	`71`