Navigation
API > API/Plugins > API/Plugins/RigVM
The variable description is used to convey information about unique variables within a Graph. Multiple Variable Nodes can share the same variable description.
| Name | FRigVMGraphVariableDescription |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMVariableDescription.h |
| Include Path | #include "RigVMCore/RigVMVariableDescription.h" |
Syntax
USTRUCT (BlueprintType )
struct FRigVMGraphVariableDescription
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bExposedOnSpawn | bool | Should this variable be exposed on spawn. | RigVMCore/RigVMVariableDescription.h |
|
| bExposeToCinematics | bool | Should this variable be exposed on spawn. | RigVMCore/RigVMVariableDescription.h |
|
| bPrivate | bool | This property should soon become deprecated, since it does not make sense for blueprint independent assets Is this variable private | RigVMCore/RigVMVariableDescription.h |
|
| bPublic | bool | Is this variable public. | RigVMCore/RigVMVariableDescription.h |
|
| Category | FText | The category of the variable. | RigVMCore/RigVMVariableDescription.h |
|
| CPPType | FString | The C++ data type of the variable. | RigVMCore/RigVMVariableDescription.h |
|
| CPPTypeObject | TObjectPtr< UObject > | The Struct of the C++ data type of the variable (or nullptr) | RigVMCore/RigVMVariableDescription.h |
|
| CPPTypeObjectPath | FName | RigVMCore/RigVMVariableDescription.h | ||
| DefaultValue | FString | The default value of the variable. | RigVMCore/RigVMVariableDescription.h |
|
| Guid | FGuid | The guid of the variable. | RigVMCore/RigVMVariableDescription.h |
|
| Name | FName | The name of the variable. | RigVMCore/RigVMVariableDescription.h |
|
| Tooltip | FText | The tooltip of the variable. | RigVMCore/RigVMVariableDescription.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| RigVMCore/RigVMVariableDescription.h | |||
FRigVMExternalVariable ToExternalVariable() |
Returns nullptr external variable matching this description. | RigVMCore/RigVMVariableDescription.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator==
(
const FRigVMGraphVariableDescription& Other |
Comparison operator | RigVMCore/RigVMVariableDescription.h |