Mostly Harmless
UE3:SessionSettingsProvider (UDK)
 |
Object >> UIRoot >> UIDataProvider >> UIPropertyDataProvider >> UISettingsProvider >> SessionSettingsProvider |
Contents
- Package:
- Engine
- Within class:
- UIDataStore_SessionSettings
- Direct subclass:
- SessionSettingsProvider_GameInfo
- This class in other games:
- UT3
| 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. |
Provides the UI with read/write access to settings which affect gameplay, such as gameinfo, mutator, and maplist settings.
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved
Todo: make this class also expose a copy of all settings as an array called "Settings" so that the UI can autogenerate lists of menu options, ala GUIMultiOptionList in UT2004.
Fixme: not ready for use yet!
Properties[edit]
ProviderClient[edit]
Type: Class
Modifiers: const, transient
the class that will provide the properties and metadata for the settings exposed in this provider. Set by calling BindProviderInstance.
ProviderClientClass[edit]
Type: class<UISettingsClient>
Modifiers: const, private
this is the UISettingsClient class that is used as the interface for retrieving metadata from data sources; only used by C++ to easily determine whether arbitrary classes implement the correct interface for use by this data provider
Default value: Class'Engine.UISettingsClient'
ProviderClientMetaClass[edit]
Type: Class
Modifiers: const
The metaclass for this data provider. Classes indicate which properties are available for use by settings data stores by marking the property with a keyword. Must implement the UISettingsClient interface.
Default values[edit]
| Property | Value |
|---|---|
| ProviderTag | 'SessionSettingsProvider' |
Functions[edit]
Native functions[edit]
BindProviderClient[edit]
Associates this data provider with the specified class.
Parameters:
- DataSourceClass - a pointer to the specific child of Dataclass that this data provider should present data for.
Returns:
- TRUE if the class specified was successfully associated with this data provider. FALSE if the object specified wasn't of the correct type or was otherwise invalid.
UnbindProviderClient[edit]
Clears the reference to the class associated with this data provider.
Returns:
- TRUE if the class reference was successfully cleared.
Events[edit]
IsValidDataSourceClass[edit]
Script hook for preventing a particular child of DataClass from being represented by this dynamic data provider.
Parameters:
- PotentialDataSourceClass - a child class of DataClass that is being considered as a candidate for binding by this provider.
Returns:
- return FALSE to prevent PotentialDataSourceClass's properties from being added to the UI editor's list of bindable properties for this data provider; also prevents any instances of PotentialDataSourceClass from binding to this provider at runtime.
ProviderClientBound[edit]
Called once BindProviderInstance has successfully verified that DataSourceInstance is of the correct type. Child classes can override this function to handle storing the reference, for example.
ProviderClientUnbound[edit]
Called immediately after this data provider's DataSource is disassociated from this data provider.
Other instance functions[edit]
CleanupDataProvider[edit]
Overrides: UISettingsProvider.CleanupDataProvider
Allows the data provider to clear any references that would interfere with garbage collection.
