SCR_LocalPlayerPenalty Interface Reference

Inheritance diagram for SCR_LocalPlayerPenalty:

Public Member Functions
void	OnPlayerConnected (int playerId)
void	OnControllableDestroyed (IEntity entity, IEntity killerEntity, Instigator instigator, notnull SCR_InstigatorContextData instigatorContextData)
void	KickPlayer (int playerId, int duration, SCR_PlayerManagerKickReason reason)
int	GetPenaltySubtractionPeriod ()
void	SCR_LocalPlayerPenalty (int friendlyPlayerKillPenalty, int friendlyAIKillPenalty, int penaltyLimit, int banDuration, int penaltySubtractionPeriod, int penaltySubtractionPoints)

Static Public Member Functions
static SCR_LocalPlayerPenalty	GetInstance ()
static SCR_ChimeraCharacter	GetInstigatorFromVehicle (IEntity veh, bool gunner=false)

Protected Member Functions
SCR_LocalPlayerPenaltyData	GetPlayerPenaltyData (int playerId)
void	EvaluatePlayerPenalties ()

Protected Attributes
int	m_iFriendlyPlayerKillPenalty
int	m_iFriendlyAIKillPenalty
int	m_iKickPenaltyLimit
int	m_iBanDuration
int	m_iPenaltySubtractionPeriod
int	m_iPenaltySubtractionPoints
ref array< ref SCR_LocalPlayerPenaltyData >	m_aPlayerPenaltyData = {}

Static Protected Attributes
static SCR_LocalPlayerPenalty	s_Instance
static const int	EVALUATION_PERIOD = 1000

Constructor & Destructor Documentation

SCR_LocalPlayerPenalty()

void SCR_LocalPlayerPenalty.SCR_LocalPlayerPenalty	(	int	friendlyPlayerKillPenalty,
		int	friendlyAIKillPenalty,
		int	penaltyLimit,
		int	banDuration,
		int	penaltySubtractionPeriod,
		int	penaltySubtractionPoints )

Parameters

[in]	friendlyPlayerKillPenalty
[in]	friendlyAIKillPenalty
[in]	penaltyLimit
[in]	banDuration
[in]	penaltySubtractionPeriod
[in]	penaltySubtractionPoints

Member Function Documentation

EvaluatePlayerPenalties()

void SCR_LocalPlayerPenalty.EvaluatePlayerPenalties ( )

protected

GetInstance()

static SCR_LocalPlayerPenalty SCR_LocalPlayerPenalty.GetInstance ( )

static

Returns

GetInstigatorFromVehicle()

static SCR_ChimeraCharacter SCR_LocalPlayerPenalty.GetInstigatorFromVehicle ( IEntity veh, bool gunner = false )

static

Parameters

[in]	veh
[in]	gunner

Returns

GetPenaltySubtractionPeriod()

int SCR_LocalPlayerPenalty.GetPenaltySubtractionPeriod

(

)

Returns

GetPlayerPenaltyData()

SCR_LocalPlayerPenaltyData SCR_LocalPlayerPenalty.GetPlayerPenaltyData ( int playerId )

protected

KickPlayer()

void SCR_LocalPlayerPenalty.KickPlayer	(	int	playerId,
		int	duration,
		SCR_PlayerManagerKickReason	reason )

Parameters

[in]	playerId
[in]	duration
[in]	reason

OnControllableDestroyed()

void SCR_LocalPlayerPenalty.OnControllableDestroyed	(	IEntity	entity,
		IEntity	killerEntity,
		Instigator	instigator,
		notnull SCR_InstigatorContextData	instigatorContextData )

Parameters

[in]	entity
[in]	killerEntity
[in]	instigator
[in]	instigatorContextData	Holds data of victim and killer

OnPlayerConnected()

void SCR_LocalPlayerPenalty.OnPlayerConnected

(

int

playerId

)

Parameters

[in]

playerId

Member Data Documentation

EVALUATION_PERIOD

const int SCR_LocalPlayerPenalty.EVALUATION_PERIOD = 1000

staticprotected

m_aPlayerPenaltyData

ref array<ref SCR_LocalPlayerPenaltyData> SCR_LocalPlayerPenalty.m_aPlayerPenaltyData = {}

protected

m_iBanDuration

int SCR_LocalPlayerPenalty.m_iBanDuration

protected

m_iFriendlyAIKillPenalty

int SCR_LocalPlayerPenalty.m_iFriendlyAIKillPenalty

protected

m_iFriendlyPlayerKillPenalty

int SCR_LocalPlayerPenalty.m_iFriendlyPlayerKillPenalty

protected

m_iKickPenaltyLimit

int SCR_LocalPlayerPenalty.m_iKickPenaltyLimit

protected

m_iPenaltySubtractionPeriod

int SCR_LocalPlayerPenalty.m_iPenaltySubtractionPeriod

protected

m_iPenaltySubtractionPoints

int SCR_LocalPlayerPenalty.m_iPenaltySubtractionPoints

protected

s_Instance

SCR_LocalPlayerPenalty SCR_LocalPlayerPenalty.s_Instance

staticprotected

---

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

• Game/Components/SCR_LocalPlayerPenalty.c