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

Engine.PlayerOwnerDataStore

Extends
UIDataStore_GameState
Modifiers
native ( inherit )

Provides the UI with all data associated with the player which owns this viewport. Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.UIDataProvider
      |   
      +-- Engine.UIDataStore
         |   
         +-- Engine.UIDataStore_GameState
            |   
            +-- Engine.PlayerOwnerDataStore

Variables Summary
CurrentWeaponDataProviderCurrentWeapon
PlayerOwnerDataProviderPlayerData
array<PowerupDataProvider>PowerupList
PlayerDataProviderTypesProviderTypes
array<WeaponDataProvider>WeaponList
Inherited Variables from Engine.UIDataStore
RefreshSubscriberNotifies, Tag

Structures Summary
PlayerDataProviderTypes
PlayerOwnerDataProviderClass, CurrentWeaponDataProviderClass, WeaponDataProviderClass, PowerupDataProviderClass

Functions Summary
function ClearDataProviders ()))
functionbool NotifyGameSessionEnded ()))
function SetPlayerDataProvider (PlayerDataProvider NewPlayerData ))
Inherited Functions from Engine.UIDataStore_GameState
NotifyGameSessionEnded
Inherited Functions from Engine.UIDataStore
GetDataStoreClient, NotifyGameSessionEnded, OnCommit, RefreshSubscribers, Registered, SubscriberAttached, SubscriberDetached, Unregistered


Variables Detail

CurrentWeapon Source code

var protected CurrentWeaponDataProvider CurrentWeapon;
The WeaponDataProvider associated with the currently selected weapon. @todo - not yet implemented

PlayerData Source code

var protected PlayerOwnerDataProvider PlayerData;
The PlayerDataProvider for the owning player.

PowerupList Source code

var protected array<PowerupDataProvider> PowerupList;
PowerupDataProvider for all powerups currently in the players inventory. @todo - not yet implemented

ProviderTypes Source code

var const PlayerDataProviderTypes ProviderTypes;
The data provider types used by this PlayerOwnerDataStore

WeaponList Source code

var protected array<WeaponDataProvider> WeaponList;
Weapon data providers for all weapons currently held by the player. @todo - not yet implemented


Structures Detail

PlayerDataProviderTypes Source code

struct PlayerDataProviderTypes
{
var const class<CurrentWeaponDataProvider> CurrentWeaponDataProviderClass;
var const class<PlayerOwnerDataProvider> PlayerOwnerDataProviderClass;
var const class<PowerupDataProvider> PowerupDataProviderClass;
var const class<WeaponDataProvider> WeaponDataProviderClass;
};
Contains the classes which should be used for instancing data providers.
CurrentWeaponDataProviderClass:
the class to use for the current weapon data provider
PlayerOwnerDataProviderClass:
the class to use for the player owner data provider
PowerupDataProviderClass:
the class to use for the power data provider.
WeaponDataProviderClass:
the class to use for the general weapon data providers


Functions Detail

ClearDataProviders Source code

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

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.

SetPlayerDataProvider Source code

function SetPlayerDataProvider ( PlayerDataProvider NewPlayerData ) )
Links the PlayerDataProvider for the local player to this data store.
@param NewPlayerData the new PlayerDataProvider to use for presenting this player's data to the UI.


Defaultproperties

defaultproperties
{
   ProviderTypes=(PlayerOwnerDataProviderClass=Class'Engine.PlayerOwnerDataProvider',CurrentWeaponDataProviderClass=Class'Engine.CurrentWeaponDataProvider',WeaponDataProviderClass=Class'Engine.WeaponDataProvider',PowerupDataProviderClass=Class'Engine.PowerupDataProvider')
   Tag="PlayerOwner"
   Name="Default__PlayerOwnerDataStore"
   ObjectArchetype=UIDataStore_GameState'Engine.Default__UIDataStore_GameState'
}

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