Engine.GameViewportClient

Extends

Object

Modifiers

within Engine transient native Inherits ( FViewportClient ) Inherits ( FExec ) config ( Engine )

A game viewport (FViewport) is a high-level abstract interface for the platform specific rendering, audio, and input subsystems. GameViewportClient is the engine's interface to a game viewport. Exactly one GameViewportClient is created for each instance of the game. The only case (so far) where you might have a single instance of Engine, but multiple instances of the game (and thus multiple GameViewportClients) is when you have more than one PIE window running. Responsibilities: propagating input events to the global interactions list Copyright 1998-2011 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.GameViewportClient

Direct Known Subclasses:

UDKGameViewportClient

Delegates Summary
	bool	HandleInputAxis (int ControllerId, name Key, float Delta, float DeltaTime, bool bGamepad)
	bool	HandleInputChar (int ControllerId, string Unicode)
	bool	HandleInputKey (int ControllerId, name Key, EInputEvent EventType, float AmountDepressed, optional bool bGamepad)

Functions Summary
	int	AddLocalPlayer (LocalPlayer NewPlayer ))
		BecomePrimaryPlayer (int PlayerIndex))
	bool	CalculateDeadZoneForAllSides (LocalPlayer LPlayer, Canvas Canvas, out float fTopSafeZone, out float fBottomSafeZone, out float fLeftSafeZone, out float fRightSafeZone, optional bool bUseMaxPercent ))
		CalculateSafeZoneValues (out float out_Horizontal, out float out_Vertical, canvas Canvas, int LocalPlayerIndex, bool bUseMaxPercent ))
		ClearProgressMessages ()))
	string	ConsoleCommand (string Command)
	int	ConvertLocalPlayerToGamePlayerIndex (LocalPlayer LPlayer ))
	bool	CreateInitialPlayer (out string OutError ))
	LocalPlayer	CreatePlayer (int ControllerId, out string OutError, bool bSpawnActor))
		DebugCreatePlayer (int ControllerId))
		DebugRemovePlayer (int ControllerId))
		DebugSetUISystemEnabled (bool bOldUISystemActive, bool bGFxUISystemActive)
		DisplayProgressMessage (Canvas Canvas))
		DrawTitleSafeArea (canvas Canvas ))
		DrawTransition (Canvas Canvas))
		DrawTransitionMessage (Canvas Canvas, tring Message))
	LocalPlayer	FindPlayerByControllerId (int ControllerId))
		FixupOwnerReferences ()
		GameSessionEnded ()))
	class<UIInteraction>	GetCustomInteractionClass (int InIndex)
	int	GetNumCustomInteractions ()
		GetPixelSizeOfScreen (out float out_Width, out float out_Height, canvas Canvas, int LocalPlayerIndex ))
	LocalPlayer	GetPlayerOwner (int PlayerIndex)
	ESplitScreenType	GetSplitscreenConfiguration ()))
		GetSubtitleRegion (out vector2D MinPos, out vector2D MaxPos))
		GetViewportSize (out Vector2D out_ViewportSize)
	bool	HasBottomSafeZone (int LocalPlayerIndex ))
	bool	HasLeftSafeZone (int LocalPlayerIndex ))
	bool	HasRightSafeZone (int LocalPlayerIndex ))
	bool	HasTopSafeZone (int LocalPlayerIndex ))
	bool	Init (out string OutError))
	int	InsertInteraction (Interaction NewInteraction, optional int InIndex = -1 ))
	bool	IsFullScreenViewport ()
		LayoutPlayers ()))
		NotifyConnectionError (EProgressMessageType MessageType, optional string Message=Localize("Errors", "ConnectionFailed""ConnectionFailed", "Engine")"Engine"), optional string Title=Localize("Errors", "ConnectionFailed_Title""ConnectionFailed_Title", "Engine") ))
		NotifyPlayerAdded (int PlayerIndex, LocalPlayer AddedPlayer ))
		NotifyPlayerRemoved (int PlayerIndex, LocalPlayer RemovedPlayer ))
		OnPrimaryPlayerSwitch (LocalPlayer OldPrimaryPlayer, LocalPlayer NewPrimaryPlayer)
		PostRender (Canvas Canvas))
	int	RemoveLocalPlayer (LocalPlayer ExistingPlayer ))
	bool	RemovePlayer (LocalPlayer ExPlayer))
		SetConsoleTarget (int PlayerIndex))
		SetCustomInteractionObject (Interaction InInteraction)
		SetProgressMessage (EProgressMessageType MessageType, string Message, optional string Title, optional bool bIgnoreFutureNetworkMessages))
		SetProgressTime (float T))
		SetSplit (int mode ))
		SetSplitscreenConfiguration (ESplitScreenType SplitType ))
	bool	ShouldForceFullscreenViewport () con)
		ShowTitleSafeArea ()))
		SSSwapControllers ()))
		Tick (float DeltaTime)
		UpdateActiveSplitscreenType ()))

ActiveSplitscreenType Source code

The splitscreen type that is actually being used; takes into account the number of players and other factors (such as cinematic mode) that could affect the splitscreen mode that is actually used.

bDebugNoGFxUI Source code

DEBUG: If TRUE, the GFx UI will NOT be rendered at runtime. Note that to REMOVE GFx functionality permanently, you should compile with WITH_GFx set to 0. This bool is for debugging only.

bDisableWorldRendering Source code

set to disable world rendering

bDisplayingUIMouseCursor Source code

Indicates whether the UI is currently displaying a mouse cursor. Prevents GameEngine::Tick() from recapturing mouse input while the UI has active scenes that mouse input.

bIsPlayInEditorViewport Source code

If TRUE, this viewport is a play in editor viewport

bOverrideDiffuseAndSpecular Source code

bShowSystemMouseCursor Source code

If TRUE, we will show the OS mouse cursor at all times (only applies to PIE viewports)

bShowTitleSafeZone Source code

if TRUE then the title safe border is drawn

bUIMouseCaptureOverride Source code

Indicates that the UI needs to receive all mouse input events. Usually enabled when the user is interacting with a draggable widget, such as a scrollbar or slider.

bUseHardwareCursorWhenWindowed Source code

A temporary workaround for seeing dobule cursors in UDK Game. We need a complete solution that handles this robustly for all GFx UIs

ConnectingMessage Source code

DebugProperties Source code

Default2PSplitType Source code

Defaults for intances where there are multiple configs for a certain number of players

Default3PSplitType Source code

DesiredSplitscreenType Source code

The splitscreen layout type that the player wishes to use; this value usually comes from places like the player's profile

GlobalInteractions Source code

A list of interactions which have a chance at all input before the player's interactions.

LoadingMessage Source code

@name Localized transition messages.

PausedMessage Source code

PrecachingMessage Source code

ProgressFadeTime Source code

ProgressMessage[2] Source code

ProgressTimeOut Source code

SavingMessage Source code

ScaleformInteraction Source code

Stores the pointer to any data needed for scaleform (if defined)

ShowFlags Source code

The show flags used by the viewport's players.

SplitscreenInfo Source code

Array of the screen data needed for all the different splitscreen configurations

TitleSafeZone Source code

border of safe area

UIController Source code

The viewport's UI controller

UIControllerClass Source code

The class for the UI controller

Viewport Source code

The platform-specific viewport which this viewport client is attached to.

ViewportConsole Source code

The viewport's console. Might be null on consoles

ViewportFrame Source code

The platform-specific viewport frame which this viewport is contained by.

ESafeZoneType Source code

The 4 different kinds of safezones

ESplitScreenType Source code

Enum of the different splitscreen types

DebugDisplayProperty Source code

debug property display functionality to interact with this, use "display", "displayall", "displayclear"
bSpecialProperty:

whether PropertyName is a "special" value not directly mapping to a real property (e.g. state name)

Obj:

the object whose property to display. If this is a class, all objects of that class are drawn.

PropertyName:

name of the property to display

ExportShowFlags_Mirror Source code

This empty struct is here so we have a non-native struct that can be exported to the header properly

PerPlayerSplitscreenData Source code

Structure to store splitscreen data.

ShowFlags_Mirror Source code

This struct needs to be the same size as EShowFlags

SplitscreenData Source code

Structure containing all the player splitscreen datas per splitscreen configuration.

TitleSafeZoneArea Source code

Max/Recommended screen viewable extents as a percentage

HandleInputAxis Source code

Provides script-only child classes the opportunity to handle input axis events received from the viewport. This delegate is called before the input axis event is passed to the interactions array for processing.
@param ControllerId the controller that generated this input axis event
@param Key the name of the axis that moved (KEY_MouseX, KEY_XboxTypeS_LeftX, etc.)
@param Delta the movement delta for the axis
@param DeltaTime the time (in seconds) since the last axis update.
@param bGamepad input came from gamepad (ie xbox controller)
@return return TRUE to indicate that the input event was handled. if the return value is TRUE, this input event will not be passed to the interactions array.

HandleInputChar Source code

Provides script-only child classes the opportunity to handle character input (typing) events received from the viewport. This delegate is called before the character event is passed to the interactions array for processing.
@param ControllerId the controller that generated this character input event
@param Unicode the character that was typed
@return return TRUE to indicate that the input event was handled. if the return value is TRUE, this input event will not be passed to the interactions array.

HandleInputKey Source code

Provides script-only child classes the opportunity to handle input key events received from the viewport. This delegate is called before the input key event is passed to the interactions array for processing.
@param ControllerId the controller that generated this input key event
@param Key the name of the key which an event occured for (KEY_Up, KEY_Down, etc.)
@param EventType the type of event which occured (pressed, released, etc.)
@param AmountDepressed for analog keys, the depression percent.
@param bGamepad input came from gamepad (ie xbox controller)
@return return TRUE to indicate that the input event was handled. if the return value is TRUE, this input event will not be passed to the interactions array.

AddLocalPlayer Source code

Adds a LocalPlayer to the local and global list of Players.
@param NewPlayer the player to add

BecomePrimaryPlayer Source code

Makes a player the primary player
@param PlayerIndex - The index of the player to be made into the primary player

CalculateDeadZoneForAllSides Source code

CalculateSafeZoneValues Source code

Calculate the amount of safezone needed for a single side for both vertical and horizontal dimensions

ClearProgressMessages Source code

ConsoleCommand Source code

Executes a console command in the context of this viewport.
@param Command - The command to execute.
@return The output of the command will be returned.

ConvertLocalPlayerToGamePlayerIndex Source code

Convert a LocalPlayer to it's index in the GamePlayer array Returns -1 if the index could not be found.

CreateInitialPlayer Source code

Create the game's initial player at startup. First search for a player that is signed into the OnlineSubsystem; if none are found, create a player with a ControllerId of 0.
@param OutError receives the error string if an error occurs while creating the player.
@return TRUE if a player was successfully created.

CreatePlayer Source code

Adds a new player.
@param ControllerId - The controller ID the player should accept input from.
@param OutError - If no player is returned, OutError will contain a string describing the reason.
@param SpawnActor - True if an actor should be spawned for the new player.
@return The player which was created.

DebugCreatePlayer Source code

Debug console command to create a player.
@param ControllerId - The controller ID the player should accept input from.

DebugRemovePlayer Source code

Debug console command to remove the player with a given controller ID.
@param ControllerId - The controller ID to search for.

DebugSetUISystemEnabled Source code

DEBUG: function to easily allow script to turn on / off the two UI systems for developing during the transition from the old UI to the new GFx UI

DisplayProgressMessage Source code

display progress messages in center of screen

DrawTitleSafeArea Source code

Draw the safe area using the current TitleSafeZone settings

DrawTransition Source code

Displays the transition screen.
@param Canvas - The canvas to use for rendering.

DrawTransitionMessage Source code

Print a centered transition message with a drop shadow.

FindPlayerByControllerId Source code

Finds a player by controller ID.
@param ControllerId - The controller ID to search for.
@return None or the player with matching controller ID.

FixupOwnerReferences Source code

Called after the primary player has been changed so that the UI references to the owner are switched

GameSessionEnded Source code

Called when the current map is being unloaded. Cleans up any references which would prevent garbage collection.

GetCustomInteractionClass Source code

Defining the above mentioned custom interactions

GetNumCustomInteractions Source code

Function that allow for custom numbers of interactions dictated in code

GetPixelSizeOfScreen Source code

Get the total pixel size of the screen. This is different from the pixel size of the viewport since we could be in splitscreen

GetPlayerOwner Source code

Retrieves a reference to a LocalPlayer.
@param PlayerIndex if specified, returns the player at this index in the GamePlayers array. Otherwise, returns the player associated with the owner scene.
@return the player that owns this scene or is located in the specified index of the GamePlayers array.

GetSplitscreenConfiguration Source code

@return the actual splitscreen type being used, taking into account the number of players.

GetSubtitleRegion Source code

called before rending subtitles to allow the game viewport to determine the size of the subtitle area
@param Min top left bounds of subtitle region (0 to 1)
@param Max bottom right bounds of subtitle region (0 to 1)

GetViewportSize Source code

Retrieve the size of the main viewport.
@param out_ViewportSize [out] will be filled in with the size of the main viewport

HasBottomSafeZone Source code

Whether the player at LocalPlayerIndex's viewport has a "bottom of viewport" safezone or not.

HasLeftSafeZone Source code

Whether the player at LocalPlayerIndex's viewport has a "left of viewport" safezone or not.

HasRightSafeZone Source code

Whether the player at LocalPlayerIndex's viewport has a "right of viewport" safezone or not.

HasTopSafeZone Source code

Whether the player at LocalPlayerIndex's viewport has a "top of viewport" safezone or not.

Init Source code

Initialize the game viewport.
@param OutError - If an error occurs, returns the error description.
@return False if an error occurred, true if the viewport was initialized successfully.

InsertInteraction Source code

Inserts an interaction into the GlobalInteractions array at the specified index
@param NewInteraction the interaction that should be inserted into the array
@param Index the position in the GlobalInteractions array to insert the element. if no value (or -1) is specified, inserts the interaction at the end of the array
@return the position in the GlobalInteractions array where the element was placed, or -1 if the element wasn't added to the array for some reason

IsFullScreenViewport Source code

@return Whether or not the main viewport is fullscreen or windowed.

LayoutPlayers Source code

Called before rendering to allow the game viewport to allocate subregions to players.

NotifyConnectionError Source code

Notifies the player that an attempt to connect to a remote server failed, or an existing connection was dropped.
@param MessageType EProgressMessageType of current connection error
@param Message a description of why the connection was lost
@param Title the title to use in the connection failure message.

NotifyPlayerAdded Source code

Notifies all interactions that a new player has been added to the list of active players.
@param PlayerIndex the index [into the GamePlayers array] where the player was inserted
@param AddedPlayer the player that was added

NotifyPlayerRemoved Source code

Notifies all interactions that a new player has been added to the list of active players.
@param PlayerIndex the index [into the GamePlayers array] where the player was located
@param RemovedPlayer the player that was removed

OnPrimaryPlayerSwitch Source code

Called after a new primary player has been made

PostRender Source code

Called after rendering the player views and HUDs to render menus, the console, etc. This is the last rendering call in the render loop
@param Canvas - The canvas to use for rendering.

RemoveLocalPlayer Source code

Removes a LocalPlayer from the local and global list of Players.
@param ExistingPlayer the player to remove

RemovePlayer Source code

Removes a player.
@param Player - The player to remove.
@return whether the player was successfully removed. Removal is not allowed while connected to a server.

SetConsoleTarget Source code

Sets the player which console commands will be executed in the context of.

SetCustomInteractionObject Source code

Passing the custom interaction object back to native code to do with it as it likes

SetProgressMessage Source code

handler for global state messages, generally network connection related (failures, download progress, etc)

SetProgressTime Source code

SetSplit Source code

debug test for testing splitscreens

SetSplitscreenConfiguration Source code

Sets the screen layout configuration that the player wishes to use when in split-screen mode.

ShouldForceFullscreenViewport Source code

Determine whether a fullscreen viewport should be used in cases where there are multiple players.
@return TRUE to use a fullscreen viewport; FALSE to allow each player to have their own area of the viewport.

ShowTitleSafeArea Source code

Exec for toggling the display of the title safe area

SSSwapControllers Source code

Rotates controller ids among gameplayers, useful for testing splitscreen with only one controller.

Tick Source code

Called every frame to allow the game viewport to update time based state.
@param DeltaTime - The time since the last call to Tick.

UpdateActiveSplitscreenType Source code

Sets the value of ActiveSplitscreenConfiguration based on the desired split-screen layout type, current number of players, and any other factors that might affect the way the screen should be layed out.

defaultproperties
{
	UIControllerClass=class'Engine.UIInteraction'
	TitleSafeZone=(MaxPercentX=0.9,MaxPercentY=0.9,RecommendedPercentX=0.8,RecommendedPercentY=0.8)

	Default2PSplitType=eSST_2P_HORIZONTAL
	Default3PSplitType=eSST_3P_FAVOR_TOP
	DesiredSplitscreenType=eSST_NONE

	bIsPlayInEditorViewport=False
	bShowSystemMouseCursor=False

	ProgressFadeTime=1.0
	ProgressTimeOut=8.0

	SplitscreenInfo(eSST_None)=			(PlayerData=((SizeX=1.0f,SizeY=1.0f,OriginX=0.0f,OriginY=0.0f)))

	SplitscreenInfo(eSST_2P_HORIZONTAL)={(PlayerData=(
										(SizeX=1.0f,SizeY=0.5f,OriginX=0.0f,OriginY=0.0f),
										(SizeX=1.0f,SizeY=0.5f,OriginX=0.0f,OriginY=0.5f))
										)}

	SplitscreenInfo(eSST_2P_VERTICAL)={(PlayerData=(
										(SizeX=0.5f,SizeY=1.0f,OriginX=0.0f,OriginY=0.0f),
										(SizeX=0.5f,SizeY=1.0f,OriginX=0.5f,OriginY=0.0))
										)}

	SplitscreenInfo(eSST_3P_FAVOR_TOP)={(PlayerData=(
										(SizeX=1.0f,SizeY=0.5f,OriginX=0.0f,OriginY=0.0f),
										(SizeX=0.5f,SizeY=0.5f,OriginX=0.0f,OriginY=0.5f),
										(SizeX=0.5f,SizeY=0.5f,OriginX=0.5f,OriginY=0.5f))
										)}

	SplitscreenInfo(eSST_3P_FAVOR_BOTTOM)={(PlayerData=(
										(SizeX=0.5f,SizeY=0.5f,OriginX=0.0f,OriginY=0.0f),
										(SizeX=0.5f,SizeY=0.5f,OriginX=0.5f,OriginY=0.0f),
										(SizeX=1.0f,SizeY=0.5f,OriginX=0.0f,OriginY=0.5f))
										)}

	SplitscreenInfo(eSST_4P)={(PlayerData=(
										(SizeX=0.5f,SizeY=0.5f,OriginX=0.0f,OriginY=0.0f),
										(SizeX=0.5f,SizeY=0.5f,OriginX=0.5f,OriginY=0.0f),
										(SizeX=0.5f,SizeY=0.5f,OriginX=0.0f,OriginY=0.5f),
										(SizeX=0.5f,SizeY=0.5f,OriginX=0.5f,OriginY=0.5f))
										)}
}