Interface IXRActivateInteractor
An interface that represents an Interactor component that can activate an Interactable component. Not to be confused with the active state of a GameObject, an activate event in this context refers to a contextual command action, such as toggling a flashlight on and off.
Inherited Members
Namespace: UnityEngine.XR.Interaction.Toolkit.Interactors
Assembly: Unity.XR.Interaction.Toolkit.dll
Syntax
[MovedFrom("UnityEngine.XR.Interaction.Toolkit")]
public interface IXRActivateInteractor : IXRInteractorRemarks
For more information and examples about handling interaction events, refer to Handle interaction events and Interaction state and events.
Properties
shouldActivate
(Read Only) Indicates whether this interactor is in a state where it should send the activate event this frame.
Declaration
bool shouldActivate { get; }Property Value
| Type | Description |
|---|---|
| bool |
See Also
shouldDeactivate
(Read Only) Indicates whether this interactor is in a state where it should send the deactivate event this frame.
Declaration
bool shouldDeactivate { get; }Property Value
| Type | Description |
|---|---|
| bool |
See Also
Methods
GetActivateTargets(List<IXRActivateInteractable>)
Retrieve the list of Interactables that this Interactor could possibly activate or deactivate this frame.
Declaration
void GetActivateTargets(List<IXRActivateInteractable> targets)Parameters
| Type | Name | Description |
|---|---|---|
| List<IXRActivateInteractable> | targets | The results list to populate with Interactables that are valid for activate or deactivate. |
Remarks
When implementing this method, Unity expects you to clear targets before adding to it.