Navigation
API > API/Plugins > API/Plugins/RigVM
The RigVMParameter define an input or output of the RigVM. Parameters are mapped to work state memory registers and can be used to set input parameters as well as retrieve output parameters.
| Name | FRigVMParameter |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVM.h |
| Include Path | #include "RigVMCore/RigVM.h" |
Syntax
USTRUCT (BlueprintType )
struct FRigVMParameter
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| RigVMCore/RigVM.h | |||
FRigVMParameter
(
ERigVMParameterType InType, |
RigVMCore/RigVM.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CPPType | FString | RigVMCore/RigVM.h | ||
| Name | FName | RigVMCore/RigVM.h | ||
| RegisterIndex | int32 | RigVMCore/RigVM.h | ||
| ScriptStruct | TObjectPtr< UScriptStruct > | RigVMCore/RigVM.h |
|
|
| ScriptStructPath | FName | RigVMCore/RigVM.h | ||
| Type | ERigVMParameterType | RigVMCore/RigVM.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString GetCPPType() |
Returns the cpp type of the parameter | RigVMCore/RigVM.h | |
const FName & GetName() |
Returns the name of this parameters | RigVMCore/RigVM.h | |
int32 GetRegisterIndex() |
Returns the register index of this parameter in the work memory | RigVMCore/RigVM.h | |
UScriptStruct * GetScriptStruct() |
Returns the script struct used by this parameter (in case it is a struct) | RigVMCore/RigVM.h | |
ERigVMParameterType GetType() |
Returns the type of this parameter | RigVMCore/RigVM.h | |
bool IsValid() |
Returns true if the parameter is valid | RigVMCore/RigVM.h | |
void Load
(
FArchive& Ar |
RigVMCore/RigVM.h | ||
void Save
(
FArchive& Ar |
RigVMCore/RigVM.h | ||
void Serialize
(
FArchive& Ar |
RigVMCore/RigVM.h |