Skip to main content

The "sys_trans_init" Function

Syntax#

sys_trans_init(entity, index, trans, duration, reverse);
ArgumentTypeDescription
entityintegerThe data structure of the entity to transition
indexintegerThe index of the row containing the target entity
transinteger/macroSets the transition to perform on the target entity
durationrealSets the duration of the entire transition, in seconds
reversebooleanEnables or disables reversing the transition

Description#

When a new entity is created, before a transition can be applied, it must be initialized so that the entity begins with its transitioned properties rather than the properties to which it will be transitioned.

As this script is run automatically by any actions that require forward transitions, it is almost never necessary to run sys_trans_init manually.

See Macros & Keywords for a list of available transitions.