I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

Difference between revisions of "UE3:UIDataStore SessionSettings (UDK)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
 
m (1 revision: class descriptions for UDK January update (part 6))
 
Line 1: Line 1:
{{infobox class
+
{{UE3:UIDataStore_SessionSettings (UT3)}}
| package = Engine
+
| parent1 = UIDataStore_Settings
+
| parent2 = UIDataStore
+
| parent3 = UIDataProvider
+
| parent4 = UIRoot
+
| parent5 = Object
+
}}
+
{{autogenerated}}
+
This class provides the UI with access to game session settings providers.
+
 
+
'''Fixme:''' not ready for use yet!
+
 
+
==Properties==
+
====SessionSettings====
+
'''Type:''' [[array]]<{{cl|SessionSettingsProvider}}>
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' transient
+
 
+
The data providers for all session settings, such as game info settings, access control settings, etc.
+
 
+
====SessionSettingsProviderClasses====
+
'''Type:''' [[array]]<[[class]]<{{cl|SessionSettingsProvider}}> >
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' const, transient
+
 
+
Array of SessionSettingsProvider derived classes loaded from SessionSettingsProviderClassNames.  Filled in InitializeDataStore().
+
 
+
====SessionSettingsProviderClassNames====
+
'''Type:''' [[array]]<[[string]]>
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' const, config
+
 
+
<!-- enter variable description -->
+
 
+
===Default values===
+
{| class="list defaults"
+
! Property
+
! Value
+
|-
+
| {{tl|Tag||UIDataStore}}
+
| 'GameSettings'
+
|}
+
 
+
==Instance functions==
+
====ClearDataProviders====
+
{{code|final function '''ClearDataProviders''' ()}}
+
 
+
Clears all data provider references.
+
 
+
====NotifyGameSessionEnded====
+
{{code|function [[bool]]&nbsp;'''NotifyGameSessionEnded''' ()}}
+
 
+
'''Overrides:''' {{tl|NotifyGameSessionEnded|UIDataStore}}
+
 
+
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.
+

Latest revision as of 05:50, 17 January 2010

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.

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved

Fixme: not ready for use yet!

Properties[edit]

SessionSettings[edit]

Type: array<SessionSettingsProvider>

Modifiers: transient

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

SessionSettingsProviderClasses[edit]

Type: array<class<SessionSettingsProvider> >

Modifiers: const, transient

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

SessionSettingsProviderClassNames[edit]

Type: array<string>

Modifiers: const, config

Array of SessionSettingsProvider derived class names to load and initialize

Default values[edit]

Property Value
Tag 'GameSettings'

Instance functions[edit]

ClearDataProviders[edit]

final function ClearDataProviders ()

Clears all data provider references.

NotifyGameSessionEnded[edit]

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.