App Class

This is a core component of Immerse SDK. An instance of this must be included in the scene at build index #0. This component will not be destroyed on scene load and will persist throughout the application, any additional instances will be automatically destroyed. The Inspector for the App component shows connection information and can be used to enable Offline Mode for quicker testing.

Inheritance Hierarchy

SystemObject
  UnityEngine.Object
    UnityEngine.Component
      UnityEngine.Behaviour
        UnityEngine.MonoBehaviour
          ImmerseSDKLoggingBehaviour
            ImmerseSDKSingletonBehaviour
              ImmerseSDKApp
                ImmerseSDK.Tests.PlayModeTests.UtilitiesUnitTestApp

Namespace: ImmerseSDK
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.7.0.0 (3.7.0.0)

Syntax

Copy

[UnityEngine.RequireComponent(typeof(RolesList))]
[UnityEngine.DisallowMultipleComponent]
public class App : SingletonBehaviour

The App type exposes the following members.

Constructors

	Name	Description
	App
	App	Initializes a new instance of the App class

Top

Properties

	Name	Description
	AllowVerboseLoggingInBuilds	Returns true if the current client is a VR client
	ApplicationQuitting	True if the we received the OnApplicationQuit event form Unity
	AreNotificationsEnabled	Are notifications enabled for this app?
	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 runningin the editor. This does not need to be called from the main thread
	IsVrClient
	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

Top

Methods

	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

Top

Fields

	Name	Description
	_allowVerboseLoggingInBuilds	Add open log shortcut to standalone player
	_areNotificationsEnabled	Are Notifications enabled for this app. If true, then Notifications will be accessible from the Hand menu.
	_checkIndexesOnGameStart	Enable/Disable Checking Indexes when on play in the editor
	_checkIndexesOnLevelLoad	Enable/Disable Checking Indexes when level is loaded in the editor.
	_customLocalisationFileSetPath	A custom localisation path to a set of localisation files to load for your application. These are TSV files with named text keys and localised text in. The SDK will attempt to load the current locale and platform variations from this file.
	_handMenuType	Which type of hand menu should be used, or should the HandGui be disabled?
	_logLevel	Set the logging level of the application
	_logShortcut	Add open log shortcut to standalone player
	_showControllerInstructionsAtStartup	Should the controller instructions dialog be displayed at startup?
	_showControllerInstructionsOnHandMenu	Should the controller instructions dialog be accessible from the Hand menu?
	_showToggleOutlineOnHandMenu	Should toggling the outline effect on objects be accessible from the Hand menu?
	DefaultSettingsHandUiPageId	Id for the Default HandGui settings page. You can use this Id to find the page.

Top

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.)

Top

Reference

ImmerseSDK Namespace