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

Light Theme

Dark Theme

FWorldTreeItem

A tree item that represents an entire world

Windows

MacOS

Linux

Inheritance Hierarchy

IDropTarget

TSharedFromThis

ITreeItem

FWorldTreeItem

References

Module	SceneOutliner
Header	/Engine/Source/Editor/SceneOutliner/Public/WorldTreeItem.h
Include	#include "WorldTreeItem.h"

Syntax

struct FWorldTreeItem : public SceneOutliner::ITreeItem

Remarks

A tree item that represents an entire world

Variables

		Name	Description
	const FObjectKe...	ID	Constant identifier for this tree item
	TWeakObjectPtr<...	World	The world this tree item is associated with.

Constructors

	Name	Description
	FWorldTreeItem ( UWorld* InWorld )	Construct this item from a world

Functions

		Name	Description
	FString	GetWorldName()	Get just the name of the world, for tooltip use
	void	OpenWorldSettings()	Open the world settings for the contained world

Overridden from ITreeItem

	Name	Description
bool	CanInteract()	Check whether it should be possible to interact with this tree item
FTreeItemPtr	CreateParent()	Create this item's parent. Always returns nullptr.
FTreeItemPtr	FindParent ( const FTreeItemMap& ExistingItems )	Get this item's parent item. Always returns nullptr.
void	GenerateContextMenu ( UToolMenu* Menu, SSceneOutliner& Outliner )	Generate a context menu for this item. Only called if only this item is selected.
FString	GetDisplayString()	Get the raw string to display for this tree item - used for sorting
FTreeItemID	GetID()	Get the ID that represents this tree item. Used to reference this item in a map
int32	GetTypeSortPriority()	Get the sort priority given to this item's type
void	PopulateDragDropPayload ( FDragDropPayload& Payload )	Populate the specified drag/drop payload with any relevant information for this type
void	Visit ( const ITreeItemVisitor& Visitor )	Visit this tree item
void	Visit ( const IMutableTreeItemVisitor& Vis... )

Overridden from IDropTarget

		Name	Description
	void	OnDrop ( FDragDropPayload& DraggedObjects, UWorld& World, const FDragValidationInfo& Validat..., TSharedRef< SWidget > DroppedOnWidg... )	Called to drop the specified objects on this item.
	FDragValidat...	ValidateDrop ( FDragDropPayload& DraggedObjects, UWorld& World )	Called to test whether the specified payload can be dropped onto this tree item

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

Take our survey

Dismiss