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

UE3:UIDataStore_PlayerSettings (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_Settings >> UIDataStore_PlayerSettings
Package: 
Engine
Known classes within UIDataStore_PlayerSettings:
PlayerSettingsProvider

This class provides the UI with access to player settings providers.

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

Properties[edit]

PlayerIndex[edit]

Type: int

Modifiers: const, transient

The index [into the Engine.GamePlayers array] for the player that this data store provides settings for.

PlayerSettings[edit]

Type: array<PlayerSettingsProvider>

Modifiers: transient

The data provider for all player specific settings, such as input, display, and audio settings. Each element of the array represents the settings for the player associated with the corresponding element of the Engine.GamePlayers array.

PlayerSettingsProviderClasses[edit]

Type: array<class<PlayerSettingsProvider> >

Modifiers: const, transient

Array of PlayerSettingsProvider derived classes loaded from PlayerSettingsProviderClassNames. Filled in InitializeDataStore().

PlayerSettingsProviderClassNames[edit]

Type: array<string>

Modifiers: const, config

Array of PlayerSettingsProvider derived class names to load and initialize

Default values[edit]

Property Value
Tag 'PlayerSettings'

Functions[edit]

Native functions[edit]

GetPlayerOwner[edit]

native final function LocalPlayer GetPlayerOwner () const

Returns a reference to the ULocalPlayer that this PlayerSettingsProvdier provider settings data for

Other 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.