My program doesn't have bugs. It just develops random features.

UE3:UTUITabPage_InGame (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 07:03, 17 January 2010 by Wormbo (Talk | contribs) (1 revision: class descriptions for UDK January update (part 9))

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UDK Object >> UIRoot >> UIScreenObject >> UIObject >> UIContainer >> UITabPage >> UTTabPage >> UTUITabPage_InGame
Package: 
UTGame
Implemented interfaces
UIDataStoreSubscriber
This class in other games:
UT3


Properties[edit]

bCensor[edit]

Type: bool


bEndOfMatch[edit]

Type: bool

Modifiers: transient


bShowingRules[edit]

Type: bool

Modifiers: transient


bTeamGame[edit]

Type: bool

Modifiers: transient


ConsoleTextCnt[edit]

Type: int

Modifiers: transient


ConText[edit]

Type: UILabel

Modifiers: transient


LocalMapList[edit]

Type: array<UTUIDataProvider_MapInfo>

list of local maps - used to get more friendly names when possible

MOTD[edit]

Type: UILabel

Modifiers: transient


MOTDText[edit]

Type: string

Modifiers: transient


MyButtonBar[edit]

Type: UTUIButtonBar

Modifiers: transient


PlayerPanel[edit]

Type: UIPanel

Modifiers: transient


RulesButtonIndex[edit]

Type: int

Modifiers: transient


Servername[edit]

Type: UILabel

Modifiers: transient


TeamScore[edit]

Type: UILabel

Array size: 2

Modifiers: transient


Default values[edit]

Property Value
OnTick TabTick
bRequiresTick True

Subobjects[edit]

WidgetEventComponent[edit]

Class: Engine.UIComp_Event

Inherits from: UTTabPage.WidgetEventComponent

No new values.

Functions[edit]

Events[edit]

ActivatePage[edit]

event bool ActivatePage (int PlayerIndex, bool bActivate, optional bool bTakeFocus)

Overrides: UITabPage.ActivatePage

(Description copied from UITabPage.ActivatePage)
Causes this page to become (or no longer be) the tab control's currently active page.

Parameters:

  • PlayerIndex - the index [into the Engine.GamePlayers array] for the player that wishes to activate this page.
  • bActivate - TRUE if this page should become the tab control's active page; FALSE if it is losing the active status.
  • bTakeFocus - specify TRUE to give this panel focus once it's active (only relevant if bActivate = true)

Returns:

TRUE if this page successfully changed its active state; FALSE otherwise.

PostInitialize[edit]

event PostInitialize ()

Overrides: UIScreenObject.PostInitialize

Called after this screen object's children have been initialized. While the Initialized event is only called when a widget is initialized for the first time, PostInitialize() will be called every time this widget receives a call to Initialize(), even if the widget was already initialized. Examples would be reparenting a widget.

Other instance functions[edit]

CheckGameStatus[edit]

function CheckGameStatus ()


GetMapFriendlyName[edit]

function string GetMapFriendlyName (string Map)


HandleInputKey[edit]

function bool HandleInputKey (const out UIRoot.InputEventParameters EventParms)

Overrides: UTTabPage.HandleInputKey

(Description copied from UTTabPage.HandleInputKey)
Provides a hook for unrealscript to respond to input using actual input key names (i.e. Left, Tab, etc.)

Called when an input key event is received which this widget responds to and is in the correct state to process. The keys and states widgets receive input for is managed through the UI editor's key binding dialog (F8).

This delegate is called BEFORE kismet is given a chance to process the input.

Parameters:

  • EventParms - information about the input event.

Returns:

TRUE to indicate that this input key was processed; no further processing will occur on this input key event.

OnChangeTeam[edit]

function bool OnChangeTeam (UIScreenObject InButton, int InPlayerIndex)


OnMenuItemChosen[edit]

function OnMenuItemChosen (UTSimpleList SourceList, int SelectedIndex, int PlayerIndex)


ParseMutatorList[edit]

function string ParseMutatorList (string t)


Reset[edit]

function Reset (WorldInfo WI)


RulesButtonClicked[edit]

function bool RulesButtonClicked (UIScreenObject EventObject, int PlayerIndex)


SetMessageOfTheDay[edit]

function SetMessageOfTheDay ()

Looks up the Message of the Day and sets it

SetupButtonBar[edit]

function SetupButtonBar (UTUIButtonBar ButtonBar)

Overrides: UTTabPage.SetupButtonBar

Callback allowing the tabpage to setup the button bar for the current scene.

TabTick[edit]

function TabTick (float DeltaTime)

This tab is being ticked