Navigation
API > API/Plugins > API/Plugins/RigVM
Starts a timer and provides access to the time simulation
| Name | FRigVMFunction_TimerValue |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
| Include Path | #include "RigVMFunctions/Simulation/RigVMFunction_Timeline.h" |
Syntax
USTRUCT (Meta=(DisplayName="Timer Value", Keywords="Playback,Pause,Timeline"))
struct FRigVMFunction_TimerValue : public FRigVMFunction_TimeBase
Inheritance Hierarchy
- FRigVMStruct → FRigVMFunction_SimBase → FRigVMFunction_TimeBase → FRigVMFunction_TimerValue
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigVMFunction_TimerValue() |
RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AccumulatedValue | float | RigVMFunctions/Simulation/RigVMFunction_Timeline.h | ||
| bIsInitialized | bool | RigVMFunctions/Simulation/RigVMFunction_Timeline.h | ||
| Duration | float | The duration in seconds the timer will take to complete. | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
| IsRunning | bool | True if the timer is running. | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
| JustFinished | bool | True if the timer has just finished. | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
| JustStarted | bool | True if the timer has just started. | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
| Ratio | float | The played back / accumulated time as a ratio of time / duration (0.0 - 1.0) | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
| Repeats | bool | A flag indicating if the timer is a one-shot or if it should repeat / loop. | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
| Reset | bool | A flag to reset / restart the timer. | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
| Speed | float | The speed to apply to the played back time. | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
| Time | float | The played back / accumulated time in seconds. | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
Functions
Public
Public Virtual
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Execute logic for this struct | RigVMFunctions/Simulation/RigVMFunction_Timeline.h | |
virtual void Initialize() |
Initialize logic for this struct | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |