Introduction
The Interface Manager provide a centralized location for dealing with Input, Object Management, Interaction, and UI. This object will automatically create itself will default settings whenever data is requested from it if there is not already an instance in your scene. A secondary canvas is also created specifically for system UI components such as Tooltips.
Fields#
| Name | Description |
|---|---|
| Persist | Mark this object as DontDestroyOnLoad |
| Input Manager | Input manager to use |
| Object Manager | Object manager to use |
| Use Existing Canvas | Use the a canvas already in the scene |
| Use Canvas | Canvas to use for UI |
| Include Raycaster | Add a Raycaster component to the canvas. |
| Tooltip Prefab | Prefab to use when displaying a tooltip. |
| Enabled Object Tooltips | Enable tooltips for non-UI elements |
| Tip Offset | Pixel offset from cursor to use when displaying tooltip. |
| Display Delay | Seconds to wait after cursor is over item to display tooltip |
| Additional Tooltips | List of additional Tooltip Displays that can be found by id |
| Interactor Prefab | Interaction UI prefab to use by default |
| Interaction Type | Method of confirming interaction |
| Interaction Button | Button to use for confirming interaction |
| Interaction Key | Key to use for confirming interaction |
| Additional Interactors | List of additional Interactor UIs that can be found by id |
| Activate First Tab Stop | Automatically activate the first TabStop |
| Tab Style | Method of performing tab stops |
| Tab Button | Button to use for tabbing |
| Tab Key | Key to use for tabbing |
| On Next Update | Event raised each frame, subscriptions cleared at the end |
Properties#
| Name | Description |
|---|---|
| ActiveModal | Gets the currently active modal |
| Current | Returns the current instance |
| Input | Returns the current Input Manager |
| InterfaceFlags | Get/Set Interface Flags |
| hideHardwareCursor | Gets/Sets if the hardware pointer is hidden |
| localizationSettings | Returns current Localization Settings |
| LockPlayerController | Returns if Interface Flags contains LockPlayerController |
| ObjectManagement | Returns current Object Manager |
| ObjectsUnderPointer | Returns a list of objects under the pointer |
| PreventInteractions | Returns if Interface Flags contains PreventInteractionUI |
| PreventPrompts | Returns if Interface Flags contains PreventPrompts |
| PreventWindows | Returns if Interface Flags contains PreventWindows |
| PromptOpen | Returns if a prompt is open |
| ShowInputCursor | Gets/Sets if Input Cursor should be shown |
| SuppressUI | Gets/Sets UI suppression state |
| UICanvas | Returns current UI Canvas |
Methods#
| Name | Description |
|---|---|
| AddInteractorUI | Add an Interactor UI to the 'additionalInteractors' list |
| AddTooltip | Add a TooltipDisplay to the 'additionalTooltips' list |
| GetInteractorUI | Get an Interactor UI by id |
| GetTooltip | Get a TooltipDisplay by id |
| HideTooltip | Hide any currently active tooltip |
| IsBlockedByModal | Check if a GameObject is blocked by a modal |
| LoadScene | Loads a scene by index |
| NextTab | Set focus to next Tab Stop |
| Quit | Exit the game or play mode |
| RemoveActiveModal | Remove object from list of active modals |
| RemoveInteractorUI | Remove an Interactor UI by id |
| RemoveTooltip | Remove a TooltipDisplay by id |
| ObjectUnderPointer | Checks if an object is under the pointer |
| OpenHyperlink | Open a hyperlink |
| SetActiveModal | Sets a GameObject as an active modal |
| SetActiveInputMap | Set the active input map |
| SyncRequest | Sync a request to the main GUI thread |