UE3:DataStoreClient (UT3)

Object >> UIRoot >> DataStoreClient

Package: 

Engine

This class in other games:

UDK

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

Properties

GlobalDataStoreClasses

Type: array<string>

Modifiers: config

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

Default value, index 0: "Engine.UIDataStore_Strings"

Default value, index 1: "Engine.UIDataStore_Images"

Default value, index 2: "Engine.UIDataStore_GameResource"

Default value, index 3: "Engine.CurrentGameDataStore"

Default value, index 4: "Engine.UIDataStore_SessionSettings"

Default value, index 5: "Engine.UIDataStore_Fonts"

Default value, index 6: "Engine.UIDataStore_Color"

Default value, index 7: "Engine.UIDataStore_Gamma"

Default value, index 8: "Engine.UIDataStore_Registry"

Default value, index 9: "UTGame.UTUIDataStore_Options"

Default value, index 10: "UTGame.UTUIDataStore_MenuItems"

Default value, index 11: "UTGame.UTDataStore_GameSettingsDM"

Default value, index 12: "UTGame.UTDataStore_GameSearchDM"

Default value, index 13: "UTGame.UTUIDataStore_CustomChar"

Default value, index 14: "UTGame.UTUIDataStore_StringList"

Default value, index 15: "UTGame.UTDataStore_OnlineStats"

Default value, index 16: "UTGame.UTUIDataStore_StringAliasMap"

Default value, index 17: "UTGame.UTUIDataStore_Content"

Default value, index 18: "UTGame.UTUIDataStore_2DStringList"

GlobalDataStores

Type: array<UIDataStore>

Modifiers: const

The list of global persistent data stores.

PlayerDataStoreClasses

Type: array<class<UIDataStore> >

Modifiers: const, private

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

PlayerDataStoreClassNames

Type: array<string>

Modifiers: config

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.)

Default value, index 0: "Engine.PlayerOwnerDataStore"

Default value, index 1: "Engine.UIDataStore_PlayerSettings"

Default value, index 2: "Engine.UIDataStore_OnlinePlayerData"

Default value, index 3: "UTGame.UTUIDataStore_StringAliasBindingsMap"

PlayerDataStores

Type: array<PlayerDataStoreGroup>

Modifiers: const

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

Structs

PlayerDataStoreGroup

Modifiers: native, transient

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

LocalPlayer PlayerOwner 

the player that this group is associated with.

array<UIDataStore> DataStores 

the list of data stores registered for this player.

Functions

Native functions

CreateDataStore

native final function coerce UIDataStore CreateDataStore (class<UIDataStore> DataStoreClass)

Creates and initializes an instance of the data store class specified.

Parameters:

• DataStoreClass - the data store class to create an instance of. DataStoreClass should be a child class of UUIDataStore

Returns:

a pointer to an instance of the data store class specified.

FindDataStore

native final function UIDataStore FindDataStore (name DataStoreTag, optional LocalPlayer PlayerOwner)

Finds the data store indicated by DataStoreTag and returns a pointer to it.

Parameters:

• DataStoreTag - A name corresponding to the 'Tag' property of a data store
• PlayerOwner - used for resolving the correct data stores in split-screen games.

Returns:

a pointer to the data store that has a Tag corresponding to DataStoreTag, or NULL if no data were found with that tag.

FindPlayerDataStoreIndex

native final function int FindPlayerDataStoreIndex (LocalPlayer PlayerOwner) const

Finds the index into the PlayerDataStores array for the data stores associated with the specified player.

Parameters:

• PlayerOwner - the player to search for associated data stores for.

GetAvailableDataStores

native final function GetAvailableDataStores (UIScene CurrentScene, out array<UIDataStore> out_DataStores) const

Retrieve the list of currently available data stores, including any temporary data stores associated with the specified scene.

Parameters:

• CurrentScene - the scene to use as the context for determining which data stores are available
• out_DataStores - will be filled with the list of data stores which are available from the context of the specified scene

RegisterDataStore

native final function bool RegisterDataStore (UIDataStore DataStore, optional LocalPlayer PlayerOwner)

Adds a new data store to the GlobalDataStores array.

Parameters:

• DataStore - the data store to add
• PlayerOwner - if specified, the data store will be added to the list of PlayerDataStores, rather than the list of global data stores

Returns:

TRUE if the data store was successfully added, or if the data store was already in the list.

UnregisterDataStore

native final function bool UnregisterDataStore (UIDataStore DataStore)

Removes a data store from the GlobalDataStores array.

Parameters:

• DataStore - the data store to remove

Returns:

TRUE if the data store was successfully removed, or if the data store wasn't in the list.

Events

NotifyGameSessionEnded

final event NotifyGameSessionEnded ()

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

Other instance functions

DebugDumpDataStoreInfo

final function DebugDumpDataStoreInfo (bool bVerbose)

FindDataStoreClass

final function class<UIDataStore> FindDataStoreClass (class<UIDataStore> RequiredMetaClass)

Searches the data store client's data store class arrays for a child of the specified meta class.

Parameters:

• RequiredMetaClass - the data store base class to search for.

Returns:

a pointer to a child class of RequiredMetaClass that was specified in the ini.