Module: nla

API methods to control non linear animation.

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:

check_nla_scripts() → {Boolean}

Check if the current scene has NLA-scripts
Returns:
Check result.
Type
Boolean
Deprecated:
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_nla_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: