Module: nla

API methods to control non linear animation.
Source:

Summary

Methods

Type Definitions

Detailed Description

Methods

check_logic_nodes() → {boolean}

Check if the current scene has logic nodes
Returns:
Check result.
Type
boolean
Source:

check_nla() → {boolean}

Check if the current scene is currently NLA animated.
Returns:
Check result.
Type
boolean
Source:

clear_callback()

Clear callback executed after the NLA animation finished
Source:

get_frame() → {number}

Get NLA animation frame from the active scene
Returns:
NLA animation current frame.
Type
number
Source:

get_frame_end() → {number}

Get NLA animation ending frame for the active scene
Returns:
End frame.
Type
number
Source:

get_frame_start() → {number}

Get NLA animation starting frame for the active scene
Returns:
Start frame.
Type
number
Source:

is_play() → {boolean}

Check if NLA animation is being run for the active scene
Returns:
Check result.
Type
boolean
Source:

play(callbackopt, nullable)

Play NLA animation for the active scene
Parameters:
Name Type Attributes Default Description
callback NlaFinishCallback <optional>
<nullable>
 null Nla finish callback.
Source:

reset_range()

Reset NLA animation playing range
Source:

set_cyclic(is_cyclic)

Set cyclic behaviour for the active scene
Parameters:
Name Type Description
is_cyclic boolean Cyclic behavior.
Source:

set_frame(frame)

Set NLA animation frame for the active scene.
Parameters:
Name Type Description
frame number NLA animation frame
Source:

set_range(start_frame, end_frame)

Play NLA animation for the active scene from start frame to end frame.
Parameters:
Name Type Description
start_frame number Start NLA animation frame
end_frame number End NLA animation frame
Source:

stop()

Stop NLA animation for the active scene.
Source:

Type Definitions

NlaFinishCallback()

Callback executed after the NLA animation has finished.
Source: