Navigation
API > API/Editor > API/Editor/Kismet
Wrapper class for nodes displayed in the SCS (Simple Construction Script) editor tree widget.
| Name | FSCSEditorTreeNode |
| Type | class |
| Header File | /Engine/Source/Editor/Kismet/Public/SSCSEditor.h |
| Include Path | #include "SSCSEditor.h" |
Syntax
class FSCSEditorTreeNode : public TSharedFromThis< FSCSEditorTreeNode >
Inheritance Hierarchy
- TSharedFromThis< FSCSEditorTreeNode > → FSCSEditorTreeNode
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSCSEditorTreeNode
(
FSCSEditorTreeNode::ENodeType InNodeType |
Constructs an empty tree node. | SSCSEditor.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FSCSEditorTreeNode() |
Destructor. | SSCSEditor.h |
Enums
Public
| Name | Remarks |
|---|---|
| ENodeType |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnRenameRequested | TBaseDelegate_NoParams< void > | Delegate for when the context menu requests a rename | SSCSEditor.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActorRootNodePtr | FSCSEditorActorNodePtrType | SSCSEditor.h | ||
| Children | TArray< FSCSEditorTreeNodePtrType > | SSCSEditor.h | ||
| FilterFlags | uint8 | SSCSEditor.h | ||
| NodeType | ENodeType | The type of tree node. | SSCSEditor.h | |
| ParentNodePtr | FSCSEditorTreeNodePtrType | Actual tree structure. | SSCSEditor.h | |
| RenameRequestedDelegate | FOnRenameRequested | Handles rename requests | SSCSEditor.h | |
| WeakObjectPtr | TWeakObjectPtr< UObject > | Weak ptr to the object instance represented by this node (e.g. component template) | SSCSEditor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSCSEditorTreeNodePtrType AddChild
(
USCS_Node* InSCSNode, |
Adds a child node for the given SCS node. | SSCSEditor.h | |
virtual void AddChild
(
FSCSEditorTreeNodePtrType InChildNodePtr |
Adds the given node as a child node. | SSCSEditor.h | |
FSCSEditorTreeNodePtrType AddChildFromComponent
(
UActorComponent* InComponentTemplate |
Adds a child node for the given component template. | SSCSEditor.h | |
virtual bool CanDelete() |
SSCSEditor.h | ||
virtual bool CanEdit() |
SSCSEditor.h | ||
virtual bool CanRename() |
SSCSEditor.h | ||
virtual bool CanReparent() |
SSCSEditor.h | ||
void CloseOngoingCreateTransaction () |
Ends the 'Create + enter initial name' transaction of this node. | SSCSEditor.h | |
FSCSEditorTreeNodePtrType FindChild
(
const USCS_Node* InSCSNode, |
Attempts to find a reference to the child node that matches the given SCS node. | SSCSEditor.h | |
FSCSEditorTreeNodePtrType FindChild
(
const UActorComponent* InComponentTemplate, |
Attempts to find a reference to the child node that matches the given component template. | SSCSEditor.h | |
FSCSEditorTreeNodePtrType FindChild
(
const FName& InVariableOrInstanceName, |
Attempts to find a reference to the child node that matches the given component variable or instance name. | SSCSEditor.h | |
FSCSEditorTreeNodePtrType FindClosestParent
(
TArray< FSCSEditorTreeNodePtrType > InNodes |
Finds the closest ancestor node in the given node set. | SSCSEditor.h | |
virtual UActorComponent * FindComponentInstanceInActor
(
const AActor* InActor |
Finds the component instance represented by this node contained within a given Actor instance. | SSCSEditor.h | |
FSCSEditorActorNodePtrType GetActorRootNode() |
SSCSEditor.h | ||
UBlueprint * GetBlueprint() |
SSCSEditor.h | ||
virtual FSCSEditorChildActorNodePtrType GetChildActorNode() |
Returns the associated child actor node if applicable to this node type. | SSCSEditor.h | |
const TArray< FSCSEditorTreeNodePtrType > & GetChildren() |
SSCSEditor.h | ||
UActorComponent * GetComponentTemplate
(
bool bEvenIfPendingKill |
Deliberately non-virtual, for performance reasons. | SSCSEditor.h | |
virtual FText GetDisplayName() |
SSCSEditor.h | ||
virtual FString GetDisplayString() |
SSCSEditor.h | ||
T * GetEditableObjectForBlueprint
(
UBlueprint* InBlueprint |
May not be the same as the value returned by GetObject(). | SSCSEditor.h | |
virtual FName GetNodeID() |
SSCSEditor.h | ||
ENodeType GetNodeType() |
SSCSEditor.h | ||
const T * GetObject
(
bool bEvenIfPendingKill |
Deliberately non-virtual, for performance reasons. | SSCSEditor.h | |
UActorComponent * GetOrCreateEditableComponentTemplate
(
UBlueprint* ActualEditedBlueprint |
Derived classes should override GetOrCreateEditableObjectForBlueprint(). | SSCSEditor.h | |
FSCSEditorTreeNodePtrType GetParent() |
SSCSEditor.h | ||
virtual USCS_Node * GetSCSNode() |
SSCSEditor.h | ||
virtual FName GetVariableName() |
SSCSEditor.h | ||
bool IsActorNode() |
SSCSEditor.h | ||
bool IsAttachedTo
(
FSCSEditorTreeNodePtrType InNodePtr |
SSCSEditor.h | ||
bool IsBlueprintComponent() |
SSCSEditor.h | ||
bool IsComponentNode() |
SSCSEditor.h | ||
virtual bool IsDefaultSceneRoot() |
SSCSEditor.h | ||
bool IsDirectlyAttachedTo
(
FSCSEditorTreeNodePtrType InNodePtr |
SSCSEditor.h | ||
virtual bool IsFlaggedForFiltration() |
Query that determines if this item should be filtered out or not | SSCSEditor.h | |
virtual bool IsInheritedComponent() |
SSCSEditor.h | ||
virtual bool IsInheritedSCSNode() |
SSCSEditor.h | ||
virtual bool IsInstanced() |
SSCSEditor.h | ||
bool IsInstancedActor() |
SSCSEditor.h | ||
bool IsInstancedComponent() |
SSCSEditor.h | ||
virtual bool IsNativeComponent() |
SSCSEditor.h | ||
virtual bool IsRootComponent() |
SSCSEditor.h | ||
bool IsSceneComponent() |
SSCSEditor.h | ||
virtual bool IsUserInstancedComponent() |
SSCSEditor.h | ||
virtual bool MatchesFilterType
(
const UClass* InFilterType |
Returns whether the node will match the given type (for filtering) | SSCSEditor.h | |
virtual void OnCompleteRename
(
const FText& InNewName |
Renames the object or variable represented by this node | SSCSEditor.h | |
void OnRequestRename
(
TUniquePtr< FScopedTransaction > OngoingCreateTransaction |
Requests a rename on the node. | SSCSEditor.h | |
virtual bool RefreshFilteredState
(
const UClass* InFilterType, |
Refreshes this item's filtration state. Set bRecursive to 'true' to refresh any child nodes as well | SSCSEditor.h | |
virtual void RemoveChild
(
FSCSEditorTreeNodePtrType InChildNodePtr |
Removes the given node from the list of child nodes. | SSCSEditor.h | |
void SetActorRootNode
(
FSCSEditorActorNodePtrType InActorNode |
Sets the actor root to the given node for this node along with any children. | SSCSEditor.h | |
void SetObject
(
UObject* InObject |
Sets the internal object instance represented by this node. | SSCSEditor.h | |
void SetRenameRequestedDelegate
(
FOnRenameRequested InRenameRequested |
Sets up the delegate for a rename operation | SSCSEditor.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ApplyFilteredStateToParent() |
Used to update the EFilteredState::ChildMatches flag for parent nodes, when this item's filtration state has changed | SSCSEditor.h | |
T * GetMutableObject() |
Provides derived classes with non-const access to the object represented by this node (e.g. for rename operations, etc.). This should not be made public. | SSCSEditor.h | |
virtual UObject * GetOrCreateEditableObjectForBlueprint
(
UBlueprint* InBlueprint |
Derived classes can override to create and/or return a reference to an alternate editable object. | SSCSEditor.h | |
void RefreshCachedChildFilterState
(
bool bUpdateParent |
Updates the EFilteredState::ChildMatches flag, based off of children's current state | SSCSEditor.h | |
virtual void RemoveMeAsChild() |
Called when this node is being removed via a RemoveChild call. | SSCSEditor.h | |
void SetCachedFilterState
(
bool bMatchesFilter, |
Sets this item's filtration state. | SSCSEditor.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FSCSEditorTreeNodePtrType FactoryNodeFromComponent
(
UActorComponent* InComponent |
Creates the correct type of node based on the component (instanced or not, etc...) | SSCSEditor.h | |
static USCS_Node * FindSCSNodeForInstance
(
const UActorComponent* InstanceComponent, |
Tries to find a SCS node that was likely responsible for creating the specified instance component. Note: This is not always possible to do! | SSCSEditor.h |