Class HVRStabber

Inheritance

System.Object

UnityEngine.Object

UnityEngine.Component

UnityEngine.Behaviour

UnityEngine.MonoBehaviour

HVRStabber

Inherited Members

UnityEngine.MonoBehaviour.IsInvoking()

UnityEngine.MonoBehaviour.CancelInvoke()

UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)

UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)

UnityEngine.MonoBehaviour.CancelInvoke(System.String)

UnityEngine.MonoBehaviour.IsInvoking(System.String)

UnityEngine.MonoBehaviour.StartCoroutine(System.String)

UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)

UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)

UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)

UnityEngine.MonoBehaviour.StopCoroutine(System.String)

UnityEngine.MonoBehaviour.StopAllCoroutines()

UnityEngine.MonoBehaviour.print(System.Object)

UnityEngine.MonoBehaviour.useGUILayout

UnityEngine.MonoBehaviour.runInEditMode

UnityEngine.Behaviour.enabled

UnityEngine.Behaviour.isActiveAndEnabled

UnityEngine.Component.GetComponent(System.Type)

UnityEngine.Component.GetComponent<T>()

UnityEngine.Component.TryGetComponent(System.Type, UnityEngine.Component)

UnityEngine.Component.TryGetComponent<T>(T)

UnityEngine.Component.GetComponent(System.String)

UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentInChildren(System.Type)

UnityEngine.Component.GetComponentInChildren<T>(System.Boolean)

UnityEngine.Component.GetComponentInChildren<T>()

UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)

UnityEngine.Component.GetComponentsInChildren(System.Type)

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, System.Boolean)

UnityEngine.Component.GetComponentsInParent(System.Type)

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.Component.SendMessage(System.String)

UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)

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.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.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)

UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)

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.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectOfType<T>()

UnityEngine.Object.FindObjectsOfTypeAll(System.Type)

UnityEngine.Object.FindObjectOfType(System.Type)

UnityEngine.Object.ToString()

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: HurricaneVR.Framework.Core.Stabbing

Assembly: HurricaneVR.Framework.dll

Syntax

[RequireComponent(typeof(Rigidbody))]
public class HVRStabber : MonoBehaviour

Fields

| Improve this Doc View Source

Base

Declaration

[Tooltip("Base of the stabber, limits the stab depth unless CanRunThrough is set to true.")]
public Transform Base

Field Value

Type	Description
UnityEngine.Transform

| Improve this Doc View Source

CanRunThrough

Declaration

[Tooltip("If true the stabber can exit through the base")]
public bool CanRunThrough

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

CollidersToIgnore

Declaration

[Header("Collision")]
[Tooltip("Colliders to disable collision with the stabbed object")]
public Collider[] CollidersToIgnore

Field Value

Type	Description
UnityEngine.Collider[]

| Improve this Doc View Source

ContactOffset

Declaration

[Tooltip("Stabbing colliders contact offset will be modified to this if current offset is larger")]
public float ContactOffset

Field Value

Type	Description
System.Single

| Improve this Doc View Source

Depth

Declaration

public float Depth

Field Value

Type	Description
System.Single

| Improve this Doc View Source

DepthPercent

Declaration

public float DepthPercent

Field Value

Type	Description
System.Single

| Improve this Doc View Source

DrawGizmos

Declaration

[Header("Debug")]
public bool DrawGizmos

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

FallbackSettings

Declaration

public HVRStabbableSettings FallbackSettings

Field Value

Type	Description
HVRStabbableSettings

| Improve this Doc View Source

FullStabbed

Declaration

public HVRStabEvents FullStabbed

Field Value

Type	Description
HVRStabEvents

| Improve this Doc View Source

IgnoreVelocityCheck

Declaration

[Tooltip("Ignores stabbable velocity requirement")]
public bool IgnoreVelocityCheck

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsDualStabber

Declaration

[Tooltip("Both base and tip can stab something")]
public bool IsDualStabber

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

LogFailedAngle

Declaration

public bool LogFailedAngle

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

LogFailedVelocity

Declaration

public bool LogFailedVelocity

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

LogJointForce

Declaration

public bool LogJointForce

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

LogJointForceThreshold

Declaration

public float LogJointForceThreshold

Field Value

Type	Description
System.Single

| Improve this Doc View Source

LogJointLock

Declaration

public bool LogJointLock

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

LogJointUnlock

Declaration

public bool LogJointUnlock

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

ProjectionAngle

Declaration

public float ProjectionAngle

Field Value

Type	Description
System.Single

| Improve this Doc View Source

ProjectionDistance

Declaration

public float ProjectionDistance

Field Value

Type	Description
System.Single

| Improve this Doc View Source

ProjectionMode

Declaration

public JointProjectionMode ProjectionMode

Field Value

Type	Description
UnityEngine.JointProjectionMode

| Improve this Doc View Source

Settings

Declaration

public HVRStabberSettings Settings

Field Value

Type	Description
HVRStabberSettings

| Improve this Doc View Source

StabAnything

Declaration

[Tooltip("Wanna stab anything and everything for fun or testing?!")]
public bool StabAnything

Field Value

Type	Description
System.Boolean

| Improve this Doc View Source

Stabbed

Declaration

public HVRStabEvent Stabbed

Field Value

Type	Description
HVRStabEvent

| Improve this Doc View Source

StabbingColliders

Declaration

[Tooltip("Colliders involved in stab detection")]
public Collider[] StabbingColliders

Field Value

Type	Description
UnityEngine.Collider[]

| Improve this Doc View Source

Tip

Declaration

[Header("Objects / Components")]
[Tooltip("Starting tip point of the stabber")]
public Transform Tip

Field Value

Type	Description
UnityEngine.Transform

| Improve this Doc View Source

UnStabbed

Declaration

public HVRStabEvents UnStabbed

Field Value

Type	Description
HVRStabEvents

| Improve this Doc View Source

VerboseDebugging

Declaration

public bool VerboseDebugging

Field Value

Type	Description
System.Boolean

Properties

| Improve this Doc View Source

IsStabbing

Declaration

public bool IsStabbing { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Length

Declaration

public float Length { get; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

ManuallyLocked

Declaration

public bool ManuallyLocked { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Rigidbody

Declaration

public Rigidbody Rigidbody { get; }

Property Value

Type	Description
UnityEngine.Rigidbody

| Improve this Doc View Source

StabbedObjects

Declaration

public List<GameObject> StabbedObjects { get; }

Property Value

Type	Description
System.Collections.Generic.List<UnityEngine.GameObject>

| Improve this Doc View Source

StabbedStabbables

Declaration

public List<HVRStabbable> StabbedStabbables { get; }

Property Value

Type	Description
System.Collections.Generic.List<HVRStabbable>

| Improve this Doc View Source

StabLineLocal

Declaration

public Vector3 StabLineLocal { get; }

Property Value

Type	Description
UnityEngine.Vector3

| Improve this Doc View Source

StabLineWorld

Declaration

public Vector3 StabLineWorld { get; }

Property Value

Type	Description
UnityEngine.Vector3

Methods

| Improve this Doc View Source

Awake()

Declaration

protected virtual void Awake()

| Improve this Doc View Source

FixedUpdate()

Declaration

public void FixedUpdate()

| Improve this Doc View Source

ForceUnstab(Boolean)

Declaration

public void ForceUnstab(bool fireEvents = false)

Parameters

Type	Name	Description
System.Boolean	fireEvents

| Improve this Doc View Source

GetColliders(Rigidbody, Transform)

Declaration

public static IEnumerable<Collider> GetColliders(Rigidbody rigidbody, Transform transform)

Parameters

Type	Name	Description
UnityEngine.Rigidbody	rigidbody
UnityEngine.Transform	transform

Returns

Type	Description
System.Collections.Generic.IEnumerable<UnityEngine.Collider>

| Improve this Doc View Source

Lock()

Locks each joint on the stabber and prevents it from being unlocked until Unlock is called

Declaration

public void Lock()

| Improve this Doc View Source

OnDrawGizmos()

Declaration

public void OnDrawGizmos()

| Improve this Doc View Source

OnFullStab(HVRStabbable)

Declaration

protected virtual void OnFullStab(HVRStabbable stabbable)

Parameters

Type	Name	Description
HVRStabbable	stabbable

| Improve this Doc View Source

OnStabEnter(HVRStabbable, Collision, ContactPoint)

Declaration

protected virtual void OnStabEnter(HVRStabbable stabbable, Collision collision, ContactPoint contact)

Parameters

Type	Name	Description
HVRStabbable	stabbable
UnityEngine.Collision	collision
UnityEngine.ContactPoint	contact

| Improve this Doc View Source

OnStabExit(HVRStabbable)

Declaration

protected virtual void OnStabExit(HVRStabbable stabbable)

Parameters

Type	Name	Description
HVRStabbable	stabbable

| Improve this Doc View Source

SetupStabJoint(HVRStabbableSettings, Transform, Rigidbody)

Declaration

protected virtual ConfigurableJoint SetupStabJoint(HVRStabbableSettings settings, Transform tip, Rigidbody otherRB)

Parameters

Type	Name	Description
HVRStabbableSettings	settings
UnityEngine.Transform	tip
UnityEngine.Rigidbody	otherRB

Returns

Type	Description
UnityEngine.ConfigurableJoint

| Improve this Doc View Source

Unlock()

Unlocks each joint on the stabber

Declaration

public void Unlock()

Extension Methods

HVRUtilities.GetRelativeValues(Component, Transform, out Vector3, out Quaternion)

HVRUtilities.GetRelativeValues(Component, Component, out Vector3, out Quaternion)

HVRUtilities.GetRelativeRotation(Component, Quaternion)

VRUtilities.GetRigidbody(MonoBehaviour)

VRUtilities.GetCopyOf<T>(Component, T)

CoroutineExtensions.ExecuteNextUpdate(MonoBehaviour, Action)

CoroutineExtensions.ExecuteAfterSeconds(MonoBehaviour, Action, Single)

CoroutineExtensions.ExecuteAfterSecondsUnscaled(MonoBehaviour, Action, Single)

CoroutineExtensions.ExecuteAfterFixedUpdate(MonoBehaviour, Action)

CoroutineExtensions.ExecuteAfterFixedUpdates(MonoBehaviour, Action, Int32)