Click or drag to resize

AvatarLocal Class

Implements the local Avatar functionality. Should only ever be a single instance of this in a scene. Add SteamVR_UpdatePoses to Camera (eye) in 5.6+
Inheritance Hierarchy
SystemObject
  UnityEngine.Object
    UnityEngine.Component
      UnityEngine.Behaviour
        UnityEngine.MonoBehaviour
          ImmerseSDKLoggingBehaviour
            ImmerseSDK.AvatarsAvatar
              ImmerseSDK.AvatarsAvatarLocal
                ImmerseSDK.AvatarsScriptedAvatarLocal

Namespace:  ImmerseSDK.Avatars
Assembly:  ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.9.0.0 (3.9.0.0)
Syntax

The AvatarLocal type exposes the following members.

Constructors
  NameDescription
Public methodAvatarLocal
Initializes a new instance of the AvatarLocal class
Top
Properties
  NameDescription
Public propertyControllers
Gets the controller set for this Avatar
Public propertyHeadCamera
The head (or eye) camera being used
Public propertyNavigation
Gets the Navigation instance for this Avatar
Top
Methods
  NameDescription
Protected methodAttachControllers (Overrides AvatarAttachControllers(ControllerSet).)
Protected methodGetControllerSerialisation
Gets the controller serialisation implementation
(Overrides AvatarGetControllerSerialisation(Hands).)
Protected methodHandleOwnerStateChanged (Overrides AvatarHandleOwnerStateChanged(User).)
Protected methodOnDestroy
Unity component method
(Overrides AvatarOnDestroy.)
Protected methodOnTrackedTransformToggled (Overrides AvatarOnTrackedTransformToggled(ToggleNotifier, Boolean).)
Public methodSetLocation
Sets this Avatar's Spawn point
(Overrides AvatarSetLocation(Spawn).)
Public methodSetLocationPersisted
Moves the avatar's to the specified position and rotation in worldspace, and is persisted. If correctForPlaySpace is TRUE, then the Avatar's head will appear at the location specified. If correctForPlaySpace is FALSE, then the play space's center will appear at the location specified
Public methodShowBackgroundFader
Fade the VR background out (block it), or fade it back in (unblock it)
Public methodTeleportToSpawnPoint
Teleports this Avatar back to it's original Spawn point (if it's still valid)
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