UE3:UIDataStore_OnlineGameSettings (UDK)

Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_Settings >> UIDataStore_OnlineGameSettings

Package: 

Engine

Direct subclass:

UTDataStore_GameSettingsDM

This class in other games:

UT3

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)

Properties

GameSettingsCfgList

Type: array<GameSettingsCfg>

Modifiers: const

The list of settings that this data store is exposing

SelectedIndex

Type: int

The index into the list that is currently being exposed

SettingsProviderClass

Type: class<UIDataProvider_Settings>

Modifiers: const

the class to use for creating the data provider for each game settings object

Default value: Class'Engine.UIDataProvider_Settings'

Default values

Property	Value
Tag	'OnlineGameSettings'
WriteAccessType	ACCESS_WriteAll

Structs

GameSettingsCfg

Modifiers: native

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

class<OnlineGameSettings> GameSettingsClass 

The OnlineGameSettings derived class to create and expose

UIDataProvider_Settings Provider 

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

OnlineGameSettings GameSettings 

The object we are exposing to the UI

name SettingsName 

Used to set/select by name

Functions

Native functions

OnSettingProviderChanged

native final function OnSettingProviderChanged (UIDataProvider SourceProvider, optional name SettingsName)

Handler for this data store internal settings data providers OnDataProviderPropertyChange delegate. When the setting associated with that provider is updated, issues a refresh notification which causes e.g. widgets to refresh their values.

Parameters:

• SourceProvider - the data provider that generated the notification
• SettingsName - the name of the setting that changed

Events

CreateGame

event bool CreateGame (byte ControllerIndex)

Called to kick create an online game based upon the settings

Parameters:

• WorldInfo - the world info object. useful for actor iterators
• ControllerIndex - the ControllerId for the player to create the game for

Returns:

TRUE if the game was created, FALSE otherwise

GetCurrentGameSettings

event OnlineGameSettings GetCurrentGameSettings ()

Returns the game settings object that is currently selected

GetCurrentProvider

event UIDataProvider_Settings GetCurrentProvider ()

Returns the provider object that is currently selected

MoveToNext

event MoveToNext ()

Moves to the next item in the list

MoveToPrevious

event MoveToPrevious ()

Moves to the previous item in the list

Registered

event Registered (LocalPlayer PlayerOwner)

Overrides: UIDataStore.Registered

Called when this data store is added to the data store manager's list of active data stores.

Parameters:

• PlayerOwner - the player that will be associated with this DataStore. Only relevant if this data store is associated with a particular player; NULL if this is a global data store.

SetCurrentByIndex

event SetCurrentByIndex (int NewIndex)

Sets the index into the list of game settings to use

Parameters:

• NewIndex - the new index to use

SetCurrentByName

event SetCurrentByName (name SettingsName)

Sets the index into the list of game settings to use

Parameters:

• SettingsName - the name of the setting to find

Unregistered

event Unregistered (LocalPlayer PlayerOwner)

Overrides: UIDataStore.Unregistered

Called when this data store is removed from the data store manager's list of active data stores.

Parameters:

• PlayerOwner - the player that will be associated with this DataStore. Only relevant if this data store is associated with a particular player; NULL if this is a global data store.