SCR_AnalyticsInteractions Class Reference

Protected Member Functions
void	Start ()
void	Close ()
void	Update (float deltaSeconds)
bool	IsReadyToSend ()
void	ResetReadyToSend ()
	We sended the data, reset current state.
int	GetReopenTimes ()
int	GetTimeSpent ()
void	SetTab (string tab)
void	SetSorting (string sorting)
void	SetFilter (string filterCategory, string filterName)
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 ()
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

Detailed Description

Definition at line 3 of file SCR_AnalyticsInteractions.c.

Member Function Documentation

Close()

void SCR_AnalyticsInteractions::Close ( )

inlineprotected

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

Definition at line 43 of file SCR_AnalyticsInteractions.c.

GetInteractions()

string SCR_AnalyticsInteractions::GetInteractions ( )

inlineprotected

Get all saved interactions, in JSON-like format.

Returns

string

Definition at line 169 of file SCR_AnalyticsInteractions.c.

GetReopenTimes()

int SCR_AnalyticsInteractions::GetReopenTimes ( )

inlineprotected

Returns

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

Definition at line 74 of file SCR_AnalyticsInteractions.c.

GetTimeSpent()

int SCR_AnalyticsInteractions::GetTimeSpent ( )

inlineprotected

Returns

time in seconds which was tracked since Start().

Definition at line 81 of file SCR_AnalyticsInteractions.c.

IsReadyToSend()

bool SCR_AnalyticsInteractions::IsReadyToSend ( )

inlineprotected

Can we send our current data to analytics already?

Returns

bool

Definition at line 60 of file SCR_AnalyticsInteractions.c.

ResetReadyToSend()

void SCR_AnalyticsInteractions::ResetReadyToSend ( )

inlineprotected

We sended the data, reset current state.

Definition at line 67 of file SCR_AnalyticsInteractions.c.

SerializeFilters()

string SCR_AnalyticsInteractions::SerializeFilters ( )

inlineprotected

Definition at line 223 of file SCR_AnalyticsInteractions.c.

SerializeMap()

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

inlineprotected

Definition at line 204 of file SCR_AnalyticsInteractions.c.

SetFilter()

void SCR_AnalyticsInteractions::SetFilter ( string filterCategory, string filterName )

inlineprotected

Set a filter and save it to the interactions.

Parameters

[in]	filterCategory
[in]	filterName

Definition at line 114 of file SCR_AnalyticsInteractions.c.

SetSorting()

void SCR_AnalyticsInteractions::SetSorting ( string sorting )

inlineprotected

Set a different sorting and save it to the interactions.

Parameters

[in]

sorting

Definition at line 101 of file SCR_AnalyticsInteractions.c.

SetTab()

void SCR_AnalyticsInteractions::SetTab ( string tab )

inlineprotected

Set a different tab and save it to the interactions.

Parameters

[in]

tab

Definition at line 89 of file SCR_AnalyticsInteractions.c.

Start()

void SCR_AnalyticsInteractions::Start ( )

inlineprotected

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.

Definition at line 20 of file SCR_AnalyticsInteractions.c.

Update()

void SCR_AnalyticsInteractions::Update ( float deltaSeconds )

inlineprotected

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

Parameters

[in]

deltaSeconds

Definition at line 52 of file SCR_AnalyticsInteractions.c.

UseFavorite()

void SCR_AnalyticsInteractions::UseFavorite ( )

inlineprotected

Use favorite button to the interactions.

Definition at line 158 of file SCR_AnalyticsInteractions.c.

UseFilterOn()

void SCR_AnalyticsInteractions::UseFilterOn ( )

inlineprotected

Use filter toggle and save it to the interactions.

Definition at line 148 of file SCR_AnalyticsInteractions.c.

UseSearch()

void SCR_AnalyticsInteractions::UseSearch ( )

inlineprotected

Use search box and save it to the interactions.

Definition at line 129 of file SCR_AnalyticsInteractions.c.

Member Data Documentation

m_bIsOpened

bool SCR_AnalyticsInteractions::m_bIsOpened = false

protected

Definition at line 15 of file SCR_AnalyticsInteractions.c.

m_DelayedSend

ref SCR_AnalyticsDelayedSend SCR_AnalyticsInteractions::m_DelayedSend = new SCR_AnalyticsDelayedSend()

protected

Definition at line 6 of file SCR_AnalyticsInteractions.c.

m_Filters

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

protected

Definition at line 9 of file SCR_AnalyticsInteractions.c.

m_iFavoriteUsages

int SCR_AnalyticsInteractions::m_iFavoriteUsages = 0

protected

Definition at line 13 of file SCR_AnalyticsInteractions.c.

m_iFilterOnUsages

int SCR_AnalyticsInteractions::m_iFilterOnUsages = 0

protected

Definition at line 12 of file SCR_AnalyticsInteractions.c.

m_iReopenTimes

int SCR_AnalyticsInteractions::m_iReopenTimes = 1

protected

Definition at line 14 of file SCR_AnalyticsInteractions.c.

m_iSearchUsages

int SCR_AnalyticsInteractions::m_iSearchUsages = 0

protected

Definition at line 11 of file SCR_AnalyticsInteractions.c.

m_LastSearchUsage

WorldTimestamp SCR_AnalyticsInteractions::m_LastSearchUsage = null

protected

Definition at line 10 of file SCR_AnalyticsInteractions.c.

m_Sortings

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

protected

Definition at line 8 of file SCR_AnalyticsInteractions.c.

m_Tabs

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

protected

Definition at line 7 of file SCR_AnalyticsInteractions.c.

MIN_DELAY_BETWEEN_SEARCHES_MS

const int SCR_AnalyticsInteractions::MIN_DELAY_BETWEEN_SEARCHES_MS = 100

staticprotected

Definition at line 5 of file SCR_AnalyticsInteractions.c.

---

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

• scripts/Game/DataCollection/ApplicationData/SCR_AnalyticsInteractions.c