Home / Tiles / Classes / UTITileMapTileInstance

UTITileMapTileInstance

Description

This is an instance of a UTITileMapTile stored in a Tile Map Instance that will get created when you add a Tile Map to a level and can be modified at runtime (for example, by adding/removing tiles)

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

GetTileSetTile

C++ ✅ Blueprint ✅

Gets the Tile Set Tile used by this Tile Instance.

Return

• UTITileSetTile*: The Tile Set Tile used by this Tile Instance.

GetCustomProperties

C++ ✅ Blueprint ✅

Gets the Custom Properties of the Tile Instance, where you can access all the individual properties stored for the Tile Instance.

Return

• UTICustomProperties*: The Custom Properties of the Tile Instance.

HasCollision

C++ ✅ Blueprint ✅

Checks if the Tile Instance has collision set up on the Tile Set Tile.

Return

• bool: True if the Tile Instance has collision.

GetTileSet

C++ ✅ Blueprint ✅

Gets the Tile Set used by this Tile Instance.

Return

• UTITileSet*: Tile Set used by this Tile Instance.

GetTileSetIndex

C++ ✅ Blueprint ✅

Gets the Tile Set Index used by this Tile Instance.

Return

• int32*: Tile Set Index used by this Tile Instance.

GetGroupID

C++ ✅ Blueprint ✅

Gets the Group ID specified in the Tile Set Tile.

Return

• int32: The Group ID.

GetGroup

C++ ✅ Blueprint ✅

Gets the Group of Tiles specified in the Tile Set Tile.

Return

• UTITileMapTileGroup*: Group of Tiles specified in the Tile Set Tile.

GetTileMapComponent

C++ ✅ Blueprint ✅

Gets the Tile Map Component used by this Tile Instance.

Return

• UTITileMapComponent*: Tile Map Component used by this Tile Instance.

GetTileMapInstance

C++ ✅ Blueprint ✅

Gets the Tile Map Instance that contains this Tile Instance.

Return

• UTITileMapActor: Tile Map Actor that contains this Tile Instance.

GetLayerInstance

C++ ✅ Blueprint ✅

Gets the Tile Layer Instance that contains this Tile Instance.

Return

• UTITileLayerInstance: Tile Layer Instance that contains this Tile Instance.

GetCoordinates

C++ ✅ Blueprint ✅

Gets the coordinates of this Tile Instance within the Tile Map.

Return

• FIntVector: The coordinates of this Tile Instance.

GetOpacity

C++ ✅ Blueprint ✅

Gets the opacity of this Tile Instance.

Return

• float: The opacity of this Tile Instance.

SetOpacity

C++ ✅ Blueprint ✅

Gets the opacity of this Tile Instance.

Arguments

• InOpacity: The new opacity for this Tile Instance.

IsAnimated

C++ ✅ Blueprint ✅

Checks if the Tile Instance has animation set up on the Tile Set Tile.

Return

• bool: True if the Tile Instance has animation.

GetFlipbook

C++ ✅ Blueprint ✅

Gets the Tile Instance animation flipbook.

Return

• UPaperFlipbook*: The animation flipbook or null if not set.

IsInViewport

C++ ✅ Blueprint ✅

Checks if the Tile Instance is currently visible in the viewport.

Return

• bool: True if the Tile Instance is visible in the viewport.

GetTilePosition

C++ ✅ Blueprint ✅

Gets the top left corner position of this Tile Instance.

Arguments

• bWorldSpace: If the returned position should be in world space of local space (within the Tile Map)

Return

• FVector: The top left corner position of the Tile Instance.

GetElevation

C++ ✅ Blueprint ✅

Gets the elevation of the owning Tile Layer

Return

• int32: The elevation of the owning Tile Layer

DebugDraw (Overrideable)

C++ ✅ Blueprint ✅

Draws debug lines around the Tile Instance.

Arguments

• Duration: How long the debug draw should last (in seconds)
• Color: The color of the debug draw lines.

OnInstanced (Overrideable)

C++ ✅ Blueprint ✅

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

OnModified (Overrideable)

C++ ✅ Blueprint ✅

Called when the Tile Instance has been modified.

Arguments

• Event: The type of modification (TileAdded, TileRemoved, TileModified).
• AffectedObject: The object that has been modified (The class will vary depending on the type of event).

OnPostLoad (Overrideable)

C++ ✅ Blueprint ✅

Called when the Tile Instance has been loaded.

OnTick (Overrideable)

C++ ✅ Blueprint ✅

Called when the Tile Instance ticks.

Arguments

• DeltaTime: Time (in seconds) since last tick.

ShouldGroupWithTile (Overrideable)

C++ ✅ Blueprint ✅

Called when making the Tile Groups

Arguments

• GroupTile: Another Tile Instance that wants to group with this Tile Instance.

Return

• bool: Return true if this Tile Instance should be grouped with the GroupTile.