Cogito, ergo sum

UE3:UIDataStore_SessionSettings (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 11:47, 6 November 2009 by (Talk)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
UDK Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_Settings >> UIDataStore_SessionSettings
Package: 
Engine
Known classes within UIDataStore_SessionSettings:
SessionSettingsProvider, SessionSettingsProvider_GameInfo
This class in other games:
UT3

This class provides the UI with access to game session settings providers.

Fixme: not ready for use yet!

Properties

SessionSettings

Type: array<SessionSettingsProvider>

Modifiers: transient

The data providers for all session settings, such as game info settings, access control settings, etc.

SessionSettingsProviderClasses

Type: array<class<SessionSettingsProvider> >

Modifiers: const, transient

Array of SessionSettingsProvider derived classes loaded from SessionSettingsProviderClassNames. Filled in InitializeDataStore().

SessionSettingsProviderClassNames

Type: array<string>

Modifiers: const, config


Default values

Property Value
Tag 'GameSettings'

Instance functions

ClearDataProviders

final function ClearDataProviders ()

Clears all data provider references.

NotifyGameSessionEnded

function bool NotifyGameSessionEnded ()

Overrides: UIDataStore.NotifyGameSessionEnded

Called when the current map is being unloaded. Cleans up any references which would prevent garbage collection.

Returns:

TRUE indicates that this data store should be automatically unregistered when this game session ends.