Skip to content

Widget Reference

Reference for UGameViewportWidget (/Script/GameViewportUMG.GameViewportWidget). API verified against plugin source (v5.8) and Unreal MCP.

Class diagram

flowchart TB
  Parent["«parent» UContentWidget"]
  Widget["UGameViewportWidget<br/>bIsActive · ViewMode EViewportViewMode · bShowOverlayText · bUseOrthographicProjection · OrthoWidth · bInvertAlpha · PostProcessSettings · AntiAliasingMethod · FieldOfView<br/>SetCameraLocation() · SetCameraRotation() · UpdateViewMode() · SetFOV() · IsolateActors() · HideActors() · AddContentWidget()"]
  Parent --> Widget

EViewportViewMode

Value	Use for
Lit	Normal shaded view (default)
Wireframe	Mesh edges
BrushWireframe	Brush wireframe
LightComplexity	Light count debug
LightmapDensity	UV / lightmap density
LitLightmapDensity	Lit + density
StationaryLightOverlap	Stationary light overlap
CollisionPawn	Pawn collision view
CollisionVisibility	Visibility collision

Switch at runtime with Update View Mode or read Get View Mode.

Properties (Details panel)

Property	Type	Description
Is Active	Boolean	Registers active timer; viewport paints every frame when true
View Mode	EViewportViewMode	Starting visualization mode
Show Overlay Text	Boolean	View mode name overlay
Use Orthographic Projection	Boolean	Ortho vs perspective
Ortho Width	Float	Orthographic width (when ortho enabled)
Invert Alpha	Boolean	Flip alpha when transparency enabled
Post Process Settings	Struct	Per-viewport post-process (not all fields apply)
Anti Aliasing Method	Enum	None, FXAA, etc.
Field Of View	Float	Perspective FOV

Blueprint API — camera

Function	Description
Set Camera Location	Follow Player Camera Manager or supply Override Location
Set Camera Rotation	Follow PCM rotation or Override Rotation
Set FOV	Perspective field of view
Toggle Orthographic	Switch projection mode
Set Orthographic Width	Adjust ortho width
Is Using Ortho View	Returns current projection mode
Set Realtime Update	Enable / disable continuous view updates

Blueprint API — visibility

Function	Description
Isolate Actors	Show only listed actors
Isolate Actors By Class	Show one actor class (optional component tag filter)
Isolate Actors By Classes	Multiple classes (can hitch on large scenes)
Un Isolate Actors	Reset show-only list
Hide Actors	Hide specific actors
Hide Actors By Class / Classes	Hide by class (+ optional tag)
Un Hide Actors	Clear hidden list

Blueprint API — transparency

Function	Description
Set Transparency	Enable alpha viewport (requires project post-process alpha support)
Set Invert Alpha	Flip alpha interpretation
Is Alpha Inverted	Query invert state

See Transparent viewport for project setup.

Blueprint API — overlay widgets

Function	Description
Add Content Widget	Attach existing User Widget with ZOrder
Add Content Widget From Class	Spawn and attach; returns widget
Remove Widget	Remove by reference
Remove Widget At ZOrder	Remove by layer
Clear All Widgets	Remove all overlays

Content paths

Item	Location
Content root	`GameViewportUMG/`
Demo map	`DemoMap`
Sample overlay	`WBP_SampleWidget`

C++ module

PrivateDependencyModuleNames.AddRange(new string[] { "GameViewportUMG" });

#include "GameViewportWidget.h"