UnityToolbox
Brief documentation for all existing scripts.
 
Loading...
Searching...
No Matches
IDManager Class Reference

A manager which can generate unique IDs. Works in editor and runtime.

Inheritance diagram for IDManager:
Module

Public Member Functions

override void Awake ()
 
virtual void Awake ()
 

Static Public Member Functions

static void SceneChanged (Scene newScene)
 Is called when the scene changes. See IDInitializer.
 
static string GetUniqueID ()
 Generates a new unique ID.
 
static void RemoveID (string ID)
 Removes an ID from the existing.
 
static void RegisterID (string ID)
 Registeres a given ID. Throws an error if the ID is already known.
 
static string GetSceneNameOfID (string ID)
 Extracts the scene name of the ID.
 

Member Function Documentation

◆ Awake()

override void IDManager.Awake ( )
virtual

Reimplemented from Module.

References SceneChanged().

◆ GetSceneNameOfID()

static string IDManager.GetSceneNameOfID ( string  ID)
static
Parameters
IDThe ID to read its scene from.
Returns
A scene name.

◆ GetUniqueID()

static string IDManager.GetUniqueID ( )
static
Returns
A unique ID.

Referenced by Saveable.OnValidate().

◆ RegisterID()

static void IDManager.RegisterID ( string  ID)
static
Parameters
IDThe ID to register.
Exceptions
Exception

◆ RemoveID()

static void IDManager.RemoveID ( string  ID)
static
Parameters
IDAn existing ID.

◆ SceneChanged()

static void IDManager.SceneChanged ( Scene  newScene)
static
Parameters
newSceneThe new scene.

References Saveable.ID.

Referenced by Awake().