Show / Hide Table of Contents

    Class Throwable

    Inheritance
    System.Object
    UnityEngine.Object
    UnityEngine.Component
    UnityEngine.Behaviour
    UnityEngine.MonoBehaviour
    Throwable
    ModalThrowable
    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.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
    [RequireComponent(typeof(Interactable))]
    [RequireComponent(typeof(Rigidbody))]
    [RequireComponent(typeof(VelocityEstimator))]
    public class Throwable : MonoBehaviour

    Fields

    attachEaseInTransform

    Declaration
    protected Transform attachEaseInTransform
    Field Value
    Type Description
    UnityEngine.Transform

    attached

    Declaration
    protected bool attached
    Field Value
    Type Description
    System.Boolean

    attachmentFlags

    Declaration
    [EnumFlags]
    [Tooltip("The flags used to attach this object to the hand.")]
    public Hand.AttachmentFlags attachmentFlags
    Field Value
    Type Description
    Hand.AttachmentFlags

    attachmentOffset

    Declaration
    [Tooltip("The local point which acts as a positional and rotational offset to use while held")]
    public Transform attachmentOffset
    Field Value
    Type Description
    UnityEngine.Transform

    attachPosition

    Declaration
    protected Vector3 attachPosition
    Field Value
    Type Description
    UnityEngine.Vector3

    attachRotation

    Declaration
    protected Quaternion attachRotation
    Field Value
    Type Description
    UnityEngine.Quaternion

    attachTime

    Declaration
    protected float attachTime
    Field Value
    Type Description
    System.Single

    catchingSpeedThreshold

    Declaration
    [Tooltip("How fast must this object be moving to attach due to a trigger hold instead of a trigger press? (-1 to disable)")]
    public float catchingSpeedThreshold
    Field Value
    Type Description
    System.Single

    hadInterpolation

    Declaration
    protected RigidbodyInterpolation hadInterpolation
    Field Value
    Type Description
    UnityEngine.RigidbodyInterpolation

    interactable

    Declaration
    [HideInInspector]
    public Interactable interactable
    Field Value
    Type Description
    Interactable

    onDetachFromHand

    Declaration
    public UnityEvent onDetachFromHand
    Field Value
    Type Description
    UnityEngine.Events.UnityEvent

    onHeldUpdate

    Declaration
    public UnityEvent<Hand> onHeldUpdate
    Field Value
    Type Description
    UnityEngine.Events.UnityEvent<Hand>

    onPickUp

    Declaration
    public UnityEvent onPickUp
    Field Value
    Type Description
    UnityEngine.Events.UnityEvent

    releaseVelocityStyle

    Declaration
    public ReleaseStyle releaseVelocityStyle
    Field Value
    Type Description
    ReleaseStyle

    releaseVelocityTimeOffset

    Declaration
    [Tooltip("The time offset used when releasing the object with the RawFromHand option")]
    public float releaseVelocityTimeOffset
    Field Value
    Type Description
    System.Single

    restoreOriginalParent

    Declaration
    [Tooltip("When detaching the object, should it return to its original parent?")]
    public bool restoreOriginalParent
    Field Value
    Type Description
    System.Boolean

    rigidbody

    Declaration
    protected Rigidbody rigidbody
    Field Value
    Type Description
    UnityEngine.Rigidbody

    scaleReleaseVelocity

    Declaration
    public float scaleReleaseVelocity
    Field Value
    Type Description
    System.Single

    velocityEstimator

    Declaration
    protected VelocityEstimator velocityEstimator
    Field Value
    Type Description
    VelocityEstimator

    Methods

    Awake()

    Declaration
    protected virtual void Awake()

    GetReleaseVelocities(Hand, out Vector3, out Vector3)

    Declaration
    public virtual void GetReleaseVelocities(Hand hand, out Vector3 velocity, out Vector3 angularVelocity)
    Parameters
    Type Name Description
    Hand hand
    UnityEngine.Vector3 velocity
    UnityEngine.Vector3 angularVelocity

    HandAttachedUpdate(Hand)

    Declaration
    protected virtual void HandAttachedUpdate(Hand hand)
    Parameters
    Type Name Description
    Hand hand

    HandHoverUpdate(Hand)

    Declaration
    protected virtual void HandHoverUpdate(Hand hand)
    Parameters
    Type Name Description
    Hand hand

    LateDetach(Hand)

    Declaration
    protected virtual IEnumerator LateDetach(Hand hand)
    Parameters
    Type Name Description
    Hand hand
    Returns
    Type Description
    System.Collections.IEnumerator

    OnAttachedToHand(Hand)

    Declaration
    protected virtual void OnAttachedToHand(Hand hand)
    Parameters
    Type Name Description
    Hand hand

    OnDetachedFromHand(Hand)

    Declaration
    protected virtual void OnDetachedFromHand(Hand hand)
    Parameters
    Type Name Description
    Hand hand

    OnHandFocusAcquired(Hand)

    Declaration
    protected virtual void OnHandFocusAcquired(Hand hand)
    Parameters
    Type Name Description
    Hand hand

    OnHandFocusLost(Hand)

    Declaration
    protected virtual void OnHandFocusLost(Hand hand)
    Parameters
    Type Name Description
    Hand hand

    OnHandHoverBegin(Hand)

    Declaration
    protected virtual void OnHandHoverBegin(Hand hand)
    Parameters
    Type Name Description
    Hand hand

    OnHandHoverEnd(Hand)

    Declaration
    protected virtual void OnHandHoverEnd(Hand hand)
    Parameters
    Type Name Description
    Hand hand
    In This Article
    • Fields
      • attachEaseInTransform
      • attached
      • attachmentFlags
      • attachmentOffset
      • attachPosition
      • attachRotation
      • attachTime
      • catchingSpeedThreshold
      • hadInterpolation
      • interactable
      • onDetachFromHand
      • onHeldUpdate
      • onPickUp
      • releaseVelocityStyle
      • releaseVelocityTimeOffset
      • restoreOriginalParent
      • rigidbody
      • scaleReleaseVelocity
      • velocityEstimator
    • Methods
      • Awake()
      • GetReleaseVelocities(Hand, out Vector3, out Vector3)
      • HandAttachedUpdate(Hand)
      • HandHoverUpdate(Hand)
      • LateDetach(Hand)
      • OnAttachedToHand(Hand)
      • OnDetachedFromHand(Hand)
      • OnHandFocusAcquired(Hand)
      • OnHandFocusLost(Hand)
      • OnHandHoverBegin(Hand)
      • OnHandHoverEnd(Hand)
    Back to top Copyright (c) Valve Corporation, All rights reserved.