 | HandGui Methods |
The HandGui type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddCommandsToPage |
Adds commands to an existing page to the HandGui.
|
| AddCustomPage(String, Sprite, ListUICommand) |
Adds a custom page to the HandGui.
|
| AddCustomPage(String, Sprite, String, HandGuiPage) |
Adds a custom page to the HandGui from a prefab
|
| AddCustomPage(String, Sprite, String, ListUICommand) |
Adds a custom page to the HandGui.
|
| AddNotification |
Adds a new notification
|
| CoroutineInitialise |
Override this to perform initialisation tasks
This coroutine is started in Awake().
To execute code in Awake(), override OnAwake()
(Overrides SingletonBehaviourCoroutineInitialise.) |
| EnableCommandOnPage |
Enables/Disables a command on the page.
|
| HasCustomPage |
Returns true if the custom page exists, otherwise false
|
 | OnAwake |
Override this method to call code in the Awake() method (after singleton registration, but before coroutine)
(Overrides SingletonBehaviourOnAwake.) |
| RemoveCommandsFromPage |
Removes commands from an existing page to the HandGui.
|
| RemoveNotification |
Remove a previously added notification
|
| RemovePage |
Removes a page with the given ID
|
| SetPageAvailable |
If the page is available, it can be selected from the top shelf. If not, it is hidden from the top shelf.
|
| UpdateCommandColorOnPage |
Applies a color to a command on the page. Pass in null to revert back to original default color.
|
Extension Methods| Name | Description | |
|---|---|---|
 | GetCopyOf |
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.) |
| WaitForT |
Waits for a singleton on a coroutine
(Defined by SingletonManager.) |
See Also