SCR_AnalyticsInventory Interface Reference

Public Member Functions
void	OpenInventory (float currentWeight)
	User opens the inventory and it contains a specific weight.
void	CloseInventory (float currentWeight)
	User closes the inventory and it contains a specific weight.
void	Update (float deltaSeconds)
	Update time spent in inventory and outside it.
bool	IsReadyToSend ()
	Check if we are ready to send our saved data to analytics.
void	ResetReadyToSend ()
	We have sended the data, so we reset.
void	InteractWithItem (SCR_EAnalyticalItemSlotType itemSlotType)
	We have interacted with an item of particular slot type.
void	UseHealing ()
	We used healing (bandages) through the inventory. Save it for analytics.
void	UseExamination ()
	We used examination through the inventory. Save it for analytics.
SCR_InventoryData	GetClonedData ()

Protected Member Functions
string	ArrayToString (array< float > arr)

Protected Attributes
ref SCR_InventoryData	m_Inventory = new SCR_InventoryData()
ref SCR_AnalyticsDelayedSend	m_DelayedSend = new SCR_AnalyticsDelayedSend()
ref array< float >	m_aOpenWeights = {}
ref array< float >	m_aCloseWeights = {}

Member Function Documentation

ArrayToString()

string SCR_AnalyticsInventory.ArrayToString ( array< float > arr )

protected

Returns

currently saved data as a copy

CloseInventory()

void SCR_AnalyticsInventory.CloseInventory

(

float

currentWeight

)

User closes the inventory and it contains a specific weight.

Save it for the analytics.

Parameters

[in]

currentWeight

GetClonedData()

SCR_InventoryData SCR_AnalyticsInventory.GetClonedData

(

)

Returns

currently saved data as a copy

InteractWithItem()

void SCR_AnalyticsInventory.InteractWithItem

(

SCR_EAnalyticalItemSlotType

itemSlotType

)

We have interacted with an item of particular slot type.

Parameters

[in]

itemSlotType

IsReadyToSend()

bool SCR_AnalyticsInventory.IsReadyToSend

(

)

Check if we are ready to send our saved data to analytics.

Returns

bool

OpenInventory()

void SCR_AnalyticsInventory.OpenInventory

(

float

currentWeight

)

User opens the inventory and it contains a specific weight.

Save it for the analytics.

Parameters

[in]

currentWeight

ResetReadyToSend()

void SCR_AnalyticsInventory.ResetReadyToSend

(

)

We have sended the data, so we reset.

Update()

void SCR_AnalyticsInventory.Update

(

float

deltaSeconds

)

Update time spent in inventory and outside it.

We need to wait until we send the inventoryClosed event to prevent multiple sends in rapid succession.

Parameters

[in]

deltaSeconds

UseExamination()

void SCR_AnalyticsInventory.UseExamination

(

)

We used examination through the inventory. Save it for analytics.

UseHealing()

void SCR_AnalyticsInventory.UseHealing

(

)

We used healing (bandages) through the inventory. Save it for analytics.

Member Data Documentation

m_aCloseWeights

ref array<float> SCR_AnalyticsInventory.m_aCloseWeights = {}

protected

m_aOpenWeights

ref array<float> SCR_AnalyticsInventory.m_aOpenWeights = {}

protected

m_DelayedSend

ref SCR_AnalyticsDelayedSend SCR_AnalyticsInventory.m_DelayedSend = new SCR_AnalyticsDelayedSend()

protected

m_Inventory

ref SCR_InventoryData SCR_AnalyticsInventory.m_Inventory = new SCR_InventoryData()

protected

---

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

• Game/DataCollection/ApplicationData/SCR_AnalyticsInventory.c