The three virtues of a programmer: Laziness, Impatience, and Hubris. – Larry Wall

Difference between revisions of "UE3:PlayerOwnerDataStore (UDK)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
 
(Talk)
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{infobox class
+
{{UE3:PlayerOwnerDataStore (UT3)}}
| package = Engine
+
| parent1 = UIDataStore_GameState
+
| parent2 = UIDataStore
+
| parent3 = UIDataProvider
+
| parent4 = UIRoot
+
| parent5 = Object
+
}}
+
{{autogenerated}}
+
Provides the UI with all data associated with the player which owns this viewport.
+
 
+
==Properties==
+
====CurrentWeapon====
+
'''Type:''' {{cl|CurrentWeaponDataProvider}}
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' protected
+
 
+
The WeaponDataProvider associated with the currently selected weapon.
+
 
+
'''Todo:''' not yet implemented
+
 
+
====PlayerData====
+
'''Type:''' {{cl|PlayerOwnerDataProvider}}
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' protected
+
 
+
The PlayerDataProvider for the owning player.
+
 
+
====PowerupList====
+
'''Type:''' [[array]]<{{cl|PowerupDataProvider}}>
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' protected
+
 
+
PowerupDataProvider for all powerups currently in the players inventory.
+
 
+
'''Todo:''' not yet implemented
+
 
+
====ProviderTypes====
+
'''Type:''' {{tl|PlayerDataProviderTypes}}
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' const
+
 
+
The data provider types used by this PlayerOwnerDataStore
+
 
+
'''Default value:'''
+
{| class="list defaults"
+
! {{tl|PlayerDataProviderTypes|||Member}}
+
! Value
+
|-
+
| CurrentWeaponDataProviderClass
+
| [[Types#Class|Class]]'{{cl|CurrentWeaponDataProvider|Engine}}'
+
|-
+
| PlayerOwnerDataProviderClass
+
| [[Types#Class|Class]]'{{cl|PlayerOwnerDataProvider|Engine}}'
+
|-
+
| PowerupDataProviderClass
+
| [[Types#Class|Class]]'{{cl|PowerupDataProvider|Engine}}'
+
|-
+
| WeaponDataProviderClass
+
| [[Types#Class|Class]]'{{cl|WeaponDataProvider|Engine}}'
+
|}
+
 
+
====WeaponList====
+
'''Type:''' [[array]]<{{cl|WeaponDataProvider}}>
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' protected
+
 
+
Weapon data providers for all weapons currently held by the player.
+
 
+
'''Todo:''' not yet implemented
+
 
+
===Default values===
+
{| class="list defaults"
+
! Property
+
! Value
+
|-
+
| {{tl|Tag||UIDataStore}}
+
| 'PlayerOwner'
+
|}
+
 
+
==Structs==
+
===PlayerDataProviderTypes===
+
'''[[Structs#Modifiers|Modifiers]]:''' native
+
 
+
<!-- enter struct description -->
+
; [[class]]<{{cl|PlayerOwnerDataProvider}}> PlayerOwnerDataProviderClass : the class to use for the player owner data provider
+
; [[class]]<{{cl|CurrentWeaponDataProvider}}> CurrentWeaponDataProviderClass : the class to use for the current weapon data provider
+
; [[class]]<{{cl|WeaponDataProvider}}> WeaponDataProviderClass : the class to use for the general weapon data providers
+
; [[class]]<{{cl|PowerupDataProvider}}> PowerupDataProviderClass : the class to use for the power data provider.
+
 
+
==Instance functions==
+
====ClearDataProviders====
+
{{code|final function '''ClearDataProviders''' ()}}
+
 
+
Clears all data provider references.
+
 
+
====NotifyGameSessionEnded====
+
{{code|function [[bool]]&nbsp;'''NotifyGameSessionEnded''' ()}}
+
 
+
'''Overrides:''' {{tl|NotifyGameSessionEnded|UIDataStore_GameState}}
+
 
+
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====
+
{{code|function '''SetPlayerDataProvider''' ({{cl|PlayerDataProvider}}&nbsp;'''NewPlayerData''')}}
+
 
+
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.
+

Revision as of 06:12, 17 January 2010

UDK Object >> UIRoot >> UIDataProvider >> UIDataStore >> UIDataStore_GameState >> PlayerOwnerDataStore
Package: 
Engine
This class in other games:
UT3

Provides the UI with all data associated with the player which owns this viewport.

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

Properties

CurrentWeapon

Type: CurrentWeaponDataProvider

Modifiers: protected

The WeaponDataProvider associated with the currently selected weapon.

Todo: not yet implemented

PlayerData

Type: PlayerOwnerDataProvider

Modifiers: protected

The PlayerDataProvider for the owning player.

PowerupList

Type: array<PowerupDataProvider>

Modifiers: protected

PowerupDataProvider for all powerups currently in the players inventory.

Todo: not yet implemented

ProviderTypes

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

Type: array<WeaponDataProvider>

Modifiers: protected

Weapon data providers for all weapons currently held by the player.

Todo: not yet implemented

Default values

Property Value
Tag 'PlayerOwner'

Structs

PlayerDataProviderTypes

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

ClearDataProviders

final function ClearDataProviders ()

Clears all data provider references.

NotifyGameSessionEnded

function bool NotifyGameSessionEnded ()

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

function SetPlayerDataProvider (PlayerDataProvider NewPlayerData)

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.