unreal.RigVMFunction_ControlFlowTimer

class unreal.RigVMFunction_ControlFlowTimer(execute_context: RigVMExecuteContext = [], reset: bool = False, speed: float = 0.0, duration: float = 0.0, repeats: bool = False, just_started: RigVMExecuteContext = [], is_running: RigVMExecuteContext = [], just_finished: RigVMExecuteContext = [], time: float = 0.0, ratio: float = 0.0, completed: RigVMExecuteContext = [])

Bases: RigVMFunction_ControlFlowBase

Executes the output branches based on a timer

C++ Source:

• Plugin: RigVM

• Module: RigVM

• File: RigVMFunction_ControlFlow.h

Editor Properties: (see get_editor_property/set_editor_property)

• completed (RigVMExecuteContext): [Read-Write] The execute flow to run every frame after all other branches

• duration (float): [Read-Write] The duration in seconds the timer will take to complete

• execute_context (RigVMExecuteContext): [Read-Write] The input execution pin to hook up to the graph

• is_running (RigVMExecuteContext): [Read-Write] The branch to run when the timer is running

• just_finished (RigVMExecuteContext): [Read-Write] The branch to run when the timer has just finished

• just_started (RigVMExecuteContext): [Read-Write] The branch to run when the timer has just started

• ratio (float): [Read-Write] The played back / accumulated time as a ratio of time / duration (0.0 - 1.0)

• repeats (bool): [Read-Write] A flag indicating if the timer is a one-shot or if it should repeat / loop

• reset (bool): [Read-Write] A flag to reset / restart the timer

• speed (float): [Read-Write] The speed to apply to the played back time

• time (float): [Read-Write] The played back / accumulated time in seconds

property completed: RigVMExecuteContext

[Read-Only] The execute flow to run every frame after all other branches

Type:

(RigVMExecuteContext)

property duration: float

[Read-Write] The duration in seconds the timer will take to complete

Type:

(float)

property execute_context: RigVMExecuteContext

[Read-Write] The input execution pin to hook up to the graph

Type:

(RigVMExecuteContext)

property is_running: RigVMExecuteContext

[Read-Only] The branch to run when the timer is running

Type:

(RigVMExecuteContext)

property just_finished: RigVMExecuteContext

[Read-Only] The branch to run when the timer has just finished

Type:

(RigVMExecuteContext)

property just_started: RigVMExecuteContext

[Read-Only] The branch to run when the timer has just started

Type:

(RigVMExecuteContext)

property ratio: float

[Read-Only] The played back / accumulated time as a ratio of time / duration (0.0 - 1.0)

Type:

(float)

property repeats: bool

[Read-Write] A flag indicating if the timer is a one-shot or if it should repeat / loop

Type:

(bool)

property reset: bool

[Read-Write] A flag to reset / restart the timer

Type:

(bool)

property speed: float

[Read-Write] The speed to apply to the played back time

Type:

(float)

property time: float

[Read-Only] The played back / accumulated time in seconds

Type:

(float)