CMAPUMODULE :: Catur Documentation

Diagrams

Sat, 20 Jul 2024 21:09:28 +0200

Overview Visual diagrams illustrating the internal architecture and runtime behavior of CMAPUMODULE. 1. Map Visual Behavior What the map module produces, how mapScale and mapResolution affect the result, and how tile coloring works via closest-room assignment (implicit Voronoi partition). The visual behavior SVG is the most important diagram for understanding the module.

Data Structures

Sat, 20 Jul 2024 21:09:28 +0200

FCMapMakerStruct Configuration structure for map generation parameters. Used as a FTableRowBase row in a DataTable, referenced by ACMapSpawner via FDataTableRowHandle. Name Description tileMesh Static mesh used for each hex tile instance tileMeshSize Base size of a tile mesh in world units (default 100.0) splineMesh Static mesh used for spline-based border rendering splineMeshSize Size of the spline mesh (default 100) tangentForce Tangent strength for spline curves, best between 1 and 3 (default 1.0) FCMapMakerStruct mapStruct; mapStruct.tileMesh = myHexMesh; mapStruct.tileMeshSize = 100.0; mapStruct.splineMesh = mySplineMesh; mapStruct.splineMeshSize = 100; mapStruct.tangentForce = 2.0; FCMapDataQueue Internal queue structure used by UCMapMaker to batch async build results.

CMapSpawner

Sat, 20 Jul 2024 21:09:28 +0200

Overview ACMapSpawner is the main actor to place in a level for minimap generation. It inherits from ACAbstractSpawner and implements ICMapData. It reads its configuration from a DataTable row (FCMapMakerStruct), instantiates UCMapMaker and drives the build loop on tick. Properties Name Description mapMakerRH FDataTableRowHandle pointing to a FCMapMakerStruct row (RowType = CMapStruct) mapMaker Transient reference to the instantiated UCMapMaker Lifecycle Name Description init Reads the DataTable row, validates data, instantiates UCMapMaker Tick Calls mapMaker->buildASync when room is built and actor is ready. Stops ticking once the map is built clean Destroys the map maker and its resources storeSpawnerSingleton Registers this spawner as CNAME_Singleton_MapSpawner // ACMapSpawner is placed in the level. // Configure mapMakerRH to point to a DataTable row of type FCMapMakerStruct. // init() is called by the spawner system (ACAbstractSpawner). // It reads the row and instantiates UCMapMaker: FCMapMakerStruct* data = getRowFromRH(mapMakerRH); UCMapMaker::instantiate(GetRootComponent(), mapMaker, stream, *data); // On Tick, the spawner waits for room data and actor readiness, // then delegates to the map maker: if (IsValid(mapMaker) && RoomUtility::roomBuilt() && ActorUtility::actorReady()) { if (!mapMaker->built) { mapMaker->buildASync(this); } else { SetActorTickEnabled(false); } }

CMapMaker

Sat, 20 Jul 2024 21:09:28 +0200

Overview UCMapMaker is the core object responsible for building the minimap. It computes a hexagonal tile grid scaled down from the world room layout, creates an UInstancedStaticMeshComponent with one instance per hex tile, and encodes cluster/room identity into per-instance custom data for material-driven rendering. The build pipeline is asynchronous: drawMap runs off the game thread, enqueues results, and updateMap_sync dequeues and creates ISM instances on the game thread.