UCommonUILayoutManager

The Dynamic HUD Scene Manager is used to control the HUD module visibility by adding/removing active scenes.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

CommonUILayout

Header

/Engine/Plugins/Experimental/CommonUILayout/Source/CommonUILayout/Public/CommonUILayoutManager.h

Include

#include "CommonUILayoutManager.h"

Syntax

UCLASS()
class UCommonUILayoutManager : public UWorldSubsystem

Remarks

The Dynamic HUD Scene Manager is used to control the HUD module visibility by adding/removing active scenes. Each time a scene is added or removed, the allowed & unallowed list is refreshed to determine which HUD modules can be visible.

Functions

Name Description

Public function

void

 

Add

(
    const TArray< UCommonUILayout*...,
    const UObject* OptionalContext
)

Add scenes to the active list and trigger a recalculation of the allowed & unallowed widgets.

Public function

void

 

Add

(
    const UCommonUILayout* Layout,
    const UObject* OptionalContext
)

Add scenes to the active list and trigger a recalculation of the allowed & unallowed widgets.

Protected function UFunction BlueprintCallable, Category

void

 

AddLayout

(
    const UCommonUILayout* Layout
)

Public function

void

 

AddLayoutToPreloadQueue

(
    const UCommonUILayout* Layout,
    const UObject* OptionalContext
)

Protected function UFunction BlueprintCallable, Category

void

 

AddPreloadLayout

(
    const UCommonUILayout* Layout
)

Protected function UFunction BlueprintCallable, Category

void

 

ClearPreloadLayouts()

Public function

void

 

ClearPreloadQueue()

Public function Const

TWeakObjectP...

 

FindUserWidgetWithUniqueID

(
    const TSoftClassPtr< UUserWidget > ...,
    const FName& UniqueID
)

Get the instantiated user widget matching class and unique id.

Public function Static

UCommonUILay...

 

GetInstance

(
    const UWorld* World
)

Public function Const

FName

 

GetUniqueIDForWidget

(
    UUserWidget* Widget
)

Get the unique id associated to a user widget.

Public function

bool

 

IsLayoutPreloaded

(
    const UCommonUILayout* Layout,
    const UObject* OptionalContext
)

Protected function UFunction BlueprintCallable, Category

void

 

IsPreloadLayoutComplete

(
    const UCommonUILayout* Layout
)

Public function

void

 

NotifyLayoutAddedToViewport()

Use to trigger a refresh of the layout in case scenes were added before the layout widget was created, preventing the manager from creating the layout panel.

Public function

void

 

Remove

(
    const UCommonUILayout* Layout,
    const UObject* OptionalContext
)

Remove scenes from the active list.

Public function

void

 

Remove

(
    const TArray< UCommonUILayout*...,
    const UObject* OptionalContext
)

Remove scenes from the active list.

Protected function UFunction BlueprintCallable, Category

void

 

RemoveLayout

(
    const UCommonUILayout* Layout
)

Public function

void

 

RemoveLayoutFromPreloadQueue

(
    const UCommonUILayout* Layout,
    const UObject* OptionalContext
)

Protected function UFunction BlueprintCallable, Category

void

 

RemovePreloadLayout

(
    const UCommonUILayout* Layout
)

Public function

void

 

SetHUDScale

(
    const float InHUDScale
)

Set the HUD scale applied to ALL children.

Overridden from USubsystem

Name Description

Public function Virtual

void

 

Deinitialize()

Implement this for deinitialization of instances of the system

Public function Virtual

void

 

Initialize

(
    FSubsystemCollectionBase& Collecti...
)

Implement this for initialization of instances of the system

Public function Virtual Const

bool

 

ShouldCreateSubsystem

(
    UObject* Outer
)

Override to control if the Subsystem should be created at all.