GameViewportClient¶

Class in Engine · Engine.GameViewportClient · transient, native, config

Object › ScriptViewportClient › GameViewportClient

Using it from Lua

h7.find_all("GameViewportClient")            -- live instances
h7.find_class("Engine.GameViewportClient")   -- the class
h7.hook("Engine.GameViewportClient.AddLocalPlayer", fn)

Enums¶

ESafeZoneType

eSZ_TOP = 0, eSZ_BOTTOM = 1, eSZ_LEFT = 2, eSZ_RIGHT = 3

ESetMode

SetMode_Toggle = 0, SetMode_Enable = 1, SetMode_Disable = 2

ESplitScreenType

eSST_NONE = 0, eSST_2P_HORIZONTAL = 1, eSST_2P_VERTICAL = 2, eSST_3P_FAVOR_TOP = 3, eSST_3P_FAVOR_BOTTOM = 4, eSST_4P = 5

Structs¶

DebugDisplayProperty

Field	Type
`Obj`	`Object`
`PropertyName`	`name`
`bSpecialProperty`	`bool`

ExportShowFlags_Mirror

PerPlayerSplitscreenData

Field	Type
`SizeX`	`float`
`SizeY`	`float`
`OriginX`	`float`
`OriginY`	`float`

ShowFlags_Mirror

Field	Type
`flags0`	`qword`
`flags1`	`qword`

SplitscreenData

Field	Type
`PlayerData`	`array<PerPlayerSplitscreenData>`

TitleSafeZoneArea

Field	Type
`MaxPercentX`	`float`
`MaxPercentY`	`float`
`RecommendedPercentX`	`float`
`RecommendedPercentY`	`float`

Properties¶

Name	Type	Notes
`ActiveSplitscreenType`	`ESplitscreenType`	protected
`bCapturedWorldRendering`	`bool`
`bDebugNoGFxUI`	`bool`	config
`bDisableWorldRendering`	`bool`
`bDisplayHardwareMouseCursor`	`bool`	transient
`bIsPlayInEditorViewport`	`bool`	transient
`bOverrideDiffuseAndSpecular`	`bool`	transient
`bShowSystemMouseCursor`	`bool`	transient
`bShowTitleSafeZone`	`bool`
`ConnectingMessage`	`string`	localized
`DebugProperties`	`array<DebugDisplayProperty>`
`Default2PSplitType`	`ESplitScreenType`	const
`Default3PSplitType`	`ESplitScreenType`	const
`DesiredSplitscreenType`	`ESplitScreenType`	protected
`GlobalInteractions`	`array`	no declaration: type is approximate
`LoadingMessage`	`string`	localized
`PausedMessage`	`string`	localized
`PrecachingMessage`	`string`	localized
`ProgressFadeTime`	`float`
`ProgressMessage`	`string[2]`
`ProgressTimeOut`	`float`
`SavingMessage`	`string`	localized
`ScaleformInteraction`	`pointer`	const, native
`ShowFlags`	`ExportShowFlags_Mirror`	const
`SplitscreenInfo`	`array<SplitscreenData>`
`TitleSafeZone`	`TitleSafeZoneArea`
`UIController`	`UIInteraction`
`UIControllerClass`	`class<UIInteraction>`
`Viewport`	`pointer`	const
`ViewportConsole`	`Console`
`ViewportFrame`	`pointer`	const

Functions¶

Name	Declaration
`AddLocalPlayer`	`private final function int AddLocalPlayer(LocalPlayer NewPlayer)`
`BecomePrimaryPlayer`	`function BecomePrimaryPlayer(int PlayerIndex)`
`CalculateDeadZoneForAllSides`	`final function bool CalculateDeadZoneForAllSides(LocalPlayer LPlayer, Canvas Canvas, out float fTopSafeZone, out float fBottomSafeZone, out float fLeftSafeZone, out float fRightSafeZone, optional bool bUseMaxPercent)`
`CalculateSafeZoneValues`	`final function CalculateSafeZoneValues(out float out_Horizontal, out float out_Vertical, canvas Canvas, int LocalPlayerIndex, bool bUseMaxPercent)`
`ClearProgressMessages`	`exec function ClearProgressMessages()`
`ConsoleCommand`	`native function string ConsoleCommand(string Command)`
`ConvertLocalPlayerToGamePlayerIndex`	`final function int ConvertLocalPlayerToGamePlayerIndex(LocalPlayer LPlayer)`
`CreateInitialPlayer`	`function bool CreateInitialPlayer(out string OutError)`
`CreatePlayer`	`event LocalPlayer CreatePlayer(int ControllerId, out string OutError, bool bSpawnActor)`
`DebugSetUISystemEnabled`	`native function DebugSetUISystemEnabled(bool bOldUISystemActive, bool bGFxUISystemActive)`
`DisableScaleform`	`final native function DisableScaleform()`
`DisplayProgressMessage`	`function DisplayProgressMessage(Canvas Canvas)`
`DrawTitleSafeArea`	`function DrawTitleSafeArea(canvas Canvas)`
`DrawTransition`	`function DrawTransition(Canvas Canvas)`
`DrawTransitionMessage`	`function DrawTransitionMessage(Canvas Canvas, string Message)`
`EnableScaleform`	`final native function EnableScaleform()`
`FindPlayerByControllerId`	`final event LocalPlayer FindPlayerByControllerId(int ControllerId)`
`FixupOwnerReferences`	`final native function FixupOwnerReferences(array IDMappings)`
`ForceUpdateMouseCursor`	`native function ForceUpdateMouseCursor(bool bSetCursor)`
`GameSessionEnded`	`event GameSessionEnded()`
`GetCustomInteractionClass`	`native function class<UIInteraction> GetCustomInteractionClass(int InIndex)`
`GetMousePosition`	`final native function vector2D GetMousePosition()`
`GetNumCustomInteractions`	`native function int GetNumCustomInteractions()`
`GetPixelSizeOfScreen`	`final function GetPixelSizeOfScreen(out float out_Width, out float out_Height, canvas Canvas, int LocalPlayerIndex)`
`GetPlayerOwner`	`final native function LocalPlayer GetPlayerOwner(int PlayerIndex)`
`GetSplitscreenConfiguration`	`function ESplitScreenType GetSplitscreenConfiguration()`
`GetSubtitleRegion`	`event GetSubtitleRegion(out vector2D MinPos, out vector2D MaxPos)`
`GetViewportSize`	`final native function GetViewportSize(out Vector2D out_ViewportSize)`
`HandleInputAxis`	`delegate bool HandleInputAxis(int ControllerId, name Key, float Delta, float DeltaTime, bool bGamepad)`
`HandleInputChar`	`delegate bool HandleInputChar(int ControllerId, string Unicode)`
`HandleInputKey`	`delegate bool HandleInputKey(int ControllerId, name Key, EInputEvent EventType, float AmountDepressed, optional bool bGamepad)`
`HasBottomSafeZone`	`final function bool HasBottomSafeZone(int LocalPlayerIndex)`
`HasLeftSafeZone`	`final function bool HasLeftSafeZone(int LocalPlayerIndex)`
`HasRightSafeZone`	`final function bool HasRightSafeZone(int LocalPlayerIndex)`
`HasTopSafeZone`	`final function bool HasTopSafeZone(int LocalPlayerIndex)`
`Init`	`event bool Init(out string OutError)`
`InsertInteraction`	`event int InsertInteraction(Interaction NewInteraction, optional int InIndex = -1)`
`IsBorderlessViewport`	`function bool IsBorderlessViewport()` (no declaration: types are approximate)
`IsClientMouseLockedToWindow`	`function bool IsClientMouseLockedToWindow()` (no declaration: types are approximate)
`IsFullScreenViewport`	`final native function bool IsFullScreenViewport()`
`IsScaleformEnabled`	`final native function bool IsScaleformEnabled()`
`LayoutPlayers`	`event LayoutPlayers()`
`NotifyConnectionError`	`function NotifyConnectionError(EProgressMessageType MessageType, optional string Message = Localize("Errors", "ConnectionFailed", "Engine"), optional string Title = Localize("Errors", "ConnectionFailed_Title", "Engine"))`
`NotifyPlayerAdded`	`final function NotifyPlayerAdded(int PlayerIndex, LocalPlayer AddedPlayer)`
`NotifyPlayerRemoved`	`final function NotifyPlayerRemoved(int PlayerIndex, LocalPlayer RemovedPlayer)`
`NotifySplitscreenLayoutChanged`	`native function NotifySplitscreenLayoutChanged()`
`OnPrimaryPlayerSwitch`	`function OnPrimaryPlayerSwitch(LocalPlayer OldPrimaryPlayer, LocalPlayer NewPrimaryPlayer)`
`PostRender`	`event PostRender(Canvas Canvas)`
`RemoveLocalPlayer`	`private final function int RemoveLocalPlayer(LocalPlayer ExistingPlayer)`
`RemovePlayer`	`event bool RemovePlayer(LocalPlayer ExPlayer)`
`SetClientMouseLockedToWindow`	`function SetClientMouseLockedToWindow(bool IsLocked)` (no declaration: types are approximate)
`SetCustomInteractionObject`	`native function SetCustomInteractionObject(Interaction InInteraction)`
`SetHardwareMouseCursorVisibility`	`simulated event SetHardwareMouseCursorVisibility(bool bIsVisible)`
`SetMouse`	`native function SetMouse(int X, int Y)`
`SetProgressMessage`	`event SetProgressMessage(EProgressMessageType MessageType, string Message, optional string Title, optional bool bIgnoreFutureNetworkMessages)`
`SetProgressTime`	`exec event SetProgressTime(float T)`
`SetSplitscreenConfiguration`	`function SetSplitscreenConfiguration(ESplitScreenType SplitType)`
`ShouldForceFullscreenViewport`	`final native function bool ShouldForceFullscreenViewport()`
`Tick`	`event Tick(float DeltaTime)`
`UpdateActiveSplitscreenType`	`function UpdateActiveSplitscreenType()`

Default values¶

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))

Inherited¶

From	Members
ScriptViewportClient	0 properties, 0 functions
Object	13 properties, 308 functions