SCR_AnalyticsInteractions Interface Reference

Public Member Functions
void	Start ()
	Start tracking interactions.
void	Close ()
	Closes tracking interactions.
void	Update (float deltaSeconds)
	Update the current timers with specified seconds that have elapsed since last update.
bool	IsReadyToSend ()
	Can we send our current data to analytics already?
void	ResetReadyToSend ()
	We sended the data, reset current state.
int	GetReopenTimes ()
int	GetTimeSpent ()
void	SetTab (string tab)
	Set a different tab and save it to the interactions.
void	SetSorting (string sorting)
	Set a different sorting and save it to the interactions.
void	SetFilter (string filterCategory, string filterName)
	Set a filter and save it to the interactions.
void	UseSearch ()
	Use search box and save it to the interactions.
void	UseFilterOn ()
	Use filter toggle and save it to the interactions.
void	UseFavorite ()
	Use favorite button to the interactions.
string	GetInteractions ()
	Get all saved interactions, in JSON-like format.

Protected Member Functions
string	SerializeMap (map< string, int > mapp)
string	SerializeFilters ()

Protected Attributes
ref SCR_AnalyticsDelayedSend	m_DelayedSend = new SCR_AnalyticsDelayedSend()
ref map< string, int >	m_Tabs = new map<string, int>()
ref map< string, int >	m_Sortings = new map<string, int>()
ref map< string, ref map< string, int > >	m_Filters = new map<string, ref map<string, int>>()
WorldTimestamp	m_LastSearchUsage = null
int	m_iSearchUsages = 0
int	m_iFilterOnUsages = 0
int	m_iFavoriteUsages = 0
int	m_iReopenTimes = 1
bool	m_bIsOpened = false

Static Protected Attributes
static const int	MIN_DELAY_BETWEEN_SEARCHES_MS = 100

Member Function Documentation

Close()

void SCR_AnalyticsInteractions.Close

(

)

Closes tracking interactions.

Will start tracking delay before it will be ready to send to analytics.

GetInteractions()

string SCR_AnalyticsInteractions.GetInteractions

(

)

Get all saved interactions, in JSON-like format.

Returns

string

GetReopenTimes()

int SCR_AnalyticsInteractions.GetReopenTimes

(

)

Returns

how many times we have re-openned the menu (1 = we have openned the menu only once).

GetTimeSpent()

int SCR_AnalyticsInteractions.GetTimeSpent

(

)

Returns

time in seconds which was tracked since Start().

IsReadyToSend()

bool SCR_AnalyticsInteractions.IsReadyToSend

(

)

Can we send our current data to analytics already?

Returns

bool

ResetReadyToSend()

void SCR_AnalyticsInteractions.ResetReadyToSend

(

)

We sended the data, reset current state.

SerializeFilters()

string SCR_AnalyticsInteractions.SerializeFilters ( )

protected

SerializeMap()

string SCR_AnalyticsInteractions.SerializeMap ( map< string, int > mapp )

protected

SetFilter()

void SCR_AnalyticsInteractions.SetFilter	(	string	filterCategory,
		string	filterName )

Set a filter and save it to the interactions.

Parameters

[in]	filterCategory
[in]	filterName

SetSorting()

void SCR_AnalyticsInteractions.SetSorting

(

string

sorting

)

Set a different sorting and save it to the interactions.

Parameters

[in]

sorting

SetTab()

void SCR_AnalyticsInteractions.SetTab

(

string

tab

)

Set a different tab and save it to the interactions.

Parameters

[in]

tab

Start()

void SCR_AnalyticsInteractions.Start

(

)

Start tracking interactions.

This needs to be used BEFORE any other method and CLEARS all current data if it is not openned soon enough from the last openned instance.

Update()

void SCR_AnalyticsInteractions.Update

(

float

deltaSeconds

)

Update the current timers with specified seconds that have elapsed since last update.

Parameters

[in]

deltaSeconds

UseFavorite()

void SCR_AnalyticsInteractions.UseFavorite

(

)

Use favorite button to the interactions.

UseFilterOn()

void SCR_AnalyticsInteractions.UseFilterOn

(

)

Use filter toggle and save it to the interactions.

UseSearch()

void SCR_AnalyticsInteractions.UseSearch

(

)

Use search box and save it to the interactions.

Member Data Documentation

m_bIsOpened

bool SCR_AnalyticsInteractions.m_bIsOpened = false

protected

m_DelayedSend

ref SCR_AnalyticsDelayedSend SCR_AnalyticsInteractions.m_DelayedSend = new SCR_AnalyticsDelayedSend()

protected

m_Filters

ref map<string, ref map<string, int> > SCR_AnalyticsInteractions.m_Filters = new map<string, ref map<string, int>>()

protected

m_iFavoriteUsages

int SCR_AnalyticsInteractions.m_iFavoriteUsages = 0

protected

m_iFilterOnUsages

int SCR_AnalyticsInteractions.m_iFilterOnUsages = 0

protected

m_iReopenTimes

int SCR_AnalyticsInteractions.m_iReopenTimes = 1

protected

m_iSearchUsages

int SCR_AnalyticsInteractions.m_iSearchUsages = 0

protected

m_LastSearchUsage

WorldTimestamp SCR_AnalyticsInteractions.m_LastSearchUsage = null

protected

m_Sortings

ref map<string, int> SCR_AnalyticsInteractions.m_Sortings = new map<string, int>()

protected

m_Tabs

ref map<string, int> SCR_AnalyticsInteractions.m_Tabs = new map<string, int>()

protected

MIN_DELAY_BETWEEN_SEARCHES_MS

const int SCR_AnalyticsInteractions.MIN_DELAY_BETWEEN_SEARCHES_MS = 100

staticprotected

---

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

• Game/DataCollection/ApplicationData/SCR_AnalyticsInteractions.c