Cleanup and renaming of the camera script

README.md

@@ -2,5 +2,6 @@
 
 My attempt at a [Conway's Game of Life](https://en.wikipedia.org/wiki/Conway's_Game_of_Life) simulation using Godot 4
 
+The project is also utilizing a RenderingServer to generate the cells.
 
-The project is also utilizing a RenderingServer to generate the cells. This might be overkill but though it would be fun to try.
+The project is over engineered but what isn't?

icon.svg.import → assets/icon.svg.import

@@ -3,15 +3,15 @@
 importer="texture"
 type="CompressedTexture2D"
 uid="uid://c2vm5pfsamed4"
-path="res://.godot/imported/icon.svg-218a8f2b3041327d8a5756f3a245f83b.ctex"
+path="res://.godot/imported/icon.svg-56083ea2a1f1a4f1e49773bdc6d7826c.ctex"
 metadata={
 "vram_texture": false
 }
 
 [deps]
 
-source_file="res://icon.svg"
-dest_files=["res://.godot/imported/icon.svg-218a8f2b3041327d8a5756f3a245f83b.ctex"]
+source_file="res://assets/icon.svg"
+dest_files=["res://.godot/imported/icon.svg-56083ea2a1f1a4f1e49773bdc6d7826c.ctex"]
 
 [params]
 

project.godot

@@ -11,9 +11,9 @@ config_version=5
 [application]
 
 config/name="Conway's Game of Life"
-run/main_scene="res://world.tscn"
+run/main_scene="res://scenes/conway.tscn"
 config/features=PackedStringArray("4.1", "Forward Plus")
-config/icon="res://icon.svg"
+config/icon="res://assets/icon.svg"
 
 [input]
 
@@ -34,3 +34,44 @@ Menu={
 , 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":78,"key_label":0,"unicode":110,"echo":false,"script":null)
 ]
 }
+"Zoom In"={
+"deadzone": 0.5,
+"events": [Object(InputEventMouseButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"button_mask":8,"position":Vector2(178, 5),"global_position":Vector2(182, 48),"factor":1.0,"button_index":4,"canceled":false,"pressed":true,"double_click":false,"script":null)
+, 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":61,"key_label":0,"unicode":61,"echo":false,"script":null)
+]
+}
+"Zoom Out"={
+"deadzone": 0.5,
+"events": [Object(InputEventMouseButton,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"button_mask":16,"position":Vector2(231, 17),"global_position":Vector2(235, 60),"factor":1.0,"button_index":5,"canceled":false,"pressed":true,"double_click":false,"script":null)
+, 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":45,"key_label":0,"unicode":45,"echo":false,"script":null)
+]
+}
+"Reset Zoom"={
+"deadzone": 0.5,
+"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":82,"key_label":0,"unicode":114,"echo":false,"script":null)
+]
+}
+Left={
+"deadzone": 0.5,
+"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":65,"key_label":0,"unicode":97,"echo":false,"script":null)
+, 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":4194319,"key_label":0,"unicode":0,"echo":false,"script":null)
+]
+}
+Right={
+"deadzone": 0.5,
+"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":68,"key_label":0,"unicode":100,"echo":false,"script":null)
+, 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":4194321,"key_label":0,"unicode":0,"echo":false,"script":null)
+]
+}
+Up={
+"deadzone": 0.5,
+"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":87,"key_label":0,"unicode":119,"echo":false,"script":null)
+, 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":4194320,"key_label":0,"unicode":0,"echo":false,"script":null)
+]
+}
+Down={
+"deadzone": 0.5,
+"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":83,"key_label":0,"unicode":115,"echo":false,"script":null)
+, 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":4194322,"key_label":0,"unicode":0,"echo":false,"script":null)
+]
+}

scenes/camera.gd

@@ -0,0 +1,21 @@
+extends Camera2D
+
+
+@export var move_speed: int = 250
+@export var zoom_increment: Vector2 = Vector2(0.1, 0.1)
+
+
+func _process(delta: float) -> void:
+	var input_dir := Input.get_vector("Left", "Right", "Up", "Down")
+	var velocity_y = input_dir.y * move_speed * delta
+	var velocity_x = input_dir.x * move_speed * delta
+
+	position += Vector2(velocity_x, velocity_y)
+
+func _unhandled_input(event: InputEvent) -> void:
+	if event.is_action_pressed("Reset Zoom"):
+		zoom = Vector2.ONE
+	if event.is_action_pressed("Zoom In"):
+		zoom += zoom_increment
+	if event.is_action_pressed("Zoom Out"):
+		zoom -= zoom_increment

world.gd → scenes/conway.gd

@@ -21,29 +21,42 @@ enum CellStates {
 
 @onready var generation_ui: MarginContainer = $UI/WorldGeneration
 @onready var generation_seed: LineEdit = $UI/WorldGeneration/VBoxContainer/Seed/Input
+@onready var generation_speed: HSlider = $UI/WorldGeneration/VBoxContainer/GenerationSpeed/Input
 @onready var generation_world_size_x: LineEdit = $UI/WorldGeneration/VBoxContainer/WorldSize/Input_x
 @onready var generation_world_size_y: LineEdit = $UI/WorldGeneration/VBoxContainer/WorldSize/Input_y
-@onready var generation_cell_size_x: LineEdit = $UI/WorldGeneration/VBoxContainer/CellSize/Input_x
-@onready var generation_cell_size_y: LineEdit = $UI/WorldGeneration/VBoxContainer/CellSize/Input_y
 @onready var start_paused_button: CheckBox = $UI/WorldGeneration/VBoxContainer/FinalRow/StartPausedButton
 
+@onready var messages_label: Label = $UI/Messages/Label
+
 ## Other
-@onready var camera: Camera2D = $Camera2D
+@onready var camera: Camera2D = $Camera
 @onready var generation_timer: Timer = $GenerationTimer
 
-@export var world_seed: int
-@export var cell_size: Vector2 = Vector2(16, 16)
-@export var cell_texture: Texture2D
-@export var world_size: Vector2 = Vector2(32, 32)
+@export var world_seed: int ## The seed utilized for generation of the world
+@export var cell_size: Vector2 = Vector2(16, 16) ## Size of each cell image
+@export var cell_texture: Texture2D ## Testure for each cell
+@export var world_size: Vector2 = Vector2(32, 32) ## The size of the world
 
 var cell_instance
+var evolution_is_stalled: bool = false
 var generation: int = 1
-var is_paused: int = false
+var is_paused: bool = false
 var total_living: int = 0
 
 var cell_ids: Array = [] # Store cell RIDs
 var cell_states: Array = []
 
+var previous_generation_hashes: Array = [] # Store the generation related to the hashes
+var previous_generation_count: int = 10 # Number of generations to check for evolution stalling
+
+# Number of collisions to consider evolution stalled
+#  The higher the number, the less likely to catch oscillators
+#  Consider the previous_generation_count as this may need to increase for larger counts
+#  4 Collisions out of 10 previous_generation_count seems reasonable although it may not be quite enough
+var collision_count_limit: int = 4
+
+var timer_speeds: Array = [0.1, 0.08, 0.05, 0.03, 0.01] # The speeds for the generation_timer for selection from the UI
+
 
 func _ready() -> void:
 	update_generation_ui()
@@ -75,8 +88,6 @@ func update_generation_ui() -> void:
 		generation_seed.text = str(randi())
 	generation_world_size_x.text = str(world_size.x)
 	generation_world_size_y.text = str(world_size.y)
-	generation_cell_size_x.text = str(cell_size.x)
-	generation_cell_size_y.text = str(cell_size.y)
 	start_paused_button.button_pressed = false
 
 
@@ -84,19 +95,24 @@ func update_generation_ui() -> void:
 # Conway Specific
 #
 func start_conway() -> void:
+	clear_world()
+	generate_world()
+	update_previous_generation_hashes()
+
 	generation = 1
+	evolution_is_stalled = false
 	debug_world_seed.text = "World Seeed: %s" % world_seed
 	debug_generation_counter.text = "Generation: %s" % generation
-
-	generate_world()
-
 	debug_living_cells_counter.text = "Living Cells: %s" % total_living
 
-	if not is_paused: generation_timer.start()
-
 	# Center the camera on the world
-	camera.position.x = world_size.x * cell_size.x / 2
-	camera.position.y = world_size.y * cell_size.y / 2
+	camera.position = Vector2(
+		world_size.x * cell_size.x / 2,
+		world_size.y * cell_size.y / 2
+	)
+	camera.zoom = Vector2.ONE
+
+	if not is_paused: generation_timer.start()
 
 
 ## Check a cell against the Conway rules and return True if cell should be alive
@@ -138,8 +154,32 @@ func count_living_neighbors(pos: Vector2) -> int:
 				count += 1
 	return count
 
+func end_world_generation() -> void:
+	# Determine which generation first stalled
+	var current_world_hash: int = cell_states.hash()
+	var colliding = previous_generation_hashes.filter(func(gen): return gen.hash == current_world_hash)
+	var stalled_generation = colliding[0].generation
+
+	messages_label.text = "Detected Stalled Evolution Starting at Generation %s" % stalled_generation
+	messages_label.visible = true
+	evolution_is_stalled = true
+
+## Get the number of previous generation results that collide with the current hash
+func get_colliding_hash_count(input_hash: int) -> int:
+	var count = 0
+	for gen in previous_generation_hashes:
+		count += int(gen.hash == input_hash)
+	return count
+
 ## Loop through world to generate cell states, hide/show cells depending on state
 func process_generation() -> void:
+	if evolution_is_stalled: return
+
+	update_previous_generation_hashes()
+
+	if previous_generation_hashes[previous_generation_hashes.size()-1].collisions >= collision_count_limit:
+		return end_world_generation()
+
 	generation += 1
 	total_living = 0
 
@@ -158,13 +198,40 @@ func process_generation() -> void:
 
 	cell_states = new_states
 
+## Update the previous run hash and generation ids
+##  We only store the last `previous_generation_count` number of results
+func update_previous_generation_hashes() -> void:
+	if previous_generation_hashes.size() < previous_generation_count:
+		previous_generation_hashes.resize(previous_generation_count)
+		previous_generation_hashes.fill({"generation": 0, "hash": 0, "collisions": 0})
+
+	# Remove the oldest generation information
+	previous_generation_hashes.remove_at(0)
+
+	var generation_hash := cell_states.hash()
+	previous_generation_hashes.append({
+		"generation": generation,
+		"hash": generation_hash,
+		"collisions": get_colliding_hash_count(generation_hash),
+	})
+
 ## Toggle Pause UI and Start/Stop Generation Timer
 func toggle_pause() -> void:
-	if is_paused: generation_timer.start()
-	else: generation_timer.stop()
 	is_paused = !is_paused
 	background_ui.visible = is_paused
 
+	if is_paused: generation_timer.stop()
+	else: generation_timer.start()
+
+
+## Loop over cell_ids and free the resource in the RenderingServer
+##   Clear cell_ids and cell_states
+func clear_world() -> void:
+	for row in cell_ids:
+		for id in row:
+			RenderingServer.free_rid(id)
+	cell_ids = []
+	cell_states = []
 
 ## Create the cell using the rendering server
 ##  This is only performed on initial world generation
@@ -193,7 +260,7 @@ func generate_world() -> void:
 		cell_states.append([])
 		cell_states[x].resize(world_size.x)
 		for y in range(world_size.y):
-			var is_alive: int = randi_range(0, 1)
+			var is_alive: int = randi_range(CellStates.DEAD, CellStates.ALIVE)
 			total_living += is_alive
 			cell_states[x][y] = is_alive
 			cell_ids[x][y] = create_cell(Vector2(x, y), bool(is_alive))
@@ -207,20 +274,25 @@ func _on_generation_timer_timeout() -> void:
 
 	generation_timer.start()
 
+func _on_generation_speed_drag_ended(value_changed: bool) -> void:
+	var speed = generation_speed.value - 1
+	if value_changed:
+		generation_timer.wait_time = timer_speeds[speed]
+
 func _on_quit_button_pressed() -> void:
 	get_tree().quit()
 
 func _on_run_button_pressed() -> void:
-	if not generation_seed.text.strip_edges():
-		world_seed = randi()
-	else:
+	if generation_seed.text.strip_edges():
 		world_seed = int(generation_seed.text)
+	else:
+		world_seed = randi()
 	world_size = Vector2(int(generation_world_size_x.text), int(generation_world_size_y.text))
-	cell_size = Vector2(int(generation_cell_size_x.text), int(generation_cell_size_y.text))
 
 	debug_ui.visible = true
 	generation_ui.visible = false
 	background_ui.visible = false
+	messages_label.visible = false
 	seed(world_seed)
 
 	start_conway()
@@ -230,3 +302,7 @@ func _on_start_paused_button_toggled(button_pressed: bool) -> void:
 
 func _on_world_seed_generate_pressed() -> void:
 	generation_seed.text = str(randi())
+
+
+func _exit_tree() -> void:
+	clear_world()

world.tscn → scenes/conway.tscn

@@ -1,17 +1,18 @@
 [gd_scene load_steps=5 format=3 uid="uid://d3twfk56sjf2m"]
 
-[ext_resource type="Script" path="res://world.gd" id="1_wavft"]
-[ext_resource type="Texture2D" uid="uid://c2vm5pfsamed4" path="res://icon.svg" id="2_8r6bn"]
-[ext_resource type="PackedScene" uid="uid://cy6vsgu8o0rad" path="res://scenes/fps_counter/fps_counter.tscn" id="3_ves6s"]
-[ext_resource type="Texture2D" uid="uid://b8gggrriib8n" path="res://assets/refresh.png" id="4_fcljs"]
+[ext_resource type="Script" path="res://scenes/conway.gd" id="1_1gvb0"]
+[ext_resource type="Texture2D" uid="uid://c2vm5pfsamed4" path="res://assets/icon.svg" id="2_l6fa6"]
+[ext_resource type="Script" path="res://scenes/camera.gd" id="3_e0v0d"]
+[ext_resource type="Texture2D" uid="uid://b8gggrriib8n" path="res://assets/refresh.png" id="4_hmfh6"]
 
 [node name="World" type="Node2D"]
 position = Vector2(-152, 0)
-script = ExtResource("1_wavft")
-cell_texture = ExtResource("2_8r6bn")
+script = ExtResource("1_1gvb0")
+cell_texture = ExtResource("2_l6fa6")
 
-[node name="Camera2D" type="Camera2D" parent="."]
+[node name="Camera" type="Camera2D" parent="."]
 position = Vector2(464, 200)
+script = ExtResource("3_e0v0d")
 
 [node name="GenerationTimer" type="Timer" parent="."]
 wait_time = 0.05
@@ -44,10 +45,6 @@ offset_bottom = 116.0
 [node name="VBoxContainer" type="VBoxContainer" parent="UI/Debug"]
 layout_mode = 2
 
-[node name="FPSCounter" parent="UI/Debug/VBoxContainer" instance=ExtResource("3_ves6s")]
-layout_mode = 2
-text = "FPS: 0"
-
 [node name="WorldSeed" type="Label" parent="UI/Debug/VBoxContainer"]
 layout_mode = 2
 text = "World Seed: 0"
@@ -94,7 +91,7 @@ text = "Seed"
 [node name="Generate" type="Button" parent="UI/WorldGeneration/VBoxContainer/Seed"]
 self_modulate = Color(0.501961, 0.501961, 0.501961, 1)
 layout_mode = 2
-icon = ExtResource("4_fcljs")
+icon = ExtResource("4_hmfh6")
 
 [node name="Input" type="LineEdit" parent="UI/WorldGeneration/VBoxContainer/Seed"]
 custom_minimum_size = Vector2(200, 0)
@@ -139,41 +136,30 @@ text = "32"
 max_length = 4
 select_all_on_focus = true
 
-[node name="CellSize" type="HBoxContainer" parent="UI/WorldGeneration/VBoxContainer"]
+[node name="GenerationSpeed" type="HBoxContainer" parent="UI/WorldGeneration/VBoxContainer"]
 layout_mode = 2
-theme_override_constants/separation = 6
 
-[node name="Label" type="Label" parent="UI/WorldGeneration/VBoxContainer/CellSize"]
-custom_minimum_size = Vector2(120, 0)
+[node name="Label" type="Label" parent="UI/WorldGeneration/VBoxContainer/GenerationSpeed"]
 layout_mode = 2
-text = "Cell Size"
+text = "Generation Speed"
 
-[node name="Padding" type="VSeparator" parent="UI/WorldGeneration/VBoxContainer/CellSize"]
+[node name="Padding" type="VSeparator" parent="UI/WorldGeneration/VBoxContainer/GenerationSpeed"]
 modulate = Color(1, 1, 1, 0)
 layout_mode = 2
 size_flags_horizontal = 3
 
-[node name="Label_x" type="Label" parent="UI/WorldGeneration/VBoxContainer/CellSize"]
-layout_mode = 2
-text = "X:"
-
-[node name="Input_x" type="LineEdit" parent="UI/WorldGeneration/VBoxContainer/CellSize"]
-custom_minimum_size = Vector2(20, 0)
-layout_mode = 2
-text = "16"
-max_length = 4
-select_all_on_focus = true
-
-[node name="Label_y" type="Label" parent="UI/WorldGeneration/VBoxContainer/CellSize"]
+[node name="Input" type="HSlider" parent="UI/WorldGeneration/VBoxContainer/GenerationSpeed"]
+custom_minimum_size = Vector2(200, 0)
 layout_mode = 2
-text = "Y:"
+tooltip_text = "The higher the speed, the less time between generations.
 
-[node name="Input_y" type="LineEdit" parent="UI/WorldGeneration/VBoxContainer/CellSize"]
-custom_minimum_size = Vector2(20, 0)
-layout_mode = 2
-text = "16"
-max_length = 4
-select_all_on_focus = true
+Slowest: 0.1/s
+Fastest: 0.01/s"
+min_value = 1.0
+max_value = 5.0
+value = 3.0
+tick_count = 5
+ticks_on_borders = true
 
 [node name="FinalRow" type="HBoxContainer" parent="UI/WorldGeneration/VBoxContainer"]
 layout_mode = 2
@@ -196,8 +182,25 @@ layout_direction = 3
 layout_mode = 2
 text = "Quit"
 
+[node name="Messages" type="MarginContainer" parent="UI"]
+anchors_preset = 7
+anchor_left = 0.5
+anchor_top = 1.0
+anchor_right = 0.5
+anchor_bottom = 1.0
+offset_left = -20.0
+offset_top = -40.0
+offset_right = 20.0
+grow_horizontal = 2
+grow_vertical = 0
+
+[node name="Label" type="Label" parent="UI/Messages"]
+visible = false
+layout_mode = 2
+
 [connection signal="timeout" from="GenerationTimer" to="." method="_on_generation_timer_timeout"]
 [connection signal="pressed" from="UI/WorldGeneration/VBoxContainer/Seed/Generate" to="." method="_on_world_seed_generate_pressed"]
+[connection signal="drag_ended" from="UI/WorldGeneration/VBoxContainer/GenerationSpeed/Input" to="." method="_on_generation_speed_drag_ended"]
 [connection signal="toggled" from="UI/WorldGeneration/VBoxContainer/FinalRow/StartPausedButton" to="." method="_on_start_paused_button_toggled"]
 [connection signal="pressed" from="UI/WorldGeneration/VBoxContainer/FinalRow/RunButton" to="." method="_on_run_button_pressed"]
 [connection signal="pressed" from="UI/WorldGeneration/VBoxContainer/FinalRow/QuitButton" to="." method="_on_quit_button_pressed"]

scenes/fps_counter/fps_counter.gd

@@ -1,10 +0,0 @@
-extends Label
-
-
-@export var include_label: bool = true
-
-@onready var label_prepend: String = "FPS: " if include_label else ""
-
-
-func _process(_delta: float) -> void:
-	text = label_prepend + str(Engine.get_frames_per_second())

scenes/fps_counter/fps_counter.tscn

@@ -1,8 +0,0 @@
-[gd_scene load_steps=2 format=3 uid="uid://cy6vsgu8o0rad"]
-
-[ext_resource type="Script" path="res://scenes/fps_counter/fps_counter.gd" id="1_vn43a"]
-
-[node name="FPSCounter" type="Label"]
-offset_right = 40.0
-offset_bottom = 23.0
-script = ExtResource("1_vn43a")