Navigation
API > API/Plugins > API/Plugins/RigVMDeveloper
Comment Nodes can be used to annotate a Graph by adding colored grouping as well as user provided text. Comment Nodes are purely cosmetic and don't contribute to the runtime result of the Graph / Function.
| Name | URigVMCommentNode |
| Type | class |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMModel/Nodes/RigVMCommentNode.h |
| Include Path | #include "RigVMModel/Nodes/RigVMCommentNode.h" |
Syntax
UCLASS (BlueprintType)
class URigVMCommentNode : public URigVMNode
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → URigVMNode → URigVMCommentNode
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
URigVMCommentNode() |
Default constructor. | RigVMModel/Nodes/RigVMCommentNode.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bBubbleVisible | bool | RigVMModel/Nodes/RigVMCommentNode.h | ||
| bColorBubble | bool | RigVMModel/Nodes/RigVMCommentNode.h | ||
| CommentText | FString | RigVMModel/Nodes/RigVMCommentNode.h | ||
| FontSize | int32 | RigVMModel/Nodes/RigVMCommentNode.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetCommentBubbleVisible() |
Returns the current user provided bubble visibility of this comment. | RigVMModel/Nodes/RigVMCommentNode.h |
|
bool GetCommentColorBubble() |
Returns the current user provided bubble color inheritance of this comment. | RigVMModel/Nodes/RigVMCommentNode.h |
|
int32 GetCommentFontSize() |
Returns the current user provided font size of this comment. | RigVMModel/Nodes/RigVMCommentNode.h |
|
FString GetCommentText() |
Returns the current user provided text of this comment. | RigVMModel/Nodes/RigVMCommentNode.h |
|
Overridden from URigVMNode
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FString GetNodeTitle() |
Override of node title. | RigVMModel/Nodes/RigVMCommentNode.h |