Engine.UIDataStore_PlayerSettings

/**
 * This class provides the UI with access to player settings providers.
 *
 * Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
 */
class UIDataStore_PlayerSettings extends UIDataStore_Settings
	native(inherit);

// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)
// (cpptext)

/**
 * Array of PlayerSettingsProvider derived class names to load and initialize
 */
var	const	config		array<string>							PlayerSettingsProviderClassNames;

/**
 * Array of PlayerSettingsProvider derived classes loaded from PlayerSettingsProviderClassNames.  Filled in InitializeDataStore().
 */
var	const	transient	array<class<PlayerSettingsProvider> >	PlayerSettingsProviderClasses;

/**
 * The data provider for all player specific settings, such as input, display, and audio settings.  Each element of the array
 * represents the settings for the player associated with the corresponding element of the Engine.GamePlayers array.
 */
var			transient	array<PlayerSettingsProvider>			PlayerSettings;

/**
 * The index [into the Engine.GamePlayers array] for the player that this data store provides settings for.
 */
var	const	transient		int									PlayerIndex;

/**
 * Returns a reference to the ULocalPlayer that this PlayerSettingsProvdier provider settings data for
 */
native final function LocalPlayer GetPlayerOwner() const;

/**
 * Clears all data provider references.
 */
final function ClearDataProviders()
{
	local int i;

	for ( i = 0; i < PlayerSettings.Length; i++ )
	{
		//@todo - what to do if CleanupDataProvider return false?
		PlayerSettings[i].CleanupDataProvider();
	}

	PlayerSettings.Length = 0;
}

/**
 * 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.
 */
function bool NotifyGameSessionEnded()
{
	ClearDataProviders();

	// this data store should be automatically unregistered when the game session ends
	return true;
}

defaultproperties
{
   Tag="PlayerSettings"
   Name="Default__UIDataStore_PlayerSettings"
   ObjectArchetype=UIDataStore_Settings'Engine.Default__UIDataStore_Settings'
}