Skip to main content

The "sys_anim_init" Function

Syntax#

sys_anim_init(entity, index, anim, duration, loop, reverse, ease);
ArgumentTypeDescription
entityintegerThe data structure of the entity to be animated
indexintegerThe index of the row containing the target entity
animscriptThe animation script to be performed
durationrealSets the duration of the entire animation, in seconds
loopbooleanEnables or disables endlessly looping the animation
reversebooleanEnables or disables reversing the animation
easeinteger/macroSets the animation easing override

Description#

Initializes a given scripted animation for the input entity which can be performed with sys_anim_perform.

As this script is run automatically by any animation scripts tailored to specific entity types, it is almost never necessary to run sys_anim_init manually.

See Animations for a list of included animation scripts and how to make your own.