UE3:UTUITabPage StatsPage (UT3): Difference between revisions

From Unreal Wiki, The Unreal Engine Documentation Site
Auto-generated page
 
m added missing members
 
Line 11: Line 11:
}}
}}
{{autogenerated}}
{{autogenerated}}
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.
Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.


Tab page for a user's stats.
Tab page for a user's stats.
Line 36: Line 36:


Reference to the stats interface.
Reference to the stats interface.
====StatsList====
'''Type:''' {{cl|UIList}}
'''[[Variables#Modifiers|Modifiers]]:''' transient
Reference to the stats list


===Subobjects===
===Subobjects===
Line 47: Line 54:
==Functions==
==Functions==
===Events===
===Events===
====ActivatePage====
{{code|event [[bool]] '''ActivatePage''' ([[int]] '''PlayerIndex''', [[bool]] '''bActivate''', optional [[bool]] '''bTakeFocus''')}}
'''Overrides:''' {{tl|ActivatePage|UITabPage}}
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====
====PostInitialize====
{{code|event '''PostInitialize''' ()}}
{{code|event '''PostInitialize''' ()}}

Latest revision as of 06:43, 16 August 2009

UT3 Object >> UIRoot >> UIScreenObject >> UIObject >> UIContainer >> UITabPage >> UTTabPage >> UTUITabPage_StatsPage
Package:
UTGame
Implemented interfaces:
UIDataStoreSubscriber
Direct subclasses:
UTUITabPage_StatsVehicles, UTUITabPage_StatsWeapons, UTUITabPage_StatsGeneral, UTUITabPage_StatsRewards, UTUITabPage_StatsVehicleWeapons

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

Tab page for a user's stats.

Properties[edit]

RefreshingLabel[edit]

Type: UILabel

Modifiers: transient

Refreshing label.

StatsDataStore[edit]

Type: UTDataStore_OnlineStats

Modifiers: transient

Reference to the stats datastore.

StatsInterface[edit]

Type: OnlineStatsInterface

Modifiers: transient

Reference to the stats interface.

StatsList[edit]

Type: UIList

Modifiers: transient

Reference to the stats list

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

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

Callback for when the widget has finished initialized.

Other instance functions[edit]

OnStatsReadComplete[edit]

function OnStatsReadComplete (bool bWasSuccessful)

Called by the data store when the stats read has completed

Parameters:

  • bWasSuccessful - whether the stats read was successful or not

ReadStats[edit]

function ReadStats ()

Starts the stats read for this page.