The "sys_deform_init" Function

Syntax

sys_deform_init(entity, index, def, duration, loop, reverse, ease);

Argument	Type	Description
entity	integer	The data structure of the entity to be animated
index	integer	The index of the row containing the target entity
def	script	The deformation script to be performed
duration	real	Sets the duration of the entire deformation, in seconds
loop	boolean	Enables or disables endlessly looping the deformation
reverse	boolean	Enables or disables reversing the deformation
ease	integer/macro	Sets the deformation easing override

Description

Initializes a given scripted deformation for the input entity which can be performed with sys_deform_perform.

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

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