Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.UIDataStore_PlayerSettings

Extends
UIDataStore_Settings
Modifiers
native ( inherit )

This class provides the UI with access to player settings providers. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIDataProvider
      |   
      +-- Engine.UIDataStore
         |   
         +-- Engine.UIDataStore_Settings
            |   
            +-- Engine.UIDataStore_PlayerSettings

Variables Summary
intPlayerIndex
array<PlayerSettingsProvider>PlayerSettings
array<class<PlayerSettingsProvider>>PlayerSettingsProviderClasses
array<string>PlayerSettingsProviderClassNames
Inherited Variables from Engine.UIDataStore
RefreshSubscriberNotifies, Tag

Functions Summary
function ClearDataProviders ()))
functionLocalPlayer GetPlayerOwner () con)
functionbool NotifyGameSessionEnded ()))
Inherited Functions from Engine.UIDataStore
GetDataStoreClient, NotifyGameSessionEnded, OnCommit, RefreshSubscribers, Registered, SubscriberAttached, SubscriberDetached, Unregistered


Variables Detail

PlayerIndex Source code

var const transient int PlayerIndex;
The index [into the Engine.GamePlayers array] for the player that this data store provides settings for.

PlayerSettings Source code

var transient array<PlayerSettingsProvider> PlayerSettings;
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 Source code

var const transient array<class<PlayerSettingsProvider>> PlayerSettingsProviderClasses;
Array of PlayerSettingsProvider derived classes loaded from PlayerSettingsProviderClassNames. Filled in InitializeDataStore().

PlayerSettingsProviderClassNames Source code

var const config array<string> PlayerSettingsProviderClassNames;
Array of PlayerSettingsProvider derived class names to load and initialize


Functions Detail

ClearDataProviders Source code

final function ClearDataProviders ( ) )
Clears all data provider references.

GetPlayerOwner Source code

native final const function LocalPlayer GetPlayerOwner ( ) con )
Returns a reference to the ULocalPlayer that this PlayerSettingsProvdier provider settings data for

NotifyGameSessionEnded Source code

function bool NotifyGameSessionEnded ( ) )
Called when the current map is being unloaded. Cleans up any references which would prevent garbage collection.
@return TRUE indicates that this data store should be automatically unregistered when this game session ends.


Defaultproperties

defaultproperties
{
   Tag="PlayerSettings"
   Name="Default__UIDataStore_PlayerSettings"
   ObjectArchetype=UIDataStore_Settings'Engine.Default__UIDataStore_Settings'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:46.890 - Created with UnCodeX