UxrToggleObjectsUsingButtons Class
Component that allows to enable/disable GameObjects based on input from the VR controller buttons.
Inheritance Hierarchy
System.Object
Object
Component
Behaviour
MonoBehaviour
UltimateXR.Core.Components.UxrComponent
UltimateXR.Animation.GameObjects.UxrToggleObjectsUsingButtons
Namespace: UltimateXR.Animation.GameObjects
Assembly: UltimateXR (in UltimateXR.dll) Version: 0.0.0.0
Syntax
C#
public class UxrToggleObjectsUsingButtons : UxrComponent
The UxrToggleObjectsUsingButtons type exposes the following members.
Constructors
Name | Description | |
---|---|---|
UxrToggleObjectsUsingButtons |
Properties
Name | Description | |
---|---|---|
ButtonsToDisable | Gets or sets the button(s) to disable. | |
ButtonsToEnable | Gets or sets the button(s) used to enable. | |
ControllerHand | Gets or sets which controller hand is responsible for the input. | |
DisableButtonEvent | Gets or sets the button event to disable. | |
EnableButtonEvent | Gets or sets the button event to enable. | |
ObjectList | Gets or sets the object list to enable/disable. |
Methods
Name | Description | |
---|---|---|
Awake | Called at the beginning. Sets the object initial state. (Overrides UxrComponent.Awake().) |
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.) |