Engine.GameUISceneClient

Extends

UISceneClient

Modifiers

within UIInteraction native ( UIPrivate ) config ( UI )

UISceneClient used when playing a game. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UISceneClient
      |   
      +-- Engine.GameUISceneClient

Direct Known Subclasses:

UTGameUISceneClient

Functions Summary
	UIAnimationSeq	AnimLookupSequence (name SequenceName))
		AnimSubscribe (UIObject Target))
		AnimUnSubscribe (UIObject Target))
	bool	CanShowToolTips ()))
	bool	CanUnpauseInternalUI ()
		ClearMenuProgression ()))
		CloseMenu (name SceneName ))
		ConditionalPause (bool bDesiredPauseState ))
		CreateMenu (class<UIScene> SceneClass, optional int PlayerIndex=INDEX_NONE ))
	UIScene	CreateScene (class<UIScene> SceneClass, optional name SceneTag, optional UIScene SceneTemplate)
	UIObject	CreateTransientWidget (class<UIObject> WidgetClass, Name WidgetTag, optional UIObject Owner)
	UIScene	FindSceneByTag (name SceneTag, optional LocalPlayer SceneOwner ) con)
	UIScene	GetActiveScene ()))
	WorldInfo.ENetMode	GetCurrentNetMode ()
	UIScene	GetTransientScene () con)
		NotifyGameSessionEnded ()))
		NotifyLinkStatusChanged (bool bConnected ))
		NotifyOnlineServiceStatusChanged (EOnlineServerConnectionStatus NewConnectionStatus ))
		NotifyPlayerAdded (int PlayerIndex, LocalPlayer AddedPlayer ))
		NotifyPlayerRemoved (int PlayerIndex, LocalPlayer RemovedPlayer ))
		OpenMenu (string MenuPath, optional int PlayerIndex=INDEX_NONE ))
		RefreshFormatting ()))
		RequestCursorRenderUpdate ()
		RequestInputProcessingUpdate ()
		RestoreMenuProgression (optional UIScene BaseScene ))
		SaveMenuProgression ()))
	bool	SetActiveControl (UIObject NewActiveControl)
		ShowDataStoreField (string DataStoreMarkup ))
		ShowDataStores (optional bool bVerbose ))
		ShowDockingStacks ()))
		ShowMenuProgression ()))
		ShowMenuStates ()))
		ShowRenderBounds ()))
		ToggleDebugInput (optional bool bEnable=!bEnableDebugInput ))

ActiveScenes Source code

the list of scenes currently open. A scene corresponds to a top-level UI construct, such as a menu or HUD There is always at least one scene in the stack - the transient scene. The transient scene is used as the container for all widgets created by unrealscript and is always rendered last.

AnimSequencePool Source code

Holds a list of all available animations for an object

AnimSubscribers Source code

Holds a list of UIObjects that have animations being applied to them

bDisplayFullPaths Source code

bEnableDebugInput Source code

Controls whether debug input commands are accepted

bInteractiveMode Source code

bKillRestoreMenuProgression Source code

Will halt the restoring of the menu progression

bRenderActiveControlInfo Source code

Controls whether debug information is rendered about the active control

bRenderCursor Source code

Determines whether the cursor should be rendered. Set by UpdateMouseCursor()

bRenderDebugInfo Source code

Controls whether debug information about the scene is rendered

bRenderDebugInfoAtTop Source code

Controls whether debug information is rendered at the top or bottom of the screen

bRenderFocusedControlInfo Source code

Controls whether debug information is rendered about the currently focused control

bRenderTargetControlInfo Source code

Controls whether debug information is rendered about the targeted control

bRestrictActiveControlToFocusedScene Source code

Controls whether a widget can become the scene client's ActiveControl if it isn't in the top-most/focused scene. False allows widgets in background scenes to become the active control.

bSelectVisibleTargetsOnly Source code

Controls whether a widget must be visible to become the debug target

bShowCurrentState Source code

bShowMousePos Source code

bShowRenderBounds Source code

bShowWidgetPath Source code

bUpdateCursorRenderStatus Source code

Indicates that the input processing status of the UI has potentially changed; causes UpdateCursorRenderStatus to be called in the next Tick().

bUpdateInputProcessingStatus Source code

Indicates that the input processing status of the UI has potentially changed; causes UpdateInputProcessingStatus to be called in the next Tick().

CurrentMouseCursor Source code

The mouse cursor that is currently being used. Updated by scenes & widgets as they change states by calling ChangeMouseCursor.

DebugTarget Source code

For debugging - the widget that is currently being watched.

DefaultUITexture[EUIDefaultPenColor] Source code

Textures for general use by the UI

DoubleClickStartPosition Source code

The location of the mouse the last time a key press was received. Used to determine when to simulate a double-click event.

DoubleClickStartTime Source code

The time (in seconds) that the last "key down" event was recieved from a key that can trigger double-click events

InitialPressedKeys Source code

map of controllerID to list of keys which were pressed when the UI began processing input used to ignore the initial "release" key event from keys which were already pressed when the UI began processing input.

LatestDeltaTime Source code

Cached DeltaTime value from the last Tick() call

OverlaySceneAlphaModulation Source code

A multiplier value (between 0.0 and 1.f) used for adjusting the transparency of scenes rendered behind scenes which have bRenderParentScenes set to TRUE. The final alpha used for rendering background scenes is cumulative.

AnimLookupSequence Source code

Attempt to find an animation in the AnimSequencePool.
@Param SequenceName The sequence to find
@returns the sequence if it was found otherwise returns none

AnimSubscribe Source code

Subscribes a UIObject so that it will receive TickAnim calls

AnimUnSubscribe Source code

UnSubscribe a UIObject so that it will receive TickAnim calls

CanShowToolTips Source code

Returns whether widget tooltips should be displayed.

CanUnpauseInternalUI Source code

Callback which allows the UI to prevent unpausing if scenes which require pausing are still active. @see PlayerController.SetPause

ClearMenuProgression Source code

Clears out any existing stored menu progression values.

CloseMenu Source code

ConditionalPause Source code

Toggles the game's paused state if it does not match the desired pause state.
@param bDesiredPauseState TRUE indicates that the game should be paused.

CreateMenu Source code

CreateScene Source code

Creates an instance of the scene class specified. Used to create scenes from unrealscript. Does not initialize the scene - you must call OpenScene, passing in the result of this function as the scene to be opened.
@param SceneClass the scene class to open
@param SceneTag if specified, the scene will be given this tag when created
@param SceneTemplate if specified, will be used as the template for the newly created scene if it is a subclass of SceneClass
@return a UIScene instance of the class specified

CreateTransientWidget Source code

Create a temporary widget for presenting data from unrealscript
@param WidgetClass the widget class to create
@param WidgetTag the tag to assign to the widget.
@param Owner the UIObject that should contain the widget
@return a pointer to a fully initialized widget of the class specified, contained within the transient scene
@todo - add support for metacasting using a property flag (i.e. like spawn auto-casts the result to the appropriate type)

FindSceneByTag Source code

Searches through the ActiveScenes array for a UIScene with the tag specified
@param SceneTag the name of the scene to locate
@param SceneOwner if specified, only scenes that have the specified SceneOwner will be considered.
@return pointer to the UIScene that has a SceneName matching SceneTag, or NULL if no scenes in the ActiveScenes stack have that name

GetActiveScene Source code

Returns the currently active scene

GetCurrentNetMode Source code

@return the current netmode, or NM_MAX if there is no valid world

GetTransientScene Source code

Get a reference to the transient scene, which is used to contain transient widgets that are created by unrealscript
@return pointer to the UIScene that owns transient widgets

NotifyGameSessionEnded Source code

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

NotifyLinkStatusChanged Source code

Called when the status of the platform's network connection changes.

NotifyOnlineServiceStatusChanged Source code

Called when a system level connection change notification occurs.
@param ConnectionStatus the new connection status.

NotifyPlayerAdded Source code

Called when a new player has been added to the list of active players (i.e. split-screen join)
@param PlayerIndex the index [into the GamePlayers array] where the player was inserted
@param AddedPlayer the player that was added

NotifyPlayerRemoved Source code

Called when a player has been removed from the list of active players (i.e. split-screen players)
@param PlayerIndex the index [into the GamePlayers array] where the player was located
@param RemovedPlayer the player that was removed

OpenMenu Source code

RefreshFormatting Source code

RequestCursorRenderUpdate Source code

Triggers a call to UpdateCursorRenderStatus on the next Tick().

RequestInputProcessingUpdate Source code

Triggers a call to UpdateInputProcessingStatus on the next Tick().

RestoreMenuProgression Source code

Re-opens the scenes which were saved off to the Registry data store. Should be called from your game's main front-end menu.
@param BaseScene the scene to use as the starting point for restoring scenes; if not specified, uses the currently active scene.

SaveMenuProgression Source code

Stores the list of currently active scenes which are restorable to the Registry data store for retrieval when returning back to the front end menus.

SetActiveControl Source code

Changes this scene client's ActiveControl to the specified value, which might be NULL. If there is already an ActiveControl
@param NewActiveControl the widget that should become to ActiveControl, or NULL to clear the ActiveControl.
@return TRUE if the ActiveControl was updated successfully.

ShowDataStoreField Source code

ShowDataStores Source code

Debug console command for dumping all registered data stores to the log
@param bFullDump specify TRUE to show detailed information about each registered data store.

ShowDockingStacks Source code

ShowMenuProgression Source code

ShowMenuStates Source code

ShowRenderBounds Source code

ToggleDebugInput Source code

defaultproperties
{
   bEnableDebugInput=True
   bRenderDebugInfoAtTop=True
   bRenderActiveControlInfo=True
   bRenderFocusedControlInfo=True
   bRenderTargetControlInfo=True
   bSelectVisibleTargetsOnly=True
   bDisplayFullPaths=True
   bShowWidgetPath=True
   bShowRenderBounds=True
   bShowCurrentState=True
   bShowMousePos=True
   bRestrictActiveControlToFocusedScene=True
   OverlaySceneAlphaModulation=0.450000
   Name="Default__GameUISceneClient"
   ObjectArchetype=UISceneClient'Engine.Default__UISceneClient'
}