The Sequence._stepsToActivate field contains an optional list of IActiveState's which must be 'activated' in order. The sequence can progress from Step N to N + 1 when: ActivationStep.MinActiveTime <= "Time step N active for" <= ActivationStep.MaxStepTime, and:

Step N just became inactive OR Step N is the last step OR Step N+1 is active

Note that once the sequence has moved on to the next step, the previous step does not need to remain active. Each step has three fields: ActivationStep.ActiveState: The IActiveState that is used to determine if the conditions of this step are fulfilled ActivationStep.MinActiveTime: How long (in seconds) the IActiveState of this step must be contiguously active before moving on to the next step. If the ActiveState drops out of being active for even a single frame the countdown is reset. ActivationStep.MaxStepTime: If the elapsed time that the sequence is spent waiting for this step to reach its MinActiveTime exceeds this value then the whole sequence is reset back to the beginning.

Once all steps are complete the Sequence.Active becomes true. It will remain true as long as RemainActiveWhile is true. If _remainActiveCooldown > 0, Sequence.Active will remain active even after RemainActiveWhile becomes false until the cooldown timer is met. The timer is reset if RemainActiveWhile becomes true again.

Properties

IActiveState RemainActiveWhile[Get]

int CurrentActivationStep[Get]

Returns the index of the step in _stepsToActivate whose conditions are waiting to be activated.

If Active is true, this value will be set to the size of _stepsToActivate. If _stepsToActivate has no steps, this property will be 0.

bool Active[Get]

Implements IActiveState.Active, in this case indicating whether the described sequence of IActiveStates has been "recognized" as having occurred with acceptable order and timing.

Member Functions

void SetTimeProvider

( Func< float > timeProvider )

Implements ITimeConsumer.SetTimeProvider(Func<float>).

Sets the time provider for this sequence, allowing for the default time provider (Unity's built-in Time.time) to be overridden with custom behavior to enable pausing, time dilation, etc.

Parameters

timeProvider

The new time provider to be used by this instance.

void InjectOptionalStepsToActivate

( ActivationStep [] stepsToActivate )

Sets the ActivationSteps for a dynamically instantiated Sequence.

This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.

void InjectOptionalRemainActiveWhile

( IActiveState activeState )

Sets the IActiveState for the optional "remain active while" capability (which allows a Sequence to remain active pending the inactivity of the given IActiveState rather than resetting after activation) for a dynamically instantiated Sequence.

This method exists to support Interaction SDK's dependency injection pattern and is not needed for typical Unity Editor-based usage.

void InjectOptionalTimeProvider

( Func< float > timeProvider )