Timeline Object

Timeline

Description

This Level Object is used to modify any object properties or fire any Input/Output events at specific times over a set "Duration".

Location

Right-click on an empty space in the Layout Scene Manager and choose Logic > Timeline from the list.

Properties

Name	Type	Description	Read Only
CODE NAME
NAME	string	The name of the Timeline for coding.
LOAD
PAUSE ON UNLOAD	bool	If True the Timeline will pause when the level is unloaded. If False the Timeline will finish playing.
RESET PROPERTIES	bool	If True the Timeline will reset the properties of the objects inside the Timeline on load.
START ON LOAD	bool	If True the Timeline will play automatically when the level is loaded.
MODIFICATION
LAYOUT CONTROL	bool	If True Layout Link Timelines can control the Timeline.
TIME MULT BACKWARDS	float	A multiplier to modify the duration when playing the Timeline backwards.
TYPE	string	When a Layout Link loads a Timeline it can adjust the duration by the specified type. Multiply None Set
NETWORK
SEND DATA	bool	If True the Timeline will send its state to multiplayer clients.
TIMELINE
DEFAULT INTERPOLATION TYPE	string	The interpolation type that all Timeline properties will default to. Linear Linear Round Linear Round Down Linear Round Up No Interpolation Quaternion Spline
DURATION	float	The duration of the Timeline.
LOOPS	bool	If True the Timeline will loop.
STEP	float	The update step.
UI PROPERTIES
START TYPE	string	Tells the UI when and how to start the Timeline. Invisible None Visible

Input Events

Enable

Enable the Timeline.

Disable

Disable the Timeline.

Play

Play the Timeline forwards.

Play Backwards

Play the Timeline backwards.

Stop

Stop the Timeline.

Stop to End

Stop the Timeline to the end.

Pause

Pause the Timeline.

Reset

Reset the Timeline to the beginning.

Reset To End

Reset the Timeline to the end.

Fast Forward To End

Fast forward the Timeline to the end.

Rewind to Start

Rewind the Timeline to the beginning.

Output Events

Enabled

This event will fire when the Timeline receives an "Enable" Input event.

Disabled

This event will fire when the Timeline receives a "Disable" Input event.

Started

This event will fire when the Timeline receives a "Play" or "Play Backwards" Input event.

Started Forwards

This event will fire when the Timeline receives a "Play" Input event.

Started Backwards

This event will fire when the Timeline receives a "Play Backwards" Input event.

Stopped

This event will fire when the Timeline receives a "Stop" or "Stop to End" Input event.

• This event will also fire when the Timeline finishes playing forwards or backwards.

Stopped Forwards

This event will fire when the Timeline receives a "Stop" Input event while playing forwards.

• This event will also fire when the Timeline finishes playing forwards.

Stopped Backwards

This event will fire when the Timeline receives a "Stop" Input event while playing backwards.

• This event will also fire when the Timeline finishes playing forwards.

Looped

This event will fire when the Timeline loops.

Paused

This event will fire when the Timeline receives a "Paused" Input event.

Reset to Beginning

This event will fire when the Timeline receives a "Reset" Input event.

Reset to End

This event will fire when the Timeline receives a "Reset to End" Input event.

Finished

This event will fire when the Timeline finishes playing forwards or backwards.

Finished Backwards

This event will fire when the Timeline finishes playing backwards.

Finished Forwards

This event will fire when the Timeline finishes playing forwards.

Tutorials

• Moving Objects with a Timeline