Navigation
API > API/Plugins > API/Plugins/RigVM
Simulates a time value - and outputs loop information
| Name | FRigVMFunction_TimeLoop |
| 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="Time Loop", Category="Simulation|Accumulate", Keywords="Playback,Pause,Timeline"))
struct FRigVMFunction_TimeLoop : public FRigVMFunction_SimBase
Inheritance Hierarchy
- FRigVMStruct → FRigVMFunction_SimBase → FRigVMFunction_TimeLoop
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigVMFunction_TimeLoop() |
RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Absolute | float | The overall time in seconds | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
| AccumulatedAbsolute | float | RigVMFunctions/Simulation/RigVMFunction_Timeline.h | ||
| AccumulatedRelative | float | RigVMFunctions/Simulation/RigVMFunction_Timeline.h | ||
| bIsInitialized | bool | RigVMFunctions/Simulation/RigVMFunction_Timeline.h | ||
| Duration | float | The duration of a single loop in seconds | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
| Even | bool | True if the iteration of the loop is even | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
| FlipFlop | float | The relative time in seconds (within the loop), going from 0 to duration and then back from duration to 0, or 0 to 1 and 1 to 0 if Normalize is turned on | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
| Normalize | bool | If set to true the output relative and flipflop will be normalized over the duration. | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
| NumIterations | int32 | RigVMFunctions/Simulation/RigVMFunction_Timeline.h | ||
| Relative | float | The relative time in seconds (within the loop) | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
| Speed | float | RigVMFunctions/Simulation/RigVMFunction_Timeline.h |
|
Functions
Public
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 |