1. Epic GamesDeveloper
  3. UGameViewportSubsystem

UGameViewportSubsystem

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Blueprint

Inheritance Hierarchy

  • UEngineSubsystem
  • UGameViewportSubsystem

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Blueprint/GameViewportSubsystem.h
Include #include "Blueprint/GameViewportSubsystem.h"

Syntax

UCLASS (MinimalAPI)  
class UGameViewportSubsystem : public UEngineSubsystem

Variables

  Type Name Description
Public variable FWidgetAddedEvent OnWidgetAdded  
Public variable FWidgetRemovedEvent OnWidgetRemoved  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category blueprintcosmetic bool Adds it to the game's viewport.
Public function UFunction BlueprintCallable, Category blueprintcosmetic bool

AddWidgetForPlayer ( UWidget* Widget,
ULocalPlayer* Player,
FGameViewportWidgetSlot Slot
)

 Adds the widget to the game's viewport in the section dedicated to the player.
Public function Virtual void  
Public function Static UGameViewportSubsystem *

Get ()

  
Public function Static UGameViewportSubsystem *

Get ( UWorld* World
)

  
Public function Const UFunction BlueprintCallable, Category blueprintcosmetic FGameViewportWidgetSlot

GetWidgetSlot ( const UWidget* Widget
)

 The slot info from previously added widget or info that is store for later.
Public function Virtual void

Initialize ( FSubsystemCollectionBase& Collection
)

  
Public function Const UFunction BlueprintPure, Category blueprintcosmetic bool

IsWidgetAdded ( const UWidget* Widget
)

  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

RemoveWidget ( UWidget* Widget
)

 Removes the widget from the viewport.
Public function UFunction BlueprintCallable, Category blueprintcosmetic void Update the slot info of a previously added widget or Store the slot info for later use.
Public function Static UFunction BlueprintCallable, Category FGameViewportWidgetSlot Helper function to set the desired size in the viewport for the Slot.
Public function Static UFunction BlueprintCallable, Category FGameViewportWidgetSlot

SetWidgetSlotPosition ( FGameViewportWidgetSlot Slot,
const UWidget* Widget,
FVector2D Position,
bool bRemoveDPIScale
)

 Helper function to set the position in the viewport for the Slot.

Classes

  Type Name Description
Public class FWidgetAddedEvent    
Public class FWidgetRemovedEvent    

Typedefs

Name Description
FViewportWidgetList  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page