unreal.RigVMFunction_TimerValue

class unreal.RigVMFunction_TimerValue(reset: bool = False, speed: float = 0.0, duration: float = 0.0, repeats: bool = False, just_started: bool = False, is_running: bool = False, just_finished: bool = False, time: float = 0.0, ratio: float = 0.0)

Bases: RigVMFunction_TimeBase

Starts a timer and provides access to the time simulation

C++ Source:

  • Plugin: RigVM

  • Module: RigVM

  • File: RigVMFunction_Timeline.h

Editor Properties: (see get_editor_property/set_editor_property)

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

  • is_running (bool): [Read-Write] True if the timer is running

  • just_finished (bool): [Read-Write] True if the timer has just finished

  • just_started (bool): [Read-Write] True if 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 duration: float

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

Type:

(float)

property is_running: bool

[Read-Only] True if the timer is running

Type:

(bool)

property just_finished: bool

[Read-Only] True if the timer has just finished

Type:

(bool)

property just_started: bool

[Read-Only] True if the timer has just started

Type:

(bool)

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)