The IActiveState interface defines the contract for components that can represent an active state within the Interaction SDK.
Implementing classes are responsible for determining whether they are currently in an "active" state, which can be used to trigger various interactions, events, or behaviors.
The IActiveState interface is a fundamental part of the Interaction SDK, providing a standardized way to represent and query active conditions. It is commonly used in conjunction with other components, such as ActiveStateGroup, ActiveStateNot, and ActiveStateUnityEventWrapper, to build complex interaction logic based on multiple conditions.
Properties
bool Active[Get]
Evaluates the current state of the component and returns whether it is active.
The logic for determining the active state is defined by the implementing class. This method is typically used in interaction scripts to check whether a certain condition is met before triggering an event or action. For example implementations, please refer to HandActiveState.Active and ActiveStateGroup.Active.
Returns
Returns true if the component is currently active; otherwise, returns false.
