• Articles
  • Tutorials
  • Api Documentation
  • Api Documentation

    Show / Hide Table of Contents

    Class Player

    Inheritance
    System.Object
    UnityEngine.Object
    UnityEngine.Component
    UnityEngine.Behaviour
    UnityEngine.MonoBehaviour
    Player
    Inherited Members
    UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)
    UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)
    UnityEngine.MonoBehaviour.CancelInvoke()
    UnityEngine.MonoBehaviour.CancelInvoke(System.String)
    UnityEngine.MonoBehaviour.IsInvoking(System.String)
    UnityEngine.MonoBehaviour.IsInvoking()
    UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)
    UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)
    UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)
    UnityEngine.MonoBehaviour.StartCoroutine(System.String)
    UnityEngine.MonoBehaviour.StopCoroutine(System.String)
    UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)
    UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)
    UnityEngine.MonoBehaviour.StopAllCoroutines()
    UnityEngine.MonoBehaviour.print(System.Object)
    UnityEngine.MonoBehaviour.useGUILayout
    UnityEngine.Behaviour.enabled
    UnityEngine.Behaviour.isActiveAndEnabled
    UnityEngine.Component.GetComponent(System.Type)
    UnityEngine.Component.GetComponent<T>()
    UnityEngine.Component.GetComponent(System.String)
    UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)
    UnityEngine.Component.GetComponentInChildren(System.Type)
    UnityEngine.Component.GetComponentInChildren<T>()
    UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)
    UnityEngine.Component.GetComponentsInChildren(System.Type)
    UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)
    UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean)
    UnityEngine.Component.GetComponentsInChildren<T>(System.Boolean, System.Collections.Generic.List<T>)
    UnityEngine.Component.GetComponentsInChildren<T>()
    UnityEngine.Component.GetComponentsInChildren<T>(System.Collections.Generic.List<T>)
    UnityEngine.Component.GetComponentInParent(System.Type)
    UnityEngine.Component.GetComponentInParent<T>()
    UnityEngine.Component.GetComponentsInParent(System.Type)
    UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)
    UnityEngine.Component.GetComponentsInParent<T>(System.Boolean)
    UnityEngine.Component.GetComponentsInParent<T>(System.Boolean, System.Collections.Generic.List<T>)
    UnityEngine.Component.GetComponentsInParent<T>()
    UnityEngine.Component.GetComponents(System.Type)
    UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List<UnityEngine.Component>)
    UnityEngine.Component.GetComponents<T>(System.Collections.Generic.List<T>)
    UnityEngine.Component.GetComponents<T>()
    UnityEngine.Component.CompareTag(System.String)
    UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)
    UnityEngine.Component.SendMessageUpwards(System.String, System.Object)
    UnityEngine.Component.SendMessageUpwards(System.String)
    UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)
    UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)
    UnityEngine.Component.SendMessage(System.String, System.Object)
    UnityEngine.Component.SendMessage(System.String)
    UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)
    UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)
    UnityEngine.Component.BroadcastMessage(System.String, System.Object)
    UnityEngine.Component.BroadcastMessage(System.String)
    UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)
    UnityEngine.Component.transform
    UnityEngine.Component.gameObject
    UnityEngine.Component.tag
    UnityEngine.Component.rigidbody
    UnityEngine.Component.rigidbody2D
    UnityEngine.Component.camera
    UnityEngine.Component.light
    UnityEngine.Component.animation
    UnityEngine.Component.constantForce
    UnityEngine.Component.renderer
    UnityEngine.Component.audio
    UnityEngine.Component.guiText
    UnityEngine.Component.networkView
    UnityEngine.Component.guiElement
    UnityEngine.Component.guiTexture
    UnityEngine.Component.collider
    UnityEngine.Component.collider2D
    UnityEngine.Component.hingeJoint
    UnityEngine.Component.particleEmitter
    UnityEngine.Component.particleSystem
    UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)
    UnityEngine.Object.Destroy(UnityEngine.Object)
    UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)
    UnityEngine.Object.DestroyImmediate(UnityEngine.Object)
    UnityEngine.Object.FindObjectsOfType(System.Type)
    UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)
    UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)
    UnityEngine.Object.DestroyObject(UnityEngine.Object)
    UnityEngine.Object.FindSceneObjectsOfType(System.Type)
    UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)
    UnityEngine.Object.FindObjectsOfTypeAll(System.Type)
    UnityEngine.Object.ToString()
    UnityEngine.Object.GetInstanceID()
    UnityEngine.Object.GetHashCode()
    UnityEngine.Object.Equals(System.Object)
    UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)
    UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
    UnityEngine.Object.Instantiate(UnityEngine.Object)
    UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)
    UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)
    UnityEngine.Object.Instantiate<T>(T)
    UnityEngine.Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectOfType(System.Type)
    UnityEngine.Object.FindObjectOfType<T>()
    UnityEngine.Object.name
    UnityEngine.Object.hideFlags
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Valve.VR.InteractionSystem
    Assembly: Assembly-CSharp.dll
    Syntax
    public class Player : MonoBehaviour

    Fields

    allowToggleTo2D

    Declaration
    public bool allowToggleTo2D
    Field Value
    Type Description
    System.Boolean

    audioListener

    Declaration
    [Tooltip("The audio listener for this player")]
    public Transform audioListener
    Field Value
    Type Description
    UnityEngine.Transform

    hands

    Declaration
    [Tooltip("List of possible Hands, including no-SteamVR fallback Hands.")]
    public Hand[] hands
    Field Value
    Type Description
    Hand[]

    headCollider

    Declaration
    [Tooltip("Reference to the physics collider that follows the player's HMD position.")]
    public Collider headCollider
    Field Value
    Type Description
    UnityEngine.Collider

    headsetOnHead

    Declaration
    [Tooltip("This action lets you know when the player has placed the headset on their head")]
    public SteamVR_Action_Boolean headsetOnHead
    Field Value
    Type Description
    SteamVR_Action_Boolean

    hmdTransforms

    Declaration
    [Tooltip("List of possible transforms for the head/HMD, including the no-SteamVR fallback camera.")]
    public Transform[] hmdTransforms
    Field Value
    Type Description
    UnityEngine.Transform[]

    rig2DFallback

    Declaration
    [Tooltip("These objects are enabled when SteamVR is not available, or when the user toggles out of VR")]
    public GameObject rig2DFallback
    Field Value
    Type Description
    UnityEngine.GameObject

    rigSteamVR

    Declaration
    [Tooltip("These objects are enabled when SteamVR is available")]
    public GameObject rigSteamVR
    Field Value
    Type Description
    UnityEngine.GameObject

    trackingOriginTransform

    Declaration
    [Tooltip("Virtual transform corresponding to the meatspace tracking origin. Devices are tracked relative to this.")]
    public Transform trackingOriginTransform
    Field Value
    Type Description
    UnityEngine.Transform

    Properties

    bodyDirectionGuess

    Declaration
    public Vector3 bodyDirectionGuess { get; }
    Property Value
    Type Description
    UnityEngine.Vector3

    eyeHeight

    Declaration
    public float eyeHeight { get; }
    Property Value
    Type Description
    System.Single

    feetPositionGuess

    Declaration
    public Vector3 feetPositionGuess { get; }
    Property Value
    Type Description
    UnityEngine.Vector3

    handCount

    Declaration
    public int handCount { get; }
    Property Value
    Type Description
    System.Int32

    hmdTransform

    Declaration
    public Transform hmdTransform { get; }
    Property Value
    Type Description
    UnityEngine.Transform

    instance

    Declaration
    public static Player instance { get; }
    Property Value
    Type Description
    Player

    leftHand

    Declaration
    public Hand leftHand { get; }
    Property Value
    Type Description
    Hand

    rightHand

    Declaration
    public Hand rightHand { get; }
    Property Value
    Type Description
    Hand

    scale

    Declaration
    public float scale { get; }
    Property Value
    Type Description
    System.Single

    Methods

    Draw2DDebug()

    Declaration
    public void Draw2DDebug()

    GetHand(Int32)

    Declaration
    public Hand GetHand(int i)
    Parameters
    Type Name Description
    System.Int32 i
    Returns
    Type Description
    Hand

    PlayerShotSelf()

    Declaration
    public void PlayerShotSelf()

    Update()

    Declaration
    protected virtual void Update()
    In This Article
    • Fields
      • allowToggleTo2D
      • audioListener
      • hands
      • headCollider
      • headsetOnHead
      • hmdTransforms
      • rig2DFallback
      • rigSteamVR
      • trackingOriginTransform
    • Properties
      • bodyDirectionGuess
      • eyeHeight
      • feetPositionGuess
      • handCount
      • hmdTransform
      • instance
      • leftHand
      • rightHand
      • scale
    • Methods
      • Draw2DDebug()
      • GetHand(Int32)
      • PlayerShotSelf()
      • Update()
    Back to top Copyright (c) Valve Corporation, All rights reserved.