SCR_AnalyticsDataCollectionComponent.c File Reference

Go to the source code of this file.

Classes
class	SCR_AnalyticsDataCollectionComponentClass

Functions
SCR_AnalyticsDataCollectionComponentClass SCR_BaseGameModeComponentClass	Attribute ()] protected ref array< ref SCR_AnalyticsDataCollectionModule > m_aModules
override void	OnGameModeStart ()
override void	OnGameModeEnd (SCR_GameModeEndData data)
override void	OnGameEnd ()
	Called on all machines when the world ends.
override void	OnPlayerConnected (int playerId)
override void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
override void	OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
override void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
SCR_AnalyticsDataCollectionModule	FindModule (typename type)
array< ref SCR_AnalyticsDataCollectionModule >	GetAllModules ()
SCR_AnalyticsDataCollectionModule	GetModuleById (int id)
void	DisableAllModules ()
	Disables all analytics data collection modules.
override void	EOnFrame (IEntity owner, float timeSlice)
void	SessionMeasures ()
override void	OnPostInit (IEntity owner)
	Editable Mine.
override void	OnDelete (IEntity owner)

Variables
int	m_iSessionMeasuresInterval
IEntity	m_Owner
float	m_fSessionMeasuresTimer

Function Documentation

Attribute()

SCR_AnalyticsDataCollectionComponentClass SCR_BaseGameModeComponentClass Attribute

(

)

Definition at line 82 of file SendGoalMessage.c.

DisableAllModules()

void DisableAllModules ( )

protected

Disables all analytics data collection modules.

Definition at line 162 of file SCR_AnalyticsDataCollectionComponent.c.

EOnFrame()

override void EOnFrame ( IEntity owner, float timeSlice )

protected

Definition at line 171 of file SCR_AnalyticsDataCollectionComponent.c.

FindModule()

SCR_AnalyticsDataCollectionModule FindModule ( typename type )

protected

Parameters

[in]

type

Returns

found module or null if not found

Definition at line 130 of file SCR_AnalyticsDataCollectionComponent.c.

GetAllModules()

array< ref SCR_AnalyticsDataCollectionModule > GetAllModules ( )

protected

Returns

all modules

Definition at line 143 of file SCR_AnalyticsDataCollectionComponent.c.

GetModuleById()

SCR_AnalyticsDataCollectionModule GetModuleById ( int id )

protected

Parameters

[in]

id

Returns

found module or null if not found

Definition at line 152 of file SCR_AnalyticsDataCollectionComponent.c.

OnControllableDestroyed()

override void 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

Definition at line 118 of file SCR_AnalyticsDataCollectionComponent.c.

OnDelete()

override void OnDelete ( IEntity owner )

protected

Definition at line 226 of file SCR_AnalyticsDataCollectionComponent.c.

OnGameEnd()

override void OnGameEnd ( )

protected

Called on all machines when the world ends.

Definition at line 65 of file SCR_AnalyticsDataCollectionComponent.c.

OnGameModeEnd()

override void OnGameModeEnd ( SCR_GameModeEndData data )

protected

Called when game mode ends.

Parameters

[in]

data

End game data with game logic.

Definition at line 50 of file SCR_AnalyticsDataCollectionComponent.c.

OnGameModeStart()

override void 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.

Definition at line 25 of file SCR_AnalyticsDataCollectionComponent.c.

OnPlayerConnected()

override void OnPlayerConnected ( int playerId )

protected

Called after a player is connected. Server-only.

Parameters

[in]	playerId	PlayerId of connected player.
[in]	playerId

Definition at line 74 of file SCR_AnalyticsDataCollectionComponent.c.

OnPlayerDisconnected()

override void 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

What happens when a player disconnects.

Parameters

[in]	playerID	is a unique player identifier that defines which player has disconnected.
[in]	cause
[in]	timeout

Definition at line 90 of file SCR_AnalyticsDataCollectionComponent.c.

OnPlayerSpawnFinalize_S()

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

protected

Parameters

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

Definition at line 102 of file SCR_AnalyticsDataCollectionComponent.c.

SessionMeasures()

void SessionMeasures ( )

protected

Definition at line 188 of file SCR_AnalyticsDataCollectionComponent.c.

Variable Documentation

m_fSessionMeasuresTimer

float m_fSessionMeasuresTimer

protected

Definition at line 16 of file SCR_AnalyticsDataCollectionComponent.c.

m_iSessionMeasuresInterval

int m_iSessionMeasuresInterval

protected

Definition at line 12 of file SCR_AnalyticsDataCollectionComponent.c.

m_Owner

IEntity m_Owner

protected

Definition at line 14 of file SCR_AnalyticsDataCollectionComponent.c.