Always snap to grid

Difference between revisions of "UE3:UIDataProvider OnlinePlayers (UDK)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
 
m (1 revision: class descriptions for UDK January update (part 6))
 
Line 1: Line 1:
{{infobox class
+
{{UE3:UIDataProvider_OnlinePlayers (UT3)}}
| package = Engine
+
| parent1 = UIDataProvider_OnlinePlayerDataBase
+
| parent2 = UIDataProvider
+
| parent3 = UIRoot
+
| parent4 = Object
+
| interface1 = UIListElementCellProvider
+
}}
+
{{autogenerated}}
+
This class is responsible for retrieving the players list from the online
+
subsystem and populating the UI with that data.
+
 
+
==Functions==
+
===Events===
+
====OnRegister====
+
{{code|event '''OnRegister''' ({{cl|LocalPlayer}} '''InPlayer''')}}
+
 
+
'''Overrides:''' {{tl|OnRegister|UIDataProvider_OnlinePlayerDataBase}}
+
 
+
<!-- enter event description -->
+
 
+
===Other instance functions===
+
====OnPlayersReadComplete====
+
{{code|function '''OnPlayersReadComplete''' ()}}
+
 
+
Handles the notification that the async read of the players data is done
+

Latest revision as of 06:50, 17 January 2010

UDK Object >> UIRoot >> UIDataProvider >> UIDataProvider_OnlinePlayerDataBase >> UIDataProvider_OnlinePlayers
Package: 
Engine
Implemented interfaces
UIListElementCellProvider
This class in other games:
UT3

This class is responsible for retrieving the players list from the online subsystem and populating the UI with that data.

Functions[edit]

Events[edit]

OnRegister[edit]

event OnRegister (LocalPlayer InPlayer)

Overrides: UIDataProvider_OnlinePlayerDataBase.OnRegister

Binds the player to this provider. Starts the async friends list gathering

Parameters:

  • InPlayer - the player that we are retrieving friends for

Other instance functions[edit]

OnPlayersReadComplete[edit]

function OnPlayersReadComplete ()

Handles the notification that the async read of the players data is done