Click or drag to resize

HandUI Methods

The HandUI type exposes the following members.

Methods
  NameDescription
Public methodAddCommandsToPage
Adds commands to an existing page to the HandUI.
Public methodAddCustomPage(String, Sprite, ListUICommand)
Adds a custom page to the HandUI.
Public methodAddCustomPage(String, Sprite, String, ListUICommand)
Adds a custom page to the HandUI.
Public methodAddNotification
Adds a new notification
Public methodCoroutineInitialise
Override this to perform initialisation tasks This coroutine is started in Awake(). To execute code in Awake(), override OnAwake()
(Overrides SingletonBehaviourCoroutineInitialise.)
Public methodEnableCommandOnPage
Enables/Disables a command on the page.
Public methodHasCustomPage
Returns true if the custom page exists, otherwise false
Protected methodOnAwake
Override this method to call code in the Awake() method (after singleton registration, but before coroutine)
(Overrides SingletonBehaviourOnAwake.)
Public methodRemoveCommandsFromPage
Removes commands from an existing page to the HandUI.
Public methodRemoveNotification
Remove a previously added notification
Public methodRemovePage
Removes a page with the given ID
Public methodSetPageAvailable
If the page is available, it can be selected from the top shelf. If not, it is hidden from the top shelf.
Public methodUpdateCommandColorOnPage
Applies a color to a command on the page. Pass in null to revert back to original default color.
Top
Extension Methods
  NameDescription
Public Extension MethodGetCopyOf
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.)
Public Extension MethodWaitForT
Waits for a singleton on a coroutine
(Defined by SingletonManager.)
Top
See Also