UxrGrenadeWeapon Class

Grenade weapon. A grenade inflicts explosive damage to UxrActor components.

Inheritance Hierarchy

Namespace: UltimateXR.Mechanics.Weapons
Assembly: UltimateXR (in UltimateXR.dll) Version:



public class UxrGrenadeWeapon : UxrWeapon, 

The UxrGrenadeWeapon type exposes the following members.


Public methodUxrGrenadeWeapon


Public propertyDamageFar Gets the minimum damage, applied at DamageRadius distance.
Public propertyDamageNear Gets the maximum damage, applied at the very point of the explosion.
Public propertyDamageRadius Gets distance from the explosion the grenade will start inflicting damage.
Public propertyIsActivated Gets whether the grenade has been activated and the detonation timer is running.
Public propertyPrecachedInstances Gets the GameObjects, usually prefabs, that will be precached when the scene is loaded.
Public propertyTimer Gets the seconds left to explode. If the grenade hasn’t been activated yet, it will return TimerDuration.
Public propertyTimerDuration Gets the seconds it will take for the grenade to explode once it has been activated.


Public methodActivateTimer Starts the detonation timer.
Public methodFreezeTimer Freezes or resumes the detonation timer.
Protected methodOnDisable Unsubscribes from events. (Overrides UxrGrabbableObjectComponent<T>.OnDisable().)
Protected methodOnEnable Subscribes to events. (Overrides UxrGrabbableObjectComponent<T>.OnEnable().)
Public methodRestoreTimer Restores the detonation timer to the initial time.
Protected methodStart Initializes the component. (Overrides UxrComponent.Start().)

Extension Methods

Public Extension MethodCheckSetEnabled Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.)
Public Extension MethodGetOrAddComponent<T> Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.)
Public Extension MethodGetPathUnderScene Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.)
Public Extension MethodGetSceneUid Gets an unique identifier string for the given component. (Defined by ComponentExt.)
Public Extension MethodGetUniqueScenePath Gets an unique path in the scene for the given component. It will include scene name, sibling and component indices to make it unique. (Defined by ComponentExt.)
Public Extension MethodLoopCoroutine Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.)
Public Extension MethodSafeGetComponentInParent<T> Gets the Component of a given type in the GameObject or any of its parents. It also works on prefabs, where regular GetComponentInParent(Type, Boolean) will not work: https://issuetracker.unity3d.com/issues/getcomponentinparent-is-returning-null-when-the-gameobject-is-a-prefab (Defined by ComponentExt.)
Public Extension MethodShowInInspector(Boolean)Overloaded.
Controls whether to show the current object in the inspector. (Defined by ObjectExt.)
Public Extension MethodShowInInspector(Boolean, Boolean)Overloaded.
Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.)
Public Extension MethodThrowIfNull Throws an exception if the object is null. (Defined by ObjectExt.)

See Also


UltimateXR.Mechanics.Weapons Namespace