TilePlus Version 5
Unity3D Tilemap Extension
Loading...
Searching...
No Matches
TilePlus.TpFabLoader Class Reference

A component that can be added to a GRID's GameObject for loading an entire TileFab. Note that the names or tags of the Tilemaps need to match the names or tags embedded in the TileFab or this will not work. More...

Inheritance diagram for TilePlus.TpFabLoader:
Collaboration diagram for TilePlus.TpFabLoader:

Public Member Functions

bool Load (Vector3Int offset, bool loadPrefabs=true, bool clearPrefabs=false, bool resetTilemap=false)
 Load the contents of the TpTileBundle asset. A shortcut for TpLib.LoadBundle.

Public Attributes

TpTileFab m_TileFabAsset
 The tileset archive.
bool m_LoadOnRun = true
 Optional load on run.
float m_DelayTime
 delay time when loading @ runtime
bool m_LoadPrefabs = true
 load prefabs or not
bool m_ClearExistingPrefabsOnLoad = true
 clear existing prefabs optioin
bool m_ClearMap
 clear tilemap option
Vector3Int m_Offset = Vector3Int.zero
 Optional offset.

Detailed Description

A component that can be added to a GRID's GameObject for loading an entire TileFab. Note that the names or tags of the Tilemaps need to match the names or tags embedded in the TileFab or this will not work.

Member Function Documentation

◆ Load()

bool TilePlus.TpFabLoader.Load ( Vector3Int offset,
bool loadPrefabs = true,
bool clearPrefabs = false,
bool resetTilemap = false )

Load the contents of the TpTileBundle asset. A shortcut for TpLib.LoadBundle.

Parameters
offsetAdd an offset to each loaded item.
loadPrefabsload and parent prefabs if true
clearPrefabsclear all child GameObjects if true.
resetTilemapuse ClearAllTiles on tilemap if true
Returns
true/false : ok/fail

Member Data Documentation

◆ m_ClearExistingPrefabsOnLoad

bool TilePlus.TpFabLoader.m_ClearExistingPrefabsOnLoad = true

clear existing prefabs optioin

◆ m_ClearMap

bool TilePlus.TpFabLoader.m_ClearMap

clear tilemap option

◆ m_DelayTime

float TilePlus.TpFabLoader.m_DelayTime

delay time when loading @ runtime

◆ m_LoadOnRun

bool TilePlus.TpFabLoader.m_LoadOnRun = true

Optional load on run.

◆ m_LoadPrefabs

bool TilePlus.TpFabLoader.m_LoadPrefabs = true

load prefabs or not

◆ m_Offset

Vector3Int TilePlus.TpFabLoader.m_Offset = Vector3Int.zero

Optional offset.

◆ m_TileFabAsset

TpTileFab TilePlus.TpFabLoader.m_TileFabAsset

The tileset archive.


The documentation for this class was generated from the following file:
  • /Users/jms/Documents/Tpt_55/TPT55/Assets/Plugins/TilePlus/Runtime/MonoComponents/TpFabLoader.cs