SCR_TaskFinishHistoryManagerComponent Interface Reference

Inheritance diagram for SCR_TaskFinishHistoryManagerComponent:

Public Member Functions
array< ref SCR_TaskFinishEntry >	GetAll ()
array< ref SCR_TaskFinishEntry >	GetByTaskID (string taskID)
array< ref SCR_TaskFinishEntry >	GetByPlayerID (int playerID)
array< ref SCR_TaskFinishEntry >	GetByFinalState (SCR_ETaskState state)
map< string, int >	GetAggregatedByPlayerID (int playerID)
map< int, ref map< string, int > >	GetAggregatedByTypeAndPlayer ()
override void	OnPostInit (IEntity owner)
override void	OnDelete (IEntity owner)
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)
void	SCR_TaskFinishHistoryManagerComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
void	~SCR_TaskFinishHistoryManagerComponent ()
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.
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 instigator)
	See SCR_BaseGameMode.HandlePlayerKilled.
void	OnPlayerKilled (notnull SCR_InstigatorContextData instigatorContextData)
	Called after a player gets killed.
void	OnPlayerKilledHandled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	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	OnControllableSpawned (IEntity entity)
	When a controllable entity is spawned, this event is raised.
void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
	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)

Static Public Member Functions
static SCR_TaskFinishHistoryManagerComponent	GetInstance ()

Protected Member Functions
void	OnTaskStateChanged (SCR_Task task, SCR_ETaskState newState)
bool	IsFinishedState (SCR_ETaskState state)
void	RecordIfFinished (SCR_Task task, SCR_ETaskState newState)

Protected Attributes
ref array< ref SCR_TaskFinishEntry >	m_aFinished = {}
Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	m_pGameMode
	The game mode entity this component is attached to.

Static Protected Attributes
static SCR_TaskFinishHistoryManagerComponent	s_Instance

Constructor & Destructor Documentation

SCR_TaskFinishHistoryManagerComponent()

void SCR_TaskFinishHistoryManagerComponent.SCR_TaskFinishHistoryManagerComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent )

Parameters

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

~SCR_TaskFinishHistoryManagerComponent()

void SCR_TaskFinishHistoryManagerComponent.~SCR_TaskFinishHistoryManagerComponent

(

)

Member Function Documentation

GetAggregatedByPlayerID()

map< string, int > SCR_TaskFinishHistoryManagerComponent.GetAggregatedByPlayerID

(

int

playerID

)

Parameters

[in]

playerID

Returns

aggregated counts of task types finished by player with input playerID or returns null if no finished tasks recorded

GetAggregatedByTypeAndPlayer()

map< int, ref map< string, int > > SCR_TaskFinishHistoryManagerComponent.GetAggregatedByTypeAndPlayer

(

)

Returns

aggregated counts of finished task types which are grouped by playerIDs or returns null if no finished tasks recroded

GetAll()

array< ref SCR_TaskFinishEntry > SCR_TaskFinishHistoryManagerComponent.GetAll

(

)

Returns

list of all finished task entries

GetByFinalState()

array< ref SCR_TaskFinishEntry > SCR_TaskFinishHistoryManagerComponent.GetByFinalState

(

SCR_ETaskState

state

)

Parameters

[in]

final

state

Returns

list of finished task entries with final state same as input

GetByPlayerID()

array< ref SCR_TaskFinishEntry > SCR_TaskFinishHistoryManagerComponent.GetByPlayerID

(

int

playerID

)

Parameters

[in]

playerID

Returns

list of finished task entries with player with input playerID as assignee

GetByTaskID()

array< ref SCR_TaskFinishEntry > SCR_TaskFinishHistoryManagerComponent.GetByTaskID

(

string

taskID

)

Parameters

[in]

taskID

Returns

list of finished task entries with the same taskID as input

GetInstance()

static SCR_TaskFinishHistoryManagerComponent SCR_TaskFinishHistoryManagerComponent.GetInstance ( )

static

IsFinishedState()

bool SCR_TaskFinishHistoryManagerComponent.IsFinishedState ( SCR_ETaskState state )

protected

OnDelete()

override void SCR_TaskFinishHistoryManagerComponent.OnDelete

(

IEntity

owner

)

OnPostInit()

override void SCR_TaskFinishHistoryManagerComponent.OnPostInit

(

IEntity

owner

)

OnTaskStateChanged()

void SCR_TaskFinishHistoryManagerComponent.OnTaskStateChanged ( SCR_Task task, SCR_ETaskState newState )

protected

RecordIfFinished()

void SCR_TaskFinishHistoryManagerComponent.RecordIfFinished ( SCR_Task task, SCR_ETaskState newState )

protected

RplLoad()

override bool SCR_TaskFinishHistoryManagerComponent.RplLoad

(

ScriptBitReader

reader

)

RplSave()

override bool SCR_TaskFinishHistoryManagerComponent.RplSave

(

ScriptBitWriter

writer

)

Member Data Documentation

m_aFinished

ref array<ref SCR_TaskFinishEntry> SCR_TaskFinishHistoryManagerComponent.m_aFinished = {}

protected

s_Instance

SCR_TaskFinishHistoryManagerComponent SCR_TaskFinishHistoryManagerComponent.s_Instance

staticprotected

---

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

• Game/Tasks/SCR_TaskFinishHistoryManagerComponent.c