FSCSEditorTreeNode

[FSCSEditorTreeNode](API\Editor\Kismet\FSCSEditorTreeNode)

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Kismet

Header

/Engine/Source/Editor/Kismet/Public/SSCSEditor.h

Include

#include "SSCSEditor.h"

Syntax

class FSCSEditorTreeNode : public TSharedFromThis< FSCSEditorTreeNode >

Remarks

FSCSEditorTreeNode

Wrapper class for component template nodes displayed in the SCS (Simple Construction Script) editor tree widget.

Variables

Name Description

Protected variable

TWeakObjectPtr<...

 

ComponentTemplatePtr

Component template represented by this node, if it's a component node, otherwise invalid.

Protected variable

TUniquePtr< FSc...

 

OngoingCreateTransaction

Scope the creation of a component which ends when the initial component 'name' is given/accepted by the user, which can be several frames after the component was actually created.

Constructors

Name Description

Public function

FSCSEditorTreeNode

(
    FSCSEditorTreeNode::ENodeType InNod...
)

Constructs an empty tree node.

Destructors

Name Description

Public function Virtual

~FSCSEditorTreeNode()

Destructor.

Functions

Name Description

Public function

FSCSEditorTr...

 

AddChild

(
    USCS_Node* InSCSNode,
    bool bIsInheritedSCS
)

Adds a child node for the given SCS node.

Public function Virtual

void

 

AddChild

(
    FSCSEditorTreeNodePtrType InChildNo...
)

Adds the given node as a child node.

Public function

FSCSEditorTr...

 

AddChildFromComponent

(
    UActorComponent* InComponentTe...
)

Adds a child node for the given component template.

Protected function

void

 

ApplyFilteredStateToParent()

Used to update the EFilteredState::ChildMatches flag for parent nodes, when this item's filtration state has changed

Public function Virtual Const

bool

 

CanDelete()

Public function Virtual Const

bool

 

CanEditDefaults()

Public function Virtual Const

bool

 

CanRename()

Public function Virtual Const

bool

 

CanReparent()

Public function Static

FSCSEditorTr...

 

FactoryNodeFromComponent

(
    UActorComponent* InComponent
)

Creates the correct type of node based on the component (instanced or not, etc...)

Public function Const

FSCSEditorTr...

 

FindChild

(
    const USCS_Node* InSCSNode,
    bool bRecursiveSearch,
    uint32* OutDepth
)

Attempts to find a reference to the child node that matches the given SCS node.

Public function Const

FSCSEditorTr...

 

FindChild

(
    const UActorComponent* InCompo...,
    bool bRecursiveSearch,
    uint32* OutDepth
)

Attempts to find a reference to the child node that matches the given component template.

Public function Const

FSCSEditorTr...

 

FindChild

(
    const FName& InVariableOrInstanceN...,
    bool bRecursiveSearch,
    uint32* OutDepth
)

Attempts to find a reference to the child node that matches the given component variable or instance name.

Public function

FSCSEditorTr...

 

FindClosestParent

Finds the closest ancestor node in the given node set.

Public function Virtual Const

UActorCompon...

 

FindComponentInstanceInActor

(
    const AActor* InActor
)

Finds the component instance represented by this node contained within a given Actor instance.

Public function Static

USCS_Node &#...

 

FindSCSNodeForInstance

(
    UActorComponent* InstanceCompo...,
    UClass* ClassToSearch
)

Tries to find a SCS node that was likely responsible for creating the specified instance component. Note: This is not always possible to do!

Public function Const

UBlueprint &...

 

GetBlueprint()

Public function Const

const TArray...

 

GetChildren()

Public function Const

UActorCompon...

 

GetComponentTemplate

(
    bool bEvenIfPendingKill
)

Deliberately non-virtual, for performance reasons.

Public function Virtual Const

FText

 

GetDisplayName()

Public function Virtual Const

FString

 

GetDisplayString()

Public function Virtual Const

FName

 

GetNodeID()

Public function Const

ENodeType

 

GetNodeType()

Public function Virtual Const

UActorCompon...

 

GetOrCreateEditableComponentTemplate

(
    UBlueprint* ActualEditedBluepr...
)

Public function Const

FSCSEditorTr...

 

GetParent()

Public function Virtual Const

USCS_Node &#...

 

GetSCSNode()

Public function Virtual Const

FName

 

GetVariableName()

Public function Const

bool

 

IsAttachedTo

(
    FSCSEditorTreeNodePtrType InNodePtr
)

Public function Virtual Const

bool

 

IsDefaultSceneRoot()

Public function Const

bool

 

IsDirectlyAttachedTo

(
    FSCSEditorTreeNodePtrType InNodePtr
)

Public function Virtual Const

bool

 

IsFlaggedForFiltration()

Query that determines if this item should be filtered out or not

Public function Virtual Const

bool

 

IsInherited()

Public function Virtual Const

bool

 

IsInheritedSCS()

Public function Virtual Const

bool

 

IsInstanced()

Public function Virtual Const

bool

 

IsNative()

Public function Virtual Const

bool

 

IsRootComponent()

Public function Const

bool

 

IsSceneComponent()

Public function Virtual Const

bool

 

IsUserInstanced()

Public function Virtual

void

 

OnCompleteRename

(
    const FText& InNewName
)

Renames the component

Public function

void

 

OnRequestRename

(
    TUniquePtr< FScopedTransaction > On...
)

Requests a rename on the component.

Protected function

void

 

RefreshCachedChildFilterState

(
    bool bUpdateParent
)

Updates the EFilteredState::ChildMatches flag, based off of children's current state

Public function Virtual

void

 

RemoveChild

(
    FSCSEditorTreeNodePtrType InChildNo...
)

Removes the given node from the list of child nodes.

Protected function Virtual

void

 

RemoveMeAsChild()

Called when this node is being removed via a RemoveChild call.

Public function

void

 

SetComponentTemplate

(
    UActorComponent* Component
)

Set the component template represented by this node, if it's a component node.

Public function

void

 

SetRenameRequestedDelegate

(
    FOnRenameRequested InRenameRequeste...
)

Sets up the delegate for renaming a component

Public function

void

 

UpdateCachedFilterState

(
    bool bMatchesFilter,
    bool bUpdateParent
)

Refreshes this item's filtration state.

Enums

Name

Description

Private enum

EFilteredState

Public enum

ENodeType

Typedefs

Name

Description

FOnRenameRequested

Delegate for when the context menu requests a rename

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