1. Epic GamesDeveloper
  3. FActorFolders

FActorFolders

Class responsible for managing an in-memory representation of actor folders in the editor

API > API/Editor > API/Editor/UnrealEd

Class responsible for managing an in-memory representation of actor folders in the editor

   
Name FActorFolders
Type struct
Header File /Engine/Source/Editor/UnrealEd/Public/EditorActorFolders.h
Include Path #include "EditorActorFolders.h"

Syntax

struct FActorFolders :  
    public FGCObject ,  
    public IActorEditorContextClient

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FActorFolders()

   EditorActorFolders.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FActorFolders()

   EditorActorFolders.h  

Constants

Name Type Remarks Include Path
OnFolderCreate FOnActorFolderCreate   EditorActorFolders.h
OnFolderCreated FOnActorFolderCreated Folder creation and deletion events. Called whenever a folder is created or deleted in a world. EditorActorFolders.h
OnFolderDelete FOnActorFolderDelete   EditorActorFolders.h
OnFolderDeleted FOnActorFolderDeleted   EditorActorFolders.h
OnFolderMove FOnActorFolderMove   EditorActorFolders.h
OnFolderMoved FOnActorFolderMoved   EditorActorFolders.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActorEditorContextClientChanged FOnActorEditorContextClientChanged Delegate used to notify changes to ActorEditorContextSubsystem EditorActorFolders.h  
bAnyLevelsChanged bool   EditorActorFolders.h  
UWorldFolders friend   EditorActorFolders.h  
WorldFolders TMap< TWeakObjectPtr< UWorld >, TObjectPtr< UWorldFolders > > Transient map of folders, keyed on world pointer EditorActorFolders.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ContainsFolder ( UWorld& InWorld,
const FFolder& InFolder
)

 Return if folder exists EditorActorFolders.h  

bool CreateFolder ( UWorld& InWorld,
const FFolder& InFolder
)

 Create a new folder in the specified world, of the specified path EditorActorFolders.h  

void CreateFolder ( UWorld& InWorld,
FName Path
)

   EditorActorFolders.h  

void CreateFolderContainingSelection ( UWorld& InWorld,
const FFolder& InFolder
)

 Same as CreateFolder, but moves the current actor selection into the new folder as well EditorActorFolders.h  

void CreateFolderContainingSelection ( UWorld& InWorld,
FName Path
)

   EditorActorFolders.h  

void DeleteFolder ( UWorld& InWorld,
FName FolderToDelete
)

   EditorActorFolders.h  

void DeleteFolder ( UWorld& InWorld,
const FFolder& InFolderToDelete
)

 Delete the specified folder in the world EditorActorFolders.h  

void ForEachFolder ( UWorld& InWorld,
TFunctionRef< bool(const FFolder&)> Operation
)

 Iterate on all folders of a world and pass it to the provided operation. EditorActorFolders.h  

void ForEachFolderWithRootObject ( UWorld& InWorld,
const FFolder::FRootObject& InFolderRootObject,
TFunctionRef< bool(const FFolder&)> Operation
)

 Iterate on all world's folders with the given root object and pass it to the provided operation. EditorActorFolders.h  

FFolder GetActorEditorContextFolder ( UWorld& InWorld,
bool bMustMatchCurrentLevel
) const

   EditorActorFolders.h  

FFolder GetDefaultFolderForSelection ( UWorld& InWorld,
TArray< FFolder >* InSelectedFolders
)

 Get a new default folder name that would apply to the current selection EditorActorFolders.h  

FFolder GetDefaultFolderName ( UWorld& InWorld,
const FFolder& InParentFolder
)

 Get a default folder name under the specified parent path EditorActorFolders.h  

FName GetDefaultFolderName ( UWorld& InWorld,
FName ParentPath
)

   EditorActorFolders.h  

FName GetDefaultFolderNameForSelection ( UWorld& InWorld
)

   EditorActorFolders.h  

FFolder GetFolderName ( UWorld& InWorld,
const FFolder& InParentFolder,
const FName& InLeafName
)

 Get folder name that is unique under specified parent path EditorActorFolders.h  

FName GetFolderName ( UWorld& InWorld,
FName ParentPath,
FName FolderName
)

   EditorActorFolders.h  

FActorFolderProps * GetFolderProperties ( UWorld& InWorld,
const FFolder& InFolder
)

 Get the folder properties for the specified path. Returns nullptr if no properties exist EditorActorFolders.h  
  EditorActorFolders.h  

bool IsFolderExpanded ( UWorld& InWorld,
const FFolder& InFolder
)

 Return the folder expansion state EditorActorFolders.h  

bool IsInitializedForWorld ( UWorld& InWorld
) const

 Tests whether a folder container exists for the specified world EditorActorFolders.h  

void OnFolderRootObjectRemoved ( UWorld& InWorld,
const FFolder::FRootObject& InFolderRootObject
)

 Notify that a root object has been removed. Cleanup of existing folders with with root object. EditorActorFolders.h  

bool RenameFolderInWorld ( UWorld& World,
FName OldPath,
FName NewPath
)

   EditorActorFolders.h  

bool RenameFolderInWorld ( UWorld& InWorld,
const FFolder& OldPath,
const FFolder& NewPath
)

 Rename the specified path to a new name EditorActorFolders.h  

void SetActorEditorContextFolder ( UWorld& InWorld,
const FFolder& InFolder
)

   EditorActorFolders.h  

void SetIsFolderExpanded ( UWorld& InWorld,
const FFolder& InFolder,
bool bIsExpanded
)

 Set the folder expansion state EditorActorFolders.h  

void SetSelectedFolderPath ( FName Path
) const

   EditorActorFolders.h  

void SetSelectedFolderPath ( const FFolder& InFolder
) const

 Sets the folder path for all the selected actors EditorActorFolders.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   EditorActorFolders.h  

virtual FString GetReferencerName()

   EditorActorFolders.h  

Overridden from IActorEditorContextClient

Name Remarks Include Path Unreal Specifiers

virtual bool CanResetContext ( UWorld* InWorld
) const

   EditorActorFolders.h  

virtual void CaptureActorEditorContextState ( UWorld* InWorld,
UActorEditorContextStateCollection* InStateCollection
) const

   EditorActorFolders.h  

virtual bool GetActorEditorContextDisplayInfo ( UWorld* InWorld,
FActorEditorContextClientDisplayInfo& OutDiplayInfo
) const

   EditorActorFolders.h  

virtual TSharedRef< SWidget > GetActorEditorContextWidget ( UWorld* InWorld
) const

   EditorActorFolders.h  

virtual FOnActorEditorContextClientChanged & GetOnActorEditorContextClientChanged()

   EditorActorFolders.h  

virtual void OnExecuteActorEditorContextAction ( UWorld* InWorld,
const EActorEditorContextAction& InType,
AActor* InActor
)

   EditorActorFolders.h  

virtual void RestoreActorEditorContextState ( UWorld* InWorld,
const UActorEditorContextStateCollection* InStateCollection
)

   EditorActorFolders.h  

Static

Name Remarks Include Path Unreal Specifiers

static void ForEachActorDescInFolders ( UWorld& InWorld,
const TSet< FName >& InPaths,
TFunctionRef< bool(const FWorldPartitionActorDesc*)> Operation,
const FFolder::FRootObject& InFolderRootObject
)

   EditorActorFolders.h  

static void ForEachActorDescInstanceInFolders ( UWorld& InWorld,
const TSet< FName >& InPaths,
TFunctionRef< bool(const FWorldPartitionActorDescInstance*)> Operation,
const FFolder::FRootObject& InFolderRootObject
)

 Apply an operation to each actor desc in the given list of folders. EditorActorFolders.h  

static void ForEachActorInFolders ( UWorld& InWorld,
const TSet< FName >& InPaths,
TFunctionRef< bool(AActor*)> Operation,
const FFolder::FRootObject& InFolderRootObject
)

   EditorActorFolders.h  

static void ForEachActorInFolders ( UWorld& InWorld,
const TArray< FName >& InPaths,
TFunctionRef< bool(AActor*)> Operation,
const FFolder::FRootObject& InFolderRootObject
)

 Apply an operation to each actor in the given list of folders. EditorActorFolders.h  

static FActorFolders & Get()

 Singleton access EditorActorFolders.h  

static FFolder GetActorDescFolder ( UWorld& InWorld,
const FWorldPartitionActorDesc* InActorDesc
)

   EditorActorFolders.h  

static FFolder GetActorDescInstanceFolder ( UWorld& InWorld,
const FWorldPartitionActorDescInstance* InActorDescInstance
)

   EditorActorFolders.h  

static void GetActorsFromFolders ( UWorld& InWorld,
const TArray< FName >& InPaths,
TArray< AActor* >& OutActors,
const FFolder::FRootObject& InFolderRootObject
)

 Get an array of actors from a list of folders EditorActorFolders.h  

static void GetActorsFromFolders ( UWorld& InWorld,
const TSet< FName >& InPaths,
TArray< AActor* >& OutActors,
const FFolder::FRootObject& InFolderRootObject
)

   EditorActorFolders.h  

static void GetWeakActorsFromFolders ( UWorld& InWorld,
const TArray< FName >& InPaths,
TArray< TWeakObjectPtr< AActor > >& OutActors,
const FFolder::FRootObject& InFolderRootObject
)

 Get an array of weak actor pointers from a list of folders EditorActorFolders.h  

static void GetWeakActorsFromFolders ( UWorld& InWorld,
const TSet< FName >& InPaths,
TArray< TWeakObjectPtr< AActor > >& OutActors,
const FFolder::FRootObject& InFolderRootObject
)

   EditorActorFolders.h  

static FFolder::FRootObject GetWorldFolderRootObject ( UWorld& InWorld
)

   EditorActorFolders.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page