Navigation
API > API/Editor > API/Editor/SceneOutliner
A tree item that represents an entire world
| Name | FWorldTreeItem |
| Type | struct |
| Header File | /Engine/Source/Editor/SceneOutliner/Public/WorldTreeItem.h |
| Include Path | #include "WorldTreeItem.h" |
Syntax
struct FWorldTreeItem : public ISceneOutlinerTreeItem
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FWorldTreeItem
(
UWorld* InWorld |
Construct this item from a world | WorldTreeItem.h | |
FWorldTreeItem
(
TWeakObjectPtr< UWorld > InWorld |
WorldTreeItem.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FContextMenuProviderFunc | TFunction< void(const UWorld *, UToolMenu *)> | WorldTreeItem.h | |
| FFilterPredicate | TBaseDelegate_OneParam< bool, const UWorld * > | WorldTreeItem.h | |
| FInteractivePredicate | TBaseDelegate_OneParam< bool, const UWorld * > | WorldTreeItem.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ContextMenuProviders | TMap< FName, FContextMenuProviderFunc > | Static map that registers all context menu providers | WorldTreeItem.h |
| Type | const FSceneOutlinerTreeItemType | Static type identifier for this tree item class | WorldTreeItem.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ID | const FObjectKey | Constant identifier for this tree item | WorldTreeItem.h | |
| World | TWeakObjectPtr< UWorld > | The world this tree item is associated with. | WorldTreeItem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BrowseToAsset() |
Browse to world asset in content browser | WorldTreeItem.h | |
bool CanBrowseToAsset() |
WorldTreeItem.h | ||
bool Filter
(
FFilterPredicate Pred |
WorldTreeItem.h | ||
bool GetInteractiveState
(
FInteractivePredicate Pred |
WorldTreeItem.h | ||
FString GetWorldName() |
Get just the name of the world, for tooltip use | WorldTreeItem.h | |
void OpenWorldSettings() |
Open the world settings for the contained world | WorldTreeItem.h |
Overridden from ISceneOutlinerTreeItem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanInteract() |
Check whether it should be possible to interact with this tree item | WorldTreeItem.h | |
virtual void GenerateContextMenu
(
UToolMenu* Menu, |
Generate a context menu for this item. Only called if only this item is selected. | WorldTreeItem.h | |
virtual TSharedRef< SWidget > GenerateLabelWidget
(
ISceneOutliner& Outliner, |
Generate the label widget for this item | WorldTreeItem.h | |
virtual FString GetDisplayString() |
Get the raw string to display for this tree item - used for sorting | WorldTreeItem.h | |
virtual FSceneOutlinerTreeItemID GetID() |
Get the ID that represents this tree item. Used to reference this item in a map | WorldTreeItem.h | |
virtual bool IsValid() |
Begin ISceneOutlinerTreeItem Implementation | WorldTreeItem.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void RegisterContextMenuProvider
(
FName InProviderName, |
WorldTreeItem.h | ||
static void UnregisterContextMenuProvider
(
FName InProviderName |
WorldTreeItem.h |