FProceduralMapGroup
Overview
FProceduralMapGroup is used to organize procedural maps into logical groups. It includes properties for the group's name and an array of soft object pointers to UProceduralMapParameters.
Properties
Type | Name | Access | Description |
|---|---|---|---|
FName | GroupName | EditDefaultsOnly, BlueprintReadOnly | The name of the map group. |
TArray<TSoftObjectPtr< UProceduralMapParameters >> | GroupMaps | EditDefaultsOnly, BlueprintReadOnly | An array of soft object pointers to |
Functions
Return Type | Signature | Description |
|---|---|---|
bool | operator==(const FName& InGroupName) const | Compares the group name with another |
ALimenProceduralMapBuilder
Overview
ALimenProceduralMapBuilder is an abstract class that extends ALimenGameplayManager. It manages the lifecycle of procedural maps, handling events such as map load, build, destroy, and unload. The class uses delegates to notify when these events occur.
Properties
Type | Name | Access | Description |
|---|---|---|---|
TArray | MapCollections | EditDefaultsOnly | An array of |
Functions
Return Type | Signature | Description |
|---|---|---|
FGuid | LoadMap(const FName GroupName, const int32 Index) | Loads a map from a specified group and index, returning a unique identifier for the map. |
void | BuildMap(const FGuid& MapId) | Initiates the building process for a map identified by |
void | DestroyMap(const FGuid& MapId) | Initiates the destruction process for a map identified by |
void | UnloadMap(const FGuid& MapId) | Initiates the unloading process for a map identified by |
bool | IsMapLoaded(const FGuid& MapId) const | Checks if a map is currently loaded. |
bool | IsMapBuilt(const FGuid& MapId) const | Checks if a map has been built. |
bool | DoesMapExist(const FName GroupName, const int32 Index) const | Checks if a map exists in the specified group and index. |
int32 | GetCollectionMapCount(const FName& CollectionName) const | Returns the number of maps in a specified collection. |
TArray<TWeakObjectPtr< ULimenProceduralMap >> | GetLoadedMapsData() const | Retrieves an array of weak object pointers to loaded procedural maps. |
TArray<TWeakObjectPtr< ULimenProceduralMap >> | GetBuiltMapsData() const | Retrieves an array of weak object pointers to built procedural maps. |
int32 | GetMapsBuilt() const | Returns the total number of maps that have been built. |
FOnMapUpdate& | GetOnMapBeginBuild() | Gets the delegate for when a map begins building. |
FOnMapUpdate& | GetOnMapFinishBuild() | Gets the delegate for when a map finishes building. |
FOnMapUpdate& | GetOnMapBeginLoad() | Gets the delegate for when a map begins loading. |
FOnMapUpdate& | GetOnMapFinishLoad() | Gets the delegate for when a map finishes loading. |
FOnMapUpdate& | GetOnMapBeginUnload() | Gets the delegate for when a map begins unloading. |
FOnMapUpdate& | GetOnMapFinishUnload() | Gets the delegate for when a map finishes unloading. |
FOnMapUpdate& | GetOnMapBeginDestroy() | Gets the delegate for when a map begins destroying. |
FOnMapUpdate& | GetOnMapFinishDestroy() | Gets the delegate for when a map finishes destroying. |
Usage & Implementation Notes
The class uses
TFunctionto define callbacks for asynchronous operations like building and destroying maps.It manages map instances using a
TMap, where each entry is identified by a uniqueFGuid.The class includes delegates (
FOnMapUpdate) that can be used to notify other parts of the system about significant events in the lifecycle of procedural maps.