1. Epic GamesDeveloper
  3. FSCSEditorTreeNode

FSCSEditorTreeNode

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

API > API/Editor > API/Editor/Kismet

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 nodes displayed in the SCS (Simple Construction Script) editor tree widget.

Variables

  Type Name Description
Protected variable TUniquePtr< FScopedTransaction > OngoingCreateTransaction Scope the creation of a node which ends when the initial 'name' is given/accepted by the user, which can be several frames after the node was actually created.

Constructors

  Type Name Description
Public function   Constructs an empty tree node.

Destructors

  Type Name Description
Public function Virtual   Destructor.

Functions

  Type Name Description
Public function FSCSEditorTreeNodePtrType

AddChild ( USCS_Node* InSCSNode,
bool bIsInheritedSCS
)

 Adds a child node for the given SCS node.
Public function Virtual void

AddChild ( FSCSEditorTreeNodePtrType InChildNodePtr
)

 Adds the given node as a child node.
Public function FSCSEditorTreeNodePtrType

AddChildFromComponent ( UActorComponent* InComponentTemplate
)

 Adds a child node for the given component template.
Protected function void Used to update the EFilteredState::ChildMatches flag for parent nodes, when this item's filtration state has changed
Public function Virtual Const bool  
Public function Virtual Const bool

CanEdit ()

  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function void Ends the 'Create + enter initial name' transaction of this node.
Public function Static FSCSEditorTreeNodePtrType Creates the correct type of node based on the component (instanced or not, etc...)
Public function Const FSCSEditorTreeNodePtrType

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 FSCSEditorTreeNodePtrType

FindChild ( const UActorComponent* InComponentTemplate,
bool bRecursiveSearch,
uint32* OutDepth
)

 Attempts to find a reference to the child node that matches the given component template.
Public function Const FSCSEditorTreeNodePtrType

FindChild ( const FName& InVariableOrInstanceName,
bool bRecursiveSearch,
uint32* OutDepth
)

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

FindClosestParent ( TArray< FSCSEditorTreeNodePtrType > InNodes
)

 Finds the closest ancestor node in the given node set.
Public function Virtual Const UActorComponent * Finds the component instance represented by this node contained within a given Actor instance.
Public function Static USCS_Node *

FindSCSNodeForInstance ( const UActorComponent* InstanceComponent,
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 FSCSEditorActorNodePtrType  
Public function Const UBlueprint *  
Public function Virtual FSCSEditorChildActorNodePtrType Returns the associated child actor node if applicable to this node type.
Public function Const const TArray< FSCSEditorTreeNodePtrType > &  
Public function Const UActorComponent *

GetComponentTemplate ( bool bEvenIfPendingKill
)

 Deliberately non-virtual, for performance reasons.
Public function Virtual Const FText  
Public function Virtual Const FString  
Public function Const T * May not be the same as the value returned by GetObject().
Protected function Const T * 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.
Public function Virtual Const FName  
Public function Const ENodeType  
Public function Const const T *

GetObject ( bool bEvenIfPendingKill
)

 Deliberately non-virtual, for performance reasons.
Public function Const UActorComponent * Derived classes should override GetOrCreateEditableObjectForBlueprint().
Protected function Virtual Const UObject * Derived classes can override to create and/or return a reference to an alternate editable object.
Public function Const FSCSEditorTreeNodePtrType  
Public function Virtual Const USCS_Node *  
Public function Virtual Const FName  
Public function Const bool  
Public function Const bool

IsAttachedTo ( FSCSEditorTreeNodePtrType InNodePtr
)

  
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool  
Public function Const bool

IsDirectlyAttachedTo ( FSCSEditorTreeNodePtrType InNodePtr
)

  
Public function Virtual Const bool Query that determines if this item should be filtered out or not
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool

MatchesFilterType ( const UClass* InFilterType
)

 Returns whether the node will match the given type (for filtering)
Public function Virtual void

OnCompleteRename ( const FText& InNewName
)

 Renames the object or variable represented by this node
Public function void

OnRequestRename ( TUniquePtr< FScopedTransaction > OngoingCreateTransaction
)

 Requests a rename on the node.
Protected function void

RefreshCachedChildFilterState ( bool bUpdateParent
)

 Updates the EFilteredState::ChildMatches flag, based off of children's current state
Public function Virtual bool

RefreshFilteredState ( const UClass* InFilterType,
const TArray< FString >& InFilterTerms,
bool bRecursive
)

 Refreshes this item's filtration state. Set bRecursive to 'true' to refresh any child nodes as well
Public function Virtual void

RemoveChild ( FSCSEditorTreeNodePtrType InChildNodePtr
)

 Removes the given node from the list of child nodes.
Protected function Virtual void Called when this node is being removed via a RemoveChild call.
Public function void

SetActorRootNode ( FSCSEditorActorNodePtrType InActorNode
)

 Sets the actor root to the given node for this node along with any children.
Protected function void

SetCachedFilterState ( bool bMatchesFilter,
bool bUpdateParent
)

 Sets this item's filtration state.
Public function void

SetObject ( UObject* InObject
)

 Sets the internal object instance represented by this node.
Public function void Sets up the delegate for a rename operation

Enums

  Type Name Description
Private enum EFilteredState    
Public enum ENodeType    

Typedefs

Name Description
FOnRenameRequested Delegate for when the context menu requests a rename

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page