Engine.UIDataStore_OnlineGameSettings

Extends

UIDataStore_Settings

Modifiers

native ( inherit ) abstract transient

This class is responsible for mapping properties in an OnlineGameSettings object to something that the UI system can consume. NOTE: Each game needs to derive at least one class from this one in order to expose the game's specific settings class(es)

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIDataProvider
      |   
      +-- Engine.UIDataStore
         |   
         +-- Engine.UIDataStore_Settings
            |   
            +-- Engine.UIDataStore_OnlineGameSettings

Direct Known Subclasses:

UTDataStore_GameSettingsDM

Functions Summary
	bool	CreateGame (byte ControllerIndex ))
	OnlineGameSettings	GetCurrentGameSettings ()))
	UIDataProvider_Settings	GetCurrentProvider ()))
		LoadToCurrentSettings (string ProfileName))
		MoveToNext ()))
		MoveToPrevious ()))
		SetCurrentByIndex (int NewIndex))
		SetCurrentByName (name SettingsName))
		StoreCurrentSettings (string ProfileName))

GameSettingsCfgList Source code

The list of settings that this data store is exposing

SelectedIndex Source code

The index into the list that is currently being exposed

GameSettingsCfg Source code

Holds the information used to expose 1 or more game settings providers
GameSettings:

The object we are exposing to the UI

GameSettingsClass:

The OnlineGameSettings derived class to create and expose

Provider:

The provider that was created to process the specified game settings object

SettingsName:

Used to set/select by name

CreateGame Source code

Called to kick create an online game based upon the settings
@param WorldInfo the world info object. useful for actor iterators
@param ControllerIndex the ControllerId for the player to create the game for
@return TRUE if the game was created, FALSE otherwise

GetCurrentGameSettings Source code

Returns the game settings object that is currently selected

GetCurrentProvider Source code

Returns the provider object that is currently selected

LoadToCurrentSettings Source code

MoveToNext Source code

Moves to the next item in the list

MoveToPrevious Source code

Moves to the previous item in the list

SetCurrentByIndex Source code

Sets the index into the list of game settings to use
@param NewIndex the new index to use

SetCurrentByName Source code

Sets the index into the list of game settings to use
@param SettingsName the name of the setting to find

StoreCurrentSettings Source code

defaultproperties
{
   Tag="OnlineGameSettings"
   WriteAccessType=ACCESS_WriteAll
   Name="Default__UIDataStore_OnlineGameSettings"
   ObjectArchetype=UIDataStore_Settings'Engine.Default__UIDataStore_Settings'
}