SCR_AnalyticsDataCollectionModule Interface Reference

Inheritance diagram for SCR_AnalyticsDataCollectionModule:

Public Member Functions
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 ()
void	Enable ()
void	Disable ()

Public Attributes
float	m_fUpdatePeriod

Protected Member Functions
void	AddInvokers (IEntity player)
void	RemoveInvokers (IEntity player)
SCR_SessionDataEvent	GetSessionDataEvent ()

Protected Attributes
float	m_fTimeSinceUpdate = 0
bool	m_bIsEnabled = true

Member Function Documentation

AddInvokers()

void SCR_AnalyticsDataCollectionModule.AddInvokers ( IEntity player )

protected

Disable()

void SCR_AnalyticsDataCollectionModule.Disable

(

)

Implemented in SCR_AnalyticsDataCollectionAiGroupCostModule, SCR_AnalyticsDataCollectionCompositionCostModule, SCR_AnalyticsDataCollectionLoadoutCostModule, SCR_AnalyticsDataCollectionMilitaryBaseEventsModule, SCR_AnalyticsDataCollectionPlayerFactionModule, SCR_AnalyticsDataCollectionPlayerKicksModule, SCR_AnalyticsDataCollectionTransferSuppliesModule, SCR_AnalyticsDataCollectionTutorialCompletionModule, SCR_AnalyticsDataCollectionVehicleCostModule, SCR_AnalyticsDataCollectionVoNDataModule, and SCR_AnalyticsDataCollectionXPEventsModule.

Enable()

void SCR_AnalyticsDataCollectionModule.Enable

(

)

Implemented in SCR_AnalyticsDataCollectionAiGroupCostModule, SCR_AnalyticsDataCollectionCompositionCostModule, SCR_AnalyticsDataCollectionLoadoutCostModule, SCR_AnalyticsDataCollectionMilitaryBaseEventsModule, SCR_AnalyticsDataCollectionPlayerFactionModule, SCR_AnalyticsDataCollectionPlayerKicksModule, SCR_AnalyticsDataCollectionTransferSuppliesModule, SCR_AnalyticsDataCollectionTutorialCompletionModule, SCR_AnalyticsDataCollectionVehicleCostModule, SCR_AnalyticsDataCollectionVoNDataModule, and SCR_AnalyticsDataCollectionXPEventsModule.

GetSessionDataEvent()

SCR_SessionDataEvent SCR_AnalyticsDataCollectionModule.GetSessionDataEvent ( )

protected

InitModule()

void SCR_AnalyticsDataCollectionModule.InitModule

(

)

Implemented in SCR_AnalyticsDataCollectionTutorialCompletionModule.

IsEnabled()

bool SCR_AnalyticsDataCollectionModule.IsEnabled

(

)

OnControllableDestroyed()

void SCR_AnalyticsDataCollectionModule.OnControllableDestroyed

(

notnull SCR_InstigatorContextData

instigatorContextData

)

OnControlledEntityChanged()

void SCR_AnalyticsDataCollectionModule.OnControlledEntityChanged	(	IEntity	from,
		IEntity	to )

OnGameEnd()

void SCR_AnalyticsDataCollectionModule.OnGameEnd

(

)

OnGameModeEnd()

void SCR_AnalyticsDataCollectionModule.OnGameModeEnd

(

)

Implemented in SCR_AnalyticsDataCollectionPlayerKicksModule, SCR_AnalyticsDataCollectionSupplyCostBaseModule, and SCR_AnalyticsDataCollectionXPEventsModule.

OnPlayerConnected()

void SCR_AnalyticsDataCollectionModule.OnPlayerConnected

(

int

playerId

)

Implemented in SCR_AnalyticsDataCollectionPlayerKicksModule, SCR_AnalyticsDataCollectionSupplyCostBaseModule, SCR_AnalyticsDataCollectionTimeAndWeatherModule, SCR_AnalyticsDataCollectionVoNDataModule, and SCR_AnalyticsDataCollectionXPEventsModule.

OnPlayerDisconnected()

void SCR_AnalyticsDataCollectionModule.OnPlayerDisconnected	(	int	playerId,
		KickCauseCode	cause,
		IEntity	controlledEntity = null )

Implemented in SCR_AnalyticsDataCollectionPlayerKicksModule, SCR_AnalyticsDataCollectionTimeAndWeatherModule, SCR_AnalyticsDataCollectionVoNDataModule, and SCR_AnalyticsDataCollectionXPEventsModule.

OnPlayerSpawned()

void SCR_AnalyticsDataCollectionModule.OnPlayerSpawned	(	SCR_SpawnRequestComponent	requestComponent,
		int	playerId,
		SCR_SpawnData	data,
		IEntity	controlledEntity )

Implemented in SCR_AnalyticsDataCollectionLoadoutCostModule.

RemoveInvokers()

void SCR_AnalyticsDataCollectionModule.RemoveInvokers ( IEntity player )

protected

SessionMeasures()

void SCR_AnalyticsDataCollectionModule.SessionMeasures

(

)

Periodically called when server has players To be overriden in modules to add session data before it is sent.

Implemented in SCR_AnalyticsDataCollectionPlayerGroupsModule, and SCR_AnalyticsDataCollectionTransferSuppliesModule.

Update()

void SCR_AnalyticsDataCollectionModule.Update

(

float

timeTick

)

Member Data Documentation

m_bIsEnabled

bool SCR_AnalyticsDataCollectionModule.m_bIsEnabled = true

protected

m_fTimeSinceUpdate

float SCR_AnalyticsDataCollectionModule.m_fTimeSinceUpdate = 0

protected

m_fUpdatePeriod

float SCR_AnalyticsDataCollectionModule.m_fUpdatePeriod

---

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

• Game/DataCollection/SCR_AnalyticsDataCollectionModule.c