PlayerIdentityBase Class Reference

Player description (base engine class) More...

Inheritance diagram for PlayerIdentityBase:

Collaboration diagram for PlayerIdentityBase:

Private Member Functions
proto int	GetPingAct ()
	ping range estimation
proto int	GetPingMin ()
	ping range estimation
proto int	GetPingMax ()
	ping range estimation
proto int	GetPingAvg ()
	ping range estimation
proto int	GetBandwidthMin ()
	bandwidth estimation (in kbps)
proto int	GetBandwidthMax ()
	bandwidth estimation (in kbps)
proto int	GetBandwidthAvg ()
	bandwidth estimation (in kbps)
proto string	GetName ()
	nick (short) name of player
proto string	GetPlainName ()
	nick without any processing
proto string	GetFullName ()
	full name of player
proto string	GetId ()
	unique id of player (hashed steamID, database Xbox id...) can be used in database or logs
proto string	GetPlainId ()
	plaintext unique id of player (cannot be used in database or logs)
proto int	GetPlayerId ()
	id of player in one session (is reused after player disconnects)
proto Man	GetPlayer ()
	get player
void	PlayerIdentityBase ()
	This is a C++ managed class, so script has no business managing the lifetime.
void	~PlayerIdentityBase ()
Private Member Functions inherited from Managed
void	IntroSceneCharacter ()
void	~IntroSceneCharacter ()
bool	IsDefaultCharacter ()
void	SetToDefaultCharacter ()
void	SetCharacterID (int char_id)
int	GetCharacterID ()
PlayerBase	GetCharacterObj ()
TStringArray	GetCharGenderList ()
TStringArray	GetCharList (ECharGender gender)
TStringArray	GetCharShirtsList ()
TStringArray	GetCharPantsList ()
TStringArray	GetCharShoesList ()
void	SetCharacterGender (ECharGender gender)
bool	IsCharacterFemale ()
ECharGender	GetCharacterGender ()
vector	GetPosition ()
int	GetNextCharacterID ()
int	GetPrevCharacterID ()
void	CreateNewCharacterRandom ()
void	CreateNewCharacterById (int character_id)
void	CreateNewCharacterByName (string character_name, bool randomize_equip=true)
void	CreateDefaultCharacter ()
void	GetLastPlayedServer (int characterID, out string address, out string name, out int port)
void	CreateNewCharacter ()
void	LoadCharacterData (vector char_pos, vector char_rot, bool default_char=false)
	Generates random equip for the new IntroSceneCharacter, whatever is defined in 'cfgCharacterCreation'.
void	CharacterUnload ()
void	CharacterLoad (int character_id, vector char_pos, vector char_rot)
void	SetupPlayerName (bool new_name)
void	SetAttachment (string type, int slot)
string	GetCharacterNameById (int char_id)
string	GetCharacterName ()
void	SaveCharName (string name)
void	SaveDefaultCharacter ()
void	TransferValues (PlayerBase player)
void	Init ()
void	OnScheduledTick (float deltatime)
void	CheckValues ()
float	GetBlood ()
float	GetHealth ()
void	CheckHealth ()
void	CheckBlood ()
void	SendInitValues ()
	Sends values on object creation.
void	SendValue (int value_type, float value)
void	ReceiveValue (int value_type, float value)
void	OnRPC (ParamsReadContext ctx)
void	ShowDebugValues (bool show)
void	BleedingIndicator (int source_ID, int severity, GameplayEffectsDataBleeding parent)
void	InitIndicator (vector position)
void	StopIndicator (bool instant=false)
void	StartRunningDrops ()
bool	IsRunningDrops ()
	Are any drops currently being animated?
void	TrySpawnNextDrop ()
void	ResetSequence ()
void	ResetIndicator ()
void	Update (float timeSlice)
bool	GetEndNow ()
int	GetSeverity ()
void	GameplayEffectsData (array< ref Widget > input, int type, int user_override=-1)
void	Init (array< ref Widget > input, int type, Widget layout_root, int user_override=-1)
array< ref Widget >	GetWidgetSet ()
int	GetWidgetSetType ()
int	GetWidgetSetID ()
bool	HasDefinedHandle ()
	Returns 'true' if this class contains update info.
bool	DataInitialized ()
void	UpdateVisibility (bool state)
void	RegisterData (Param p)
void	Update (float timeSlice=0, Param p=null, int handle=-1)
void	ForceStop ()

Additional Inherited Members
Private Attributes inherited from Managed
int	m_CharacterId
string	m_CharacterType
MenuData	m_CharacterDta
PlayerBase	m_CharacterObj
vector	m_CharacterPos
vector	m_CharacterRot
ref TStringArray	m_CharGenderList = new TStringArray
ref TStringArray	m_CharShirtList = new TStringArray
ref TStringArray	m_CharPantsList = new TStringArray
ref TStringArray	m_CharShoesList = new TStringArray
ref map< ECharGender, ref array< string > >	m_Characters = new map<ECharGender, ref array<string>>
ECharGender	m_CharGender
bool	m_InitialSyncSent
bool	m_Initialized
bool	m_Terminating = false
bool	m_EndNow = false
bool	m_IsRunning = false
int	m_DropSpawnsQueued
int	m_ActiveDropsCount
int	m_Severity
int	m_SourceID
GameplayEffectsDataBleeding	m_ParentMetaData
array< float >	m_DropProbabilityArray
float	m_AverageFrequency
float	m_SequenceTick
float	m_SequenceDuration
float	m_TimeElapsedTotal
float	m_TimeElapsedSequence
float	m_LastDropSpawnTime
float	m_DropSpawnMinDelay
float	m_DropSpawnMaxDelay
int	m_CurrentDropProbabilityStep
int	m_DropProbabilityRollsCount
vector	m_BasePosition
ref set< ref BleedingIndicatorDropData >	m_ActiveDrops
ref set< int >	m_CleanupQueue
ref array< ref Widget >	m_WidgetArray
int	m_Type
int	m_WidgetSetIdentifier
Widget	m_LayoutRoot

Detailed Description

Player description (base engine class)

Definition at line 335 of file gameplay.c.

Constructor & Destructor Documentation

PlayerIdentityBase()

void PlayerIdentityBase::PlayerIdentityBase ( )

private

This is a C++ managed class, so script has no business managing the lifetime.

~PlayerIdentityBase()

void PlayerIdentityBase::~PlayerIdentityBase ( )

private

Member Function Documentation

GetBandwidthAvg()

proto int PlayerIdentityBase::GetBandwidthAvg ( )

private

bandwidth estimation (in kbps)

GetBandwidthMax()

proto int PlayerIdentityBase::GetBandwidthMax ( )

private

bandwidth estimation (in kbps)

GetBandwidthMin()

proto int PlayerIdentityBase::GetBandwidthMin ( )

private

bandwidth estimation (in kbps)

GetFullName()

proto string PlayerIdentityBase::GetFullName ( )

private

full name of player

GetId()

proto string PlayerIdentityBase::GetId ( )

private

unique id of player (hashed steamID, database Xbox id...) can be used in database or logs

GetName()

proto string PlayerIdentityBase::GetName ( )

private

nick (short) name of player

GetPingAct()

proto int PlayerIdentityBase::GetPingAct ( )

private

ping range estimation

GetPingAvg()

proto int PlayerIdentityBase::GetPingAvg ( )

private

ping range estimation

GetPingMax()

proto int PlayerIdentityBase::GetPingMax ( )

private

ping range estimation

GetPingMin()

proto int PlayerIdentityBase::GetPingMin ( )

private

ping range estimation

GetPlainId()

proto string PlayerIdentityBase::GetPlainId ( )

private

plaintext unique id of player (cannot be used in database or logs)

GetPlainName()

proto string PlayerIdentityBase::GetPlainName ( )

private

nick without any processing

GetPlayer()

proto Man PlayerIdentityBase::GetPlayer ( )

private

get player

GetPlayerId()

proto int PlayerIdentityBase::GetPlayerId ( )

private

id of player in one session (is reused after player disconnects)

---

The documentation for this class was generated from the following file:

• scripts/3_Game/gameplay.c