Worst-case scenario: the UEd Goblin wipes the map and burns down your house.

UE3:UIDataProvider_Settings (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> UIRoot >> UIDataProvider >> UIPropertyDataProvider >> UIDynamicDataProvider >> UIDataProvider_Settings
Package: 
Engine
Implemented interfaces
UIListElementCellProvider
Direct subclass:
UTUIDataProvider_SearchResult
This class in other games:
UT3

This class is responsible for mapping properties in an Settings object to something that the UI system can consume.

Properties[edit]

bIsAListRow[edit]

Type: bool

Whether this provider is a row in a list (removes array handling)

Settings[edit]

Type: Settings

Holds the settings object that will be exposed to the UI

SettingsArrayProviders[edit]

Type: array<SettingsArrayProvider>

The list of mappings from settings id to their provider

Default values[edit]

Property Value
WriteAccessType ACCESS_WriteAll

Structs[edit]

SettingsArrayProvider[edit]

Modifiers: native

Keeps a list of providers for each settings id

int SettingsId 
The settings id that this provider is for
name SettingsName 
Cached to avoid extra look ups
UIDataProvider_SettingsArray Provider 
The provider object to expose the data with

Functions[edit]

Events[edit]

ProviderInstanceBound[edit]

event ProviderInstanceBound (Object DataSourceInstance)

Overrides: UIDynamicDataProvider.ProviderInstanceBound

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.

ProviderInstanceUnbound[edit]

event ProviderInstanceUnbound (Object DataSourceInstance)

Overrides: UIDynamicDataProvider.ProviderInstanceUnbound

Called immediately after this data provider's DataSource is disassociated from this data provider.

Other instance functions[edit]

ArrayProviderPropertyChanged[edit]

function ArrayProviderPropertyChanged (UIDataProvider SourceProvider, optional name PropTag)

Called when a setting or property which is bound to one of our array providers is updated.

Parameters:

  • SourceProvider - the data provider that generated the notification
  • PropTag - the property that changed

OnSettingValueUpdated[edit]

function OnSettingValueUpdated (name SettingName)

Handler for the OnDataProviderPropertyChange delegate in our internal array providers. Determines which provider sent the update and propagates that update to this provider's own list of listeners.

Parameters:

  • SettingName - the name of the setting that was changed.