Cogito, ergo sum
Difference between revisions of "UE3:PlayerOwnerDataStore (UDK)"
(Talk) |
m (1 revision: class descriptions for UDK January update (part 4)) |
(No difference)
| |
Latest revision as of 05:44, 17 January 2010
 |
Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_GameState >> PlayerOwnerDataStore |
| This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
Provides the UI with all data associated with the player which owns this viewport.
Copyright 1998-2007 Epic Games, Inc. All Rights Reserved
Properties[edit]
CurrentWeapon[edit]
Type: CurrentWeaponDataProvider
Modifiers: protected
The WeaponDataProvider associated with the currently selected weapon.
Todo: not yet implemented
PlayerData[edit]
Type: PlayerOwnerDataProvider
Modifiers: protected
The PlayerDataProvider for the owning player.
PowerupList[edit]
Type: array<PowerupDataProvider>
Modifiers: protected
PowerupDataProvider for all powerups currently in the players inventory.
Todo: not yet implemented
ProviderTypes[edit]
Type: PlayerDataProviderTypes
Modifiers: const
The data provider types used by this PlayerOwnerDataStore
Default value:
| Member | Value |
|---|---|
| CurrentWeaponDataProviderClass | Class'Engine.CurrentWeaponDataProvider' |
| PlayerOwnerDataProviderClass | Class'Engine.PlayerOwnerDataProvider' |
| PowerupDataProviderClass | Class'Engine.PowerupDataProvider' |
| WeaponDataProviderClass | Class'Engine.WeaponDataProvider' |
WeaponList[edit]
Type: array<WeaponDataProvider>
Modifiers: protected
Weapon data providers for all weapons currently held by the player.
Todo: not yet implemented
Default values[edit]
| Property | Value |
|---|---|
| Tag | 'PlayerOwner' |
Structs[edit]
PlayerDataProviderTypes[edit]
Modifiers: native
Contains the classes which should be used for instancing data providers.
- class<PlayerOwnerDataProvider> PlayerOwnerDataProviderClass
- the class to use for the player owner data provider
- class<CurrentWeaponDataProvider> CurrentWeaponDataProviderClass
- the class to use for the current weapon data provider
- class<WeaponDataProvider> WeaponDataProviderClass
- the class to use for the general weapon data providers
- class<PowerupDataProvider> PowerupDataProviderClass
- the class to use for the power data provider.
Instance functions[edit]
ClearDataProviders[edit]
Clears all data provider references.
NotifyGameSessionEnded[edit]
Overrides: UIDataStore_GameState.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.
SetPlayerDataProvider[edit]
Links the PlayerDataProvider for the local player to this data store.
Parameters:
- NewPlayerData - the new PlayerDataProvider to use for presenting this player's data to the UI.
