Engine.CurrentGameDataStore

Extends

UIDataStore_GameState

Modifiers

native ( inherit )

Provides data about the current game. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIDataProvider
      |   
      +-- Engine.UIDataStore
         |   
         +-- Engine.UIDataStore_GameState
            |   
            +-- Engine.CurrentGameDataStore

Functions Summary
		AddPlayerDataProvider (PlayerReplicationInfo PRI ))
		AddTeamDataProvider (TeamInfo TI ))
		ClearDataProviders ()))
		CreateGameDataProvider (GameReplicationInfo GRI ))
	int	FindPlayerDataProviderIndex (PlayerReplicationInfo PRI ))
	int	FindTeamDataProviderIndex (TeamInfo TI ))
	PlayerDataProvider	GetPlayerDataProvider (PlayerReplicationInfo PRI ))
	TeamDataProvider	GetTeamDataProvider (TeamInfo TI ))
	bool	NotifyGameSessionEnded ()))
		RemovePlayerDataProvider (PlayerReplicationInfo PRI ))
		RemoveTeamDataProvider (TeamInfo TI ))

GameData Source code

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

PlayerData Source code

The data providers for all players in the current match

ProviderTypes Source code

TeamData Source code

The data providers for all teams in the current match.

GameDataProviderTypes Source code

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

the class to use for the game info data provider

PlayerDataProviderClass:

the class to use for the player data providers

TeamDataProviderClass:

the class to use for the team data provider.

AddPlayerDataProvider Source code

Creates a PlayerDataProvider for the specified PlayerReplicationInfo, and adds it to the PlayerData array.
@param PRI the PlayerReplicationInfo to create the PlayerDataProvider for.

AddTeamDataProvider Source code

Creates a TeamDataProvider for the specified TeamInfo, and adds it to the TeamData array.
@param TI the TeamInfo to create the TeamDataProvider for.

ClearDataProviders Source code

Clears all data provider references.

CreateGameDataProvider Source code

Creates the GameInfoDataProvider that will track all game info state data

FindPlayerDataProviderIndex Source code

Returns the index into the PlayerData array for the PlayerDataProvider associated with the specified PlayerReplicationInfo.
@param PRI the PlayerReplicationInfo to search for
@return an index into the PlayerData array for the PlayerDataProvider associated with the specified PlayerReplicationInfo, or INDEX_NONE if no associated PlayerDataProvider was found

FindTeamDataProviderIndex Source code

Returns the index into the TeamData array for the TeamDataProvider associated with the specified TeamInfo.
@param TI the TeamInfo to search for
@return an index into the TeamData array for the TeamDataProvider associated with the specified TeamInfo, or INDEX_NONE if no associated TeamDataProvider was found

GetPlayerDataProvider Source code

Returns a reference to the PlayerDataProvider associated with the PRI specified.
@param PRI the PlayerReplicationInfo to search for
@return the PlayerDataProvider associated with the PRI specified, or None if there was no PlayerDataProvider for the PRI specified.

GetTeamDataProvider Source code

Returns a reference to the TeamDataProvider associated with the TI specified.
@param TI the TeamInfo to search for
@return the TeamDataProvider associated with the TeamInfo specified, or None if there was no TeamDataProvider for the TeamInfo specified.

NotifyGameSessionEnded Source code

Called when the current map is being unloaded. Cleans up any references which would prevent garbage collection.
@return TRUE indicates that this data store should be automatically unregistered when this game session ends.

RemovePlayerDataProvider Source code

Removes the PlayerDataProvider associated with the specified PlayerReplicationInfo.
@param PRI the PlayerReplicationInfo to remove the data provider for.

RemoveTeamDataProvider Source code

Removes the TeamDataProvider associated with the specified TeamInfo.
@param TI the TeamInfo to remove the data provider for.

defaultproperties
{
   ProviderTypes=(GameDataProviderClass=Class'Engine.GameInfoDataProvider',PlayerDataProviderClass=Class'Engine.PlayerDataProvider',TeamDataProviderClass=Class'Engine.TeamDataProvider')
   Tag="CurrentGame"
   Name="Default__CurrentGameDataStore"
   ObjectArchetype=UIDataStore_GameState'Engine.Default__UIDataStore_GameState'
}