A strip is a single block part of a Sequence. It starts and ends at a specific playback time during the Sequence. Based on the type of StripGroup, the active Strip is defined in it will respond to the behaviors dictated by the StripGroupType.

Strips come in multiple flavors; director, that allows you to control the active Camera during the Sequence playback.

Audio, which gives you the opportunity to add sounds such as background music or effects.

Activity allows you to controls the Action for a certain Animation associated with an Object or other resources part of the Sequence.

Trigger; run a Script or a custom scripting common at a specific point of the Sequence either once or continuously.

Conversation, give you the opportunity to create subtitles or to progressively display Text during the Sequence playback.

With SubSequence you can run another Sequence on top of the active Sequence.

And finally Creator, that can create and destroy Entity during the Sequence playback.

Static Variables

Name	Description
`section`	Parent section where the Strip is defined.
Declaration StripSection *section
`data`	Access the StripData properties available to the Strip based on the StripGroupType it is associated to.
Declaration StripData data
`curve_in`	Access to the blend in Curve properties of the Strip.
Declaration Curve curve_in
`curve_out`	Access to the blend out Curve properties of the Strip.
Declaration Curve curve_out
`uid`	Unique id to globally identify the active Strip.
Declaration unsigned int uid

Variables

Name	Description
`start_time`	Constrol the start time position of the Strip within the Sequence.
Declaration float start_time
`end_time`	Control the end time position of the Strip within the Sequence.
Declaration float end_time
`auto_blend`	Enable or disable auto blending behavior of the Strip.
Declaration bool auto_blend Note Enabling auto-blending will automatically calculate the blending in and out interpolation when the Strip overlap others.
`blend_in`	Linear interpolation time when the Strip is blending in.
Declaration float blend_in
`blend_out`	Linear interpolation time when the Strip is blending out.
Declaration float blend_out
`state`	Control the active StripState of the active Strip.
Declaration StripState state
`name`	A unique name to identify the Strip within its parent StripGroup.
Declaration char *name

Functions

Name	Description
`SetSoundBuffer`	Connect an existing SoundBuffer to the active Strip.
Declaration bool SetSoundBuffer( SoundBuffer soundbuffer ) Parameters* `soundbuffer`: A valid reference to an existing SoundBuffer Asset; to disconnect set to `nil`. Return Value `true` if the Strip is associated to a StripGroup of the type `kAudio`; else return `false`.
`SetScript`	Connect an existing Script Asset to the current Strip.
Declaration bool SetScript( Script script ) Parameters* `script`: A valid reference to an existing Script Asset; to disconnect set to `nil`. Return Value `true` if the Strip is associated to a StripGroup of the type `kTrigger`; else return `false`.
`SetEntity`	Connect an existing Entity Asset to the current Strip.
Declaration bool SetEntity( Entity entity ) Parameters* `entity`: A valid reference to an existing Entity Asset; to disconnect set to `nil`. Return Value `true` if the Strip is associated to a StripGroup of the type `kCreator`; else return `false`.
`SetCommand`	Manually set a scripting command to the active Strip.
Declaration bool SetCommand( const char command ) Parameters* `command`: Scripting command for the Strip to execute. Return Value `true` if the Strip StripGroupType is `kTrigger`; else return `false`.
`SetString`	Assign a text/subtitle string to be used by the Strip.
Declaration bool SetString( const char string ) Parameters* `string`: The string to assign to the active Strip. Return Value `true` if the Strip StripGroupType is `kConversation`; else return `false`.
`GetAction`	Retrieve the Action associated to the active Strip.
Declaration Action GetAction( void ) Return Value* `nil` if the current Strip is not associated to a StripGroup of the StripGroupType `kActivity` or if no Action is currently attached to the Strip; else return the Action reference.
`GetSequence`	Helper to retrieve the underlying Sequence the current Strip is associated to.
Declaration Sequence GetSequence( void ) Return Value* Reference to the Sequence the Strip belongs to.
`GetEntityObject`	Help to retrieve the Object reference created by an `kCreator` Strip.
Declaration Object GetEntityObject( void ) Return Value* `nil` if the Strip does not belong to a `kCreator` StripGroup type or if no Object have been created; else return the reference of the Object created by the Strip.
`OverlapLeft`	Return the index of the Strip that currently overlap the active Strip on its left side.
Declaration int OverlapLeft( void ) Return Value `-1` if no Strip overlap the active Strip on its left side; else return the index of the Strip ovelapping on the left.
`OverlapRight`	Return the index of the Strip that currently overlap the active Strip on its right side.
Declaration int OverlapRight( void ) Return Value `-1` if no Strip overlap the active Strip on its right side; else return the index of the Strip ovelapping on the right.
`Update`	Manually trigger a Strip update.
Declaration void Update( void )

Events

Callbacks Description

OnTrigger Event called by a Strip of the type kTrigger when its playback position is reached; or its called recursively if the Strip settings force a constant command execution.

Declaration

function OnTrigger()

StripData

Access the available properties of an active Strip based on its current StripGroupType.

Static Variables

Name	Description
`group`	Reference to the StripGroup the active StripData is connected to.
Declaration StripGroup *group
`director`	Access the StripDirector properties of a `kDirector` Strip.
Declaration StripDirector *director Note This variable will be set to `nil` if the Strip StripGroupType is not `kDirector`.
`audio`	Access the StripAudio properties of a `kAudio` Strip.
Declaration StripAudio *audio Note This variable will be set to `nil` if the Strip StripGroupType is not `kAudio`.
`activity`	Access the StripActivity properties of a `kActivity` Strip.
Declaration StripActivity *activity Note This variable will be set to `nil` if the Strip StripGroupType is not `kActivity`.
`trigger`	Access the StripTrigger properties of a `kTrigger` Strip.
Declaration StripTrigger *trigger Note This variable will be set to `nil` if the Strip StripGroupType is not `kTrigger`.
`conversation`	Access the StripConversation properties of a `kConversation` Strip.
Declaration StripConversation *conversation Note This variable will be set to `nil` if the Strip StripGroupType is not `kConversation`.
`subsequence`	Access the StripSubSequence properties of a `kSubsequence` Strip.
Declaration StripSubSequence *subsequence Note This variable will be set to `nil` if the Strip StripGroupType is not `kSubsequence`.
`creator`	Access the StripCreator properties of a `kCreator` Strip.
Declaration StripCreator *creator Note This variable will be set to `nil` if the Strip StripGroupType is not `kCreator`.

StripDirector

Controls which Camera should be used during the sequence playback.

Static Variables

Name	Description
`camera`	Unique id of the Camera Object to use during the Strip execution.
Declaration unsigned int camera
`listener`	Control wheter or not the Camera should be used as Listener.
Declaration bool listener

StripAudio

Allows you to create virtual SoundSource to play SoundBuffer either in 2D or 3D, control pan, volume, and AudioEffect.

Static Variables

Name	Description
`soundbuffer`	Current SoundBuffer connected to the audio Strip.
Declaration SoundBuffer *soundbuffer
`repeat_count`	Amount of times the SoundBuffer have been looped.
Declaration int repeat_count

Variables

Name	Description
`start_time`	Starting playback time (1.0 = 1sec.) of the SoundBuffer associated to the StripAudio.
Declaration float start_time
`end_time`	Ending playback position of the SoundBuffer connected to the active StripAudio.
Declaration float end_time
`curve`	Curve to control the gain of the virtual SoundSource during the Strip playback.
Declaration Curve curve

StripActivity

Controls the Action of a specific Animation. It is used to animate characters, Object in other words to animate existing actions.

Variables

Name	Description
`action`	Unique id of the Action associated with the active Strip.
Declaration unsigned int action
`start_time`	Specify the start time of the Action connected to the Strip.
Declaration float start_time
`end_time`	Specify the end time of the Action connected to the Strip.
Declaration float end_time
`scale`	Scale factor of the Action connected to the Strip.
Declaration float scale
`influence`	The amount of influence (or weight) the Action connected to the active Strip will have on the Animation.
Declaration float influence
`actuators`	Enable or disable the actuators connected to the Action connected to the Strip.
Declaration bool actuators

StripTrigger

Run a script, a function or custom command either at a specific point in the sequence time or continuously during the Strip playback.

Static Variables

Name	Description
`script`	Current Script connected to the trigger Strip.
Declaration Script *script
`error`	Boolean value triggered by an error that happen either in the Script or the command associated with the Strip.
Declaration bool error

Variables

Name	Description
`continuous`	Determine wheter or not the Script or the command should executed on each Strip update.
Declaration bool continuous
`end_time`	Scripting command to execute (in the event that a Script is not used).
Declaration char *command

StripConversation

Provides an easy way to create subtitles or to update the string of Text Object either statically or progressively during the Sequence playback.

Variables

Name	Description
`script`	Control wheter or not the string of Text specified should be intepolated based on the Strip total duration.
Declaration bool interpolate
`string`	String of Text to use during the Strip duration.
Declaration char *string

StripSubSequence

Embed an existing Sequence within the active Sequence. Take note that this type of Strip cannot be resized since they are strictly based on the time of the external Sequence connected.

Variables

Name	Description
`sequence`	Unique id of Sequence to connect to the active Strip.
Declaration unsigned int sequence
`speed`	Control the speed of the sub Sequence connected to the active Strip.
Declaration float speed Range 0.01x to 5.0x

StripCreator

Create and destroy Entity Asset during the Sequence playback. This is the type of StripGroup to use if your Sequence requires dynamic Object to be created during the Sequence runtime.

Static Variables

Name	Description
`entity`	The current Entity connected to the active Strip.
Declaration Entity *entity
`object`	Reference to the Object created by the Entity during the Strip playback.
Declaration Object *object

Variables

Name	Description
`target`	Unique id of the Object you wish to attach the Entity to.
Declaration unsigned int target
`target_bone`	If the `target` is a SkeletalMesh this variable specifies the Bone index the Entity should be parented to.
Declaration int target_bone
`placement`	Specify the PlacementMode when the Entity gets created.
Declaration PlacementMode placement

StripState

Available flags that can be combined to represent the cumulative selection state of a Strip.

fRangeNotSelected: Center area of the Strip is not selected.
fStartTimeSelected: Flag representing that the Strip start time is selected (left side).
fEndTimeSelected: Flag representing that Strip end time is selected (right side).
fBlendInSelected: Represent that the blend in an area of the Strip is selected (upper left side).
fBlendOutSelected: Represent that the blend out area of the Strip is selected (upper right side).
fRangeSelected: Flag to toggle if the center area of the Strip is selected.