unreal.GameViewFunctionLibrary
¶
- class unreal.GameViewFunctionLibrary(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
BlueprintFunctionLibrary
Library for changing the viewport into game view. Game view shows the scene as it appears in game.
C++ Source:
Plugin: VirtualCamera
Module: VirtualCamera
File: GameViewFunctionLibrary.h
- classmethod can_toggle_game_view(viewport_id) bool ¶
note: Only works in editor builds.
- Parameters:
viewport_id (VCamTargetViewportID) –
- Returns:
Whether we can toggle game view.
- Return type:
- classmethod is_in_game_view(viewport_id) bool ¶
note: Only works in editor builds.
- Parameters:
viewport_id (VCamTargetViewportID) –
- Returns:
Whether we are in game view.
- Return type:
- classmethod restore_game_view_states(snapshot) None ¶
Sets the game view of the viewports as specified in the map. Util for using together with SnapshotGameViewStates. note: Only works in editor builds.
- Parameters:
snapshot (Map[VCamTargetViewportID, bool]) –
- classmethod set_game_view_enabled(viewport_id, is_enabled) None ¶
Sets whether the specified viewport should have the game view enabled. note: Only works in editor builds.
- Parameters:
viewport_id (VCamTargetViewportID) –
is_enabled (bool) –
- classmethod set_game_view_enabled_for_all_viewports(is_enabled) None ¶
Sets the game view mode for all open viewports. note: Only works in editor builds.
- Parameters:
is_enabled (bool) –
- classmethod snapshot_game_view_states() Map[VCamTargetViewportID, bool] ¶
note: Only works in editor builds.
- Returns:
The state of each viewport’s state. If the viewport is not currently open, then the returned map will not have any entry for it.
- Return type:
- classmethod toggle_game_view(viewport_id) None ¶
Toggles the game view. Game view shows the scene as it appears in game. note: Only works in editor builds.
- Parameters:
viewport_id (VCamTargetViewportID) –