UxrExplodeHierarchy Class

Component that allows to explode a GameObject and all its rigidbody children. If the component is attached to a GameObject that also has a UxrActor component the explosion will be triggered when the actor dies. The explosion can also be called explicitly using Explode(GameObject, Single, Single, Single, Single) and ExplodeNow().

Inheritance Hierarchy

System.Object
  Object
    Component
      Behaviour
        MonoBehaviour
          UltimateXR.Core.Components.UxrComponent
            UltimateXR.Mechanics.Weapons.UxrExplodeHierarchy
Namespace: UltimateXR.Mechanics.Weapons
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0

Syntax

public class UxrExplodeHierarchy : UxrComponent

The UxrExplodeHierarchy type exposes the following members.

Constructors

	Name	Description
	UxrExplodeHierarchy

Properties

	Name	Description
	ExplodeTimer	Gets the explode timer. A negative value will either indicate that it is not using any timer (if HasExploded is false) or that it already exploded (if HasExploded is true).
	HasExploded	Gets whether the object has exploded.
	MaxExplodeAngularSpeed	Gets or sets the maximum random angular speed that the chunks will have when the object explodes.
	MaxExplodeSpeed	Gets or sets the maximum random speed that the chunks will have when the object explodes.
	MinExplodeAngularSpeed	Gets or sets the minimum random angular speed that the chunks will have when the object explodes.
	MinExplodeSpeed	Gets or sets the minimum random speed that the chunks will have when the object explodes.
	PiecesFadeoutSeconds	Gets or sets the seconds it will take for the chunks to fade-out when the chunks disappear after PiecesLifeSeconds.
	PiecesLifeSeconds	Gets or sets the seconds it will take for the chunks to disappear after the object explodes.
	SecondsToExplode	Gets or sets the seconds it will take for the object to explode after the component is enabled. A negative value will disable the user of a timer and will only explode when the object was added to an UxrActor that dies.

Methods

	Name	Description
	Awake	Initializes the component. (Overrides UxrComponent.Awake().)
	Explode	Explodes an object.
	ExplodeNow	Explodes an object immediately using the current parameters.
	OnDisable	Unsubscribes from events. (Overrides UxrComponent.OnDisable().)
	OnEnable	Subscribes to events and initializes the explosion timer. (Overrides UxrComponent.OnEnable().)

Extension Methods

	Name	Description
	CheckSetEnabled	Enables/disabled the component if it isn’t enabled already. (Defined by MonoBehaviourExt.)
	GetOrAddComponent<T>	Gets the Component of a given type. If it doesn’t exist, it is added to the GameObject. (Defined by ComponentExt.)
	GetPathUnderScene	Gets the full path under current scene, including all parents, but scene name, for the given component. (Defined by ComponentExt.)
	GetSceneUid	Gets an unique identifier string for the given component. (Defined by ComponentExt.)
	GetUniqueScenePath	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.)
	LoopCoroutine	Creates a coroutine that simplifies executing a loop during a certain amount of time. (Defined by MonoBehaviourExt.)
	SafeGetComponentInParent<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.)
	ShowInInspector(Boolean)	Overloaded. Controls whether to show the current object in the inspector. (Defined by ObjectExt.)
	ShowInInspector(Boolean, Boolean)	Overloaded. Controls whether to show the current object in the inspector and whether it is editable. (Defined by ObjectExt.)
	ThrowIfNull	Throws an exception if the object is null. (Defined by ObjectExt.)