Class HVRGunBase

Inheritance
System.Object
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
HVRDamageProvider
HVRGunBase
HVRAutomaticGun
HVRPistol
HVRShotgun
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.Weapons.Guns
Assembly: HurricaneVR.Framework.dll
Syntax
public class HVRGunBase : HVRDamageProvider

Fields

| Improve this Doc View Source

AddForceOnHit

Declaration
[Tooltip("If true adds force on hit to everything")]
public bool AddForceOnHit
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

AmmoEjectDirection

Declaration
[Header("Required Transforms")]
[Tooltip("Optional Direction to eject Ammo - use the z axis")]
public Transform AmmoEjectDirection
Field Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

AmmoEjectVelocity

Declaration
[Tooltip("How fast to kick the magazine out of the gun")]
public float AmmoEjectVelocity
Field Value
Type Description
System.Single
| Improve this Doc View Source

AmmoSocket

Declaration
[Tooltip("Socket for taking in ammo / magazines")]
public HVRSocket AmmoSocket
Field Value
Type Description
HVRSocket
| Improve this Doc View Source

AnimateGun

Declaration
public bool AnimateGun
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

Animator

Declaration
public Animator Animator
Field Value
Type Description
UnityEngine.Animator
| Improve this Doc View Source

BarrelRange

Declaration
[Tooltip("Flexible bullet range per gun type")]
public float BarrelRange
Field Value
Type Description
System.Single
| Improve this Doc View Source

Bolt

Declaration
public HVRGunBolt Bolt
Field Value
Type Description
HVRGunBolt
| Improve this Doc View Source

BoltPushedBackAfterEmpty

Declaration
[Tooltip("Should the gun automatically push the bolt back after out of ammo")]
public bool BoltPushedBackAfterEmpty
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

BulletEmitter

Declaration
[Header("Components")]
public HVRGunEmitterBase BulletEmitter
Field Value
Type Description
HVRGunEmitterBase
| Improve this Doc View Source

BulletLife

Declaration
public float BulletLife
Field Value
Type Description
System.Single
| Improve this Doc View Source

BulletOrigin

Declaration
[Tooltip("Where the bullet should come from, z forward direction")]
public Transform BulletOrigin
Field Value
Type Description
UnityEngine.Transform
| Improve this Doc View Source

BulletPrefab

Declaration
public GameObject BulletPrefab
Field Value
Type Description
UnityEngine.GameObject
| Improve this Doc View Source

BulletSpeed

Declaration
[Tooltip("Speed of the bullet prefab")]
public float BulletSpeed
Field Value
Type Description
System.Single
| Improve this Doc View Source

CasingEmitter

Declaration
public HVRGunEmitterBase CasingEmitter
Field Value
Type Description
HVRGunEmitterBase
| Improve this Doc View Source

ChamberedCasing

Declaration
public GameObject ChamberedCasing
Field Value
Type Description
UnityEngine.GameObject
| Improve this Doc View Source

ChamberedRound

Declaration
public GameObject ChamberedRound
Field Value
Type Description
UnityEngine.GameObject
| Improve this Doc View Source

ChambersAfterFiring

Declaration
[Tooltip("Should the gun automatically chamber the next round after firing")]
public bool ChambersAfterFiring
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

CockingHandle

Declaration
public HVRCockingHandle CockingHandle
Field Value
Type Description
HVRCockingHandle
| Improve this Doc View Source

Cooldown

Declaration
[Tooltip("Cooldown before the next shot")]
public float Cooldown
Field Value
Type Description
System.Single
| Improve this Doc View Source

CyclingTime

Declaration
public float CyclingTime
Field Value
Type Description
System.Single
| Improve this Doc View Source

EjectCasingAfterFiring

Declaration
[Tooltip("Should the gun automatically eject a casing after firing")]
public bool EjectCasingAfterFiring
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

Fired

Declaration
public UnityEvent Fired
Field Value
Type Description
UnityEngine.Events.UnityEvent
| Improve this Doc View Source

FireParameter

Declaration
public string FireParameter
Field Value
Type Description
System.String
| Improve this Doc View Source

FireType

Declaration
public FireType FireType
Field Value
Type Description
FireType
| Improve this Doc View Source

GunSounds

Declaration
[Tooltip("Component that handls gun sfx")]
public HVRGunSounds GunSounds
Field Value
Type Description
HVRGunSounds
| Improve this Doc View Source

HapticGrabbables

Declaration
public List<HVRGrabbable> HapticGrabbables
Field Value
Type Description
System.Collections.Generic.List<HVRGrabbable>
| Improve this Doc View Source

Haptics

Declaration
[Header("Haptics")]
public HVRGunHaptics Haptics
Field Value
Type Description
HVRGunHaptics
| Improve this Doc View Source

Hit

Declaration
public GunHitEvent Hit
Field Value
Type Description
GunHitEvent
| Improve this Doc View Source

HitLayerMask

Declaration
[Tooltip("Physics layers for the ray cast")]
public LayerMask HitLayerMask
Field Value
Type Description
UnityEngine.LayerMask
| Improve this Doc View Source

IsTriggerPulled

Declaration
public bool IsTriggerPulled
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

IsTriggerReset

Declaration
public bool IsTriggerReset
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

MaxPooledBullets

Declaration
public int MaxPooledBullets
Field Value
Type Description
System.Int32
| Improve this Doc View Source

MuzzleFlashObject

Declaration
[Header("Objects")]
[Tooltip("Muzzle flash object")]
public GameObject MuzzleFlashObject
Field Value
Type Description
UnityEngine.GameObject
| Improve this Doc View Source

MuzzleFlashTime

Declaration
public float MuzzleFlashTime
Field Value
Type Description
System.Single
| Improve this Doc View Source

MuzzleSmoke

Declaration
[Tooltip("Muzzle smoke object")]
public GameObject MuzzleSmoke
Field Value
Type Description
UnityEngine.GameObject
| Improve this Doc View Source

MuzzleSmokeTime

Declaration
[Tooltip("How long until we destroy the muzzle smoke object")]
public float MuzzleSmokeTime
Field Value
Type Description
System.Single
| Improve this Doc View Source

NoAmmoRange

Declaration
[Tooltip("If not using ammo properties, range of the bullet")]
public float NoAmmoRange
Field Value
Type Description
System.Single
| Improve this Doc View Source

RecoilComponent

Declaration
[Tooltip("Recoil settings component")]
public HVRRecoil RecoilComponent
Field Value
Type Description
HVRRecoil
| Improve this Doc View Source

RequiresAmmo

Declaration
[Tooltip("Does this gun require ammo inserted to shoot")]
public bool RequiresAmmo
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

RequiresChamberedBullet

Declaration
[Tooltip("Is chambering required to shoot")]
public bool RequiresChamberedBullet
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

SlowMotionBulletOnly

Declaration
[Header("Projectile")]
public bool SlowMotionBulletOnly
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

StabilizerGrabbable

Declaration
[Tooltip("If this grabbable is held, the StabilizedRecoilForce is used when shooting.")]
public HVRGrabbable StabilizerGrabbable
Field Value
Type Description
HVRGrabbable
| Improve this Doc View Source

TriggerAnimator

Declaration
[Header("Animation")]
public HVRTriggerAnimator TriggerAnimator
Field Value
Type Description
HVRTriggerAnimator
| Improve this Doc View Source

TriggerPullThreshold

Declaration
[Header("Settings")]
public float TriggerPullThreshold
Field Value
Type Description
System.Single
| Improve this Doc View Source

TriggerResetThreshold

Declaration
public float TriggerResetThreshold
Field Value
Type Description
System.Single
| Improve this Doc View Source

UseAmmoProperties

Declaration
[Tooltip("If true will use damage, force, range, from the ammo")]
public bool UseAmmoProperties
Field Value
Type Description
System.Boolean

Properties

| Improve this Doc View Source

Ammo

Declaration
public HVRAmmo Ammo { get; set; }
Property Value
Type Description
HVRAmmo
| Improve this Doc View Source

AmmoGrabbable

Declaration
public HVRGrabbable AmmoGrabbable { get; set; }
Property Value
Type Description
HVRGrabbable
| Improve this Doc View Source

BulletRange

Declaration
public float BulletRange { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

DamageProvider

Declaration
public HVRDamageProvider DamageProvider { get; }
Property Value
Type Description
HVRDamageProvider
| Improve this Doc View Source

Grabbable

Declaration
public HVRGrabbable Grabbable { get; }
Property Value
Type Description
HVRGrabbable
| Improve this Doc View Source

IsBulletChambered

Declaration
public bool IsBulletChambered { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsFiring

Declaration
public bool IsFiring { get; protected set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

OutOfAmmo

Declaration
public bool OutOfAmmo { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

RoundsFired

Declaration
protected int RoundsFired { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

TimeOfLastShot

Declaration
protected float TimeOfLastShot { get; set; }
Property Value
Type Description
System.Single

Methods

| Improve this Doc View Source

AfterAmmoReleased(HVRGrabbable, HVRAmmo)

Declaration
protected virtual void AfterAmmoReleased(HVRGrabbable ammoGrabbable, HVRAmmo releasedAmmo)
Parameters
Type Name Description
HVRGrabbable ammoGrabbable
HVRAmmo releasedAmmo
| Improve this Doc View Source

AfterFired()

Declaration
protected virtual void AfterFired()
| Improve this Doc View Source

AmmoSocketedHaptics()

Declaration
protected virtual void AmmoSocketedHaptics()
| Improve this Doc View Source

AmmoSocketReleasedHaptics()

Declaration
protected virtual void AmmoSocketReleasedHaptics()
| Improve this Doc View Source

Animate()

Declaration
protected virtual void Animate()
| Improve this Doc View Source

AnimationRoutine()

Declaration
protected IEnumerator AnimationRoutine()
Returns
Type Description
System.Collections.IEnumerator
| Improve this Doc View Source

Awake()

Declaration
protected virtual void Awake()
| Improve this Doc View Source

CanFire()

Declaration
protected virtual bool CanFire()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CheckTriggerHaptics()

Declaration
protected virtual void CheckTriggerHaptics()
| Improve this Doc View Source

CheckTriggerPull()

Declaration
protected virtual void CheckTriggerPull()
| Improve this Doc View Source

CockingHandleChamberedHaptics()

Declaration
protected virtual void CockingHandleChamberedHaptics()
| Improve this Doc View Source

CockingHandleEjectHaptics()

Declaration
protected virtual void CockingHandleEjectHaptics()
| Improve this Doc View Source

CockingHandleReleasedHaptics()

Declaration
protected virtual void CockingHandleReleasedHaptics()
| Improve this Doc View Source

DisableChamberedCasing()

Declaration
protected virtual void DisableChamberedCasing()
| Improve this Doc View Source

DisableChamberedRound()

Declaration
protected virtual void DisableChamberedRound()
| Improve this Doc View Source

DisableFireAnimator()

Declaration
public void DisableFireAnimator()
| Improve this Doc View Source

DryFireHaptics()

Declaration
protected virtual void DryFireHaptics()
| Improve this Doc View Source

EjectAmmo(HVRGrabbable)

Declaration
protected virtual void EjectAmmo(HVRGrabbable ammoGrabbable)
Parameters
Type Name Description
HVRGrabbable ammoGrabbable
| Improve this Doc View Source

EjectBullet()

Declaration
public virtual void EjectBullet()
| Improve this Doc View Source

EjectCasing()

Declaration
public virtual void EjectCasing()
| Improve this Doc View Source

EnableChamberedCasing()

Declaration
protected virtual void EnableChamberedCasing()
| Improve this Doc View Source

EnableChamberedRound()

Declaration
protected virtual void EnableChamberedRound()
| Improve this Doc View Source

FireBullet(Vector3)

Declaration
protected virtual void FireBullet(Vector3 direction)
Parameters
Type Name Description
UnityEngine.Vector3 direction
| Improve this Doc View Source

FireHaptics()

Declaration
protected virtual void FireHaptics()
| Improve this Doc View Source

IgnoreCollision(Collider[], Single)

Declaration
public virtual void IgnoreCollision(Collider[] colliders, float time)
Parameters
Type Name Description
UnityEngine.Collider[] colliders
System.Single time
| Improve this Doc View Source

IgnoreCollisionRoutine(Collider[], Single)

Declaration
protected virtual IEnumerator IgnoreCollisionRoutine(Collider[] colliders, float time)
Parameters
Type Name Description
UnityEngine.Collider[] colliders
System.Single time
Returns
Type Description
System.Collections.IEnumerator
| Improve this Doc View Source

MuzzleFlash()

Declaration
protected virtual void MuzzleFlash()
| Improve this Doc View Source

OnAmmoSocketed(HVRGrabberBase, HVRGrabbable)

Declaration
protected virtual void OnAmmoSocketed(HVRGrabberBase grabber, HVRGrabbable grabbable)
Parameters
Type Name Description
HVRGrabberBase grabber
HVRGrabbable grabbable
| Improve this Doc View Source

OnAmmoSocketReleased(HVRGrabberBase, HVRGrabbable)

Declaration
protected virtual void OnAmmoSocketReleased(HVRGrabberBase arg0, HVRGrabbable arg1)
Parameters
Type Name Description
HVRGrabberBase arg0
HVRGrabbable arg1
| Improve this Doc View Source

OnCockingHandleChambered()

Declaration
protected virtual void OnCockingHandleChambered()
| Improve this Doc View Source

OnCockingHandleEjected()

Declaration
protected virtual void OnCockingHandleEjected()
| Improve this Doc View Source

OnCockingHandleReleased()

Declaration
protected virtual void OnCockingHandleReleased()
| Improve this Doc View Source

OnFire(Vector3)

Declaration
protected virtual void OnFire(Vector3 direction)
Parameters
Type Name Description
UnityEngine.Vector3 direction
| Improve this Doc View Source

OnHandGrabbed(HVRHandGrabber, HVRGrabbable)

Declaration
protected virtual void OnHandGrabbed(HVRHandGrabber hand, HVRGrabbable arg1)
Parameters
Type Name Description
HVRHandGrabber hand
HVRGrabbable arg1
| Improve this Doc View Source

OnHandReleased(HVRHandGrabber, HVRGrabbable)

Declaration
protected virtual void OnHandReleased(HVRHandGrabber arg0, HVRGrabbable arg1)
Parameters
Type Name Description
HVRHandGrabber arg0
HVRGrabbable arg1
| Improve this Doc View Source

OnHit(RaycastHit, Vector3)

Declaration
protected virtual void OnHit(RaycastHit hit, Vector3 direction)
Parameters
Type Name Description
UnityEngine.RaycastHit hit
UnityEngine.Vector3 direction
| Improve this Doc View Source

OnOutOfAmmo()

Declaration
protected virtual void OnOutOfAmmo()
| Improve this Doc View Source

OnShoot()

Declaration
protected virtual void OnShoot()
| Improve this Doc View Source

PlayAnimator()

Declaration
protected virtual void PlayAnimator()
| Improve this Doc View Source

PlayDryFire()

Declaration
protected virtual void PlayDryFire()
| Improve this Doc View Source

PlayHaptics(HVRGrabbable, HapticData)

Declaration
protected virtual void PlayHaptics(HVRGrabbable grabbable, HapticData data)
Parameters
Type Name Description
HVRGrabbable grabbable
HapticData data
| Improve this Doc View Source

PlayHapticsAllHands(HapticData)

Declaration
protected virtual void PlayHapticsAllHands(HapticData haptic)
Parameters
Type Name Description
HapticData haptic
| Improve this Doc View Source

PlaySFX()

Declaration
protected virtual void PlaySFX()
| Improve this Doc View Source

Recoil()

Declaration
protected virtual void Recoil()
| Improve this Doc View Source

ReleaseAmmo()

Declaration
public virtual void ReleaseAmmo()
| Improve this Doc View Source

SetupPooledBullets()

Declaration
protected virtual void SetupPooledBullets()
| Improve this Doc View Source

Shoot()

Declaration
protected virtual void Shoot()
| Improve this Doc View Source

Smoke()

Declaration
protected virtual void Smoke()
| Improve this Doc View Source

TriggerPulled()

Declaration
public virtual void TriggerPulled()
| Improve this Doc View Source

TriggerReleased()

Declaration
public virtual void TriggerReleased()
| Improve this Doc View Source

TriggerReleasedHaptics()

Declaration
public virtual void TriggerReleasedHaptics()
| Improve this Doc View Source

TryChamberRound()

Declaration
public virtual void TryChamberRound()
| Improve this Doc View Source

TryReload()

Declaration
protected virtual void TryReload()
| Improve this Doc View Source

Update()

Declaration
protected virtual void Update()
| Improve this Doc View Source

UpdateShooting()

Declaration
protected virtual void UpdateShooting()
| Improve this Doc View Source

UpdateTriggerAnimation()

Declaration
public virtual void UpdateTriggerAnimation()

Extension Methods