1. Epic GamesDeveloper
  3. FRigVMByteCode

FRigVMByteCode

The [FRigVMByteCode](API\Plugins\RigVM\RigVMCore\FRigVMByteCode) is a container to store a list of instructions with their corresponding data.

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

References

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

Syntax

USTRUCT&40;&41;  
struct FRigVMByteCode

Remarks

The FRigVMByteCode is a container to store a list of instructions with their corresponding data. The byte code is then used within a VM to execute. To iterate over the instructions within the byte code you can use GetInstructions() to retrieve a FRigVMInstructionArray.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function uint64

AddBeginBlockOp ( FRigVMOperand InCountArg,
FRigVMOperand InIndexArg
)

 Adds an operator to end the last memory slice
Public function int32

AddBranchInfo ( const FName& InBranchLabel,
int32 InInstructionIndex,
int32 InArgumentIndex,
int32 InFirstBranchInstruction,
int32 InLastBranchInstruction
)

 Adds information about a branch for an instruction's argument
Public function int32

AddBranchInfo ( const FRigVMBranchInfo& InBranchInfo
)

 Adds information about a branch for an instruction's argument
Public function uint64

AddCopyOp ( const FRigVMOperand& InSource,
const FRigVMOperand& InTarget
)

 Adds a copy operator to copy the content of a source argument to a target argument
Public function uint64

AddCopyOp ( const FRigVMCopyOp& InCopyOp
)

 Adds a copy operator to copy the content of a source argument to a target argument
Public function uint64

AddDecrementOp ( const FRigVMOperand& InArg
)

 Adds an decrement operator to decrement a int32 argument
Public function uint64 Adds an operator to end the last memory slice
Public function uint64

AddEqualsOp ( const FRigVMOperand& InA,
const FRigVMOperand& InB,
const FRigVMOperand& InResult
)

 Adds an equals operator to store the comparison result of A and B into a Result argument
Public function uint64

AddExecuteOp ( uint16 InFunctionIndex,
const FRigVMOperandArray& InOperands,
const int32& StartPredicateIndex,
const int32 PredicateCount
)

 Adds an execute operator given its function index operands
Public function uint64 Adds an exit operator to exit the execution loop
Public function uint64

AddFalseOp ( const FRigVMOperand& InArg
)

 Adds a false operator to set a given argument to false
Public function uint64

AddIncrementOp ( const FRigVMOperand& InArg
)

 Adds an increment operator to increment a int32 argument
Public function uint64

AddInvokeEntryOp ( const FName& InEntryName
)

 Adds an invoke entry operator
Public function uint64

AddJumpIfOp ( ERigVMOpCode InOpCode,
uint16 InInstructionIndex,
const FRigVMOperand& InConditionArg,
bool bJumpWhenConditionIs
)

 Adds an absolute, forward or backward jump operator based on a condition argument
Public function uint64

AddJumpOp ( ERigVMOpCode InOpCode,
uint16 InInstructionIndex
)

 Adds an absolute, forward or backward jump operator
Public function uint64

AddJumpToBranchOp ( FRigVMOperand InBranchNameArg,
int32 InFirstBranchInfoIndex
)

 Adds a jump to branch operator
Public function uint64

AddNotEqualsOp ( const FRigVMOperand& InA,
const FRigVMOperand& InB,
const FRigVMOperand& InResult
)

 Adds an not-equals operator to store the comparison result of A and B into a Result argument
Public function int32

AddPredicateBranch ( const FRigVMPredicateBranch& InPredicateBranch
)

 Adds information about a predicate branch for an instruction
Public function uint64

AddTrueOp ( const FRigVMOperand& InArg
)

 Adds a true operator to set a given argument to true
Public function uint64

AddZeroOp ( const FRigVMOperand& InArg
)

 Adds a zero operator to zero the memory of a given argument
Public function Const FString  
Public function void

Empty ()

 Resets the container and removes all memory
Public function Const int32

FindEntryIndex ( const FName& InEntryName
)

 Returns the index of an entry given a name or INDEX_NONE
Public function Const TArray< int32 >

GetAllInstructionIndicesForCallPath ( const FString& InCallPath,
bool bStartsWith,
bool bEndsWith
)

 Returns all found instruction indices for a given callpath
Public function Const const TArray< int32 > & Returns all found instruction indices for a given callpath
Public function Const const TArray< int32 > & Returns all found instruction indices for a given subject
Public function Const const TArrayView< const uint8 > Returns the raw data of the byte code
Public function Const uint32 Returns a unique hash identifying this bytecode
Public function Const FString

GetCallPathForInstruction ( int32 InInstructionIndex
)

 Returns the callpath which was used to inject a given instruction
Public function Const const TArray< UObject * > *

GetCallstackForInstruction ( int32 InInstructionIndex
)

 Returns the callstack which was used to inject a given instruction
Public function Static uint32

GetCallstackHash ( const TArrayView< UObject*const >& InCallstack
)

 Computes a hash for a given callstack
Public function Static uint32

GetCallstackHash ( const TArray< UObject* >& InCallstack
)

 Computes a hash for a given callstack
Public function Const uint32

GetCallstackHashForInstruction ( int32 InInstructionIndex
)

 Returns the callstack hash which was used to inject a given instruction
Public function Const const FRigVMByteCodeEntry &

GetEntry ( int32 InEntryIndex
)

 Returns the entry with a given index
Public function Const int32

GetFirstInstructionIndexForCallPath ( const FString& InCallPath,
bool bStartsWith,
bool bEndsWith
)

 Returns the first hit instruction index for a given callpath (or INDEX_NONE)
Public function Const int32 Returns the first hit instruction index for a given callpath (or INDEX_NONE)
Public function Const int32 Returns the first hit instruction index for a given subject (or INDEX_NONE)
Public function Const uint64

GetFirstOperandByteIndex ( const FRigVMInstruction& InInstruction
)

 Returns the byte index of the first operand for this instructions
Public function Const FRigVMOperandArray

GetInputOperands ( int32 InInstructionIndex
)

 Returns the input operands of a given instruction
Public function Const FRigVMInstructionArray Returns an instruction array for iterating over all operators
Public function Const TArray< int32 > Returns all of the operands for a given instruction
Public function Const int32 Returns the number of instructions within this byte code
Public function Const uint64 Returns the alignment for an operator given its opcode
Public function OpType &

GetOpAt ( const FRigVMInstruction& InInstruction
)

 Returns an operator for a given instruction
Public function Const const OpType &

GetOpAt ( const FRigVMInstruction& InInstruction
)

 Returns an operator for a given instruction
Public function Const const OpType &

GetOpAt ( uint64 InByteCodeIndex
)

 Returns an operator at a given byte code index
Public function OpType &

GetOpAt ( uint64 InByteCodeIndex
)

 Returns an operator at a given byte code index
Public function Const ERigVMOpCode

GetOpCodeAt ( uint64 InByteCodeIndex
)

 Returns the opcode at a given byte index
Public function Const uint64 Returns the alignment for an operand
Public function Const FRigVMOperandArray

GetOperandsAt ( uint64 InByteCodeIndex,
uint16 InArgumentCount
)

 Returns a list of operands at a given byte code index
Public function Const FRigVMOperandArray

GetOperandsForExecuteOp ( const FRigVMInstruction& InInstruction
)

 Returns the operands for a given execute instruction
Public function Const FRigVMOperandArray

GetOperandsForOp ( const FRigVMInstruction& InInstruction
)

 Returns all of the operands for a given instruction
Public function Const uint32

GetOperatorHash ( const FRigVMInstruction& InInstruction
)

 Returns a unique hash for an operator at a given instruction index
Public function Const uint64

GetOpNumBytesAt ( uint64 InByteCodeIndex,
bool bIncludeOperands
)

 Returns the size of the operator in bytes at a given byte index
Public function Const FRigVMOperandArray

GetOutputOperands ( int32 InInstructionIndex
)

 Returns the output operands of a given instruction
Public function Const FRigVMByteCodeStatistics Returns the statistics information
Public function Const UObject *

GetSubjectForInstruction ( int32 InInstructionIndex
)

 Returns the subject which was used to inject a given instruction
Public function uint64

InlineFunction ( const FRigVMByteCode* FunctionByteCode,
const FRigVMOperandArray& InOperands
)

 Adds an execute operator given its function index operands
Public function Const bool

IsOperandShared ( const FRigVMOperand& InOperand
)

 Returns true if the operator in question is used by multiple instructions
Public function void

Load ( FArchive& Ar
)

  
Public function Const uint64

Num ()

 Returns the number of instructions in this container
Public function Const uint64 Returns the number of entries
Public function void

Reset ()

 Resets the container and maintains all memory
Public function Const void

Save ( FArchive& Ar
)

  
Public function void  
Public function void

SetOperandsForInstruction ( int32 InInstructionIndex,
const FRigVMOperandArray& InputOperands,
const FRigVMOperandArray& OutputOperands
)

  

Operators

  Type Name Description
Public function Const const uint8 &

operator[] ( int32 InIndex
)

 Const accessor for a byte given its index

Constants

Name Description
EmptyInstructionIndices  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page