Skip to main content

Class Stockholm

Declaration
public class Stockholm : SingletonBehaviour<Stockholm>

Derived:
MatchinghamGames.StockholmCore.Demo.DemoUIManager

Properties​

UiRoot​

The parent of the transform of a controller when no parent is specified.

Declaration
protected Transform UiRoot { get; }

Loader​

The Load Functionality to manage fetching from directory at mount.

Declaration
public IUiLoader Loader { get; set; }

Manager​

The Spawn Functionality to manage instantiating gameobjects.

Declaration
public IObjectManager Manager { get; set; }

Fields​

UIRootTag​

Declaration
public const string UIRootTag = "UIRoot"

defaultRoot​

Declaration
protected Transform defaultRoot

manager​

Declaration
protected IObjectManager manager

loader​

Declaration
protected IUiLoader loader

Methods​

Awake()​

Declaration
protected virtual void Awake()

Register<TController>(string, TController)​

Register already created UI instance.

Declaration
protected void Register<TController>(string name, TController controller) where TController : Controller
Parameters​
TypeNameDescription
System.StringnamePrefab name
<TController>controller
Type Parameters​
  • TController

MountSingle<TController>()​

Loads the selected Controller and instantiates it on default canvas given on, if already mounted one, returns it. If previously mounted several, returns first found.

Declaration
public TController MountSingle<TController>() where TController : Controller
Returns​

<TController>

Type Parameters​
  • TController

MountSingle<TController>(string)​

Loads the selected Controller and instantiates it on default canvas given on, if already mounted one, returns it. If previously mounted several, returns first found.

Declaration
public TController MountSingle<TController>(string name) where TController : Controller
Returns​

<TController>

Parameters​
TypeNameDescription
System.StringnameName of the prefab
Type Parameters​
  • TController

MountSingle<TController>(Transform)​

Loads the selected Controller and instantiates it on default canvas given on, if already mounted one, returns it. If previously mounted several, returns first found.

Declaration
public TController MountSingle<TController>(Transform root) where TController : Controller
Returns​

<TController>

Parameters​
TypeNameDescription
Global.TransformrootName of the prefab
Type Parameters​
  • TController

MountSingle<TController>(string, Transform)​

Loads the selected Controller and instantiates it on given transform, if already mounted one, returns it. If previously mounted several, returns first found.

Declaration
public TController MountSingle<TController>(string name, Transform root) where TController : Controller
Returns​

<TController>

Parameters​
TypeNameDescription
System.StringnameName of the prefab
Global.TransformrootParent Transform object
Type Parameters​
  • TController

Mount<TController>()​

Loads the selected Controller and instantiates it on default canvas given on.

Declaration
public TController Mount<TController>() where TController : Controller
Returns​

<TController>

Type Parameters​
  • TController

Mount<TController>(string)​

Loads the selected Controller and instantiates it on default canvas given on.

Declaration
public TController Mount<TController>(string name) where TController : Controller
Returns​

<TController>

Parameters​
TypeNameDescription
System.StringnameName of the prefab
Type Parameters​
  • TController

Mount<TController>(Transform)​

Loads the selected Controller and instantiates it on given transform, logically a Canvas.

Declaration
public TController Mount<TController>(Transform root) where TController : Controller
Returns​

<TController>

Parameters​
TypeName
Global.Transformroot
Type Parameters​
  • TController

Mount<TController>(string, Transform)​

Loads the selected Controller and instantiates it on given transform, logically a Canvas.

Declaration
public TController Mount<TController>(string name, Transform root) where TController : Controller
Returns​

<TController>

Parameters​
TypeNameDescription
System.StringnameName of the prefab
Global.TransformrootParent Transform object
Type Parameters​
NameDescription
TControllerController type

MountSingleAsync<TController>(Action<TController>)​

[Experimental] Loads the selected Controller and instantiates it on given transform, logically a Canvas.

Declaration
public void MountSingleAsync<TController>(Action<TController> onLoad) where TController : Controller
Parameters​
TypeName
System.Action<<TController>>onLoad
Type Parameters​
  • TController

MountSingleAsync<TController>(Transform, Action<TController>)​

[Experimental] Loads the selected Controller and instantiates it on given transform, logically a Canvas.

Declaration
public void MountSingleAsync<TController>(Transform root, Action<TController> onLoad) where TController : Controller
Parameters​
TypeName
Global.Transformroot
System.Action<<TController>>onLoad
Type Parameters​
  • TController

MountAsync<TController>(Action<TController>)​

[Experimental] Loads the selected Controller and instantiates it on given transform, logically a Canvas.

Declaration
public void MountAsync<TController>(Action<TController> onLoad) where TController : Controller
Parameters​
TypeName
System.Action<<TController>>onLoad
Type Parameters​
  • TController

MountAsync<TController>(Transform, Action<TController>)​

[Experimental] Loads the selected Controller and instantiates it on given transform, logically a Canvas.

Declaration
public void MountAsync<TController>(Transform root, Action<TController> onLoad) where TController : Controller
Parameters​
TypeName
Global.Transformroot
System.Action<<TController>>onLoad
Type Parameters​
  • TController

MountAsync<TController>(string, Transform, Action<TController>)​

[Experimental] Loads the selected Controller and instantiates it on given transform, logically a Canvas.

Declaration
public void MountAsync<TController>(string name, Transform root, Action<TController> onLoad) where TController : Controller
Parameters​
TypeName
System.Stringname
Global.Transformroot
System.Action<<TController>>onLoad
Type Parameters​
  • TController

Unmount(Controller)​

Removes the preloaded controller instance, destroying it.

Declaration
public void Unmount(Controller instance)
Parameters​
TypeName
MatchinghamGames.StockholmCore.Controllerinstance

Unmount<TController>()​

Removes and destroys all controller instances of a given type

Declaration
public void Unmount<TController>() where TController : Controller
Type Parameters​
  • TController

Unmount(string)​

Removes and destroys all controller instances of a given name

Declaration
public void Unmount(string name)
Parameters​
TypeName
System.Stringname

IsAny()​

Checks if there is any controller

Declaration
public bool IsAny()
Returns​

System.Boolean

IsAny<TController>()​

Checks if there is any controller with given type.

Declaration
public bool IsAny<TController>() where TController : Controller
Returns​

System.Boolean

Type Parameters​
  • TController

IsAny(string)​

Checks if there is any controller with given key.

Declaration
public bool IsAny(string key)
Returns​

System.Boolean

Parameters​
TypeName
System.Stringkey

FindFirst<TController>()​

Returns the first controller instance

Declaration
public TController FindFirst<TController>() where TController : Controller
Returns​

<TController>

Type Parameters​
  • TController

FindFirst<TController>(string)​

Returns the first controller instance with a given name

Declaration
public TController FindFirst<TController>(string name) where TController : Controller
Returns​

<TController>

Parameters​
TypeNameDescription
System.StringnameName of the prefab
Type Parameters​
  • TController

FindAll<TController>()​

Returns all controller instances of a specified type

Declaration
public List<TController> FindAll<TController>() where TController : Controller
Returns​

System.Collections.Generic.List<<TController>>

Type Parameters​
  • TController