SCR_AnalyticsDataCollectionComponent Interface Reference

Inheritance diagram for SCR_AnalyticsDataCollectionComponent:

Public Member Functions
SCR_AnalyticsDataCollectionModule	FindModule (TypeName type)
array< ref SCR_AnalyticsDataCollectionModule >	GetAllModules ()
SCR_AnalyticsDataCollectionModule	GetModuleById (int id)
void	DisableAllModules ()
	Disables all analytics data collection modules.
Public Member Functions inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	GetGameMode ()
void	OnGameStateChanged (SCR_EGameModeState state)
	Called when game mode state changes called on all machines.
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.).
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)
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	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 void	OnGameModeStart ()
	Called on every machine when game mode starts.
override void	OnGameModeEnd (SCR_GameModeEndData data)
	Called when game mode ends.
override void	OnGameEnd ()
	Called on all machines when the world ends.
override void	OnPlayerConnected (int playerId)
	Called after a player is connected.
override void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Called after a player is disconnected.
override void	OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
override void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
	When a controllable entity is destroyed, this event is raised.
override void	EOnFrame (IEntity owner, float timeSlice)
void	SessionMeasures ()
override void	OnPostInit (IEntity owner)
override void	OnDelete (IEntity owner)

Protected Attributes
ref array< ref SCR_AnalyticsDataCollectionModule >	m_aModules
int	m_iSessionMeasuresInterval
IEntity	m_Owner
float	m_fSessionMeasuresTimer
Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	m_pGameMode
	The game mode entity this component is attached to.

Member Function Documentation

DisableAllModules()

void SCR_AnalyticsDataCollectionComponent.DisableAllModules

(

)

Disables all analytics data collection modules.

EOnFrame()

override void SCR_AnalyticsDataCollectionComponent.EOnFrame ( IEntity owner, float timeSlice )

protected

FindModule()

SCR_AnalyticsDataCollectionModule SCR_AnalyticsDataCollectionComponent.FindModule

(

TypeName

type

)

Parameters

[in]

type

Returns

found module or null if not found

GetAllModules()

array< ref SCR_AnalyticsDataCollectionModule > SCR_AnalyticsDataCollectionComponent.GetAllModules

(

)

Returns

all modules

GetModuleById()

SCR_AnalyticsDataCollectionModule SCR_AnalyticsDataCollectionComponent.GetModuleById

(

int

id

)

Parameters

[in]

id

Returns

found module or null if not found

OnControllableDestroyed()

override void SCR_AnalyticsDataCollectionComponent.OnControllableDestroyed ( notnull SCR_InstigatorContextData instigatorContextData )

protected

When a controllable entity is destroyed, this event is raised.

Parameters

[in]

instigatorContextData

Holds the data of the victim and killer

Implements SCR_BaseGameModeComponent.

OnDelete()

override void SCR_AnalyticsDataCollectionComponent.OnDelete ( IEntity owner )

protected

OnGameEnd()

override void SCR_AnalyticsDataCollectionComponent.OnGameEnd ( )

protected

Called on all machines when the world ends.

Implements SCR_BaseGameModeComponent.

OnGameModeEnd()

override void SCR_AnalyticsDataCollectionComponent.OnGameModeEnd ( SCR_GameModeEndData data )

protected

Called when game mode ends.

Parameters

[in]

data

End game data with game logic.

Implements SCR_BaseGameModeComponent.

OnGameModeStart()

override void SCR_AnalyticsDataCollectionComponent.OnGameModeStart ( )

protected

Called on every machine when game mode starts.

This can be immediate (if no pre-game period is set) or can happen after a certain delay, as deemed appropriate by the authority.

Implements SCR_BaseGameModeComponent.

OnPlayerConnected()

override void SCR_AnalyticsDataCollectionComponent.OnPlayerConnected ( int playerId )

protected

Called after a player is connected.

Server-only.

Parameters

[in]

playerId

PlayerId of connected player.

Implements SCR_BaseGameModeComponent.

OnPlayerDisconnected()

override void SCR_AnalyticsDataCollectionComponent.OnPlayerDisconnected ( int playerId, KickCauseCode cause, int timeout )

protected

Called after a player is disconnected.

Parameters

[in]	playerId	PlayerId of disconnected player.
[in]	cause	Reason player disconnected
[in]	timeout	Timeout for when players are allowed to connect again. -1 means Ban without an assigned timeout

Implements SCR_BaseGameModeComponent.

OnPlayerSpawnFinalize_S()

override void SCR_AnalyticsDataCollectionComponent.OnPlayerSpawnFinalize_S ( SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity )

protected

Parameters

[in]	requestComponent
[in]	handlerComponent
[in]	data
[in]	entity

Implements SCR_BaseGameModeComponent.

OnPostInit()

override void SCR_AnalyticsDataCollectionComponent.OnPostInit ( IEntity owner )

protected

SessionMeasures()

void SCR_AnalyticsDataCollectionComponent.SessionMeasures ( )

protected

Member Data Documentation

m_aModules

ref array<ref SCR_AnalyticsDataCollectionModule> SCR_AnalyticsDataCollectionComponent.m_aModules

protected

m_fSessionMeasuresTimer

float SCR_AnalyticsDataCollectionComponent.m_fSessionMeasuresTimer

protected

m_iSessionMeasuresInterval

int SCR_AnalyticsDataCollectionComponent.m_iSessionMeasuresInterval

protected

m_Owner

IEntity SCR_AnalyticsDataCollectionComponent.m_Owner

protected

---

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

• Game/DataCollection/SCR_AnalyticsDataCollectionComponent.c