UE3:UTUIScene_MidGameMenu (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
UT3 Object >> UIRoot >> UIScreenObject >> UIScene >> UTUIScene >> UTUIScene_Hud >> UTUIScene_MidGameMenu
Package:
UTGame
This class in other games:

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Properties

bInitial

Type: bool

Modifiers: transient


bLoading

Type: bool

Modifiers: transient


bNeedsProfileSave

Type: bool

Modifiers: transient


bOkToAutoClose

Type: bool

Modifiers: transient


bReturningToMainMenu

Type: bool

Modifiers: transient


ButtonBar

Type: UTUIButtonBar

Modifiers: transient


bWaitingForReady

Type: bool

Modifiers: transient


bWasDownloading

Type: bool

Modifiers: transient


InGamePage

Type: UTUITabPage_InGame

Modifiers: transient


LoadingLabel

Type: UILabel

Modifiers: transient


LoadingPanel

Type: UIPanel

Modifiers: transient


LoadingRotator

Type: UIImage

Modifiers: transient


MapVoteClock

Type: UILabel

Modifiers: transient


MBScene

Type: UTUIScene_MessageBox

Modifiers: transient


TabControl

Type: UTUITabControl

Modifiers: transient


VotePage

Type: UTUITabPage_VoteTab

Modifiers: transient


Default values

Property Value
bAlwaysRenderScene True
bDisableWorldRendering True
bDisplayCursor True
bRenderParentScenes False
bSaveSceneValuesOnClose False
SceneRenderMode SPLITRENDER_Fullscreen

Subobjects

SceneEventComponent

Class: Engine.UIComp_Event

Inherits from: UTUIScene_Hud.SceneEventComponent

No new values.

Functions

Events

BeginLoading

event BeginLoading ()


EndLoading

event EndLoading ()


PostInitialize

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Setup the delegates for the scene and cache all of the various UI Widgets

SceneActivated

event SceneActivated (bool bInitialActivation)

Overrides: UIScene.SceneActivated

(Description copied from UIScene.SceneActivated)
Called just after the scene is added to the ActiveScenes array, or when this scene has become the active scene as a result of closing another scene.

Parameters:

  • bInitialActivation - TRUE if this is the first time this scene is being activated; FALSE if this scene has become active as a result of closing another scene or manually moving this scene in the stack.

SceneDeactivated

event SceneDeactivated ()

Overrides: UIScene.SceneDeactivated

Called just after this scene is removed from the active scenes array

TickLoading

event TickLoading (float DeltaTime)


UpdateVote

event UpdateVote (UTGameReplicationInfo GRI)


Other instance functions

ActivateTab

function ActivateTab (name TabTag)


Back

function Back ()


BeginVoting

function BeginVoting (UTVoteReplicationInfo NewVoteRI)


ButtonBarBack

function bool ButtonBarBack (UIScreenObject InButton, int InPlayerIndex)

Back was selected, exit the menu

Parameters:

  • InButton - The button that selected
  • InPlayerIndex - Index of the local player that made the selection

ButtonBarDisconnect

function bool ButtonBarDisconnect (UIScreenObject InButton, int InPlayerIndex)


ButtonBarExitGame

function bool ButtonBarExitGame (UIScreenObject InButton, int InPlayerIndex)


ButtonBarJoin

function bool ButtonBarJoin (UIScreenObject InButton, int InPlayerIndex)


Disconnect

function Disconnect ()


GetMessageBoxScene

function UTUIScene_MessageBox GetMessageBoxScene (optional UIScene SceneReference)

Overrides: UTUIScene.GetMessageBoxScene

(Description copied from UTUIScene.GetMessageBoxScene)


Returns:

Opens the message box scene and returns a reference to it.

HandleInputKey

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)


MB_ExitSelection

function MB_ExitSelection (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)


MB_Selection

function MB_Selection (UTUIScene_MessageBox MessageBox, int SelectedOption, int PlayerIndex)


OnPageActivated

function OnPageActivated (UITabControl Sender, UITabPage NewlyActivePage, int PlayerIndex)

Called when a new page is activated.

Parameters:

  • Sender - the tab control that activated the page
  • NewlyActivePage - the page that was just activated
  • PlayerIndex - the index [into the Engine.GamePlayers array] for the player that generated this event.

ParseScrollback

function string ParseScrollback (const out array<stringScrollback)

Parse the scrollback and create a string out of it

PreRenderCallBack

function PreRenderCallBack ()


RepositionVotePage

function RepositionVotePage ()


Reset

function Reset ()

Reset will set the bWaitingForReady flag and reset the button bar

ScoreTabKickVoteNotify

function ScoreTabKickVoteNotify ()


SetupButtonBar

function SetupButtonBar ()

Overrides: UTUIScene.SetupButtonBar

Function that sets up a buttonbar for this scene, automatically routes the call to the currently selected tab of the scene as well.

UpdateVoteMenuLists

function UpdateVoteMenuLists (UTVoteReplicationInfo VRI, optional bool bUpdateGameLists, optional bool bUpdateMapLists, optional bool bUpdateMutatorLists)