![]() | App Class |
Namespace: ImmerseSDK
[UnityEngine.DisallowMultipleComponent] public class App : SingletonBehaviour
The App type exposes the following members.
Name | Description | |
---|---|---|
![]() ![]() | AllowVerboseLoggingInBuilds |
Returns true if the current client is a VR client
|
![]() ![]() | ApplicationQuitting |
True if the we received the OnApplicationQuit event form Unity
|
![]() ![]() | Audio |
Returns the active AudioService, used for playing UI sounds and controlling volume levels
|
![]() ![]() | Avatars |
Returns the current Avatar service. This is used to find avatars in the scene
|
![]() ![]() | CameraService |
Returns the active CameraService, used in the WebGL client for controlling camera
|
![]() | CheckIndexesOnGameStart |
Enable/Disable Checking Indexes when on play in the editor
|
![]() | CheckIndexesOnLevelLoad |
Enable/Disable Checking Indexes when level is loaded in the editor.
Note will only be check if checkIndexesOnGameStart is enabled.
|
![]() | HandGuiType |
The type of handui that has been configured in this app
|
![]() ![]() | IsEditor |
Returns true if the application is running in the editor.
This does not need to be called from the main thread
|
![]() ![]() | IsVrClient |
Returns true if the current client is a VR client
|
![]() ![]() | MessageDisplayService |
Returns the message display service, for showing messages to users
|
![]() ![]() | PostProcessing |
Returns the PostProcessingService, used for post processing effects
|
![]() ![]() | Scene |
Returns the SceneService, used for changing scenes
|
![]() ![]() | Session |
Returns the current session, this provides access to session level services
|
![]() | ShouldHighlightEngageObject |
Enable/Disable object highlighting
|
![]() ![]() | UiInputModule |
Returns the UnityUiInputModule
|
Name | Description | |
---|---|---|
![]() | CoroutineInitialise |
This method is used by our internal systems so do not call it directly.
(Overrides SingletonBehaviourCoroutineInitialise.) |
![]() | DisconnectGhost |
Disconnect anyGhost instances we might have used
|
![]() | OnApplicationFocus |
Unity component message
|
![]() | OnApplicationPause |
Unity component message
|
![]() | OnApplicationQuit |
Unity component message
|
![]() | OnAwake |
Override this method to call code in the Awake() method (after singleton registration, but before coroutine)
(Overrides SingletonBehaviourOnAwake.) |
![]() | OnDestroy |
Unity component message
(Overrides SingletonBehaviourOnDestroy.) |
![]() | Reset |
Unity component message
|
![]() | SetupDefaultHandmenu |
Setup default handmenu (when avatar was recreated)
|
![]() | ShowContollerInstructionDialog | Obsolete.
Displays the instructions for how to use the controllers
|
![]() | ShowControllerInstructionDialog |
Displays the instructions for how to use the controllers
|
![]() ![]() | WaitForSdkReadyCoroutine |
Common coroutine to wait for SDK ready.
This is safe to use immediately on Awake(), or after a restart/load
|
Name | Description | |
---|---|---|
![]() | _allowVerboseLoggingInBuilds |
Add open log shortcut to standalone player
|
![]() | _checkIndexesOnGameStart |
Enable/Disable Checking Indexes when on play in the editor
|
![]() | _checkIndexesOnLevelLoad |
Enable/Disable Checking Indexes when level is loaded in the editor.
|
![]() | _logLevel |
Set the logging level of the application
|
![]() | _logShortcut |
Add open log shortcut to standalone player
|
![]() ![]() | DefaultSettingsHandUiPageId |
Id for the Default HandGui settings page. You can use this Id to find the page.
|
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.) |