Base class that allows you to create non-linear sequences to create gameplay and cinematic cutscenes. Using sequences you can construct with ease dynamic complex animation sequences that can be triggered at any time at runtime.

Whether it is a cut-scene that have to be triggered when opening a treasure chest; or if its cinematic that elaborate the plot or storylines, sequences will help you to make your app more epic.

See Also

Static Variables

Name	Description
`animation`	Reference to the parent Animation storing the active Sequence.
Declaration Animation *animation
`stripfolder_count`	Current amount of StripFolder available in the active Sequence.
Declaration unsigned char stripfolder_count
`handler`	Handler responsible of handling the Sequence coroutines.
Declaration Handler handler
`uid`	Unique id assigned to the Sequence to identify it globally.
Declaration unsigned int uid

Variables

Name Description

fps Update rate of the current Sequence.

Declaration

unsigned char fps

Range

0 to 120 Mhz

Remarks: A value of 0 represent that the Sensor will be updated every frame.

speed The Sequence playback speed.

Declaration

float speed

Range

0.01 to 5x

name Unique name to identify the Sequence within its parent Animation.

Declaration

char *name

state The active playback State of the Sequence.

Declaration

State state

flags Bitmask controlling the various flags of the current Sequence.

Declaration

int flags

Cap	Value	Description
`SEQ_FLAG_OPEN`	`bit.lshift(1,0)`	Control wheter or not the Sequence is open or close within the editor.

Functions

Name	Description
`AddStripFolder`	Append a new StripFolder to the active Sequence.
Declaration StripFolder AddStripFolder( const char name ) Parameters `name`: A unique name to identify the new StripFolder. Return Value A new StripFolder reference; `nil` if too many folders are currently held by the active Sequence.
`GetStripFolder`	Retrieve an existing StripFolder using its name as key.
Declaration StripFolder GetStripFolder( const char name ) Parameters `name`: Name of the StripFolder to retrieve. Return Value Upon success the reference to the StripFolder matching the name received in parameter; else return `nil`.
`GetStripFolderAt`	Retrieve an existing StripFolder associated to the active Sequence by index.
Declaration StripFolder GetStripFolderAt( unsigned char index ) Parameters* `index`: Index of the StripFolder to retrieve. Return Value `nil` if the index provided is invalid; else return the reference of the StripFolder poindex by index.
`GetStripFolderIndex`	Return the internal index of a specific StripFolder maintained by the active Sequence.
Declaration int GetStripFolderIndex( const StripFolder folder ) Parameters* `folder`: Reference to an existing StripFolder. Return Value `-1` if the StripFolder reference provided is invalid; else return the internal index of the folder.
`SetStripFolderIndex`	Manually change the current position of a StripFolder.
Declaration bool SetStripFolderIndex( StripFolder folder, const unsigned char index ) Parameters* `folder`: Reference to the StripFolder to change. `index`: The new position index to use for the StripFolder. Return Value `true` if the folder have been repositionned successfully; else return `false` if either the index or the folder provided to the function is invalid.
`RemoveStripFolder`	Remove a specific StripFolder from the active Sequence.
Declaration bool RemoveStripFolder( StripFolder folder ) Parameters* `folder`: Reference to the StripFolder to remove. Return Value `true` if the StripFolder have been removed; `false` if the folder reference provided is invalid.
`RemoveStripFolderAt`	Helper to remove an existing StripFolder associated to the current Sequence using its index.
Declaration bool RemoveStripFolderAt( int index ) Parameters `index`: Index of the StripFolder to remove. Return Value `true` if the StripFolder was removed successfully; `false` if the index provided is out of bounds (see `stripfolder_count`).
`SwapStripFolders`	Swap the position of two StripFolder.
Declaration bool SwapStripFolders( unsigned char index0, unsigned char index1 ) Parameters `index0`: Index of the source StripFolder. `index1`: Index of its new destination. Return Value `true` if both indexes are valid and the operation was executed; else return `false` if one or both indexes provides were out of bounds.
`Play`	Start the Sequence playback.
Declaration bool Play( void ) Return Value `true` if the Sequence starts/resume playing; `false` if it was already playing.
`Pause`	Pause the current Sequence playback.
Declaration bool Pause( void ) Return Value `true` the active Sequence pause sucessfully; else return `false` if it was already on standby.
`Stop`	Stop the active Sequence and reset its playback time.
Declaration bool Stop( void ) Return Value `true` if the Sequence stop successfully; `false` if it was already in its initial state.
`Seek`	Manually set the playback time of the active Sequence.
Declaration void Seek( float playback_time )
`GetDuration`	Helper that returns the total duration of the current Sequence.
Declaration float GetDuration( void ) Return Value The total duration of the Sequence where `1.0=1sec`.
`Update`	Manually force a Sequence frame update.
Declaration void Update( void )

Events

Callbacks	Description
`OnPlay`	Triggered when a Sequence starts playing.
Declaration function OnPlay()
`OnResume`	Called when a Sequence was paused and the playback restart.
Declaration function OnResume()
`OnPause`	This callback is triggered when the Sequence State change to `kPause`.
Declaration function OnPause()
`OnStop`	Happend when the Sequence stops playing.
Declaration function OnStop()
`OnUpdate`	Called each time the Sequence is updated.
Declaration function OnUpdate()