1. Epic GamesDeveloper
  3. FActorFolders

FActorFolders

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

Unreal Engine C++ API Reference > Editor > UnrealEd

Inheritance Hierarchy

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Public/EditorActorFolders.h
Include #include "EditorActorFolders.h"

Syntax

struct FActorFolders :  
    public FGCObject,  
    public IActorEditorContextClient

Remarks

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

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function bool

ContainsFolder ( UWorld& InWorld,
const FFolder& InFolder
)

 Return if folder exists
Public function bool

CreateFolder ( UWorld& InWorld,
const FFolder& InFolder
)

 Create a new folder in the specified world, of the specified path
Public function void

CreateFolderContainingSelection ( UWorld& InWorld,
const FFolder& InFolder
)

 Same as CreateFolder, but moves the current actor selection into the new folder as well
Public function void

DeleteFolder ( UWorld& InWorld,
const FFolder& InFolderToDelete
)

 Delete the specified folder in the world
Public function Static void

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

 Apply an operation to each actor desc in the given list of folders.
Public function 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.
Public function Static void

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

 Apply an operation to each actor in the given list of folders.
Public function void

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

 Iterate on all folders of a world and pass it to the provided operation.
Public function 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.
Public function Static FActorFolders &

Get ()

 Singleton access
Public function Static FFolder

GetActorDescFolder ( UWorld& InWorld,
const FWorldPartitionActorDesc* InActorDesc
)

  
Public function Const FFolder

GetActorEditorContextFolder ( UWorld& InWorld,
bool bMustMatchCurrentLevel
)

  
Public function Static void

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

 Get an array of actors from a list of folders
Public function 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
Public function FFolder

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

 Get a new default folder name that would apply to the current selection
Public function FFolder

GetDefaultFolderName ( UWorld& InWorld,
const FFolder& InParentFolder
)

 Get a default folder name under the specified parent path
Public function FFolder

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

 Get folder name that is unique under specified parent path
Public function FActorFolderProps *

GetFolderProperties ( UWorld& InWorld,
const FFolder& InFolder
)

 Get the folder properties for the specified path. Returns nullptr if no properties exist
Public function 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
Public function Static void

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

 Get an array of weak actor pointers from a list of folders
Public function bool

IsFolderExpanded ( UWorld& InWorld,
const FFolder& InFolder
)

 Return the folder expansion state
Public function Const bool Tests whether a folder container exists for the specified world
Public function void

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

 Notify that a root object has been removed. Cleanup of existing folders with with root object.
Public function bool

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

 Rename the specified path to a new name
Public function void

SetActorEditorContextFolder ( UWorld& InWorld,
const FFolder& InFolder
)

  
Public function void

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

 Set the folder expansion state
Public function Const void

SetSelectedFolderPath ( const FFolder& InFolder
)

 Sets the folder path for all the selected actors

Overridden from FGCObject

  Type Name Description
Public function Virtual void Pure virtual that must be overloaded by the inheriting class.
Public function Virtual Const FString Overload this method to report a name for your referencer

Overridden from IActorEditorContextClient

  Type Name Description
Public function Virtual Const bool

CanResetContext ( UWorld* InWorld
)

  
Public function Virtual Const bool  
Public function Virtual Const TSharedRef< SWidget >  
Public function Virtual FOnActorEditorContextClientChanged &  
Public function Virtual void

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

  

Constants

Name Description
OnFolderCreate  
OnFolderCreated Folder creation and deletion events. Called whenever a folder is created or deleted in a world.
OnFolderDelete  
OnFolderDeleted  
OnFolderMove  
OnFolderMoved  

Deprecated Functions

  Type Name Description
Public function void

CreateFolder ( UWorld& InWorld,
FName Path
)

 CreateFolder using FName has been deprecated. Please use new interface using FFolder.
Public function void CreateFolderContainingSelection using FName has been deprecated. Please use new interface using FFolder.
Public function void

DeleteFolder ( UWorld& InWorld,
FName FolderToDelete
)

 DeleteFolder using FName has been deprecated. Please use new interface using FFolder.
Public function FName

GetDefaultFolderName ( UWorld& InWorld,
FName ParentPath
)

 GetDefaultFolderName using FName has been deprecated. Please use new interface using FFolder.
Public function FName GetDefaultFolderNameForSelection using FName has been deprecated. Please use new interface using FFolder.
Public function FName

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

 GetFolderName using FName has been deprecated. Please use new interface using FFolder.
Public function FActorFolderProps *

GetFolderProperties ( UWorld& InWorld,
FName InPath
)

 GetFolderProperties using FName has been deprecated. Please use new interface using FFolder.
Public function bool

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

 RenameFolderInWorld using FName has been deprecated. Please use new interface using FFolder.
Public function Const void SetSelectedFolderPath using FName has been deprecated. Please use new interface using FFolder.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page