FRigVMFunction_ControlFlowTimer | Unreal Engine 5.8 Documentation

Executes the output branches based on a timer


Name	FRigVMFunction_ControlFlowTimer
Type	struct
Header File	/Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMFunctions/RigVMFunction_ControlFlow.h
Include Path	#include "RigVMFunctions/RigVMFunction_ControlFlow.h"

Syntax

USTRUCT (Meta=(DisplayName="Timer", Keywords="Branch,If,Timeline,Execute"))  
struct FRigVMFunction_ControlFlowTimer : public FRigVMFunction_ControlFlowBase

Inheritance Hierarchy

FRigVMStruct → FRigVMFunction_ControlFlowBase → FRigVMFunction_ControlFlowTimer

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FRigVMFunction_ControlFlowTimer()		RigVMFunctions/RigVMFunction_ControlFlow.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
AccumulatedValue	float		RigVMFunctions/RigVMFunction_ControlFlow.h
bIsInitialized	bool		RigVMFunctions/RigVMFunction_ControlFlow.h
bIsRunning	bool	True if the timer is running.	RigVMFunctions/RigVMFunction_ControlFlow.h	Meta=(Singleton)
bJustFinished	bool	True if the timer has just finished.	RigVMFunctions/RigVMFunction_ControlFlow.h
bJustStarted	bool	True if the timer has just started.	RigVMFunctions/RigVMFunction_ControlFlow.h	Meta=(Singleton)
BlockToRun	FName	The internal block to run as the node progresses.	RigVMFunctions/RigVMFunction_ControlFlow.h	Meta=(Singleton)
Completed	FRigVMExecuteContext	The execute flow to run every frame after all other branches.	RigVMFunctions/RigVMFunction_ControlFlow.h	Meta=(Output)
Duration	float	The duration in seconds the timer will take to complete.	RigVMFunctions/RigVMFunction_ControlFlow.h	Meta=(Input)
ExecuteContext	FRigVMExecuteContext	The input execution pin to hook up to the graph.	RigVMFunctions/RigVMFunction_ControlFlow.h	Meta=(Input, DisplayName="Execute")
IsRunning	FRigVMExecuteContext	The branch to run when the timer is running.	RigVMFunctions/RigVMFunction_ControlFlow.h	Meta=(Output)
JustFinished	FRigVMExecuteContext	The branch to run when the timer has just finished.	RigVMFunctions/RigVMFunction_ControlFlow.h	Meta=(Output)
JustStarted	FRigVMExecuteContext	The branch to run when the timer has just started.	RigVMFunctions/RigVMFunction_ControlFlow.h	Meta=(Output)
Ratio	float	The played back / accumulated time as a ratio of time / duration (0.0 - 1.0)	RigVMFunctions/RigVMFunction_ControlFlow.h	Meta=(Output)
Repeats	bool	A flag indicating if the timer is a one-shot or if it should repeat / loop.	RigVMFunctions/RigVMFunction_ControlFlow.h	Meta=(Input)
Reset	bool	A flag to reset / restart the timer.	RigVMFunctions/RigVMFunction_ControlFlow.h	Meta=(Input)
Speed	float	The speed to apply to the played back time.	RigVMFunctions/RigVMFunction_ControlFlow.h	Meta=(Input)
Time	float	The played back / accumulated time in seconds.	RigVMFunctions/RigVMFunction_ControlFlow.h	Meta=(Output)

Functions

Public

Public Virtual

Overridden from FRigVMStruct

Name	Remarks	Include Path	Unreal Specifiers
virtual void Execute()	Execute logic for this struct	RigVMFunctions/RigVMFunction_ControlFlow.h
virtual const TArray< FName > & GetControlFlowBlocks_Impl()		RigVMFunctions/RigVMFunction_ControlFlow.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Public

Functions

Public

Public Virtual

Overridden from FRigVMStruct