SCR_AnalyticsDataCollectionTasksModule Interface Reference

Inheritance diagram for SCR_AnalyticsDataCollectionTasksModule:

Protected Member Functions
override void	Enable ()
	15 seconds
override void	Disable ()
void	TaskCreated (SCR_Task task)
	Task is created, send event to analytics db.
void	TaskRemoved (SCR_Task task)
	Task is removed, send event to analytics db.
void	SendSessionDataEvent (SCR_Task task, SCR_EAnalyticalTaskState state)
	The SessionDataEvent is sent, added to a queue and removed after a specific time.
void	RemoveElement (SCR_SessionDataEvent item)
	Remove element from the cache.
bool	IsTaskRequested (SCR_Task task)
	Check if the given task is requested.
Protected Member Functions inherited from SCR_AnalyticsDataCollectionModule
void	AddInvokers (IEntity player)
void	RemoveInvokers (IEntity player)
SCR_SessionDataEvent	GetSessionDataEvent ()

Protected Attributes
ref array< ref SCR_SessionDataEvent >	m_TaskCache
int	m_TaskCacheLifeTime = 15000
Protected Attributes inherited from SCR_AnalyticsDataCollectionModule
float	m_fTimeSinceUpdate = 0
bool	m_bIsEnabled = true

Additional Inherited Members
Public Member Functions inherited from SCR_AnalyticsDataCollectionModule
void	InitModule ()
void	Update (float timeTick)
void	OnPlayerSpawned (SCR_SpawnRequestComponent requestComponent, int playerId, SCR_SpawnData data, IEntity controlledEntity)
void	OnPlayerDisconnected (int playerId, KickCauseCode cause, IEntity controlledEntity=null)
void	OnPlayerConnected (int playerId)
void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
void	OnGameModeEnd ()
void	OnGameEnd ()
void	OnControlledEntityChanged (IEntity from, IEntity to)
void	SessionMeasures ()
	Periodically called when server has players To be overriden in modules to add session data before it is sent.
bool	IsEnabled ()
Public Attributes inherited from SCR_AnalyticsDataCollectionModule
float	m_fUpdatePeriod

Member Function Documentation

Disable()

override void SCR_AnalyticsDataCollectionTasksModule.Disable ( )

protected

Implements SCR_AnalyticsDataCollectionModule.

Enable()

override void SCR_AnalyticsDataCollectionTasksModule.Enable ( )

protected

15 seconds

Implements SCR_AnalyticsDataCollectionModule.

IsTaskRequested()

bool SCR_AnalyticsDataCollectionTasksModule.IsTaskRequested ( SCR_Task task )

protected

Check if the given task is requested.

Parameters

[in]

task

RemoveElement()

void SCR_AnalyticsDataCollectionTasksModule.RemoveElement ( SCR_SessionDataEvent item )

protected

Remove element from the cache.

Parameters

[in]

item

SendSessionDataEvent()

void SCR_AnalyticsDataCollectionTasksModule.SendSessionDataEvent ( SCR_Task task, SCR_EAnalyticalTaskState state )

protected

The SessionDataEvent is sent, added to a queue and removed after a specific time.

Parameters

[in]	task
[in]	state

TaskCreated()

void SCR_AnalyticsDataCollectionTasksModule.TaskCreated ( SCR_Task task )

protected

Task is created, send event to analytics db.

Parameters

[in]

task

TaskRemoved()

void SCR_AnalyticsDataCollectionTasksModule.TaskRemoved ( SCR_Task task )

protected

Task is removed, send event to analytics db.

Parameters

[in]

task

Member Data Documentation

m_TaskCache

ref array<ref SCR_SessionDataEvent> SCR_AnalyticsDataCollectionTasksModule.m_TaskCache

protected

m_TaskCacheLifeTime

int SCR_AnalyticsDataCollectionTasksModule.m_TaskCacheLifeTime = 15000

protected

---

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

• Game/DataCollection/AnalyticsDataCollectionModules/SCR_AnalyticsDataCollectionTasksModule.c