Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > UnrealEd > FActorFolders

Light Theme

Dark Theme

FActorFolders

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

Windows

MacOS

Linux

Inheritance Hierarchy

FGCObject

FActorFolders

References

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

Syntax

struct FActorFolders : public FGCObject

Remarks

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

Constructors

	Name	Description
	FActorFolders()

Destructors

	Name	Description
	~FActorFolders()

Functions

	Name	Description
void	Cleanup()	Clean up the singleton instance - called on Editor Exit
void	CreateFolder ( UWorld& InWorld, FName Path )	Create a new folder in the specified world, of the specified path
void	CreateFolderContainingSelection ( UWorld& InWorld, FName Path )	Same as CreateFolder, but moves the current actor selection into the new folder as well
void	DeleteFolder ( UWorld& InWorld, FName FolderToDelete )	Delete the specified folder in the world
FActorFolder...	Get()	Singleton access - only valid if IsAvailable()
FName	GetDefaultFolderName ( UWorld& InWorld, FName ParentPath )	Get a default folder name under the specified parent path
FName	GetDefaultFolderNameForSelection ( UWorld& InWorld )	Get a new default folder name that would apply to the current selection
FName	GetFolderName ( UWorld& InWorld, FName ParentPath, FName FolderName )	Get folder name that is unique under specified parent path
FActorFolder...	GetFolderProperties ( UWorld& InWorld, FName InPath )	Get the folder properties for the specified path. Returns nullptr if no properties exist
const TMap< ...	GetFolderPropertiesForWorld ( UWorld& InWorld )	Get a map of folder properties for the specified world (map of folder path -> properties)
void	Init()	Initialize the singleton instance - called on Editor Startup
bool	IsAvailable()	Check whether the singleton is valid
bool	PathIsChildOf ( const FString& InPotentialChild, const FString& InParent )	Check if the specified path is a child of the specified parent
bool	RenameFolderInWorld ( UWorld& World, FName OldPath, FName NewPath )	Rename the specified path to a new name
void	SetSelectedFolderPath ( FName Path )	Sets the folder path for all the selected actors

Overridden from FGCObject

		Name	Description
	void	AddReferencedObjects ( FReferenceCollector& Collector )	Pure virtual that must be overloaded by the inheriting class.
	FString	GetReferencerName()	Use this method to report a name for your referencer.

Constants

Name	Description
OnFolderCreate	Folder creation and deletion events. Called whenever a folder is created or deleted in a world.
OnFolderDelete
OnFolderMove
Singleton	Singleton instance maintained by the editor

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

Take our survey

Dismiss