UE3:CurrentGameDataStore (UDK)

Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_GameState >> CurrentGameDataStore

Package: 

Engine

Implemented interfaces: 

UIListElementProvider

This class in other games:

UT3

Provides data about the current game.

Properties

bRefreshPlayerDataProviders

Type: bool

Modifiers: protected, transient

Indicates that one or more players have changed or been updated.

bRefreshTeamDataProviders

Type: bool

Modifiers: protected, transient

Indicates that one or more player's teams have changed.

GameData

Type: GameInfoDataProvider

Modifiers: protected

The GameInfoDataProvider that manages access to the current gameinfo's exposed data.

PlayerData

Type: array<PlayerDataProvider>

Modifiers: protected

The data providers for all players in the current match

ProviderTypes

Type: GameDataProviderTypes

Modifiers: const

Default value:

Member	Value
GameDataProviderClass	Class'Engine.GameInfoDataProvider'
PlayerDataProviderClass	Class'Engine.PlayerDataProvider'
TeamDataProviderClass	Class'Engine.TeamDataProvider'

TeamData

Type: array<TeamDataProvider>

Modifiers: protected

The data providers for all teams in the current match.

Default values

Property	Value
Tag	'CurrentGame'

Structs

GameDataProviderTypes

Modifiers: native

Contains the classes which should be used for instancing data providers.

class<GameInfoDataProvider> GameDataProviderClass 

the class to use for the game info data provider

class<PlayerDataProvider> PlayerDataProviderClass 

the class to use for the player data providers

class<TeamDataProvider> TeamDataProviderClass 

the class to use for the team data provider.

Delegates

OnAddTeamProvider

delegate OnAddTeamProvider (TeamDataProvider Provider)

Instance functions

AddPlayerDataProvider

final function AddPlayerDataProvider (PlayerReplicationInfo PRI)

Creates a PlayerDataProvider for the specified PlayerReplicationInfo, and adds it to the PlayerData array.

Parameters:

• PRI - the PlayerReplicationInfo to create the PlayerDataProvider for.

AddTeamDataProvider

final function AddTeamDataProvider (TeamInfo TI)

Creates a TeamDataProvider for the specified TeamInfo, and adds it to the TeamData array.

Parameters:

• TI - the TeamInfo to create the TeamDataProvider for.

ClearDataProviders

final function ClearDataProviders ()

Clears all data provider references.

CreateGameDataProvider

final function CreateGameDataProvider (GameReplicationInfo GRI)

Creates the GameInfoDataProvider that will track all game info state data

FindPlayerDataProviderIndex

final function int FindPlayerDataProviderIndex (PlayerReplicationInfo PRI)

Returns the index into the PlayerData array for the PlayerDataProvider associated with the specified PlayerReplicationInfo.

Parameters:

• PRI - the PlayerReplicationInfo to search for

Returns:

an index into the PlayerData array for the PlayerDataProvider associated with the specified PlayerReplicationInfo, or INDEX_NONE if no associated PlayerDataProvider was found

FindTeamDataProviderIndex

final function int FindTeamDataProviderIndex (TeamInfo TI)

Returns the index into the TeamData array for the TeamDataProvider associated with the specified TeamInfo.

Parameters:

• TI - the TeamInfo to search for

Returns:

an index into the TeamData array for the TeamDataProvider associated with the specified TeamInfo, or INDEX_NONE if no associated TeamDataProvider was found

GetPlayerDataProvider

final function PlayerDataProvider GetPlayerDataProvider (PlayerReplicationInfo PRI)

Returns a reference to the PlayerDataProvider associated with the PRI specified.

Parameters:

• PRI - the PlayerReplicationInfo to search for

Returns:

the PlayerDataProvider associated with the PRI specified, or None if there was no PlayerDataProvider for the PRI specified.

GetTeamDataProvider

final function TeamDataProvider GetTeamDataProvider (TeamInfo TI)

Returns a reference to the TeamDataProvider associated with the TI specified.

Parameters:

• TI - the TeamInfo to search for

Returns:

the TeamDataProvider associated with the TeamInfo specified, or None if there was no TeamDataProvider for the TeamInfo specified.

NotifyGameSessionEnded

function bool NotifyGameSessionEnded ()

Overrides: UIDataStore_GameState.NotifyGameSessionEnded

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

Returns:

TRUE indicates that this data store should be automatically unregistered when this game session ends.

NotifyPlayersChanged

function NotifyPlayersChanged ()

Sets a flag indicating that the array of PlayerDataProviders has changed and subscribers should be notified

Note: not yet implemented

NotifyTeamChange

function NotifyTeamChange ()

Called whenever a player changes team or something affecting the team. Issues a request for the TeamDataProviders to update their cached lists of players.

PlayerDataProviderPropertyChange

function PlayerDataProviderPropertyChange (UIDataProvider SourceProvider, optional name PropTag)

Handler for the PlayerDataProvider's OnDataProviderPropertyChange delegate. Forwards the notification to the data store's notification delegates.

Parameters:

• SourceProvider - the data provider that generated the notification
• PropTag - the property that changed

RefreshPlayerDataProviders

function RefreshPlayerDataProviders ()

Refreshes any subscribers bound to the array of PlayerDataProviders.

Note: not yet implemented.

RefreshTeamDataProviders

function RefreshTeamDataProviders ()

Instructs the team data providers to update their cached lists of players.

RemovePlayerDataProvider

final function RemovePlayerDataProvider (PlayerReplicationInfo PRI)

Removes the PlayerDataProvider associated with the specified PlayerReplicationInfo.

Parameters:

• PRI - the PlayerReplicationInfo to remove the data provider for.

RemoveTeamDataProvider

final function RemoveTeamDataProvider (TeamInfo TI)

Removes the TeamDataProvider associated with the specified TeamInfo.

Parameters:

• TI - the TeamInfo to remove the data provider for.

TeamDataProviderPropertyChange

function TeamDataProviderPropertyChange (UIDataProvider SourceProvider, optional name PropTag)

Handler for the TeamDataProvider's OnDataProviderPropertyChange delegate. Forwards the notification to the data store's notification delegates.

Parameters:

• SourceProvider - the data provider that generated the notification
• PropTag - the property that changed

Timer

function Timer ()

Called by the GameReplicationInfo each time it receives a call to Timer()