Navigation
API > API/Plugins > API/Plugins/RigVMDeveloper
The Variable Node represents a mutable value / local state within the the Function / Graph. Variable Node's can be a getter or a setter. Getters are pure nodes with just an output value pin, while setters are mutable nodes with an execute and input value pin.
| Name | URigVMVariableNode |
| Type | class |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMModel/Nodes/RigVMVariableNode.h |
| Include Path | #include "RigVMModel/Nodes/RigVMVariableNode.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class URigVMVariableNode : public URigVMNode
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → URigVMNode → URigVMVariableNode
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
URigVMVariableNode() |
Default constructor. | RigVMModel/Nodes/RigVMVariableNode.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ValueName | const TCHAR * | RigVMModel/Nodes/RigVMVariableNode.h | |
| VariableName | const TCHAR * | RigVMModel/Nodes/RigVMVariableNode.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString GetCPPType() |
Returns the C++ data type of the variable. | RigVMModel/Nodes/RigVMVariableNode.h |
|
UObject * GetCPPTypeObject() |
Returns the C++ data type struct of the variable (or nullptr) | RigVMModel/Nodes/RigVMVariableNode.h |
|
FString GetDefaultValue() |
Returns the default value of the variable as a string. | RigVMModel/Nodes/RigVMVariableNode.h |
|
URigVMPin * GetValuePin() |
Get the value pin. | RigVMModel/Nodes/RigVMVariableNode.h | |
FRigVMGraphVariableDescription GetVariableDescription() |
Returns this variable node's variable description. | RigVMModel/Nodes/RigVMVariableNode.h |
|
FName GetVariableName() |
Returns the name of the variable. | RigVMModel/Nodes/RigVMVariableNode.h |
|
URigVMPin * GetVariableNamePin() |
Get the variable name pin. | RigVMModel/Nodes/RigVMVariableNode.h | |
bool IsExternalVariable() |
Returns true if this variable is an external variable. | RigVMModel/Nodes/RigVMVariableNode.h |
|
bool IsGetter() |
Returns true if this node is a variable getter. | RigVMModel/Nodes/RigVMVariableNode.h |
|
bool IsInputArgument() |
Returns true if this variable is an input argument. | RigVMModel/Nodes/RigVMVariableNode.h |
|
bool IsLocalVariable() |
Returns true if this variable is a local variable. | RigVMModel/Nodes/RigVMVariableNode.h |
|
Overridden from URigVMNode
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FLinearColor GetNodeColor() |
Override of node title. | RigVMModel/Nodes/RigVMVariableNode.h | |
virtual FString GetNodeSubTitle() |
Get the subtitle of the node. | RigVMModel/Nodes/RigVMVariableNode.h | |
virtual FString GetNodeTitle() |
Override of node title. | RigVMModel/Nodes/RigVMVariableNode.h | |
virtual bool IsDefinedAsVarying() |
Returns true if the node is defined as non-varying. | RigVMModel/Nodes/RigVMVariableNode.h |