Documenting how FuncGodotMap could be extended

[RisingThumb]

Not 100% sure of how useful this is, so I've opened a discussion for it. I know @sinewavey extends it to do something. Could you share how you're extending it? Do you think it's useful to document?

I don't personally see it as too useful to document, but just raising it up in case it is something of interest.

I suppose related questions are how to extend the other internals like the geometry generator, the parser etc.

[sinewavey]

So this is more for the old version, but here's what I used to do:

@tool class_name SlamfireMap extends FuncGodotMap;

@warning_ignore("UNUSED_PRIVATE_CLASS_VARIABLE")
@export_tool_button("Build Map", "Bake") var __BUILD__: Callable = verify_and_build;

@warning_ignore("UNUSED_PRIVATE_CLASS_VARIABLE")
@export_tool_button("Bake Lightmap", "Bake") var __BAKE_LM__: Callable = bake_lightmap;

@warning_ignore("UNUSED_PRIVATE_CLASS_VARIABLE")
@export_tool_button("Clear All", "MissingNode") var __CLEAR__ = remove_children; 


@export_flags("Unwrap UV:1", "Remove Persistent Nodes:2") var flags: int = 1;

@export_category("Data")
@export var persistent: Node;
@export var paintmap: Paintmap3D;
@export var particle_sdf: GPUParticlesCollisionSDF3D;
@export var nav_region: NavigationRegion3D;

func _ready() -> void:
	if Engine.is_editor_hint():
		map_settings = load("res://fgd/sf_map_settings.tres");
		add_to_group(&"navigation_mesh_source_group");
		return;
	
	if is_in_group("navigation_mesh_source_group"):
		remove_from_group("&navigation_mesh_source_group");

	process_mode = Node.PROCESS_MODE_PAUSABLE;
	return;


func _build_complete():
	reset_build_context()
	stop_profile("build_map")

	print("Finishing SLAMFIRE build...");
	
	if !persistent:
		persistent = Node.new();
		_add_to_scene(persistent);
		persistent.set_name("PersistentNodes");
		
	if (flags & 1):
		unwrap_uv2();
	
	if persistent:
		move_child(persistent, 0);
	
	if paintmap:
		move_child(paintmap, 1);
	
	if particle_sdf:
		move_child(particle_sdf, 2);
		var aabb := AABB();
		for child in get_children():
			if child is Player:
				continue;

			for grandchild in child.get_children():
				if grandchild is not MeshInstance3D:
					continue;

				var mesh_aabb: AABB = grandchild.global_transform * (grandchild as MeshInstance3D).get_aabb();
				aabb = aabb.merge(mesh_aabb);
		
		particle_sdf.position = aabb.get_center();
		particle_sdf.size = aabb.size;

	if !nav_region:
		nav_region = NavigationRegion3D.new();
		_add_to_scene(nav_region, persistent);
		nav_region.name = "NavigationRegion3D";

	if !nav_region.navigation_mesh:
		var nm := NavigationMesh.new();
		nm.agent_height = 2.0;
		nm.agent_max_climb = 0.5;
		nm.geometry_parsed_geometry_type = NavigationMesh.PARSED_GEOMETRY_STATIC_COLLIDERS;
		nm.geometry_collision_mask = FFWD.MASK_STRUCTURAL;
		nm.geometry_source_geometry_mode = NavigationMesh.SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN;
		nm.geometry_source_group_name = &"navigation_mesh_source_group";		
		nav_region.navigation_mesh = nm;

	nav_region.bake_navigation_mesh();

	var removed: int = 0;

	for child in get_children():
		if child_is_temporary(child):
			removed += 1;
			remove_child(child);
			child.queue_free();
			continue;

		child.set_display_folded(true);
		child.emit_signal(&"script_changed") # silly hack to actually update the display folding
	
	print("Removed %s temporary nodes.\nBuild complete!\n" % removed)
	emit_signal(&"build_complete");
	return;


func _add_to_scene(node: Node, new_parent: Node = self) -> void:
	if !node || !new_parent: 
		return;	

	if !node.is_inside_tree():
		new_parent.add_child(node);

	var scene_root := get_tree().get_edited_scene_root();
	node.set_owner(scene_root);
	return;


func build_entity_nodes() -> Array:
	if !paintmap:
		paintmap = Paintmap3D.new();
		paintmap.layers |= 42;
	
		# DEBUG
		paintmap.quality = LightmapGI.BakeQuality.BAKE_QUALITY_LOW;
		paintmap.bounces = 2;
		paintmap.bounce_indirect_energy = 1.1;
		_add_to_scene(paintmap);
		paintmap.name = "Paintmap";
	
	if !particle_sdf:
		particle_sdf = GPUParticlesCollisionSDF3D.new();
		particle_sdf.bake_mask = FFWD.LAYER_STRUCTURAL | FFWD.LAYER_DETAIL; 
		_add_to_scene(particle_sdf);
		particle_sdf.name = "ParticleSDF";

	return super.build_entity_nodes();


func apply_properties_and_finish() -> void:
	super();	
	for entity_idx in range(0, entity_nodes.size()):
		var entity_node: Node = entity_nodes[entity_idx] as Node
		if !entity_node:
			continue
		
		var edict: Dictionary = entity_dicts[entity_idx];
		if edict.is_empty() || !edict.has("properties"):
			continue;

		var props: Dictionary = edict["properties"];
		for property in props:
			var value: Variant = props.get(property);
			match property:
				"targetname":
					var targetname: String = props.get("targetname", "")
					if !targetname.is_empty():
						entity_node.add_to_group(targetname, true)
				"detail_text":	
					FFWD.set_detail_text(entity_node, str(value));
	return;

func remove_children() -> void:
	for child in get_children():	
		if child == persistent:	
			if !(flags & 2):
				continue;	
			persistent = null;

		elif child == paintmap:
			paintmap = null;
		
		remove_child(child);
		child.queue_free();
	return;


func bake_lightmap() -> void:
	if !paintmap:
		return;
	
	paintmap.prepare();
	return;


func child_is_temporary(n: Node) -> bool:
	if n is NavObstacle:
		return true;
	return false;

I would say it requires a little bit of knowledge about what goes on in the script itself. I'm not sure I'd recommend it for most people, though; in retrospect a lot of this was because I didn't want to redefine implementing targetname add to group, etc, in a bunch of different entities or do some minor processing automatically to prepare or clean up.