URigVM

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

API > API/Plugins > API/Plugins/RigVM

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.

   
Name URigVM
Type class
Header File /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVM.h
Include Path #include "RigVMCore/RigVM.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class URigVM : public UObject

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

URigVM()

   RigVMCore/RigVM.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~URigVM()

   RigVMCore/RigVM.h  

Structs

Name Remarks
FEntryExecuteGuard  
FInstructionBracketGuard  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ByteCodePtr FRigVMByteCode *   RigVMCore/RigVM.h  
ByteCodeStorage FRigVMByteCode The byte code of the VM. RigVMCore/RigVM.h  
DefaultWorkMemoryStorage FRigVMMemoryStorageStruct   RigVMCore/RigVM.h  
ExternalPropertyPathDescriptions TArray< FRigVMPropertyPathDescription >   RigVMCore/RigVM.h  
ExternalPropertyPaths TArray< FRigVMPropertyPath >   RigVMCore/RigVM.h  
LiteralMemoryStorage FRigVMMemoryStorageStruct   RigVMCore/RigVM.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsSerializing bool   RigVMCore/RigVM.h  
CachedNativizedVMHash TOptional< uint32 >   RigVMCore/RigVM.h  
CachedVMHash uint32   RigVMCore/RigVM.h  
EntryNames TArray< FName >   RigVMCore/RigVM.h  
ExternalVariables TArray< FRigVMExternalVariableDef >   RigVMCore/RigVM.h  
FactoriesPtr TArray< const FRigVMDispatchFactory * > *   RigVMCore/RigVM.h  
FactoriesStorage TArray< const FRigVMDispatchFactory * >   RigVMCore/RigVM.h  
FirstHandleForInstruction TArray< uint32 >   RigVMCore/RigVM.h  
FunctionNamesPtr TArray< FName > *   RigVMCore/RigVM.h  
FunctionNamesStorage TArray< FName >   RigVMCore/RigVM.h  
FunctionsPtr TArray< const FRigVMFunction * > *   RigVMCore/RigVM.h  
FunctionsStorage TArray< const FRigVMFunction * >   RigVMCore/RigVM.h  
Instructions FRigVMInstructionArray   RigVMCore/RigVM.h
  • Transient
LazyBranches TArray< FRigVMLazyBranch >   RigVMCore/RigVM.h  
MemoryHandleCount int32   RigVMCore/RigVM.h  
Parameters TArray< FRigVMParameter >   RigVMCore/RigVM.h  
ParametersNameMap TMap< FName, int32 >   RigVMCore/RigVM.h  
PreCachedMemoryHandles TArray< FRigVMMemoryHandle >   RigVMCore/RigVM.h  
PreCachedMemoryHandlesMemoryType TArray< ERigVMMemoryType >   RigVMCore/RigVM.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Adds a new external / unowned variable to the VM. RigVMCore/RigVM.h  

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

   RigVMCore/RigVM.h  

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

 Returns false if an entry can not be executed RigVMCore/RigVM.h  

void ClearExternalVariables ( FRigVMExtendedExecuteContext& Context
)

 Clears the external variables of the VM. RigVMCore/RigVM.h  

void CopyDataForSerialization ( URigVM* InVM
)

   RigVMCore/RigVM.h  

void CopyExternalVariableDefs ( URigVM* InVM
)

   RigVMCore/RigVM.h  

FRigVMMemoryStorageStruct * CreateDebugMemory ( FRigVMExtendedExecuteContext& Context
)

 Creates the debug memory for a single instance of this VM RigVMCore/RigVM.h  

bool CreateLocalizedRegistryIfRequired ( bool bForce
)

 Creates a localized registry for this VM. RigVMCore/RigVM.h  

bool CreateLocalizedRegistryIfRequired_NoLock ( bool bForce
)

   RigVMCore/RigVM.h  

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

   RigVMCore/RigVM.h  

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 RigVMCore/RigVM.h  

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. RigVMCore/RigVM.h  
  RigVMCore/RigVM.h  

uint64 GetCallableCycles ( const FRigVMExtendedExecuteContext& Context,
int32 InIndex
) const

 Returns accumulated cycles spent in a callable during the last run This requires bEnabledProfiling to be turned on in the runtime settings. RigVMCore/RigVM.h  

double GetCallableMicroSeconds ( const FRigVMExtendedExecuteContext& Context,
int32 InIndex
) const

 Returns accumulated duration of the callable in microseconds during the last run Note: this requires bEnabledProfiling to be turned on in the runtime settings. RigVMCore/RigVM.h  

int32 GetCallableVisitedCount ( const FRigVMExtendedExecuteContext& Context,
int32 InIndex
) const

 Returns the number of times a callable has been hit. RigVMCore/RigVM.h  
The instance debug watch memory. RigVMCore/RigVM.h  
  RigVMCore/RigVM.h  
  RigVMCore/RigVM.h  
The default non mutable reference literal memory (generated by the compiler and copied to the instances as initial state) RigVMCore/RigVM.h  
  RigVMCore/RigVM.h  
The default non mutable reference work memory (generated by the compiler and copied to the instances as initial state) RigVMCore/RigVM.h  

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

 Returns an external variable given it's name. RigVMCore/RigVM.h  

FRigVMExternalVariableDef GetExternalVariableDefByName ( const FName& InExternalVariableName
)

 Returns an external variable Def given it's name. RigVMCore/RigVM.h  

const TArray< FRigVMExternalVariableDef > & GetExternalVariableDefs()

 Returns the external variables of the VM (without variable memory, as it is stored in Context) RigVMCore/RigVM.h  

const TArray< FRigVMExternalVariable > GetExternalVariables ( const FRigVMExtendedExecuteContext& Context
) const

 Returns the external variables of the VM with variable memory. RigVMCore/RigVM.h  
  RigVMCore/RigVM.h  
  RigVMCore/RigVM.h  
  RigVMCore/RigVM.h  

uint64 GetInstructionCycles ( const FRigVMExtendedExecuteContext& Context,
int32 InIndex
) const

 Returns accumulated cycles spent in an instruction during the last run This requires bEnabledProfiling to be turned on in the runtime settings. RigVMCore/RigVM.h  

double GetInstructionMicroSeconds ( const FRigVMExtendedExecuteContext& Context,
int32 InIndex
) const

 Returns accumulated duration of the instruction in microseconds during the last run Note: this requires bEnabledProfiling to be turned on in the runtime settings. RigVMCore/RigVM.h  

int32 GetInstructionVisitedCount ( const FRigVMExtendedExecuteContext& Context,
int32 InIndex
) const

 Returns the number of times an instruction has been hit. RigVMCore/RigVM.h  

const TArray< int32 > GetInstructionVisitOrder ( const FRigVMExtendedExecuteContext& Context
) const

 Returns the order of all instructions during the last run. RigVMCore/RigVM.h  
  RigVMCore/RigVM.h  
The default const literal memory. RigVMCore/RigVM.h  

FRigVMRegistry_NoLock * GetLocalizedRegistry()

 Returns the localized registry this VM uses or nullptr. RigVMCore/RigVM.h  

UClass * GetNativizedClass ( uint32 InHash
) const

 Returns the VM's matching nativized class if it exists RigVMCore/RigVM.h  

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. RigVMCore/RigVM.h  

int32 GetParameterArraySize ( FRigVMExtendedExecuteContext& Context,
const FRigVMParameter& InParameter
)

 Retrieve the array size of the parameter. RigVMCore/RigVM.h  

int32 GetParameterArraySize ( FRigVMExtendedExecuteContext& Context,
int32 InParameterIndex
)

 Retrieve the array size of the parameter. RigVMCore/RigVM.h  

int32 GetParameterArraySize ( FRigVMExtendedExecuteContext& Context,
const FName& InParameterName
)

 Retrieve the array size of the parameter. RigVMCore/RigVM.h  

FRigVMParameter GetParameterByName ( const FName& InParameterName
)

 Returns a parameter given it's name. RigVMCore/RigVM.h  

const TArray< FRigVMParameter > & GetParameters()

 Returns the parameters of the VM. RigVMCore/RigVM.h  

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

 Retrieve the value of a parameter given its name. RigVMCore/RigVM.h  

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

 Retrieve the value of a parameter given its index. RigVMCore/RigVM.h  

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

 Retrieve the value of a parameter. RigVMCore/RigVM.h  

bool GetParameterValueBool ( const FName& InParameterName,
int32 InArrayIndex
)

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

double GetParameterValueDouble ( const FName& InParameterName,
int32 InArrayIndex
)

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

float GetParameterValueFloat ( const FName& InParameterName,
int32 InArrayIndex
)

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

int32 GetParameterValueInt ( const FName& InParameterName,
int32 InArrayIndex
)

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

FName GetParameterValueName ( const FName& InParameterName,
int32 InArrayIndex
)

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

FQuat GetParameterValueQuat ( const FName& InParameterName,
int32 InArrayIndex
)

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

FString GetParameterValueString ( const FName& InParameterName,
int32 InArrayIndex
)

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

FTransform GetParameterValueTransform ( const FName& InParameterName,
int32 InArrayIndex
)

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

FVector GetParameterValueVector ( const FName& InParameterName,
int32 InArrayIndex
)

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

FVector2D GetParameterValueVector2D ( const FName& InParameterName,
int32 InArrayIndex
)

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

void GetRequiredPlugins ( TArray< FString >& OutPlugins
)

   RigVMCore/RigVM.h  

FRigVMStatistics GetStatistics()

 Returns the statistics information RigVMCore/RigVM.h
  • BlueprintPure
  • Category="RigVM"
  • Meta=(DeprecatedFunction)

TMap< int32, TArray< FRigVMTraitScope > > GetTraits ( FRigVMExtendedExecuteContext& InContext,
const UScriptStruct* InScriptStruct
)

 Returns the traits for this VM's bytecode and Context RigVMCore/RigVM.h  

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 RigVMCore/RigVM.h  

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 RigVMCore/RigVM.h  
Returns the traits of a given type for this VM's bytecode and Context RigVMCore/RigVM.h  
Returns the traits of a given type for the provided memory for a single instruction RigVMCore/RigVM.h  

TArray< FRigVMTraitScope > GetTraitsForInstruction ( const FRigVMInstruction& InInstruction,
FRigVMExtendedExecuteContext& InContext,
const UScriptStruct* InScriptStruct
)

 Returns the traits for the provided memory for a single instruction RigVMCore/RigVM.h  

TArray< const UObject * > GetUserDefinedDependencies ( const TArray< const FRigVMMemoryStorageStruct* > InMemory
)

   RigVMCore/RigVM.h  
  RigVMCore/RigVM.h  
The instance mutable work memory the VM will use to execute. RigVMCore/RigVM.h  

void InvalidateCachedMemory ( FRigVMExtendedExecuteContext& Context
)

   RigVMCore/RigVM.h  

bool IsContextValidForExecution ( FRigVMExtendedExecuteContext& Context
) const

   RigVMCore/RigVM.h  

void RefreshArgumentNameCaches()

   RigVMCore/RigVM.h  

bool ResumeExecution ( FRigVMExtendedExecuteContext& Context,
const FName& InEntryName
)

   RigVMCore/RigVM.h  

void SetExternalVariableDefs ( const TArray< FRigVMExternalVariable >& InExternalVariables
)

 Sets the external variables without the instance data. RigVMCore/RigVM.h  

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

 Set the value of a parameter given its index. RigVMCore/RigVM.h  

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

 Set the value of a parameter. RigVMCore/RigVM.h  

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

 Set the value of a parameter given its name. RigVMCore/RigVM.h  

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

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

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

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

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

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

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

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

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

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

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

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

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

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

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

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

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

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

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

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported, please, update your code.")

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

   RigVMCore/RigVM.h  

bool ValidateBytecode()

   RigVMCore/RigVM.h  

bool WasInstructionVisitedDuringLastRun ( const FRigVMExtendedExecuteContext& Context,
int32 InIndex
) const

 Returns true if the given instruction has been visited during the last run. RigVMCore/RigVM.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual int32 AddRigVMFunction ( const FName& InFunctionFName
)

   RigVMCore/RigVM.h  

virtual int32 AddRigVMFunction ( const FString& InFunctionName
)

   RigVMCore/RigVM.h  

virtual int32 AddRigVMFunction ( UScriptStruct* InRigVMStruct,
const FName& InMethodName
)

 Add a function for execute instructions to this VM. RigVMCore/RigVM.h  

virtual void ClearMemory ( FRigVMExtendedExecuteContext& Context
)

   RigVMCore/RigVM.h  

virtual uint32 ComputeVMHash ( const TArray< FRigVMExternalVariableDef >& InExternalVariables
) const

   RigVMCore/RigVM.h  

virtual uint32 ComputeVMHash ( const TArray< FRigVMExternalVariable >& InExternalVariables
) const

   RigVMCore/RigVM.h  

virtual uint32 ComputeVMHash ()

 Generates a unique hash to compare VMs. RigVMCore/RigVM.h  

virtual bool ContainsEntry ( const FName& InEntryName
) const

 Returns true if this VM's bytecode contains a given entry. RigVMCore/RigVM.h  

virtual void Empty ( FRigVMExtendedExecuteContext& Context
)

 Resets the container and removes all memory RigVMCore/RigVM.h  

virtual bool Execute ( FRigVMExtendedExecuteContext& Context,
const FName& InEntryName
)

   RigVMCore/RigVM.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported.")

virtual ERigVMExecuteResult ExecuteVM ( FRigVMExtendedExecuteContext& Context,
const FName& InEntryName
)

 Executes the VM. You can optionally provide optional additional operands. RigVMCore/RigVM.h  

virtual int32 FindEntry ( const FName& InEntryName
) const

 Returns the index of an entry. RigVMCore/RigVM.h  

virtual void GenerateDefaultMemoryType ( ERigVMMemoryType InMemoryType,
const TArray< FRigVMPropertyDescription >* InProperties
)

 Used by the compiler and EngineTests to generate the default VM memory storages. RigVMCore/RigVM.h  

virtual void GenerateMemoryType ( FRigVMExtendedExecuteContext& Context,
ERigVMMemoryType InMemoryType,
const TArray< FRigVMPropertyDescription >* InProperties
)

 Generates the Default memory and copy it to the Context if required by the type of memory. RigVMCore/RigVM.h  

virtual const FRigVMByteCode & GetByteCode ()

   RigVMCore/RigVM.h  
  RigVMCore/RigVM.h  

virtual const FRigVMMemoryStorageStruct * GetDefaultMemoryByType ( ERigVMMemoryType InMemoryType
) const

 Returns a default memory storage by type. RigVMCore/RigVM.h  

virtual const TArray< FName > & GetEntryNames()

 Returns a list of all valid entry names for this VM's bytecode. RigVMCore/RigVM.h  

virtual const TArray< const FRigVMDispatchFactory * > & GetFactories ()

   RigVMCore/RigVM.h  

virtual const TArray< FName > & GetFunctionNames ()

   RigVMCore/RigVM.h  

virtual const TArray< const FRigVMFunction * > & GetFunctions ()

   RigVMCore/RigVM.h  

virtual const FRigVMInstructionArray & GetInstructions()

 Returns the instructions of the VM. RigVMCore/RigVM.h  

virtual const FRigVMMemoryStorageStruct * GetMemoryByType ( const FRigVMExtendedExecuteContext& Context,
ERigVMMemoryType InMemoryType
) const

   RigVMCore/RigVM.h  
Returns a memory storage by type. RigVMCore/RigVM.h  

virtual FString GetRigVMFunctionName ( int32 InFunctionIndex
) const

 Returns the name of a function given its index. RigVMCore/RigVM.h  

virtual uint32 GetVMHash()

 Returns the cached VM hash RigVMCore/RigVM.h  

virtual bool Initialize ( FRigVMExtendedExecuteContext& Context
)

 Prepares caches and memory for execution. RigVMCore/RigVM.h  

virtual bool InitializeInstance ( FRigVMExtendedExecuteContext& Context,
bool bCopyMemory
)

 Initializes cached memory handles and optionally copies work memory from the CDO to the Context. RigVMCore/RigVM.h  

virtual bool IsNativized()

 Returns true if this is a nativized VM RigVMCore/RigVM.h  

virtual void Load ( FArchive& Ar
)

   RigVMCore/RigVM.h  

virtual void Reset ( FRigVMExtendedExecuteContext& Context
)

 Resets the container and maintains all memory RigVMCore/RigVM.h  

virtual void Save ( FArchive& Ar
)

   RigVMCore/RigVM.h  

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

 Sets the external variables instance data required for execution. RigVMCore/RigVM.h  

virtual void SetVMHash ( uint32 InVMHash
)

 Stores the current VM hash. RigVMCore/RigVM.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   RigVMCore/RigVM.h  

virtual void Serialize ( FArchive& Ar
)

   RigVMCore/RigVM.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ClearMemory_Internal()

   RigVMCore/RigVM.h  

const URigVMHost * GetHostCDO()

   RigVMCore/RigVM.h  

FString GetLocalizedRegistryAsString()

   RigVMCore/RigVM.h  

bool IncrementInstructionIndex ( FRigVMExtendedExecuteContext& Context,
FRigVMExecuteContext& PublicData
) const

   RigVMCore/RigVM.h  

void InvalidateCachedMemory_Internal()

   RigVMCore/RigVM.h  

void Reset_Internal()

   RigVMCore/RigVM.h  

void SetLocalizedRegistryFromString ( const FString& InData
)

   RigVMCore/RigVM.h  

void SetupInstructionTracking ( FRigVMExtendedExecuteContext& Context,
int32 InInstructionCount,
int32 InCallableCount,
const FName& InEntryName
)

   RigVMCore/RigVM.h  

void StartProfiling ( FRigVMExtendedExecuteContext& Context
)

   RigVMCore/RigVM.h  

void StopProfiling ( FRigVMExtendedExecuteContext& Context
)

   RigVMCore/RigVM.h  

Protected Virtual

Name Remarks Include Path Unreal Specifiers

virtual bool SetInstructionIndex ( FRigVMExtendedExecuteContext& Context,
FRigVMExecuteContext& PublicData,
int32 InInstructionIndex
) const

   RigVMCore/RigVM.h  

Static

Name Remarks Include Path Unreal Specifiers

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

   RigVMCore/RigVM.h  

static FRigVMMemoryHandle GeneratePatchedHandle ( const TArray< FRigVMExternalVariableRuntimeData >& ExternalVariablesRuntimeData,
const TStaticArray< uint8*,(int32) ERigVMMemoryType::Num >& VMMemoryPtrs,
ERigVMMemoryType HandleMemoryType,
const FRigVMMemoryHandle& PreCachedHandle
)

   RigVMCore/RigVM.h  

static void GeneratePatchedHandles ( const TArrayView< FRigVMMemoryHandle >& OutHandles,
const TArray< FRigVMExternalVariableRuntimeData >& ExternalVariablesRuntimeData,
const TStaticArray< uint8*,(int32) ERigVMMemoryType::Num >& VMMemoryPtrs,
const TArray< FRigVMMemoryHandle >& PreCachedMemoryHandles,
const TArray< ERigVMMemoryType >& PreCachedMemoryHandlesMemoryType,
int32 FirstHandleIndex,
int32 OperandCount
)

   RigVMCore/RigVM.h  

static int32 GetContainerIndex ( ERigVMMemoryType InType
)

 This function should be kept in sync with FRigVMOperand::GetContainerIndex() RigVMCore/RigVM.h  

static bool IsSerializingToDisk ( const FArchive& Ar
)

   RigVMCore/RigVM.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
DebugMemoryStorageObject_DEPRECATED TObjectPtr< URigVMMemoryStorage > Deprecated 5.4,. RigVMCore/RigVM.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Please use DefaultDebugMemoryStorage for compiling and DebugMemoryStorage in the ExtendedExecuteContext for intance execution")
DefaultDebugMemoryStorage_DEPRECATED FRigVMMemoryStorageStruct   RigVMCore/RigVM.h  
LiteralMemoryStorageObject_DEPRECATED TObjectPtr< URigVMMemoryStorage > Deprecated 5.4. RigVMCore/RigVM.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Please, use LiteralMemoryStorage")
NumExecutions_DEPRECATED uint32   RigVMCore/RigVM.h
  • Transient
WorkMemoryStorageObject_DEPRECATED TObjectPtr< URigVMMemoryStorage > Deprecated 5.4. RigVMCore/RigVM.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Please, use DefaultWorkMemoryStorage for compiling and WorkMemoryStorage in the ExtendedExecuteContext for intance execution")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page