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

Revision as of 11:47, 6 November 2009 (edit) (Talk)		Latest revision as of 05:44, 17 January 2010 (edit) (undo) Wormbo (Talk | contribs) m (1 revision: class descriptions for UDK January update (part 4))
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.	+

---

Latest revision as of 05:44, 17 January 2010

Package: 

Engine

This class in other games:

UT3

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.