I'm a doctor, not a mechanic

UE3:CurrentGameDataStore (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
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[edit]

bRefreshPlayerDataProviders[edit]

Type: bool

Modifiers: protected, transient

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

bRefreshTeamDataProviders[edit]

Type: bool

Modifiers: protected, transient

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

GameData[edit]

Type: GameInfoDataProvider

Modifiers: protected

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

PlayerData[edit]

Type: array<PlayerDataProvider>

Modifiers: protected

The data providers for all players in the current match

ProviderTypes[edit]

Type: GameDataProviderTypes

Modifiers: const


Default value:

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

TeamData[edit]

Type: array<TeamDataProvider>

Modifiers: protected

The data providers for all teams in the current match.

Default values[edit]

Property Value
Tag 'CurrentGame'

Structs[edit]

GameDataProviderTypes[edit]

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[edit]

OnAddTeamProvider[edit]

delegate OnAddTeamProvider (TeamDataProvider Provider)


Instance functions[edit]

AddPlayerDataProvider[edit]

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[edit]

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[edit]

final function ClearDataProviders ()

Clears all data provider references.

CreateGameDataProvider[edit]

final function CreateGameDataProvider (GameReplicationInfo GRI)

Creates the GameInfoDataProvider that will track all game info state data

FindPlayerDataProviderIndex[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

function NotifyPlayersChanged ()

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

Note: not yet implemented

NotifyTeamChange[edit]

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[edit]

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[edit]

function RefreshPlayerDataProviders ()

Refreshes any subscribers bound to the array of PlayerDataProviders.

Note: not yet implemented.

RefreshTeamDataProviders[edit]

function RefreshTeamDataProviders ()

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

RemovePlayerDataProvider[edit]

final function RemovePlayerDataProvider (PlayerReplicationInfo PRI)

Removes the PlayerDataProvider associated with the specified PlayerReplicationInfo.

Parameters:

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

RemoveTeamDataProvider[edit]

final function RemoveTeamDataProvider (TeamInfo TI)

Removes the TeamDataProvider associated with the specified TeamInfo.

Parameters:

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

TeamDataProviderPropertyChange[edit]

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[edit]

function Timer ()

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