1. Epic GamesDeveloper
  3. URigVM

URigVM

The RigVM is the main object for evaluating [FRigVMByteCode](API\Plugins\RigVM\RigVMCore\FRigVMByteCode) instructions.

API > API/Plugins > API/Plugins/RigVM > API/Plugins/RigVM/RigVMCore

Inheritance Hierarchy

References

   
Module RigVM
Header /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVM.h
Include #include "RigVMCore/RigVM.h"

Syntax

UCLASS (BlueprintType)  
class URigVM : public UObject

Remarks

The RigVM is the main object for evaluating FRigVMByteCode instructions. It combines the byte code, a list of required function pointers for execute instructions and required memory in one class.

Variables

  Type Name Description
Protected variable std::atomic< int32 > ActiveExecutions  
Public variable UProperty FRigVMByteCode * ByteCodePtr  
Public variable UProperty FRigVMByteCode ByteCodeStorage The byte code of the VM.
Public variable UProperty FRigVMMemoryStorageStruct DefaultDebugMemoryStorage  
Public variable UProperty FRigVMMemoryStorageStruct DefaultWorkMemoryStorage  
Public variable TArray< FRigVMPropertyPathDescription > ExternalPropertyPathDescriptions  
Public variable TArray< FRigVMPropertyPath > ExternalPropertyPaths  
Public variable UProperty FRigVMMemoryStorageStruct LiteralMemoryStorage  
Protected variable FCriticalSection ResolveFunctionsMutex  

Constructors

  Type Name Description
Public function  

URigVM ()

  

Destructors

  Type Name Description
Public function Virtual  

~URigVM ()

  

Functions

  Type Name Description
Public function FRigVMOperand

AddExternalVariable ( FRigVMExtendedExecuteContext& Context,
const FRigVMExternalVariable& InExternalVariable,
bool bAllowNullMemory
)

 Adds a new external / unowned variable to the VM.
Public function FRigVMOperand

AddExternalVariable ( const FRigVMExternalVariable& InExternalVariable
)

  
Public function FRigVMParameter

AddParameter ( ERigVMParameterType InType,
const FName& InParameterName,
const FName& InWorkMemoryPropertyName
)

  
Public function FRigVMParameter

AddParameter ( FRigVMExtendedExecuteContext& Context,
ERigVMParameterType InType,
const FName& InParameterName,
const FName& InWorkMemoryPropertyName
)

  
Public function Virtual UFunction int32

AddRigVMFunction ( const FString& InFunctionName
)

  
Public function Virtual UFunction int32

AddRigVMFunction ( UScriptStruct* InRigVMStruct,
const FName& InMethodName
)

 Add a function for execute instructions to this VM.
Public function Const bool

CanExecuteEntry ( const FName& InEntryName,
bool bLogErrorForMissingEntry
)

  
Public function Const bool

CanExecuteEntry ( const FRigVMExtendedExecuteContext& Context,
const FName& InEntryName,
bool bLogErrorForMissingEntry
)

 Returns false if an entry can not be executed
Public function void  
Public function void Clears the external variables of the VM.
Public function Virtual void  
Public function Virtual void  
Protected function void  
Public function Virtual Const uint32 Generates a unique hash to compare VMs.
Public function Virtual Const bool

ContainsEntry ( const FName& InEntryName
)

 Returns true if this VM's bytecode contains a given entry.
Public function void  
Public function Virtual void

CopyFrom ( URigVM* InVM,
bool bDeferCopy,
bool bReferenceLiteralMemory,
bool bReferenceByteCode,
bool bCopyExternalVariables,
bool bCopyDynamicRegisters
)

  
Public function Static void

DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

  
Public function FString

DumpByteCodeAsText ( FRigVMExtendedExecuteContext& Context,
const TArray< int32 >& InInstructionOrder,
bool bIncludeLineNumbers
)

  
Public function FString

DumpByteCodeAsText ( const TArray< int32 >& InInstructionOrder,
bool bIncludeLineNumbers
)

  
Public function TArray< FString >

DumpByteCodeAsTextArray ( FRigVMExtendedExecuteContext& Context,
const TArray< int32 >& InInstructionOrder,
bool bIncludeLineNumbers,
TFunction< FString(const FString&RegisterName, const FString&RegisterOffsetName)> OperandFormatFun...
)

 Returns the instructions as text, OperandFormatFunction is an optional argument that allows you to override how operands are displayed, for example, see SRigVMExecutionStackView::PopulateStackView
Public function TArray< FString >

DumpByteCodeAsTextArray ( const TArray< int32 >& InInstructionOrder,
bool bIncludeLineNumbers,
TFunction< FString(const FString&RegisterName, const FString&RegisterOffsetName)> OperandFormatFun...
)

  
Public function Virtual void Resets the container and removes all memory
Public function Virtual void

Empty ()

  
Public function Virtual ERigVMExecuteResult

Execute ( FRigVMExtendedExecuteContext& Context,
TArrayView< URigVMMemoryStorage* > Memory,
const FName& InEntryName
)

  
Public function Virtual ERigVMExecuteResult

Execute ( TArrayView< URigVMMemoryStorage* > Memory,
const FName& InEntryName
)

  
Public function Virtual bool

Execute ( const FName& InEntryName
)

  
Public function Virtual UFunction BlueprintCallable, Category, Meta bool

Execute ( FRigVMExtendedExecuteContext& Context,
const FName& InEntryName
)

  
Public function ERigVMExecuteResult

ExecuteBranch ( FRigVMExtendedExecuteContext& Context,
const FRigVMBranchInfo& InBranchToRun
)

 Executes a single branch on the VM. We assume that the memory is already set correctly at this point.
Public function ERigVMExecuteResult

ExecuteLazyBranch ( const FRigVMBranchInfo& InBranchToRun
)

  
Public function Virtual ERigVMExecuteResult

ExecuteVM ( FRigVMExtendedExecuteContext& Context,
const FName& InEntryName
)

 Executes the VM. You can optionally provide optional additional operands.
Public function FExecutionHaltedEvent &  
Public function FExecutionReachedExitEvent &  
Public function Virtual Const int32

FindEntry ( const FName& InEntryName
)

 Returns the index of an entry.
Public function Virtual void Used by the compiler and EngineTests to generate the default VM memory storages.
Public function Virtual void Generates the Default memory and copy it to the Context if required by the type of memory.
Public function Const int32  
Public function Const const FRigVMByteCode &  
Public function FRigVMByteCode &  
Public function Const const FRigVMExtendedExecuteContext *  
Public function FRigVMExtendedExecuteContext *  
Public function Const const UScriptStruct *  
Public function URigVMMemoryStorage *

GetDebugMemory ( bool bCreateIfNeeded
)

  
Public function FRigVMMemoryStorageStruct * The instance debug watch memory.
Public function Const const FRigVMMemoryStorageStruct *  
Public function Const const FRigVMMemoryStorageStruct & The default non mutable reference debug memory (generated by the compiler and copied to the instances as initial state)
Public function FRigVMMemoryStorageStruct &  
Public function Const const FRigVMMemoryStorageStruct & The default non mutable reference literal memory (generated by the compiler and copied to the instances as initial state)
Public function FRigVMMemoryStorageStruct &  
Public function Virtual FRigVMMemoryStorageStruct *  
Public function Virtual Const const FRigVMMemoryStorageStruct * Returns a default memory storage by type.
Public function Const const FRigVMMemoryStorageStruct & The default non mutable reference work memory (generated by the compiler and copied to the instances as initial state)
Public function FRigVMMemoryStorageStruct &  
Public function Virtual Const const TArray< FName > & Returns a list of all valid entry names for this VM's bytecode.
Public function FRigVMExternalVariable

GetExternalVariableByName ( const FName& InExternalVariableName
)

  
Public function FRigVMExternalVariable

GetExternalVariableByName ( const FRigVMExtendedExecuteContext& Context,
const FName& InExternalVariableName
)

 Returns an external variable given it's name.
Public function FRigVMExternalVariableDef

GetExternalVariableDefByName ( const FName& InExternalVariableName
)

 Returns an external variable Def given it's name.
Public function Const const TArray< FRigVMExternalVariableDef > & Returns the external variables of the VM (without variable memory, as it is stored in Context)
Public function Const const TArray< FRigVMExternalVariable >  
Public function Const const TArray< FRigVMExternalVariable > Returns the external variables of the VM with variable memory.
Public function TArray< const FRigVMFunction * > &  
Public function Const const TArray< const FRigVMFunction * > &  
Public function Const const FRigVMBreakpoint &  
Protected function Const const URigVMHost *  
Public function TArray< FRigVMMemoryStorageStruct * > Returns the VM Literal memory and context instanced memory.
Public function Const uint64  
Public function Const uint64 Returns accumulated cycles spent in an instruction during the last run This requires bEnabledProfiling to be turned on in the runtime settings.
Public function Const double  
Public function Const double Returns accumulated duration of the instruction in microseconds during the last run Note: this requires bEnabledProfiling to be turned on in the runtime settings.
Public function Virtual const FRigVMInstructionArray & Returns the instructions of the VM.
Public function Const int32  
Public function Const int32 Returns the number of times an instruction has been hit.
Public function Const const TArray< int32 >  
Public function Const const TArray< int32 > Returns the order of all instructions during the last run.
Public function FRigVMMemoryStorageStruct * The default const literal memory.
Public function Const const FRigVMMemoryStorageStruct *  
Public function URigVMMemoryStorage *

GetLiteralMemory ( bool bCreateIfNeeded
)

  
Public function TArray< URigVMMemoryStorage * >  
Public function Virtual URigVMMemoryStorage *

GetMemoryByType ( ERigVMMemoryType InMemoryType,
bool bCreateIfNeeded
)

  
Public function Virtual Const const FRigVMMemoryStorageStruct *  
Public function Virtual FRigVMMemoryStorageStruct * Returns a memory storage by type.
Public function UClass *

GetNativizedClass ( const TArray< FRigVMExternalVariable >& InExternalVariables
)

  
Public function UClass *

GetNativizedClass ( const TArray< FRigVMExternalVariableDef >& InExternalVariables
)

 Returns the VM's matching nativized class if it exists
Public function Const uint32  
Public function FString

GetOperandLabel ( const FRigVMOperand& InOperand,
TFunction< FString(const FString&RegisterName, const FString&RegisterOffsetName)> FormatFunction
)

  
Public function FString

GetOperandLabel ( FRigVMExtendedExecuteContext& Context,
const FRigVMOperand& InOperand,
TFunction< FString(const FString&RegisterName, const FString&RegisterOffsetName)> FormatFunction
)

 FormatFunction is an optional argument that allows you to override how operands are displayed, for example, see SRigVMExecutionStackView::PopulateStackView.
Public function int32

GetParameterArraySize ( const FRigVMParameter& InParameter
)

  
Public function int32

GetParameterArraySize ( int32 InParameterIndex
)

  
Public function int32

GetParameterArraySize ( const FName& InParameterName
)

  
Public function int32 Retrieve the array size of the parameter.
Public function int32 Retrieve the array size of the parameter.
Public function int32

GetParameterArraySize ( FRigVMExtendedExecuteContext& Context,
const FName& InParameterName
)

 Retrieve the array size of the parameter.
Public function FRigVMParameter

GetParameterByName ( const FName& InParameterName
)

 Returns a parameter given it's name.
Public function Const const TArray< FRigVMParameter > & Returns the parameters of the VM.
Public function T

GetParameterValue ( FRigVMExtendedExecuteContext& Context,
const FName& InParameterName,
int32 InArrayIndex,
T DefaultValue
)

 Retrieve the value of a parameter given its name.
Public function T

GetParameterValue ( FRigVMExtendedExecuteContext& Context,
int32 InParameterIndex,
int32 InArrayIndex,
T DefaultValue
)

 Retrieve the value of a parameter given its index.
Public function T

GetParameterValue ( FRigVMExtendedExecuteContext& Context,
const FRigVMParameter& InParameter,
int32 InArrayIndex,
T DefaultValue
)

 Retrieve the value of a parameter.
Public function UFunction BlueprintCallable, Category, Meta bool

GetParameterValueBool ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta double

GetParameterValueDouble ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta float

GetParameterValueFloat ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta int32

GetParameterValueInt ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta FName

GetParameterValueName ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta FQuat

GetParameterValueQuat ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta FString

GetParameterValueString ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta FTransform

GetParameterValueTransform ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta FVector

GetParameterValueVector ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta FVector2D

GetParameterValueVector2D ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function Const const ExecuteContextType &  
Public function ExecuteContextType &  
Public function Virtual Const UFunction FString

GetRigVMFunctionName ( int32 InFunctionIndex
)

 Returns the name of a function given its index.
Public function Const UFunction BlueprintPure, Category, Meta FRigVMStatistics Returns the statistics information
Public function TMap< int32, TArray< FRigVMTraitScope > > Returns the traits of a given type for this VM's bytecode and Context
Public function TMap< int32, TArray< FRigVMTraitScope > >

GetTraits ( FRigVMExtendedExecuteContext& InContext,
const UScriptStruct* InScriptStruct
)

 Returns the traits for this VM's bytecode and Context
Public function TMap< int32, TArray< FRigVMTraitScope > >

GetTraits ( FRigVMExtendedExecuteContext& InContext,
TArray< FRigVMMemoryHandle >& OutAdditionalMemoryHandles
)

 Returns the traits of a given type for this VM's bytecode and Context, as well as any additional memory handles
Public function TMap< int32, TArray< FRigVMTraitScope > >

GetTraits ( FRigVMExtendedExecuteContext& InContext,
TArray< FRigVMMemoryHandle >& OutAdditionalMemoryHandles,
const UScriptStruct* InScriptStruct
)

 Returns the traits for this VM's bytecode and Context, as well as any additional memory handles
Public function TArray< FRigVMTraitScope > Returns the traits of a given type for the provided memory for a single instruction
Public function TArray< FRigVMTraitScope >

GetTraitsForInstruction ( const FRigVMInstruction& InInstruction,
FRigVMExtendedExecuteContext& InContext,
const UScriptStruct* InScriptStruct
)

 Returns the traits for the provided memory for a single instruction
Public function Virtual Const uint32 Returns the cached VM hash
Public function Const const FRigVMMemoryStorageStruct *  
Public function FRigVMMemoryStorageStruct * The instance mutable work memory the VM will use to execute.
Public function URigVMMemoryStorage *

GetWorkMemory ( bool bCreateIfNeeded
)

  
Public function Virtual bool Prepares caches and memory for execution.
Public function Virtual bool  
Public function Virtual bool  
Public function Virtual bool

InitializeInstance ( FRigVMExtendedExecuteContext& Context,
bool bCopyMemory
)

 Initializes cached memory handles and optionally copies work memory from the CDO to the Context.
Public function void  
Public function void  
Protected function void  
Public function Const bool  
Public function Virtual Const bool Returns true if this is a nativized VM
Public function Virtual void

Load ( FArchive& Ar
)

  
Public function Virtual void  
Public function void  
Public function Virtual void

Reset ( bool IsIgnoringArchetypeRef
)

  
Public function Virtual void Resets the container and maintains all memory
Protected function void  
Public function bool

ResumeExecution ( FRigVMExtendedExecuteContext& Context,
const FName& InEntryName
)

  
Public function bool

ResumeExecution ( TArrayView< URigVMMemoryStorage* > Memory,
const FName& InEntryName
)

  
Public function bool

ResumeExecution ( FRigVMExtendedExecuteContext& Context,
TArrayView< URigVMMemoryStorage* > Memory,
const FName& InEntryName
)

  
Public function bool  
Public function bool  
Public function Virtual void

Save ( FArchive& Ar
)

  
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function void  
Public function void

SetContextPublicDataStruct ( UScriptStruct* InScriptStruct
)

  
Public function void

SetDebugInfo ( FRigVMDebugInfo* InDebugInfo
)

  
Public function void

SetExternalVariableDefs ( const TArray< FRigVMExternalVariable >& InExternalVariables
)

 Sets the external variables without the instance data.
Public function void

SetExternalVariablesInstanceData ( FRigVMExtendedExecuteContext& Context,
const TArray< FRigVMExternalVariable >& InExternalVariables,
bool bAllowNullMemory
)

 Sets the external variables instance data required for execution.
Protected function Virtual void

SetInstructionIndex ( FRigVMExtendedExecuteContext& Context,
uint16 InInstructionIndex
)

  
Public function void

SetParameterValue ( FRigVMExtendedExecuteContext& Context,
int32 ParameterIndex,
const T& InNewValue,
int32 InArrayIndex
)

 Set the value of a parameter given its index.
Public function void

SetParameterValue ( FRigVMExtendedExecuteContext& Context,
const FRigVMParameter& InParameter,
const T& InNewValue,
int32 InArrayIndex
)

 Set the value of a parameter.
Public function void

SetParameterValue ( FRigVMExtendedExecuteContext& Context,
const FName& InParameterName,
const T& InNewValue,
int32 InArrayIndex
)

 Set the value of a parameter given its name.
Public function UFunction BlueprintCallable, Category, Meta void

SetParameterValueBool ( const FName& InParameterName,
bool InValue,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetParameterValueDouble ( const FName& InParameterName,
double InValue,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetParameterValueFloat ( const FName& InParameterName,
float InValue,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetParameterValueInt ( const FName& InParameterName,
int32 InValue,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetParameterValueName ( const FName& InParameterName,
const FName& InValue,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetParameterValueQuat ( const FName& InParameterName,
const FQuat& InValue,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetParameterValueString ( const FName& InParameterName,
const FString& InValue,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetParameterValueTransform ( const FName& InParameterName,
const FTransform& InValue,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetParameterValueVector ( const FName& InParameterName,
const FVector& InValue,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category, Meta void

SetParameterValueVector2D ( const FName& InParameterName,
const FVector2D& InValue,
int32 InArrayIndex
)

  
Public function void

SetPropertyValueFromString ( const FRigVMOperand& InOperand,
const FString& InDefaultValue
)

  
Public function void

SetPropertyValueFromString ( FRigVMExtendedExecuteContext& Context,
const FRigVMOperand& InOperand,
const FString& InDefaultValue
)

  
Public function void Sets the max array size allowed by this VM
Protected function void  
Public function Virtual void

SetVMHash ( uint32 InVMHash
)

 Stores the current VM hash.
Protected function void  
Protected function void  
Public function bool  
Public function Const bool  
Public function Const bool Returns true if the given instruction has been visited during the last run.

Classes

  Type Name Description
Protected struct FEntryExecuteGuard    
Public class FExecutionHaltedEvent    
Public class FExecutionReachedExitEvent Bindable event for external objects to be notified when the VM reaches an Exit Operation  
Protected struct FInstructionBracketGuard    

Deprecated Variables

  Type Name Description
Public variable UProperty Meta TObjectPtr< URigVMMemoryStorage > DebugMemoryStorageObject_DEPRECATED Deprecated 5.4,.
Public variable UProperty Meta TObjectPtr< URigVMMemoryStorage > LiteralMemoryStorageObject_DEPRECATED Deprecated 5.4.
Protected variable UProperty Transient uint32 NumExecutions_DEPRECATED  
Public variable UProperty Meta TObjectPtr< URigVMMemoryStorage > WorkMemoryStorageObject_DEPRECATED Deprecated 5.4.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page