Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.PrefabDictionary Class Reference
Inheritance diagram for PlatformerPro.PrefabDictionary:

Public Member Functions

GameObject GetAssetByName (string name)
 Gets the asset for the given name. More...
 
string[] GetNames ()
 
bool ContainsName (string name)
 
string NameOfAsset (GameObject asset)
 Get name for specific asset. More...
 
string AddNewAsset (GameObject asset)
 Add asset to dictionary. More...
 

Static Public Member Functions

static PrefabDictionary FindOrCreateInstance ()
 

Public Attributes

List< GameObject > items
 Assets used in the map. More...
 

Static Public Attributes

const string DefaultDictionaryPrefabLocation = "Assets/PlatformerPro/Prefabs/DefaultPrefabDictionary.prefab"
 The default dictionary prefab location. If editor can't find a Dictionary one will be created from this prefab. More...
 

Protected Member Functions

void Init ()
 Create a dictionary for fast access. More...
 

Properties

static PrefabDictionary Instance [get, set]
 Gets reference to the Dictionary in the scene. More...
 

Member Function Documentation

◆ AddNewAsset()

string PlatformerPro.PrefabDictionary.AddNewAsset ( GameObject  asset)

Add asset to dictionary.

Returns
The new asset.
Parameters
assetAssset.

◆ ContainsName()

bool PlatformerPro.PrefabDictionary.ContainsName ( string  name)

◆ FindOrCreateInstance()

static PrefabDictionary PlatformerPro.PrefabDictionary.FindOrCreateInstance ( )
static

◆ GetAssetByName()

GameObject PlatformerPro.PrefabDictionary.GetAssetByName ( string  name)

Gets the asset for the given name.

Returns
The asset or null if name == NONE or the asset wasn't found.
Parameters
nameAsset name.

◆ GetNames()

string [] PlatformerPro.PrefabDictionary.GetNames ( )

◆ Init()

void PlatformerPro.PrefabDictionary.Init ( )
protected

Create a dictionary for fast access.

◆ NameOfAsset()

string PlatformerPro.PrefabDictionary.NameOfAsset ( GameObject  asset)

Get name for specific asset.

Returns
The name of the asset.
Parameters
assetAsset.

Member Data Documentation

◆ DefaultDictionaryPrefabLocation

const string PlatformerPro.PrefabDictionary.DefaultDictionaryPrefabLocation = "Assets/PlatformerPro/Prefabs/DefaultPrefabDictionary.prefab"
static

The default dictionary prefab location. If editor can't find a Dictionary one will be created from this prefab.

◆ items

List<GameObject> PlatformerPro.PrefabDictionary.items

Assets used in the map.

Property Documentation

◆ Instance

PrefabDictionary PlatformerPro.PrefabDictionary.Instance
staticgetsetprotected

Gets reference to the Dictionary in the scene.

The instance.


The documentation for this class was generated from the following file: