Engine.DataStoreClient

Extends

UIRoot

Modifiers

native ( inherit ) Config ( Engine )

Creates and manages all globally accessible persistent data stores. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.DataStoreClient

Functions Summary
	UIDataStore	CreateDataStore (class<UIDataStore> DataStoreClass)
		DebugDumpDataStoreInfo (bool bVerbose ))
	UIDataStore	FindDataStore (name DataStoreTag, optional LocalPlayer PlayerOwner)
	class<UIDataStore>	FindDataStoreClass (class RequiredMetaClass ))
	int	FindPlayerDataStoreIndex (LocalPlayer PlayerOwner ) con)
		GetAvailableDataStores (UIScene CurrentScene, out array out_DataStores ) con)
		NotifyGameSessionEnded ()))
	bool	RegisterDataStore (UIDataStore DataStore, optional LocalPlayer PlayerOwner)
	bool	UnregisterDataStore (UIDataStore DataStore)

GlobalDataStoreClasses Source code

List of global data store class names to create when the data store client is created.

GlobalDataStores Source code

The list of global persistent data stores.

PlayerDataStoreClasses Source code

Stores the list of dynamic player data store classes that were loaded from PlayerDataStoreClassNames.

PlayerDataStoreClassNames Source code

List of data store class names that should be loaded at initialization time, but not created. Instances of these data stores will be created as they are needed (i.e. PlayerOwner, etc.)

PlayerDataStores Source code

the list of dynamic data stores that are created per-player.

PlayerDataStoreGroup Source code

Represents a collection of data stores that are linked to a specific player.
DataStores:

the list of data stores registered for this player.

PlayerOwner:

the player that this group is associated with.

CreateDataStore Source code

Creates and initializes an instance of the data store class specified.
@param DataStoreClass the data store class to create an instance of. DataStoreClass should be a child class of UUIDataStore
@return a pointer to an instance of the data store class specified.

DebugDumpDataStoreInfo Source code

FindDataStore Source code

Finds the data store indicated by DataStoreTag and returns a pointer to it.
@param DataStoreTag A name corresponding to the 'Tag' property of a data store
@param PlayerOwner used for resolving the correct data stores in split-screen games.
@return a pointer to the data store that has a Tag corresponding to DataStoreTag, or NULL if no data were found with that tag.

FindDataStoreClass Source code

Searches the data store client's data store class arrays for a child of the specified meta class.
@param RequiredMetaClass the data store base class to search for.
@return a pointer to a child class of RequiredMetaClass that was specified in the ini.

FindPlayerDataStoreIndex Source code

Finds the index into the PlayerDataStores array for the data stores associated with the specified player.
@param PlayerOwner the player to search for associated data stores for.

GetAvailableDataStores Source code

Retrieve the list of currently available data stores, including any temporary data stores associated with the specified scene.
@param CurrentScene the scene to use as the context for determining which data stores are available
@param out_DataStores will be filled with the list of data stores which are available from the context of the specified scene

NotifyGameSessionEnded Source code

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

RegisterDataStore Source code

Adds a new data store to the GlobalDataStores array.
@param DataStore the data store to add
@param PlayerOwner if specified, the data store will be added to the list of PlayerDataStores, rather than the list of global data stores
@return TRUE if the data store was successfully added, or if the data store was already in the list.

UnregisterDataStore Source code

Removes a data store from the GlobalDataStores array.
@param DataStore the data store to remove
@return TRUE if the data store was successfully removed, or if the data store wasn't in the list.

defaultproperties
{
   GlobalDataStoreClasses(0)="Engine.UIDataStore_Strings"
   GlobalDataStoreClasses(1)="Engine.UIDataStore_Images"
   GlobalDataStoreClasses(2)="Engine.UIDataStore_GameResource"
   GlobalDataStoreClasses(3)="Engine.CurrentGameDataStore"
   GlobalDataStoreClasses(4)="Engine.UIDataStore_SessionSettings"
   GlobalDataStoreClasses(5)="Engine.UIDataStore_Fonts"
   GlobalDataStoreClasses(6)="Engine.UIDataStore_Color"
   GlobalDataStoreClasses(7)="Engine.UIDataStore_Gamma"
   GlobalDataStoreClasses(8)="Engine.UIDataStore_Registry"
   GlobalDataStoreClasses(9)="UTGame.UTUIDataStore_Options"
   GlobalDataStoreClasses(10)="UTGame.UTUIDataStore_MenuItems"
   GlobalDataStoreClasses(11)="UTGame.UTDataStore_GameSettingsDM"
   GlobalDataStoreClasses(12)="UTGame.UTDataStore_GameSearchDM"
   GlobalDataStoreClasses(13)="UTGame.UTUIDataStore_CustomChar"
   GlobalDataStoreClasses(14)="UTGame.UTUIDataStore_StringList"
   GlobalDataStoreClasses(15)="UTGame.UTDataStore_OnlineStats"
   GlobalDataStoreClasses(16)="UTGame.UTUIDataStore_StringAliasMap"
   GlobalDataStoreClasses(17)="UTGame.UTUIDataStore_Content"
   GlobalDataStoreClasses(18)="UTGame.UTUIDataStore_2DStringList"
   PlayerDataStoreClassNames(0)="Engine.PlayerOwnerDataStore"
   PlayerDataStoreClassNames(1)="Engine.UIDataStore_PlayerSettings"
   PlayerDataStoreClassNames(2)="Engine.UIDataStore_OnlinePlayerData"
   PlayerDataStoreClassNames(3)="UTGame.UTUIDataStore_StringAliasBindingsMap"
   Name="Default__DataStoreClient"
   ObjectArchetype=UIRoot'Engine.Default__UIRoot'
}