Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Developer > RigVMDeveloper > RigVMModel > Nodes > URigVMStructNode

Light Theme

Dark Theme

URigVMStructNode

The Struct Node represents a Function Invocation of a RIGVM_METHOD declared on a USTRUCT.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

URigVMNode

URigVMStructNode

References

Module	RigVMDeveloper
Header	/Engine/Source/Developer/RigVMDeveloper/Public/RigVMModel/Nodes/RigVMStructNode.h
Include	#include "RigVMModel/Nodes/RigVMStructNode.h"

Syntax

class URigVMStructNode : public URigVMNode

Remarks

The Struct Node represents a Function Invocation of a RIGVM_METHOD declared on a USTRUCT. Struct Nodes have input / output pins for all struct UPROPERTY members.

Functions

	Name	Description
TSharedPtr< ...	ConstructStructInstance ( bool bUseDefault )	Returns an instance of the struct with the current values.
FString	GetDeprecatedMetadata()
FName	GetMethodName()	Returns the name of the declared RIGVM_METHOD.
UScriptStruc...	GetScriptStruct()	Returns the UStruct for this struct node (the struct declaring the RIGVM_METHOD)
FString	GetStructDefaultValue()	Returns the default value for the struct as text.
bool	IsDeprecated()
bool	IsLoopNode()	Return true if this node is a loop node

Overridden from URigVMNode

	Name	Description
FName	GetEventName()	Returns the name of the event.
FString	GetNodeTitle()	Override node functions.
int32	GetNumSlicesForContext ( const FName& InContextName, const FRigVMUserDataArray& InUserD... )	Returns the number of slices for a given context.
FName	GetSliceContextForPin ( URigVMPin* InRootPin, const FRigVMUserDataArray& InUserD... )	Returns the name of the slice context for a pin.
FText	GetToolTipText()	Returns the tooltip of this node.
FText	GetToolTipTextForPin ( const URigVMPin* InPin )
bool	IsDefinedAsConstant()	Returns true if the node is defined as non-varying.
bool	IsDefinedAsVarying()	Returns true if the node is defined as non-varying.

Constants

Name	Description
LoopSliceContextName

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss