API reference

ActiveStateUnityEventWrapper Class

Extends MonoBehaviour

The ActiveStateUnityEventWrapper class provides a way to link Unity events with the state of an IActiveState.

This class is designed to trigger Unity events based on changes in the active state, allowing developers to easily connect Interaction SDK logic with Unity's built-in event system.

This class is particularly useful for triggering visual or audio effects, or other Unity-based events in response to changes in an interaction's active state.

WhenActivated : UnityEvent [Get]	The Unity event that is triggered during an Update when the provided IActiveState becomes active. Signature UnityEvent WhenActivated
WhenDeactivated : UnityEvent [Get]	The Unity event that is triggered during an Update when the provided IActiveState becomes inactive. Signature UnityEvent WhenDeactivated

Awake ()	Signature virtual void Awake() Returns `void`
Start ()	Signature virtual void Start() Returns `void`
Update ()	This update method monitors the active state and triggers the appropriate Unity event based on the current state. Signature virtual void Update() Returns `void`

InjectActiveState ( activeState )	Sets the active state for the wrapper. This method is designed to support dependency injection for unit testing. Signature void InjectActiveState(IActiveState activeState) Parameters `activeState: IActiveState` The active state to set Returns `void`
InjectAllActiveStateUnityEventWrapper ( activeState )	Injects an active state that this ActiveStateUnityEventWrapper will monitor. This method is used to set up the wrapper with the active state whose changes will trigger the associated Unity events. Signature void InjectAllActiveStateUnityEventWrapper(IActiveState activeState) Parameters `activeState: IActiveState` The IActiveState instance that will be monitored. Returns `void`
InjectOptionalEmitOnFirstUpdate ( emitOnFirstUpdate )	Optionally sets whether to emit events on the first update. Signature void InjectOptionalEmitOnFirstUpdate(bool emitOnFirstUpdate) Parameters `emitOnFirstUpdate: bool` If true, events will be emitted on the first update. Returns `void`
InjectOptionalWhenActivated ( whenActivated )	Injects a Unity event that is triggered when the active state is activated. Signature void InjectOptionalWhenActivated(UnityEvent whenActivated) Parameters `whenActivated: UnityEvent` The Unity event to trigger on activation. Returns `void`
InjectOptionalWhenDeactivated ( whenDeactivated )	Injects a Unity event that is triggered when the active state is deactivated. Signature void InjectOptionalWhenDeactivated(UnityEvent whenDeactivated) Parameters `whenDeactivated: UnityEvent` The Unity event to trigger on deactivation. Returns `void`

ActiveStateUnityEventWrapper Class

Properties

Protected Methods

Methods