API reference
API reference
Select your platform
No SDKs available
No versions available

Sequence Class

Extends MonoBehaviour, IActiveState, ITimeConsumer
Chains together a number of IActiveStates into a sequence.
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: MinActiveTime <= "Time step N active for" <= 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: ActiveState: The IActiveState that is used to determine if the conditions of this step are fulfilled 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. 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]
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]

Member Functions

Sets a function that returns the current time in seconds.
void InjectOptionalStepsToActivate
( ActivationStep[] stepsToActivate )
void InjectOptionalRemainActiveWhile
( IActiveState activeState )
void InjectOptionalTimeProvider
( Func< float > timeProvider )

Protected Functions

virtual void Awake ( )
virtual void Start ( )
virtual void Update ( )
Did you find this page helpful?
Thumbs up icon
Thumbs down icon