Loading...
Searching...
No Matches
SCR_AnalyticsDataCollectionTransferSuppliesModule Interface Reference
Inheritance diagram for SCR_AnalyticsDataCollectionTransferSuppliesModule:
SCR_AnalyticsDataCollectionModule

Public Member Functions

string GetDestinationPosition (string type, SCR_ResourceComponent resource, PlayerController playerController, SCR_AIGroupUtilityComponent utility)
 
bool GetMilitaryBase (IEntity resourceOwner, out SCR_CampaignMilitaryBaseComponent outBase)
 
string GetTransferingPlayerFaction (PlayerController playerController)
 
string GetTransferingAIFaction (SCR_AIGroupUtilityComponent utility)
 
string GetCharacterUniqueId (notnull PlayerController playerController)
 
override void SessionMeasures ()
 Periodically called when server has players To be overriden in modules to add session data before it is sent.
 
- 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 OnGameEnd ()
 
void OnControlledEntityChanged (IEntity from, IEntity to)
 
bool IsEnabled ()
 

Protected Member Functions

override void Enable ()
 
override void Disable ()
 
override void OnGameModeEnd ()
 
string GetTypeFromResourceComponent (SCR_ResourceComponent resourceComponent)
 Get the type of consumer/generator by the resourceComponent.
 
bool DistinguishOrphanAndBase (SCR_ResourceComponent resourceComponent, IEntity parent)
 Check if the resourceComponents belongs to an Orphan or a base.
 
ResourceName GetPrefabName (SCR_ResourceComponent resourceComponent)
 
ResourceName GetPrefabNameFromAITruck (SCR_AIGroupUtilityComponent utility)
 
ResourceName SetPrefabName (bool isPlayer, string resourceType, SCR_ResourceComponent resourceComponent, SCR_AIGroupUtilityComponent utility)
 
void OnTransferSuppliesByPlayer (EResourcePlayerInteractionType interactionType, SCR_ResourceComponent resourceComponentFrom, SCR_ResourceComponent resourceComponentTo, EResourceType resourceType, float resourceValue, PlayerController playerController)
 
void OnTransferSuppliesByAI (EResourcePlayerInteractionType interactionType, SCR_ResourceComponent resourceComponentFrom, SCR_ResourceComponent resourceComponentTo, EResourceType resourceType, float resourceValue, SCR_AIGroupUtilityComponent utility)
 
void OnTransferSupplies (EResourcePlayerInteractionType interactionType, SCR_ResourceComponent resourceComponentFrom, SCR_ResourceComponent resourceComponentTo, EResourceType resourceType, float resourceValue, PlayerController playerController, SCR_AIGroupUtilityComponent utility)
 
string GetPrefabType (SCR_ResourceComponent resourceComponent, bool isPlayer)
 
string GetMilitaryBasePosition (SCR_ResourceComponent resourceComponent)
 
- Protected Member Functions inherited from SCR_AnalyticsDataCollectionModule
void AddInvokers (IEntity player)
 
void RemoveInvokers (IEntity player)
 
SCR_SessionDataEvent GetSessionDataEvent ()
 

Protected Attributes

ref array< ref SCR_TransferSuppliesInteractionm_Interactions = new array<ref SCR_TransferSuppliesInteraction>()
 
- Protected Attributes inherited from SCR_AnalyticsDataCollectionModule
float m_fTimeSinceUpdate = 0
 
bool m_bIsEnabled = true
 

Static Protected Attributes

static const string BASE = "BASE"
 
static const int MAX_INTERACTIONS = 2000
 

Additional Inherited Members

- Public Attributes inherited from SCR_AnalyticsDataCollectionModule
float m_fUpdatePeriod
 

Member Function Documentation

◆ Disable()

override void SCR_AnalyticsDataCollectionTransferSuppliesModule.Disable ( )
protected

◆ DistinguishOrphanAndBase()

bool SCR_AnalyticsDataCollectionTransferSuppliesModule.DistinguishOrphanAndBase ( SCR_ResourceComponent resourceComponent,
IEntity parent )
protected

Check if the resourceComponents belongs to an Orphan or a base.

Parameters
[in]resourceComponent
[in]parent

◆ Enable()

override void SCR_AnalyticsDataCollectionTransferSuppliesModule.Enable ( )
protected

◆ GetCharacterUniqueId()

string SCR_AnalyticsDataCollectionTransferSuppliesModule.GetCharacterUniqueId ( notnull PlayerController playerController)
Parameters
[in]playerController
Returns

◆ GetDestinationPosition()

string SCR_AnalyticsDataCollectionTransferSuppliesModule.GetDestinationPosition ( string type,
SCR_ResourceComponent resource,
PlayerController playerController,
SCR_AIGroupUtilityComponent utility )
Parameters
[in]type
[in]resource
[in]playerController
[in]utility
Returns

◆ GetMilitaryBase()

bool SCR_AnalyticsDataCollectionTransferSuppliesModule.GetMilitaryBase ( IEntity resourceOwner,
out SCR_CampaignMilitaryBaseComponent outBase )
Parameters
[in]resourceOwner
[out]outBase
Returns

◆ GetMilitaryBasePosition()

string SCR_AnalyticsDataCollectionTransferSuppliesModule.GetMilitaryBasePosition ( SCR_ResourceComponent resourceComponent)
protected

◆ GetPrefabName()

ResourceName SCR_AnalyticsDataCollectionTransferSuppliesModule.GetPrefabName ( SCR_ResourceComponent resourceComponent)
protected

◆ GetPrefabNameFromAITruck()

ResourceName SCR_AnalyticsDataCollectionTransferSuppliesModule.GetPrefabNameFromAITruck ( SCR_AIGroupUtilityComponent utility)
protected

◆ GetPrefabType()

string SCR_AnalyticsDataCollectionTransferSuppliesModule.GetPrefabType ( SCR_ResourceComponent resourceComponent,
bool isPlayer )
protected

◆ GetTransferingAIFaction()

string SCR_AnalyticsDataCollectionTransferSuppliesModule.GetTransferingAIFaction ( SCR_AIGroupUtilityComponent utility)
Parameters
[in]utility
Returns

◆ GetTransferingPlayerFaction()

string SCR_AnalyticsDataCollectionTransferSuppliesModule.GetTransferingPlayerFaction ( PlayerController playerController)
Parameters
[in]playerController
Returns

◆ GetTypeFromResourceComponent()

string SCR_AnalyticsDataCollectionTransferSuppliesModule.GetTypeFromResourceComponent ( SCR_ResourceComponent resourceComponent)
protected

Get the type of consumer/generator by the resourceComponent.

Parameters
[in]resourceComponent

◆ OnGameModeEnd()

override void SCR_AnalyticsDataCollectionTransferSuppliesModule.OnGameModeEnd ( )
protected

◆ OnTransferSupplies()

void SCR_AnalyticsDataCollectionTransferSuppliesModule.OnTransferSupplies ( EResourcePlayerInteractionType interactionType,
SCR_ResourceComponent resourceComponentFrom,
SCR_ResourceComponent resourceComponentTo,
EResourceType resourceType,
float resourceValue,
PlayerController playerController,
SCR_AIGroupUtilityComponent utility )
protected

◆ OnTransferSuppliesByAI()

void SCR_AnalyticsDataCollectionTransferSuppliesModule.OnTransferSuppliesByAI ( EResourcePlayerInteractionType interactionType,
SCR_ResourceComponent resourceComponentFrom,
SCR_ResourceComponent resourceComponentTo,
EResourceType resourceType,
float resourceValue,
SCR_AIGroupUtilityComponent utility )
protected

◆ OnTransferSuppliesByPlayer()

void SCR_AnalyticsDataCollectionTransferSuppliesModule.OnTransferSuppliesByPlayer ( EResourcePlayerInteractionType interactionType,
SCR_ResourceComponent resourceComponentFrom,
SCR_ResourceComponent resourceComponentTo,
EResourceType resourceType,
float resourceValue,
PlayerController playerController )
protected

◆ SessionMeasures()

override void SCR_AnalyticsDataCollectionTransferSuppliesModule.SessionMeasures ( )

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

Implements SCR_AnalyticsDataCollectionModule.

◆ SetPrefabName()

ResourceName SCR_AnalyticsDataCollectionTransferSuppliesModule.SetPrefabName ( bool isPlayer,
string resourceType,
SCR_ResourceComponent resourceComponent,
SCR_AIGroupUtilityComponent utility )
protected

Member Data Documentation

◆ BASE

const string SCR_AnalyticsDataCollectionTransferSuppliesModule.BASE = "BASE"
staticprotected

◆ m_Interactions

ref array<ref SCR_TransferSuppliesInteraction> SCR_AnalyticsDataCollectionTransferSuppliesModule.m_Interactions = new array<ref SCR_TransferSuppliesInteraction>()
protected

◆ MAX_INTERACTIONS

const int SCR_AnalyticsDataCollectionTransferSuppliesModule.MAX_INTERACTIONS = 2000
staticprotected

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