SCR_FiringRangeScoringComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_FiringRangeScoringComponentClass

Functions
void	OnDisconnected (int playerID)
void	OnKill (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator killer)
SCR_PlayerScoreInfoFiringRange	AddPlayer (int playerID)
void	RemovePlayer (int playerID)
void	ClearScore (int playerID)
void	AddScore (int playerID, int scorePoints)
void	SetScoreMax (int playerID, int scorePointsMax)
int	GetScore (int playerID)
int	GetPlayersCount ()
private SCR_PlayerScoreInfoFiringRange	GetPlayerScoreInfo (int playerID)
int	GetAllPlayersScoreInfo (notnull out array< SCR_PlayerScoreInfoFiringRange > output)
override void	OnPostInit (IEntity owner)
	Editable Mine. More...
override void	EOnInit (IEntity owner)
void	SCR_FiringRangeScoringComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Variables
SCR_FiringRangeScoringComponentClass	s_Manager
protected ref array< ref SCR_PlayerScoreInfoFiringRange >	m_aAllPlayersInfo = {}
	Contains score info of all the players. More...

Function Documentation

AddPlayer()

SCR_PlayerScoreInfoFiringRange AddPlayer

(

int

playerID

)

Add a player to the player array m_aAllPlayersInfo.

Parameters

[in]

playerID,is

unique player identifier.

Definition at line 49 of file SCR_FiringRangeScoringComponent.c.

AddScore()

void AddScore	(	int	playerID,
		int	scorePoints
	)

Parameters

[in]	playerID
[in]	scorePoints

Definition at line 82 of file SCR_FiringRangeScoringComponent.c.

ClearScore()

void ClearScore

(

int

playerID

)

Parameters

[in]

playerID

Definition at line 71 of file SCR_FiringRangeScoringComponent.c.

GetAllPlayersScoreInfo()

int GetAllPlayersScoreInfo

(

notnull out array< SCR_PlayerScoreInfoFiringRange >

output

)

Parameters

[out]

output

Returns

score info of all players.

Definition at line 136 of file SCR_FiringRangeScoringComponent.c.

GetPlayerScoreInfo()

private SCR_PlayerScoreInfoFiringRange GetPlayerScoreInfo

(

int

playerID

)

Finds a SCR_PlayerScoreInfoFiringRange by playerID from m_aAllPlayersInfo array.

Parameters

[in]

playerID,is

unique player identifier.

Definition at line 122 of file SCR_FiringRangeScoringComponent.c.

GetPlayersCount()

int GetPlayersCount

(

)

Returns

the number of players.

Definition at line 114 of file SCR_FiringRangeScoringComponent.c.

GetScore()

int GetScore

(

int

playerID

)

Get the integer equal to the player's kill count.

Parameters

[in]

playerID,is

unique player identifier.

Returns

the player's kill count.

Definition at line 104 of file SCR_FiringRangeScoringComponent.c.

OnDisconnected()

void OnDisconnected

(

int

playerID

)

Parameters

[in]

playerID

Definition at line 15 of file SCR_FiringRangeScoringComponent.c.

OnKill()

void OnKill	(	int	playerId,
		IEntity	playerEntity,
		IEntity	killerEntity,
		notnull Instigator	killer
	)

What happens when a player is killed.

Parameters

[in]	playerId
[in]	playerEntity
[in]	killerEntity
[in]	killer

Definition at line 35 of file SCR_FiringRangeScoringComponent.c.

RemovePlayer()

void RemovePlayer

(

int

playerID

)

Remove a player from the player array m_aAllPlayersInfo.

Parameters

[in]

playerID,is

unique player identifier.

Definition at line 62 of file SCR_FiringRangeScoringComponent.c.

SCR_FiringRangeScoringComponent()

void SCR_FiringRangeScoringComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent
	)

Parameters

[in]	src
[in]	ent
[in]	parent

Definition at line 182 of file SCR_FiringRangeScoringComponent.c.

SetScoreMax()

void SetScoreMax	(	int	playerID,
		int	scorePointsMax
	)

Set the maximal score of given firing line

Parameters

[in]	playerID
[in]	scorePointsMax

Definition at line 93 of file SCR_FiringRangeScoringComponent.c.

Variable Documentation

m_aAllPlayersInfo

protected ref array<ref SCR_PlayerScoreInfoFiringRange> m_aAllPlayersInfo = {}

Contains score info of all the players.

Definition at line 11 of file SCR_FiringRangeScoringComponent.c.

s_Manager

SCR_FiringRangeScoringComponentClass s_Manager