UGameViewportSubsystem Class Reference

Public Member Functions
User Interface
bool	IsWidgetAdded (const UWidget Widget) const
void	RemoveWidget (UWidget Widget)
	Removes the widget from the viewport.
bool	AddWidget (UWidget Widget, FGameViewportWidgetSlot Slot)
	Adds it to the game's viewport.
FGameViewportWidgetSlot	GetWidgetSlot (const UWidget Widget) const
	The slot info from previously added widget or info that is store for later.
bool	AddWidgetForPlayer (UWidget Widget, ULocalPlayer Player, FGameViewportWidgetSlot Slot)
	Adds the widget to the game's viewport in the section dedicated to the player. This is valuable in a split screen game where you need to only show a widget over a player's portion of the viewport.
void	SetWidgetSlot (UWidget Widget, FGameViewportWidgetSlot Slot)
	Update the slot info of a previously added widget or Store the slot info for later use.
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const

Static Public Member Functions
GameViewportWidgetSlot
static FGameViewportWidgetSlot	SetWidgetSlotDesiredSize (FGameViewportWidgetSlot Slot, FVector2D Size)
	Helper function to set the desired size in the viewport for the Slot.
static FGameViewportWidgetSlot	SetWidgetSlotPosition (FGameViewportWidgetSlot Slot, const UWidget Widget, FVector2D Position, bool bRemoveDPIScale)
	Helper function to set the position in the viewport for the Slot.
Static Functions
static UGameViewportSubsystem	Get ()
static UClass	StaticClass ()
Static Public Member Functions inherited from UEngineSubsystem
static UClass	StaticClass ()
Static Public Member Functions inherited from UDynamicSubsystem
static UClass	StaticClass ()
Static Public Member Functions inherited from USubsystem
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Additional Inherited Members
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Member Function Documentation

AddWidget()

bool AddWidget	(	UWidget	Widget,
		FGameViewportWidgetSlot	Slot )

Adds it to the game's viewport.

AddWidgetForPlayer()

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

Adds the widget to the game's viewport in the section dedicated to the player. This is valuable in a split screen game where you need to only show a widget over a player's portion of the viewport.

Get()

UGameViewportSubsystem Get ( )

static

GetWidgetSlot()

FGameViewportWidgetSlot GetWidgetSlot

(

const UWidget

Widget

)

const

The slot info from previously added widget or info that is store for later.

IsWidgetAdded()

bool IsWidgetAdded

(

const UWidget

Widget

)

const

Returns

true if the widget was added to the viewport using AddWidget or AddWidgetForPlayer.

RemoveWidget()

void RemoveWidget

(

UWidget

Widget

)

Removes the widget from the viewport.

SetWidgetSlot()

void SetWidgetSlot	(	UWidget	Widget,
		FGameViewportWidgetSlot	Slot )

Update the slot info of a previously added widget or Store the slot info for later use.

SetWidgetSlotDesiredSize()

FGameViewportWidgetSlot SetWidgetSlotDesiredSize ( FGameViewportWidgetSlot Slot, FVector2D Size )

static

Helper function to set the desired size in the viewport for the Slot.

SetWidgetSlotPosition()

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

static

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

Parameters

Position	The 2D position to set the widget to in the viewport.
bRemoveDPIScale	If you've already calculated inverse DPI, set this to false. Otherwise inverse DPI is applied to the position so that when the location is scaled by DPI, it ends up in the expected position.

StaticClass()

UClass StaticClass ( )

static