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

A Set of TScenes for the templating system (TileFabLib/TpZoneManager/TpZoneLayout). More...

Inheritance diagram for TilePlus.TSceneList:
Collaboration diagram for TilePlus.TSceneList:

Classes

class  TScene
 A TScene definition. This describes the relationshop between a ChunkTemplateSelector and the TpZoneLayout it should use. Note that the field m_LayoutSpec if injected at runtime since it's a scene object. More...
class  TSceneSpec
 The control info for a scene's layout for ONE selector and grid. More...

Public Member Functions

int IndexOfScene (string sceneNameOrGuid, bool isGuid=false)
 Get the index of a scene from its name or GUID.
TSceneSpecGetSceneSpec (TScene scene, string sceneLayoutNameOfSpec)
 Get the scene spec for a particular scene and a particular TSceneLayout component nam.
bool ValidateSceneList ()
 Validate this list.

Public Attributes

List< TScenem_TileScenes = new()
 A list of TScene definitions for this TSceneList.

Properties

IEnumerable< string > SceneNames [get]
 A list of all the Scene names.
int Count [get]
 Number of scenes.
string GuidString [get]
 The GUID string for this TScene. Can be used in a save file to specify last scene used.
HashSet< TpTileFabAllTileFabsInAllScenes [get]
 Get a HashSet with all of the TileFqbs in ALL scenes in this asset.

Detailed Description

A Set of TScenes for the templating system (TileFabLib/TpZoneManager/TpZoneLayout).

Member Function Documentation

◆ GetSceneSpec()

TSceneSpec? TilePlus.TSceneList.GetSceneSpec ( TScene scene,
string sceneLayoutNameOfSpec )

Get the scene spec for a particular scene and a particular TSceneLayout component nam.

Parameters
scenea TScene.
sceneLayoutNameOfSpecthe m_LayoutName field of a TScaleLayout component
Returns
the named scene spec or null

◆ IndexOfScene()

int TilePlus.TSceneList.IndexOfScene ( string sceneNameOrGuid,
bool isGuid = false )

Get the index of a scene from its name or GUID.

Parameters
sceneNameOrGuidstring
isGuidset TRUE if you're testing a GUID
Returns
index of -1 if not found

◆ ValidateSceneList()

bool TilePlus.TSceneList.ValidateSceneList ( )

Validate this list.

Returns
false for no scenes in asset or if a selector is missing

Member Data Documentation

◆ m_TileScenes

List<TScene> TilePlus.TSceneList.m_TileScenes = new()

A list of TScene definitions for this TSceneList.

Property Documentation

◆ AllTileFabsInAllScenes

HashSet<TpTileFab> TilePlus.TSceneList.AllTileFabsInAllScenes
get

Get a HashSet with all of the TileFqbs in ALL scenes in this asset.

◆ Count

int TilePlus.TSceneList.Count
get

Number of scenes.

◆ GuidString

string TilePlus.TSceneList.GuidString
get

The GUID string for this TScene. Can be used in a save file to specify last scene used.

◆ SceneNames

IEnumerable<string> TilePlus.TSceneList.SceneNames
get

A list of all the Scene names.


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