I love the smell of UnrealEd crashing in the morning. – tarquin
UE3:UIDataStore_OnlineGameSettings (UT3)
 |
Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_Settings >> UIDataStore_OnlineGameSettings |
Contents
- Package:
- Engine
- Direct subclass:
- UTDataStore_GameSettingsDM
- This class in other games:
- UDK
| This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
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[edit]
GameSettingsCfgList[edit]
Type: array<GameSettingsCfg>
Modifiers: const
The list of settings that this data store is exposing
SelectedIndex[edit]
Type: int
The index into the list that is currently being exposed
Default values[edit]
| Property | Value |
|---|---|
| Tag | 'OnlineGameSettings' |
| WriteAccessType | ACCESS_WriteAll |
Structs[edit]
GameSettingsCfg[edit]
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[edit]
Events[edit]
CreateGame[edit]
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[edit]
Returns the game settings object that is currently selected
GetCurrentProvider[edit]
Returns the provider object that is currently selected
MoveToNext[edit]
Moves to the next item in the list
MoveToPrevious[edit]
Moves to the previous item in the list
SetCurrentByIndex[edit]
Sets the index into the list of game settings to use
Parameters:
- NewIndex - the new index to use
SetCurrentByName[edit]
Sets the index into the list of game settings to use
Parameters:
- SettingsName - the name of the setting to find
