Choose your operating system:
Windows
macOS
Linux
| UObjectBase
|
Module |
|
Header |
/Engine/Source/Runtime/RigVM/Public/RigVMCore/RigVM.h |
Include |
#include "RigVMCore/RigVM.h" |
class URigVM : public UObject
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 | Description | ||
---|---|---|---|
|
FRigVMByteCode ... |
ByteCodePtr |
|
|
ByteCodeStorage |
The byte code of the VM. |
|
|
TObjectPtr< URi... |
DebugMemoryStorageObject |
|
|
ExternalPropertyPathDescriptions |
||
|
ExternalPropertyPaths |
||
|
TObjectPtr< URi... |
LiteralMemoryStorageObject |
|
|
TObjectPtr< URi... |
WorkMemoryStorageObject |
Name | Description | |
---|---|---|
|
URigVM() |
Name | Description | |
---|---|---|
|
~URigVM() |
Name | Description | ||
---|---|---|---|
|
FRigVMOperan... |
AddExternalVariable ( |
Adds a new external / unowned variable to the VM. |
|
FRigVMParame... |
AddParameter ( |
|
|
AddRigVMFunction ( |
Add a function for execute instructions to this VM. |
|
|
ClearExternalVariables() |
Returns the external variables of the VM. |
|
|
ClearMemory() |
Removes all memory from this VM. |
|
|
ContainsEntry ( |
Returns true if this VM's bytecode contains a given entry. |
|
|
CopyFrom |
Resets the container and clones the input VM |
|
|
DumpByteCodeAsText |
Returns the instructions as text, OperandFormatFunction is an optional argument that allows you to override how operands are displayed, for example, see SControlRigStackView::PopulateStackView |
|
|
DumpByteCodeAsTextArray |
Returns the instructions as text, OperandFormatFunction is an optional argument that allows you to override how operands are displayed, for example, see SControlRigStackView::PopulateStackView |
|
|
Empty() |
Resets the container and removes all memory |
|
|
Execute ( |
Executes the VM. |
|
|
Execute ( |
Executes the VM. |
|
|
FExecutionHa... |
ExecutionHalted() |
|
|
FExecutionRe... |
ExecutionReachedExit() |
|
|
FRigVMByteCo... |
GetByteCode() |
|
|
const FRigVM... |
GetByteCode() |
|
|
const FRigVM... |
GetContext() |
|
|
URigVMMemory... |
GetDebugMemory ( |
The default debug watch memory. |
|
GetEntryNames() |
Returns a list of all valid entry names for this VM's bytecode. |
|
|
FRigVMExtern... |
GetExternalVariableByName ( |
Returns an external variable given it's name. |
|
const TArray... |
GetExternalVariables() |
Returns the external variables of the VM. |
|
TSharedPtr< ... |
GetHaltedAtBreakpoint() |
|
|
GetInstructionCycles ( |
Returns accumulated cycles spent in an instruction during the last run This requires bEnabledProfiling to be turned on in the runtime settings. |
|
|
double |
GetInstructionMicroSeconds ( |
Returns accumulated duration of the instruction in microseconds during the last run. |
|
const FRigVM... |
GetInstructions() |
Returns the instructions of the VM. |
|
GetInstructionVisitedCount ( |
Returns the number of times an instruction has been hit. |
|
|
const TArray... |
GetInstructionVisitOrder() |
Returns the order of all instructions during the last run. |
|
URigVMMemory... |
GetLiteralMemory ( |
The default const literal memory. |
|
GetLocalMemoryArray() |
Returns all memory storages as an array |
|
|
URigVMMemory... |
GetMemoryByType ( |
Returns a memory storage by type. |
|
GetNumExecutions() |
||
|
GetOperandLabel ( |
FormatFunction is an optional argument that allows you to override how operands are displayed, for example, see SControlRigStackView::PopulateStackView. |
|
|
GetParameterArraySize ( |
Retrieve the array size of the parameter. |
|
|
GetParameterArraySize ( |
Retrieve the array size of the parameter. |
|
|
GetParameterArraySize ( |
Retrieve the array size of the parameter. |
|
|
FRigVMParame... |
GetParameterByName ( |
Returns a parameter given it's name. |
|
const TArray... |
GetParameters() |
Returns the parameters of the VM. |
|
T |
GetParameterValue ( |
Retrieve the value of a parameter. |
|
T |
GetParameterValue |
Retrieve the value of a parameter given its index. |
|
T |
GetParameterValue |
Retrieve the value of a parameter given its name. |
|
GetParameterValueBool |
||
|
double |
GetParameterValueDouble |
|
|
float |
GetParameterValueFloat |
|
|
GetParameterValueInt |
||
|
GetParameterValueName |
||
|
GetParameterValueQuat |
||
|
GetParameterValueString |
||
|
GetParameterValueTransform |
||
|
GetParameterValueVector |
||
|
GetParameterValueVector2D |
||
|
GetRigVMFunctionName ( |
Returns the name of a function given its index. |
|
|
FRigVMStatis... |
GetStatistics() |
Returns the statistics information |
|
URigVMMemory... |
GetWorkMemory ( |
The default mutable work memory. |
|
Initialize ( |
Initializes all execute ops and their memory. |
|
|
InvalidateCachedMemory() |
||
|
Load ( |
||
|
Reset() |
Resets the container and maintains all memory |
|
|
ResumeExecution ( |
||
|
ResumeExecution() |
||
|
Save ( |
||
|
SetBreakpointAction ( |
||
|
SetDebugInfo ( |
||
|
const void |
SetFirstEntryEventInEventQueue ( |
|
|
SetParameterValue ( |
Set the value of a parameter. |
|
|
SetParameterValue |
Set the value of a parameter given its index. |
|
|
SetParameterValue |
Set the value of a parameter given its name. |
|
|
SetParameterValueBool |
||
|
SetParameterValueDouble |
||
|
SetParameterValueFloat |
||
|
SetParameterValueInt |
||
|
SetParameterValueName |
||
|
SetParameterValueQuat |
||
|
SetParameterValueString |
||
|
SetParameterValueTransform ( |
||
|
SetParameterValueVector |
||
|
SetParameterValueVector2D |
||
|
SetPropertyValueFromString ( |
||
|
SetRuntimeSettings ( |
Sets the max array size allowed by this VM |
|
|
WasInstructionVisitedDuringLastRun ( |
Returns true if the given instruction has been visited during the last run. |
Name |
Description |
|
---|---|---|
|
FExecutionHaltedEvent |
|
|
FExecutionReachedExitEvent |
Bindable event for external objects to be notified when the VM reaches an Exit Operation |