Navigation
API > API/Plugins > API/Plugins/VirtualCamera
Library for changing the viewport into game view. Game view shows the scene as it appears in game.
| Name | UGameViewFunctionLibrary |
| Type | class |
| Header File | /Engine/Plugins/VirtualProduction/VirtualCamera/Source/VirtualCamera/Public/FunctionLibraries/GameViewFunctionLibrary.h |
| Include Path | #include "FunctionLibraries/GameViewFunctionLibrary.h" |
Syntax
UCLASS ()
class UGameViewFunctionLibrary : public UBlueprintFunctionLibrary
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UBlueprintFunctionLibrary → UGameViewFunctionLibrary
Functions
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool CanToggleGameView
(
EVCamTargetViewportID ViewportID |
Only works in editor builds. | FunctionLibraries/GameViewFunctionLibrary.h |
|
static bool IsInGameView
(
EVCamTargetViewportID ViewportID |
Only works in editor builds. | FunctionLibraries/GameViewFunctionLibrary.h |
|
static void RestoreGameViewStates
(
const TMap< EVCamTargetViewportID, bool >& Snapshot |
Sets the game view of the viewports as specified in the map. | FunctionLibraries/GameViewFunctionLibrary.h |
|
static void SetGameViewEnabled
(
EVCamTargetViewportID ViewportID, |
Sets whether the specified viewport should have the game view enabled. | FunctionLibraries/GameViewFunctionLibrary.h |
|
static void SetGameViewEnabledForAllViewports
(
bool bIsEnabled |
Sets the game view mode for all open viewports. Only works in editor builds. | FunctionLibraries/GameViewFunctionLibrary.h |
|
static TMap< EVCamTargetViewportID, bool > SnapshotGameViewStates() |
Only works in editor builds. | FunctionLibraries/GameViewFunctionLibrary.h |
|
static void ToggleGameView
(
EVCamTargetViewportID ViewportID |
Toggles the game view. | FunctionLibraries/GameViewFunctionLibrary.h |
|