Home / Tile Worlds / Classes / UTITileWorldInstance

UTITileWorldInstance

Description

his is an instance of a UTITileWorld that will get created when you add the asset to a level and can be modified at runtime (for example, by adding/removing maps)

Extend Class

If you want to extend the class either via C++ or Blueprint, you can specify in the Plugin Settings what class the plugin should use, instead of the default one. Keep in mind that your class must be a child class from the original one you want to extend.

Note: Setting a new class override to be used by the plugin won’t be applied to previously imported assets, you will have to delete and import the already existing assets after the settings have been changed.

Functions

GetTileWorld

C++ ✅ Blueprint ✅

Gets the Tile World asset used by this Tile World Instance.

Return

• UTITileWorld: The Tile World asset used by this Tile World Instance.

GetTileWorldActor

C++ ✅ Blueprint ✅

Gets the Tile World Actor that owns this Tile World Instance.

Return

• ATITileWorldActor*: The Tile World Actor that owns this Tile World Instance.

UsesTileWorld

C++ ✅ Blueprint ✅

Checks if the Tile World Instance uses the given Tile World asset.

Arguments

• TileWorld: The Tile World asset to check.

Return

• bool: True if the Tile World Instance uses the given Tile World asset.

GetTileMaps

C++ ✅ Blueprint ✅

Gets an array of Tile Map Components that are instantiated for this Tile World Instance.

Return

• TArray[FTITileWorldInstanceMapData]: An array of Tile Map Components instanced for this Tile World Instance.

UsesTileMap

C++ ✅ Blueprint ✅

Checks if the Tile World Instance uses the given Tile Map asset.

Arguments

• TileMap: Tile Map asset to check.

Return

• bool: True if the Tile World Instance uses the given Tile Map asset.

AddTileMap

C++ ✅ Blueprint ✅

Adds a new Tile Map to the Tile World Instance.

Arguments

• TileMapData: A struct with a reference to the Tile Map asset to use and the 2D coordinates to place it.
• Classes: The list of TileIntegration classes to use for creating this map.
• bTemplate: (internal use only)
• bCreateComponent: (internal use only)

Return

• FTITileWorldInstanceMapData: A reference to the newly added map

RemoveTileMap

C++ ✅ Blueprint ✅

Removes a existing Tile Map from the Tile World Instance.

Arguments

• TileMap: A reference to an existing Tile Map (gathered from AddTileMap or GetTileMaps)

OnInstanced (Overrideable)

C++ ✅ Blueprint ✅

Called when the Tile World Instance has been added to a level.