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 > Runtime > Engine > Engine > USCS_Node

Light Theme

Dark Theme

USCS_Node

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USCS_Node

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Engine/SCS_Node.h
Include	#include "Engine/SCS_Node.h"

Syntax

class USCS_Node : public UObject

Variables

	Name	Description
FName	AttachToName	Socket/Bone that Node might attach to
bool	bIsParentComponentNative	If the node is parented, this indicates whether or not the template is found in the CDO's Components array
FText	CategoryName	If non-None, the assigned category name
TArray< class U...	ChildNodes	Set of child nodes
UClass *	ComponentClass	Component class
UActorComponent...	ComponentTemplate	Template for the component to create
FBlueprintCooke...	CookedComponentInstancingData	Cached data for faster runtime instancing (only used in cooked builds)
TWeakObjectPtr<...	EditorComponentInstance	The scene component constructed for component editing in the SCS editor
TArray< struct ...	MetaDataArray	Metadata information for this Node
FName	ParentComponentOrVariableName	Component template or variable that Node might be parented to
FName	ParentComponentOwnerClassName	If the node is attached to another node inherited from a parent Blueprint, this contains the name of the Blueprint parent class that owns the component template
FGuid	VariableGuid

Constructors

	Name	Description
	USCS_Node ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddChildNode ( USCS_Node* InNode, bool bAddToAllNodes )	Adds the given node as a child node
UActorCompon...	ExecuteNodeOnActor ( AActor* Actor, USceneComponent* ParentCompone..., const FTransform* RootTransfor..., const FRotationConversionCache*..., bool bIsDefaultTransform )	Create the specified component on the actor, then call action on children
int32	FindMetaDataEntryIndexForKey ( FName Key )	Find the index in the array of a SCS_Node entry
UActorCompon...	GetActualComponentTemplate ( UBlueprintGeneratedClass* Actu... )	Return the actual component template used in the BPGC. The template can be overridden in a child.
const FBluep...	GetActualComponentTemplateData ( UBlueprintGeneratedClass* Actu... )	Return component template instancing data if cooked for the BPGC, as overridden template data can be cooked out for a child.
TArray< cons...	GetAllNodes()	Returns an array containing this node and all children below it
TArray< USCS...	GetAllNodes()	Returns an array containing this node and all children below it
const TArray...	GetChildNodes()	Returns an constant reference to the child nodes array of this node
const FStrin...	GetMetaData ( FName Key )	Gets a metadata value on the SCS_Node; asserts if the value isn't present.
USceneCompon...	GetParentComponentTemplate ( UBlueprintGeneratedClass* BPGC )	Finds and returns the parent component template through the given BPGC
USceneCompon...	GetParentComponentTemplate ( UBlueprint* InBlueprint )	Finds and returns the parent component template through the given Blueprint
USimpleConst...	GetSCS()	Get the SimpleConstructionScript that owns this node
FName	GetVariableName()	Get name of the variable we should create for this component instance
bool	IsChildOf ( USCS_Node* TestParent )	See if this node is a child of the supplied parent
bool	IsRootNode()	See if this node is the root
void	MoveChildNodes ( USCS_Node* SourceNode, int32 InsertLocation )	Moves a list of nodes from their current list to this node's ChildNode list
void	NameWasModified()	Signal back to the SCS that variable name was modified by an external part of program
void	PreloadChain()	Preloads the node, and all its child nodes recursively
void	RemoveChildNode ( USCS_Node* InNode, bool bRemoveFromAllNodes )	Removes the child node at the given index
void	RemoveChildNodeAt ( int32 ChildIndex, bool bRemoveFromAllNodes )	Removes the child node at the given index
void	RemoveMetaData ( FName Key )	Clear metadata value on the SCS_Node
void	RenameComponentTemplate ( UActorComponent* ComponentTemp..., const FName& NewName )	Helper method to rename the given component template along with any instances
void	SaveToTransactionBuffer()	Saves the current state of SimpleConstructionScript and its nodes to the transaction buffer.
void	SetMetaData ( FName Key, FString Value )	Set a metadata value on the SCS_Node
void	SetOnNameChanged ( const FSCSNodeNameChanged& OnChang... )	Set delegate to call when name is modified externally
void	SetParent ( USCS_Node* InParentNode )	Sets parent component attributes based on the given SCS node
void	SetParent ( const USceneComponent* InParen... )	Sets parent component attributes based on the given component instance
void	SetVariableName ( const FName& NewName, bool bRenameTemplate )	Set name of the variable we should create for this component instance
void	ValidateGuid()	Make sure, the guid is proper - backward compatibility

Overridden from UObject

	Name	Description
EDataValidat...	IsDataValid ( TArray< FText >& ValidationErrors )	Returns Valid if this object has data validation rules set up for it and the data for this object is valid.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

	Name	Description
bool	bIsNative_DEPRECATED	(DEPRECATED) Indicates if this is a native component or not
bool	bVariableNameAutoGenerated_DEPRECATED	(DEPRECATED) If true, the variable name was a autogenerated and is not presented to the user
FName	NativeComponentName_DEPRECATED	(DEPRECATED) If this is a native component, this is the name of the UActorComponent

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

Take our survey

Dismiss