Skip to content
YetiTech Studios

UViewportWorldSubsystem

#include <ViewportWorlds/Private/Global/ViewportWorldSubsystem.h>
class UViewportWorldSubsystem

Defined in ViewportWorldSubsystem.h:14

Inherits: UGameInstanceSubsystem

Inheritance diagram

Section titled “Inheritance diagram”
---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UViewportWorldSubsystem["UViewportWorldSubsystem"]
  class UGameInstanceSubsystem["UGameInstanceSubsystem"]
  UGameInstanceSubsystem <|-- UViewportWorldSubsystem

Collaboration diagram

Section titled “Collaboration diagram”
---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UViewportWorldSubsystem["UViewportWorldSubsystem"]
  class FViewportWorldHandle["FViewportWorldHandle"]
  UViewportWorldSubsystem *-- FViewportWorldHandle

Class detail

Section titled “Class detail”
---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UViewportWorldSubsystem {
    +ShouldCreateSubsystem(UObject *Outer) const override bool
    +LoadWorld(TSoftObjectPtr< UWorld > TargetWorld, const FViewportWorldHandle() *
    +AddWidgetToViewport(const FViewportWorldHandle &TestWorldHandle
    +AddSlateWidgetToViewport(const FViewportWorldHandle &TestWorldHandle bool
    +FindWorldHandle(const TSoftObjectPtr< UWorld > &TargetWorld const FViewportWorldHandle() *
    +UnloadWorldHandle(FViewportWorldHandle &WorldHandle)
    +Get(const UObject *WorldContextObject) UViewportWorldSubsystem() *
    +GetWorldID(const TSoftObjectPtr< UWorld > &TargetWorld FString
    +RemoveWidgetFromHandle(const FViewportWorldHandle &TestWorldHandle bool
    +RemoveSlateWidgetFromHandle(const FViewportWorldHandle &TestWorldHandle bool
    +ClearAllWidgetsFromHandle(const FViewportWorldHandle &TestWorldHandle
    +LoadedWorlds : TMap< FString, FViewportWorldHandle() >
    +Internal_LoadWorld(FViewportWorldHandle *WorldHandle, const FV UWorld *
  }

Caller impact — Get

Section titled “Caller impact — Get”

Documented call sites inside the plugin (5):

flowchart LR
  UViewportWorldSubsystem__Get["UViewportWorldSubsystem::Get"]
  UViewportWorldStatics__AddSlateWidgetToHandle["UViewportWorldStatics::AddSlateWidgetToHandle"]
  UViewportWorldStatics__AddSlateWidgetToHandle --> UViewportWorldSubsystem__Get
  UViewportWorldStatics__AddWidgetToHandle["UViewportWorldStatics::AddWidgetToHandle"]
  UViewportWorldStatics__AddWidgetToHandle --> UViewportWorldSubsystem__Get
  UViewportWorldStatics__FindViewportWorldHandlePtr["UViewportWorldStatics::FindViewportWorldHandlePtr"]
  UViewportWorldStatics__FindViewportWorldHandlePtr --> UViewportWorldSubsystem__Get
  UViewportWorldWidget__LoadGameWorldWithHandle["UViewportWorldWidget::LoadGameWorldWithHandle"]
  UViewportWorldWidget__LoadGameWorldWithHandle --> UViewportWorldSubsystem__Get
  UViewportWorldStatics__UnloadWorldHandle["UViewportWorldStatics::UnloadWorldHandle"]
  UViewportWorldStatics__UnloadWorldHandle --> UViewportWorldSubsystem__Get

Public Methods

Section titled “Public Methods”
ReturnNameDescription
boolShouldCreateSubsystem virtual const override
FViewportWorldHandle *LoadWorld
voidAddWidgetToViewport
boolAddSlateWidgetToViewport
const FViewportWorldHandle *FindWorldHandle const
voidUnloadWorldHandle

ShouldCreateSubsystem

Section titled “ShouldCreateSubsystem”

virtual const override

virtual bool ShouldCreateSubsystem(UObject * Outer) const override

Defined in ViewportWorldSubsystem.h:26

References
Section titled “References”

LoadWorld

Section titled “LoadWorld”
FViewportWorldHandle * LoadWorld(TSoftObjectPtr< UWorld > TargetWorld, const FViewportWorldOptions & Options, const bool bInitializeActors, const EViewportWorldViewMode & ViewMode, const bool bUseBasicDraw, const FPostProcessSettings & FastRenderPostProcess, const FString & AdditionalOptions)

Defined in ViewportWorldSubsystem.h:28

References
Section titled “References”

AddWidgetToViewport

Section titled “AddWidgetToViewport”
void AddWidgetToViewport(const FViewportWorldHandle & TestWorldHandle, UUserWidget * Widget, const int32 ZOrder)

Defined in ViewportWorldSubsystem.h:35

References
Section titled “References”

AddSlateWidgetToViewport

Section titled “AddSlateWidgetToViewport”
bool AddSlateWidgetToViewport(const FViewportWorldHandle & TestWorldHandle, const TSharedRef< SWidget > & SlateWidget, const int32 & ZOrder)

Defined in ViewportWorldSubsystem.h:36

Referenced by
Section titled “Referenced by”
References
Section titled “References”

FindWorldHandle

Section titled “FindWorldHandle”

const

const FViewportWorldHandle * FindWorldHandle(const TSoftObjectPtr< UWorld > & TargetWorld) const

Defined in ViewportWorldSubsystem.h:40

References
Section titled “References”

UnloadWorldHandle

Section titled “UnloadWorldHandle”
void UnloadWorldHandle(FViewportWorldHandle & WorldHandle)

Defined in ViewportWorldSubsystem.h:42

References
Section titled “References”

Public Static Methods

Section titled “Public Static Methods”
ReturnNameDescription
UViewportWorldSubsystem *Get static
FStringGetWorldID static
boolRemoveWidgetFromHandle static
boolRemoveSlateWidgetFromHandle static
voidClearAllWidgetsFromHandle static

Get

Section titled “Get”

static

static UViewportWorldSubsystem * Get(const UObject * WorldContextObject)

Defined in ViewportWorldSubsystem.h:23

Referenced by
Section titled “Referenced by”

GetWorldID

Section titled “GetWorldID”

static

static FString GetWorldID(const TSoftObjectPtr< UWorld > & TargetWorld)

Defined in ViewportWorldSubsystem.h:24

Referenced by
Section titled “Referenced by”

RemoveWidgetFromHandle

Section titled “RemoveWidgetFromHandle”

static

static bool RemoveWidgetFromHandle(const FViewportWorldHandle & TestWorldHandle, UUserWidget * Widget)

Defined in ViewportWorldSubsystem.h:37

Referenced by
Section titled “Referenced by”
References
Section titled “References”

RemoveSlateWidgetFromHandle

Section titled “RemoveSlateWidgetFromHandle”

static

static bool RemoveSlateWidgetFromHandle(const FViewportWorldHandle & TestWorldHandle, const TSharedRef< SWidget > & SlateWidget)

Defined in ViewportWorldSubsystem.h:38

Referenced by
Section titled “Referenced by”
References
Section titled “References”

ClearAllWidgetsFromHandle

Section titled “ClearAllWidgetsFromHandle”

static

static void ClearAllWidgetsFromHandle(const FViewportWorldHandle & TestWorldHandle)

Defined in ViewportWorldSubsystem.h:39

Referenced by
Section titled “Referenced by”
References
Section titled “References”

Private Attributes

Section titled “Private Attributes”
ReturnNameDescription
TMap< FString, FViewportWorldHandle >LoadedWorlds

LoadedWorlds

Section titled “LoadedWorlds”
TMap< FString, FViewportWorldHandle > LoadedWorlds

Defined in ViewportWorldSubsystem.h:19

Referenced by
Section titled “Referenced by”

Private Static Methods

Section titled “Private Static Methods”
ReturnNameDescription
UWorld *Internal_LoadWorld static

Internal_LoadWorld

Section titled “Internal_LoadWorld”

static

static UWorld * Internal_LoadWorld(FViewportWorldHandle * WorldHandle, const FViewportWorldOptions & Options, const bool bInitializeActors)

Defined in ViewportWorldSubsystem.h:45

Referenced by
Section titled “Referenced by”
References
Section titled “References”