Navigation
API > API/Runtime > API/Runtime/UMG
| Name | UGameViewportSubsystem |
| Type | class |
| Header File | /Engine/Source/Runtime/UMG/Public/Blueprint/GameViewportSubsystem.h |
| Include Path | #include "Blueprint/GameViewportSubsystem.h" |
Syntax
UCLASS (MinimalAPI)
class UGameViewportSubsystem : public UEngineSubsystem
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → UDynamicSubsystem → UEngineSubsystem → UGameViewportSubsystem
Classes
| Name | Remarks |
|---|---|
| FWidgetAddedEvent | |
| FWidgetRemovedEvent |
Structs
| Name | Remarks |
|---|---|
| FSlotInfo |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FViewportWidgetList | TMap< TObjectKey< UWidget >, FSlotInfo > | Blueprint/GameViewportSubsystem.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnWidgetAdded | FWidgetAddedEvent | Blueprint/GameViewportSubsystem.h | ||
| OnWidgetRemoved | FWidgetRemovedEvent | Blueprint/GameViewportSubsystem.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ViewportWidgets | FViewportWidgetList | Blueprint/GameViewportSubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddWidget
(
UWidget* Widget, |
Adds it to the game's viewport. | Blueprint/GameViewportSubsystem.h |
|
bool AddWidgetForPlayer
(
UWidget* Widget, |
Adds the widget to the game's viewport in the section dedicated to the player. | Blueprint/GameViewportSubsystem.h |
|
FGameViewportWidgetSlot GetWidgetSlot
(
const UWidget* Widget |
The slot info from previously added widget or info that is store for later. | Blueprint/GameViewportSubsystem.h |
|
bool IsWidgetAdded
(
const UWidget* Widget |
Blueprint/GameViewportSubsystem.h |
|
|
void RemoveWidget
(
UWidget* Widget |
Removes the widget from the viewport. | Blueprint/GameViewportSubsystem.h |
|
void SetWidgetSlot
(
UWidget* Widget, |
Update the slot info of a previously added widget or Store the slot info for later use. | Blueprint/GameViewportSubsystem.h |
|
Overridden from USubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Deinitialize() |
Blueprint/GameViewportSubsystem.h | ||
virtual void Initialize
(
FSubsystemCollectionBase& Collection |
Blueprint/GameViewportSubsystem.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UGameViewportSubsystem * Get () |
Blueprint/GameViewportSubsystem.h | ||
static UGameViewportSubsystem * Get
(
UWorld* World |
Blueprint/GameViewportSubsystem.h | ||
static FGameViewportWidgetSlot SetWidgetSlotDesiredSize
(
FGameViewportWidgetSlot Slot, |
Helper function to set the desired size in the viewport for the Slot. | Blueprint/GameViewportSubsystem.h |
|
static FGameViewportWidgetSlot SetWidgetSlotPosition
(
FGameViewportWidgetSlot Slot, |
Helper function to set the position in the viewport for the Slot. | Blueprint/GameViewportSubsystem.h |
|