Add threaded chunk loaders and renderers

addons/gaea/generators/2D/chunk_aware_generator_2d.gd

@@ -36,8 +36,8 @@ func erase_chunk(chunk_position: Vector2i) -> void:
 			for layer in grid.get_layer_count():
 				grid.erase(Vector2i(x, y), layer)
 
-	chunk_updated.emit(chunk_position)
-	chunk_erased.emit(chunk_position)
+	(func(): chunk_updated.emit(chunk_position)).call_deferred() # deferred for threadability
+	(func(): chunk_erased.emit(chunk_position)).call_deferred() # deferred for threadability
 
 
 func _apply_modifiers_chunk(modifiers: Array[Modifier2D], chunk_position: Vector2i) -> void:

addons/gaea/generators/2D/heightmap_generator/heightmap_generator_2d.gd

@@ -69,8 +69,8 @@ func generate_chunk(chunk_position: Vector2i, starting_grid: GaeaGrid = null) ->
 			next_pass.generate_chunk(chunk_position, grid)
 			return
 
-	chunk_updated.emit(chunk_position)
-	chunk_generation_finished.emit(chunk_position)
+	(func(): chunk_updated.emit(chunk_position)).call_deferred() # deferred for threadability
+	(func(): chunk_generation_finished.emit(chunk_position)).call_deferred() # deferred for threadability
 
 
 func _set_grid() -> void:

addons/gaea/generators/3D/chunk_aware_generator_3d.gd

@@ -37,8 +37,8 @@ func erase_chunk(chunk_position: Vector3i) -> void:
 				for layer in range(grid.get_layer_count()):
 					grid.erase(Vector3i(x, y, z), layer)
 
-	chunk_updated.emit(chunk_position)
-	chunk_erased.emit(chunk_position)
+	(func(): chunk_updated.emit(chunk_position)).call_deferred() # deferred for threadability
+	(func(): chunk_erased.emit(chunk_position)).call_deferred() # deferred for threadability
 
 
 func _apply_modifiers_chunk(modifiers, chunk_position: Vector3i) -> void:

addons/gaea/generators/3D/heightmap_generator_3d/heightmap_generator_3d.gd

@@ -69,8 +69,8 @@ func generate_chunk(chunk_position: Vector3i, starting_grid: GaeaGrid = null) ->
 			next_pass.generate_chunk(chunk_position, grid)
 			return
 
-	chunk_updated.emit(chunk_position)
-	chunk_generation_finished.emit(chunk_position)
+	(func(): chunk_updated.emit(chunk_position)).call_deferred() # deferred for threadability
+	(func(): chunk_generation_finished.emit(chunk_position)).call_deferred() # deferred for threadability
 
 
 func _set_grid() -> void:

addons/gaea/others/chunk_loader_3d.gd

@@ -41,6 +41,7 @@ func _ready() -> void:
 
 
 func _process(delta: float) -> void:
+
 	if Engine.is_editor_hint() or not is_instance_valid(generator):
 		return
 
@@ -69,6 +70,7 @@ func _try_loading() -> void:
 
 # loads needed chunks around the given position
 func _update_loading(actor_position: Vector3i) -> void:
+
 	if generator == null:
 		push_error("Chunk loading failed because generator property not set!")
 		return

addons/gaea/others/threaded_chunk_loader_2d.gd

@@ -0,0 +1,33 @@
+@tool
+class_name ThreadedChunkLoader2D
+extends ChunkLoader2D
+## @experimental
+
+@export var threaded:bool = true
+
+var queued:Callable
+var task:int = -1
+
+func _process(_delta):
+	if task > -1:
+		if WorkerThreadPool.is_task_completed(task):
+			WorkerThreadPool.wait_for_task_completion(task)
+			task = -1
+			run_job(queued)
+	super(_delta)
+
+func _update_loading(actor_position: Vector2i) -> void:
+	if not threaded:
+		super(actor_position)
+	else:
+		var job:Callable = func ():
+			super._update_loading(actor_position)
+
+		if task > -1:
+			queued = job
+		else:
+			run_job(job)
+
+func run_job(job:Callable):
+	if job:
+		task = WorkerThreadPool.add_task(job, false, "Load/Unload Chunks")

addons/gaea/others/threaded_chunk_loader_3d.gd

@@ -0,0 +1,33 @@
+@tool
+class_name ThreadedChunkLoader3D
+extends ChunkLoader3D
+## @experimental
+
+@export var threaded:bool = true
+
+var queued:Callable
+var task:int = -1
+
+func _process(_delta):
+	if task > -1:
+		if WorkerThreadPool.is_task_completed(task):
+			WorkerThreadPool.wait_for_task_completion(task)
+			task = -1
+			run_job(queued)
+	super(_delta)
+
+func _update_loading(actor_position: Vector3i) -> void:
+	if not threaded:
+		super(actor_position)
+	else:
+		var job:Callable = func ():
+			super._update_loading(actor_position)
+
+		if task > -1:
+			queued = job
+		else:
+			run_job(job)
+
+func run_job(job:Callable):
+	if job:
+		task = WorkerThreadPool.add_task(job, false, "Load/Unload Chunks")

addons/gaea/renderers/2D/threaded_tilemap_gaea_renderer.gd

@@ -0,0 +1,42 @@
+@tool
+class_name ThreadedTilemapGaeaRenderer
+extends TilemapGaeaRenderer
+## Wrapper for TilemapGaeaRenderer that runs multiple _draw_area calls
+##  in parallel using the WorkerThreadPool.
+## @experimental
+
+## Whether or not to pass calls through to the default TilemapGaeaRenderer,
+##  instead of threading them.
+@export var threaded:bool = true
+## Decides the maximum number of WorkerThreadPool tasks that can be created
+##  before queueing new tasks. A negative value (-1) means there is no limit.
+@export_range(-1, 1000, 1, "exp", "or_greater") var task_limit:int = -1
+
+var queued:Array[Callable] = []
+var tasks:PackedInt32Array = []
+
+func _process(_delta):
+	for t in range(tasks.size()-1, -1, -1):
+		if WorkerThreadPool.is_task_completed(tasks[t]):
+			WorkerThreadPool.wait_for_task_completion(tasks[t])
+			tasks.remove_at(t)
+	if threaded:
+		while task_limit >= 0 and tasks.size() < task_limit and not queued.is_empty():
+			run_task(queued.pop_front())
+	#super(_delta) # not needed for TilemapGaeaRenderer
+
+func _draw_area(area: Rect2i) -> void:
+	if not threaded:
+		super(area)
+	else:
+		var new_task:Callable = func ():
+			super._draw_area(area)
+
+		if task_limit >= 0 and tasks.size() >= task_limit:
+			queued.push_back(new_task)
+		else:
+			run_task(new_task)
+
+func run_task(task:Callable):
+	if task:
+		tasks.append(WorkerThreadPool.add_task(task, false, "Draw Area"))

addons/gaea/renderers/2D/tilemap_gaea_renderer.gd

@@ -29,7 +29,7 @@ func _draw_area(area: Rect2i) -> void:
 
 			if erase_empty_tiles and not has_cell_in_position:
 				for l in range(tile_map.get_layers_count()):
-					tile_map.erase_cell(l, Vector2i(x, y))
+					tile_map.erase_cell.call_deferred(l, Vector2i(x, y))
 				continue
 
 			for layer in range(generator.grid.get_layer_count()):
@@ -41,7 +41,7 @@ func _draw_area(area: Rect2i) -> void:
 
 				match tile_info.type:
 					TilemapTileInfo.Type.SINGLE_CELL:
-						tile_map.set_cell(
+						tile_map.set_cell.call_deferred(
 							tile_info.tilemap_layer, tile, tile_info.source_id,
 							tile_info.atlas_coord, tile_info.alternative_tile
 						)
@@ -52,12 +52,12 @@ func _draw_area(area: Rect2i) -> void:
 							terrains[tile_info].append(tile)
 
 	for tile_info in terrains:
-		tile_map.set_cells_terrain_connect(
+		tile_map.set_cells_terrain_connect.call_deferred(
 			tile_info.tilemap_layer, terrains[tile_info],
 			tile_info.terrain_set, tile_info.terrain
 		)
 
-	area_rendered.emit()
+	(func(): area_rendered.emit()).call_deferred()
 
 
 func _draw() -> void:

addons/gaea/renderers/3D/gridmap_gaea_renderer.gd

@@ -15,7 +15,7 @@ func _draw_area(area: AABB) -> void:
 				for layer in range(generator.grid.get_layer_count()):
 					var cell := Vector3i(x, y, z)
 					if not generator.grid.has_cell(cell, layer):
-						grid_map.set_cell_item(cell, -1)
+						grid_map.set_cell_item.call_deferred(cell, -1)
 						continue
 
 					if only_draw_visible_cells and not generator.grid.has_empty_neighbor(cell, layer):
@@ -25,9 +25,9 @@ func _draw_area(area: AABB) -> void:
 					if not (tile_info is GridmapTileInfo):
 						continue
 
-					grid_map.set_cell_item(cell, tile_info.index)
+					grid_map.set_cell_item.call_deferred(cell, tile_info.index)
 
-	area_rendered.emit()
+	(func(): area_rendered.emit()).call_deferred()
 
 
 func _draw() -> void:

addons/gaea/renderers/3D/threaded_gridmap_gaea_renderer.gd

@@ -0,0 +1,42 @@
+@tool
+class_name ThreadedGridmapGaeaRenderer
+extends GridmapGaeaRenderer
+## Wrapper for GridmapGaeaRenderer that runs multiple _draw_area calls
+##  in parallel using the WorkerThreadPool.
+## @experimental
+
+## Whether or not to pass calls through to the default GridmapGaeaRenderer,
+##  instead of threading them.
+@export var threaded:bool = true
+## Decides the maximum number of WorkerThreadPool tasks that can be created
+##  before queueing new tasks. A negative value (-1) means there is no limit.
+@export var task_limit:int = -1
+
+var queued:Array[Callable] = []
+var tasks:PackedInt32Array = []
+
+func _process(_delta):
+	for t in range(tasks.size()-1, -1, -1):
+		if WorkerThreadPool.is_task_completed(tasks[t]):
+			WorkerThreadPool.wait_for_task_completion(tasks[t])
+			tasks.remove_at(t)
+	if threaded:
+		while task_limit >= 0 and tasks.size() < task_limit and not queued.is_empty():
+			run_task(queued.pop_front())
+	#super(_delta) # not needed for TilemapGaeaRenderer
+
+func _draw_area(area: AABB) -> void:
+	if not threaded:
+		super(area)
+	else:
+		var new_task:Callable = func ():
+			super._draw_area(area)
+
+		if task_limit >= 0 and tasks.size() >= task_limit:
+			queued.push_back(new_task)
+		else:
+			run_task(new_task)
+
+func run_task(task:Callable):
+	if task:
+		tasks.append(WorkerThreadPool.add_task(task, false, "Draw Area"))

scenes/demos/heightmap/chunks_heightmap_demo.tscn

@@ -4,9 +4,9 @@
 [ext_resource type="Resource" uid="uid://db18nmw5jkbtc" path="res://scenes/demos/heightmap/terraria-like_generation_settings.tres" id="2_py0je"]
 [ext_resource type="Texture2D" uid="uid://caoyt0ek7fmdq" path="res://scenes/demos/heightmap/pixel-platformer-tileset - Kenney.png" id="3_wjapt"]
 [ext_resource type="Texture2D" uid="uid://6gwie8e2kpg2" path="res://scenes/demos/heightmap/ores.png" id="4_rk2l5"]
-[ext_resource type="Script" path="res://addons/gaea/renderers/2D/tilemap_gaea_renderer.gd" id="10_5yyno"]
+[ext_resource type="Script" path="res://addons/gaea/others/threaded_chunk_loader_2d.gd" id="5_4wj8l"]
+[ext_resource type="Script" path="res://addons/gaea/renderers/2D/threaded_tilemap_gaea_renderer.gd" id="6_gb7up"]
 [ext_resource type="Script" path="res://scenes/demos/heightmap/test_actor.gd" id="10_76aeg"]
-[ext_resource type="Script" path="res://addons/gaea/others/chunk_loader_2d.gd" id="10_vlq7b"]
 [ext_resource type="Texture2D" uid="uid://bh3d1rgohpb4x" path="res://icon.svg" id="11_go0dd"]
 
 [sub_resource type="TileSetAtlasSource" id="TileSetAtlasSource_68jc8"]
@@ -231,16 +231,15 @@ offset_right = 2304.0
 offset_bottom = 18.0
 color = Color(0.172549, 0.188235, 0.243137, 1)
 
-[node name="ChunkLoader" type="Node2D" parent="." node_paths=PackedStringArray("generator", "renderer", "actor")]
-script = ExtResource("10_vlq7b")
+[node name="ThreadedChunkLoader2D" type="Node2D" parent="." node_paths=PackedStringArray("generator", "actor")]
+script = ExtResource("5_4wj8l")
 generator = NodePath("../HeightmapGenerator2D")
-renderer = NodePath("../TilemapGaeaRenderer")
 actor = NodePath("../TestActor")
 loading_radius = Vector2i(4, 4)
 update_rate = 2
 
-[node name="TilemapGaeaRenderer" type="Node" parent="." node_paths=PackedStringArray("tile_map", "generator")]
-script = ExtResource("10_5yyno")
+[node name="ThreadedTilemapGaeaRenderer" type="Node" parent="." node_paths=PackedStringArray("tile_map", "generator")]
+script = ExtResource("6_gb7up")
 tile_map = NodePath("../TileMap")
 generator = NodePath("../HeightmapGenerator2D")
 

scenes/demos/heightmap_3d/actor.gd

@@ -4,9 +4,16 @@ extends CharacterBody3D
 const SPEED = 5.0
 const JUMP_VELOCITY = 4.5
 
+@export var gravity_on:bool = true :
+	set(value):
+		gravity_on = value
+		toggle_gravity(value)
+
 # Get the gravity from the project settings to be synced with RigidBody nodes.
 var gravity: float = ProjectSettings.get_setting("physics/3d/default_gravity")
 
+func toggle_gravity(on:bool=true):
+	gravity = 0 if not on else ProjectSettings.get_setting("physics/3d/default_gravity")
 
 func _physics_process(delta: float) -> void:
 	# Add the gravity.

script_templates/Node/multithread_wrapper.gd

@@ -0,0 +1,36 @@
+@tool
+class_name MultiThreadedNode
+extends Node
+## @experimental
+
+@export var threaded:bool = true
+@export var max_running:int = 1
+
+var queued:Array[Callable] = []
+var tasks:PackedInt32Array = []
+
+func _process(_delta):
+	for t in range(tasks.size()-1, -1, -1):
+		if WorkerThreadPool.is_task_completed(tasks[t]):
+			WorkerThreadPool.wait_for_task_completion(tasks[t])
+			tasks.remove_at(t)
+	if threaded:
+		while max_running >= 0 and tasks.size() < max_running and not queued.is_empty():
+			run_job(queued.pop_front())
+	#super(_delta) # not needed for TilemapGaeaRenderer
+
+func _some_method(some_value) -> void:
+	if not threaded:
+		super(some_value)
+	else:
+		var job:Callable = func ():
+			super._some_method(area)
+
+		if max_running >= 0 and tasks.size() >= max_running:
+			queued.push_back(job)
+		else:
+			run_job(job)
+
+func run_job(job:Callable):
+	if job:
+		tasks.append(WorkerThreadPool.add_task(job, false, "Some Threaded Job"))

script_templates/Node/thread_wrapper.gd

@@ -0,0 +1,33 @@
+@tool
+class_name ThreadedNode
+extends Node
+## @experimental
+
+@export var threaded:bool = true
+
+var queued:Callable
+var task:int = -1
+
+func _process(_delta):
+	if task > -1:
+		if WorkerThreadPool.is_task_completed(task):
+			WorkerThreadPool.wait_for_task_completion(task)
+			task = -1
+			run_job(queued)
+	super(_delta)
+
+func _some_method(some_value) -> void:
+	if not threaded:
+		super(some_value)
+	else:
+		var job:Callable = func ():
+			super._some_method(some_value)
+
+		if task > -1:
+			queued = job
+		else:
+			run_job(job)
+
+func run_job(job:Callable):
+	if job:
+		task = WorkerThreadPool.add_task(job, false, "Some Threaded Job")