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&40;BlueprintType&41;  
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 FRigVMByteCode * ByteCodePtr  
Public variable UProperty FRigVMByteCode ByteCodeStorage The byte code of the VM.
Public variable UProperty TObjectPtr< URigVMMemoryStorage > DebugMemoryStorageObject  
Public variable TArray< FRigVMPropertyPathDescription > ExternalPropertyPathDescriptions  
Public variable TArray< FRigVMPropertyPath > ExternalPropertyPaths  
Public variable UProperty TObjectPtr< URigVMMemoryStorage > LiteralMemoryStorageObject  
Protected variable FCriticalSection ResolveFunctionsMutex  
Public variable UProperty TObjectPtr< URigVMMemoryStorage > WorkMemoryStorageObject  

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 FRigVMParameter

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

  
Public function Virtual int32

AddRigVMFunction ( const FString& InFunctionName
)

 Add a function for execute instructions to this VM.
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 FRigVMExtendedExecuteContext& Context,
const FName& InEntryName,
bool bLogErrorForMissingEntry
)

 Returns false if an entry can not be executed
Public function void Clears the external variables of the VM.
Public function Virtual 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 Virtual void

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

 Resets the container and clones the input VM
Public function Static void

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

  
Public function FString

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

 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...
)

 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 Virtual void Resets the container and removes all memory
Public function Virtual ERigVMExecuteResult

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

 Executes the VM.
Public function Virtual UFunction BlueprintCallable, Category bool

Execute ( FRigVMExtendedExecuteContext& Context,
const FName& InEntryName
)

 Executes the VM.
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 Virtual Const int32

FindEntry ( const FName& InEntryName
)

 Returns the index of an entry.
Public function Const const FRigVMByteCode &  
Public function FRigVMByteCode &  
Public function URigVMMemoryStorage *

GetDebugMemory ( bool bCreateIfNeeded
)

 The default debug watch memory.
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 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 > Returns the external variables of the VM with variable memory.
Public function Const uint64

GetInstructionCycles ( const FRigVMExtendedExecuteContext& Context,
int32 InIndex
)

 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

GetInstructionMicroSeconds ( const FRigVMExtendedExecuteContext& Context,
int32 InIndex
)

 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

GetInstructionVisitedCount ( const FRigVMExtendedExecuteContext& Context,
int32 InIndex
)

 Returns the number of times an instruction has been hit.
Public function Const const TArray< int32 > Returns the order of all instructions during the last run.
Public function URigVMMemoryStorage *

GetLiteralMemory ( bool bCreateIfNeeded
)

 The default const literal memory.
Public function TArray< URigVMMemoryStorage * > Returns all memory storages as an array
Public function Virtual URigVMMemoryStorage *

GetMemoryByType ( ERigVMMemoryType InMemoryType,
bool bCreateIfNeeded
)

 Returns a memory storage by type.
Public function UClass *

GetNativizedClass ( const TArray< FRigVMExternalVariableDef >& InExternalVariables
)

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

GetOperandLabel ( 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 ( int32 InParameterIndex
)

 Retrieve the array size of the parameter.
Public function int32

GetParameterArraySize ( const FRigVMParameter& InParameter
)

 Retrieve the array size of the parameter.
Public function int32

GetParameterArraySize ( 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 ( int32 InParameterIndex,
int32 InArrayIndex,
T DefaultValue
)

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

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

 Retrieve the value of a parameter.
Public function T

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

 Retrieve the value of a parameter given its name.
Public function UFunction BlueprintCallable, Category bool

GetParameterValueBool ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category double

GetParameterValueDouble ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category float

GetParameterValueFloat ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category int32

GetParameterValueInt ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category FName

GetParameterValueName ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category FQuat

GetParameterValueQuat ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category FString

GetParameterValueString ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category FTransform

GetParameterValueTransform ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category FVector

GetParameterValueVector ( const FName& InParameterName,
int32 InArrayIndex
)

  
Public function UFunction BlueprintCallable, Category FVector2D

GetParameterValueVector2D ( const FName& InParameterName,
int32 InArrayIndex
)

  
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 Virtual Const uint32 Returns the cached VM hash
Public function URigVMMemoryStorage *

GetWorkMemory ( bool bCreateIfNeeded
)

 The default mutable work memory.
Public function Virtual bool Initializes all execute ops and their memory.
Public function void  
Public 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

Reset ( bool IsIgnoringArchetypeRef
)

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

Save ( FArchive& Ar
)

  
Public function const void

SetFirstEntryEventInEventQueue ( FRigVMExtendedExecuteContext& Context,
const FName& InFirstEventName
)

  
Protected function Virtual void

SetInstructionIndex ( FRigVMExtendedExecuteContext& Context,
uint16 InInstructionIndex
)

  
Public function void

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

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

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

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

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

 Set the value of a parameter.
Public function UFunction BlueprintCallable, Category void

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

  
Public function UFunction BlueprintCallable, Category void

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

  
Public function UFunction BlueprintCallable, Category void

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

  
Public function UFunction BlueprintCallable, Category void

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

  
Public function UFunction BlueprintCallable, Category void

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

  
Public function UFunction BlueprintCallable, Category void

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

  
Public function UFunction BlueprintCallable, Category void

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

  
Public function UFunction BlueprintCallable, Category void

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

  
Public function UFunction BlueprintCallable, Category void

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

  
Public function UFunction BlueprintCallable, Category void

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

  
Public function void

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

  
Protected function void

SetupInstructionTracking ( FRigVMExtendedExecuteContext& Context,
int32 InInstructionCount
)

  
Public function Virtual void

SetVMHash ( uint32 InVMHash
)

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

Overridden from UObject

  Type Name Description
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

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  

Deprecated Variables

  Type Name Description
Protected variable UProperty Transient uint32 NumExecutions_DEPRECATED  

Deprecated Functions

  Type Name Description
Public function FRigVMOperand

AddExternalVariable ( const FRigVMExternalVariable& InExternalVariable
)

 Please use AddExternalVariable with ExtendedExecuteContext parameter.
Public function Const bool

CanExecuteEntry ( const FName& InEntryName,
bool bLogErrorForMissingEntry
)

 Please, use CanExecuteEntry with Context param
Public function void Please, use ClearExternalVariables with Context param
Public function Virtual void

Empty ()

 Please, use Empty with Context param
Public function Virtual ERigVMExecuteResult

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

 Please, use Execute with Context param
Public function Virtual bool

Execute ( const FName& InEntryName
)

 Please, use Execute with Context param
Public function ERigVMExecuteResult

ExecuteLazyBranch ( const FRigVMBranchInfo& InBranchToRun
)

 Please, use ExecuteLazyBranch with Context param
Public function FExecutionHaltedEvent & Please use ExecutionHalted in the ExtendedExecuteContext.
Public function FExecutionReachedExitEvent & Please use ExecutionReachedExit in the ExtendedExecuteContext.
Public function FRigVMExtendedExecuteContext * Please, use an external Context in the RigVMHost.
Public function Const const FRigVMExtendedExecuteContext * Please, use an external Context in the RigVMHost.
Public function Const const UScriptStruct * Please, use an external Context in the RigVMHost.
Public function FRigVMExternalVariable

GetExternalVariableByName ( const FName& InExternalVariableName
)

 Please use GetExternalVariableByName with ExtendedExecuteContext parameter.
Public function Const const TArray< FRigVMExternalVariable > Please use GetExternalVariables with Context parameter.
Public function Const const FRigVMBreakpoint & Please use GetHaltedAtBreakpoint in the RigVMHost.
Public function Const uint64

GetInstructionCycles ( int32 InIndex
)

 Please, use GetInstructionCycles with Context param
Public function Const double

GetInstructionMicroSeconds ( int32 InIndex
)

 Please, use GetInstructionMicroSeconds with Context param
Public function Const int32

GetInstructionVisitedCount ( int32 InIndex
)

 Please, use GetInstructionVisitedCount with Context param
Public function Const const TArray< int32 > Please, use GetInstructionVisitOrder with Context param
Public function UClass *

GetNativizedClass ( const TArray< FRigVMExternalVariable >& InExternalVariables
)

 Please, use GetNativizedClass with FRigVMExternalVariableDef array.
Public function Const uint32 Please use GetNumExecutions() in the ExtendedExecuteContext.
Public function Const const ExecuteContextType & Please, use an external Context in the RigVMHost.
Public function ExecuteContextType & Please, use an external Context in the RigVMHost.
Public function Virtual bool Please, use Initialize with Context param
Public function bool Please, use ResumeExecution with Context param
Public function bool

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

 Please, use ResumeExecution with Context param
Public function bool Please, use ResumeExecution with Context param
Public function void Please use SetBreakpointAction in the RigVMHost.
Public function void Please, use an external Context in the RigVMHost.
Public function void

SetDebugInfo ( FRigVMDebugInfo* InDebugInfo
)

 Please use SetDebugInfo in the ExtendedExecuteContext.
Public function const void

SetFirstEntryEventInEventQueue ( const FName& InFirstEventName
)

 Please, use SetFirstEntryEventInEventQueue with Context param
Public function void Please, use Context.SetRuntimeSettings
Public function Const bool Please, use WasInstructionVisitedDuringLastRun with Context param

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page