SCR_ScoringSystemComponent Interface Reference

This component implements logic of handling certain score limits. More...

Inheritance diagram for SCR_ScoringSystemComponent:

Public Member Functions
override int	GetScoreLimit ()
Public Member Functions inherited from SCR_BaseScoringSystemComponent
OnPlayerScoreChangedInvoker	GetOnPlayerScoreChanged ()
OnFactionScoreChangedInvoker	GetOnFactionScoreChanged ()
OnPlayerEventInvoker	GetOnPlayerAdded ()
OnPlayerEventInvoker	GetOnPlayerRemoved ()
override bool	RplSave (ScriptBitWriter writer)
	Serialise current state of scoring into buffer via provided writer.
override bool	RplLoad (ScriptBitReader reader)
	Deserialise state of scoring into buffer via provided reader.
void	AddKill (int playerId, int count=1)
	Add count x kills to playerId's score info and their affiliated faction's.
void	AddDeath (int playerId, int count=1)
	Add count x deaths to playerId's score info and their affiliated faction's.
void	AddTeamKill (int playerId, int count=1)
	Add count x teamKills to playerId's score info and their affiliated faction's.
void	AddSuicide (int playerId, int count=1)
	Add count x suicides to playerId's score info and their affiliated faction's.
void	AddObjective (int playerId, int count=1, bool addToFaction=true)
	Add count x objectives to playerId's score info.
void	AddFactionObjective (notnull Faction faction, int count=1)
	Add count x objectives to provided faction.
int	GetPlayerScore (int playerId)
SCR_ScoreInfo	GetPlayerScoreInfo (int playerId)
int	GetFactionScore (notnull Faction faction)
SCR_ScoreInfo	GetFactionScoreInfo (notnull Faction faction)
override void	OnPlayerRegistered (int playerId)
	Called on every machine after a player is registered (identity, name etc.).
override void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Called after a player is disconnected.
override void	EOnDiag (IEntity owner, float timeSlice)
int	GetScoreLimit ()
override void	EOnInit (IEntity owner)
override void	OnPostInit (IEntity owner)
override void	OnDelete (IEntity owner)
Public Member Functions inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	GetGameMode ()
void	OnGameEnd ()
	Called on all machines when the world ends.
void	OnGameStateChanged (SCR_EGameModeState state)
	Called when game mode state changes called on all machines.
void	OnGameModeStart ()
	Called on every machine when game mode starts.
void	OnGameModeEnd (SCR_GameModeEndData data)
	Called when game mode ends.
void	OnPlayerConnected (int playerId)
	Called after a player is connected.
void	OnPlayerAuditSuccess (int playerId)
	Event is called when player connecting Session hosting current Game Mode where is required authentication verification via.
void	OnPlayerAuditFail (int playerId)
	Event is called when player connecting Session hosting current Game Mode AuditFail() call may be called under two occasions: 1) verification is required but failed (account is not valid, player is banned, internet issues) 2) player cannot be verified as authentication is not required or possible - where it may be valid behavior (server online connectivity turned off for example) Basically non-audited player cannot access persistency/ etc.
void	OnPlayerAuditTimeouted (int playerId)
	Event is called when player connected to Session was kicked and did not reconnected in time This mean that slot reservation can be canceled.
void	OnPlayerAuditRevived (int playerId)
	Event is called when player reconnected successfully back to Session after kick This mean that slot reservation need to be finished (closed).
void	OnPlayerRegistered (int playerId)
	Called on every machine after a player is registered (identity, name etc.).
void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Called after a player is disconnected.
void	OnPlayerSpawned (int playerId, IEntity controlledEntity)
	Called after a player is spawned.
bool	PreparePlayerEntity_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
void	OnSpawnPlayerEntityFailure_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, IEntity entity, SCR_SpawnData data, SCR_ESpawnResult reason)
void	OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
bool	HandlePlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator killer)
	See SCR_BaseGameMode.HandlePlayerKilled.
void	OnPlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator killer)
	Called after a player gets killed.
void	OnPlayerKilledHandled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator killer)
	Called after player gets killed in cases where the kill was handled by the game mode, supressing the default OnPlayerKilled behaviour.
void	OnPlayerDeleted (int playerId, IEntity player)
	Called after a player gets deleted.
void	OnPlayerRoleChange (int playerId, EPlayerRole roleFlags)
	Called when player role changes.
void	OnWorldPostProcess (World world)
	Called once loading of all entities of the world have been finished (still within the loading)
void	HandleOnLoadoutAssigned (int playerID, SCR_BasePlayerLoadout assignedLoadout)
	What happens when a player is assigned a loadout.
void	HandleOnFactionAssigned (int playerID, Faction assignedFaction)
	What happens when a player is assigned a faction.
void	HandleOnSpawnPointAssigned (int playerID, SCR_SpawnPoint spawnPoint)
	What happens when a player is assigned a spawn point.
void	OnControllableSpawned (IEntity entity)
	When a controllable entity is spawned, this event is raised.
void	OnControllableDestroyed (IEntity entity, IEntity killerEntity, notnull Instigator killer)
	When a controllable entity is destroyed, this event is raised.
void	OnControllableDeleted (IEntity entity)
	Prior to a controllable entity being DELETED, this event is raised.
void	SCR_BaseGameModeComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Protected Member Functions
override int	CalculateScore (SCR_ScoreInfo info)
	Calculate score for provided score info.
override void	OnPlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator killer)
	Handle and dispatch scoring logic for this event.
override void	OnGameModeEnd (SCR_GameModeEndData data)
	Called when game mode ends.
override void	OnPlayerScoreChanged (int playerId, SCR_ScoreInfo scoreInfo)
	Called on all machines when player score changes.
override void	OnFactionScoreChanged (Faction faction, SCR_ScoreInfo scoreInfo)
	Called on all machines when faction score changes.
void	OnPlayerScoreChanged (int playerId, SCR_ScoreInfo scoreInfo)
	Called on all machines when player score changes.
void	OnFactionScoreChanged (Faction faction, SCR_ScoreInfo scoreInfo)
	Called on all machines when faction score changes.
int	CalculateScore (SCR_ScoreInfo info)
	Calculate score for provided score info.

Protected Attributes
int	m_iKillScoreMultiplier
int	m_iTeamKillScoreMultiplier
int	m_iDeathScoreMultiplier
int	m_iSuicideScoreMultiplier
int	m_iObjectiveScoreMultiplier
ref array< ref IScoringAction >	m_aActions
Protected Attributes inherited from SCR_BaseScoringSystemComponent
ref map< int, ref SCR_ScoreInfo >	m_mPlayerScores = new map<int, ref SCR_ScoreInfo>()
	Map of scores per player.
ref map< Faction, ref SCR_ScoreInfo >	m_mFactionScores = new map<Faction, ref SCR_ScoreInfo>()
	Map of scores per faction.
ref OnPlayerScoreChangedInvoker	m_OnPlayerScoreChangedInvoker
	This invoker is invoked when score of provided player changes.
ref OnFactionScoreChangedInvoker	m_OnFactionScoreChangedInvoker
	This invoker is invoked when score of provided faction changes.
ref OnPlayerEventInvoker	m_OnPlayerAdded
	This invoker is invoked when a player is registered to the scoreboard.
ref OnPlayerEventInvoker	m_OnPlayerRemoved
	This invoker is invoked when a player is registered to the scoreboard.
Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	m_pGameMode
	The game mode entity this component is attached to.

Detailed Description

This component implements logic of handling certain score limits.

Member Function Documentation

CalculateScore()

override int SCR_ScoringSystemComponent.CalculateScore ( SCR_ScoreInfo  info )

protected

Calculate score for provided score info.

Different kinds of score multipliers and evaluation can be calculated by overriding this method.

Parameters

[in]

info

Returns

Implements SCR_BaseScoringSystemComponent.

GetScoreLimit()

override int SCR_ScoringSystemComponent.GetScoreLimit

(

)

Returns

maximum allowed score or -1 if undefined.

Implements SCR_BaseScoringSystemComponent.

OnFactionScoreChanged()

override void SCR_ScoringSystemComponent.OnFactionScoreChanged ( Faction  faction, SCR_ScoreInfo  scoreInfo  )

protected

Called on all machines when faction score changes.

Implements SCR_BaseScoringSystemComponent.

OnGameModeEnd()

override void SCR_ScoringSystemComponent.OnGameModeEnd ( SCR_GameModeEndData  data )

protected

Called when game mode ends.

Parameters

[in]

data

End game data with game logic.

Implements SCR_BaseGameModeComponent.

OnPlayerKilled()

override void SCR_ScoringSystemComponent.OnPlayerKilled ( int  playerId, IEntity  playerEntity, IEntity  killerEntity, notnull Instigator  killer  )

protected

Handle and dispatch scoring logic for this event.

Implements SCR_BaseGameModeComponent.

OnPlayerScoreChanged()

override void SCR_ScoringSystemComponent.OnPlayerScoreChanged ( int  playerId, SCR_ScoreInfo  scoreInfo  )

protected

Called on all machines when player score changes.

Implements SCR_BaseScoringSystemComponent.

Member Data Documentation

m_aActions

ref array<ref IScoringAction> SCR_ScoringSystemComponent.m_aActions

protected

m_iDeathScoreMultiplier

int SCR_ScoringSystemComponent.m_iDeathScoreMultiplier

protected

m_iKillScoreMultiplier

int SCR_ScoringSystemComponent.m_iKillScoreMultiplier

protected

m_iObjectiveScoreMultiplier

int SCR_ScoringSystemComponent.m_iObjectiveScoreMultiplier

protected

m_iSuicideScoreMultiplier

int SCR_ScoringSystemComponent.m_iSuicideScoreMultiplier

protected

m_iTeamKillScoreMultiplier

int SCR_ScoringSystemComponent.m_iTeamKillScoreMultiplier

protected

---

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

• Game/GameMode/Scoring/SCR_ScoringSystemComponent.c