AnalyticsKit

Data Structures
struct	PleyCurrency
struct	PleyATKConfig
struct	PleyVariant
struct	PleyAnalyticsParameter
struct	PleyATKScene
struct	PleyAnalyticsKit

Typedefs
typedef int32_t	PleyCurrencyType
typedef struct PleyCurrency	PleyCurrency
typedef struct PleyATKConfig	PleyATKConfig
typedef int32_t	PleyVariantType
typedef struct PleyVariant	PleyVariant
typedef struct PleyAnalyticsParameter	PleyAnalyticsParameter
typedef struct PleyATKScene	PleyATKScene
typedef void(*	PleyATKGetUserPropertyCB) (PleyResult result, const char *name, const PleyVariant *variant, void *callback_data)
typedef struct PleyAnalyticsKit	PleyAnalyticsKit

Enumerations
enum	{ PLEY_CURRENCY_TYPE_NORMAL = 0 , PLEY_CURRENCY_TYPE_PREMIUM = 1 }
enum	{   PLEY_VARIANT_TYPE_INT = 0 , PLEY_VARIANT_TYPE_LONG = 1 , PLEY_VARIANT_TYPE_FLOAT = 2 , PLEY_VARIANT_TYPE_DOUBLE = 3 ,   PLEY_VARIANT_TYPE_STRING = 4 , PLEY_VARIANT_TYPE_BOOL = 5 }

Detailed Description

---

Data Structure Documentation

PleyCurrency

struct PleyCurrency

Data Fields
int32_t	amount
const char *	name
PleyCurrencyType	type

PleyATKConfig

struct PleyATKConfig

Data Fields
const char *	application_version
bool	cross_platform_user
const PleyCurrency *	currencies
int32_t	currencies_len
int32_t	current_level
const char *	custom_user_id
const char *	username

PleyVariant

struct PleyVariant

Data Fields
PleyVariantType	type
void *	value

PleyAnalyticsParameter

struct PleyAnalyticsParameter

Data Fields
const char *	name
PleyVariant	variant

PleyATKScene

struct PleyATKScene

Data Fields
char	id[256]
char	name[256]

PleyAnalyticsKit

struct PleyAnalyticsKit

Data Fields
PleyResult(*	initialize_analytics )(const PleyATKConfig *config)
PleyResult(*	is_analytics_initialized )(bool *is_initialized)
PleyResult(*	game_loaded )()
PleyResult(*	user_interacted )()
PleyResult(*	user_engaged )()
PleyResult(*	scene_changed )(const PleyATKScene *new_scene)
PleyResult(*	tutorial_started )()
PleyResult(*	tutorial_advanced )(const char *step)
PleyResult(*	tutorial_completed )()
PleyResult(*	tutorial_skipped )()
PleyResult(*	level_advanced )(const int32_t level)
PleyResult(*	currency_spent )(const char *name, const int32_t amount, PleyCurrencyType type, const int32_t *new_balance, const char *source)
PleyResult(*	currency_gained )(const char *name, const int32_t amount, PleyCurrencyType type, const int32_t *new_balance, const char *source)
PleyResult(*	store_opened )()
PleyResult(*	offer_shown )(const char *offer)
PleyResult(*	loading_start )()
PleyResult(*	loading_stop )()
PleyResult(*	gameplay_start )()
PleyResult(*	gameplay_stop )()
PleyResult(*	custom_event )(const char *name, PleyAnalyticsParameter *parameters, int32_t parameters_len)
PleyResult(*	set_user_property )(const char *name, const PleyVariant *variant)
PleyResult(*	remove_user_property )(const char *name)
PleyResult(*	clear_all_user_properties )()

Field Documentation

clear_all_user_properties

PleyResult(* PleyAnalyticsKit::clear_all_user_properties) ()

currency_gained

PleyResult(* PleyAnalyticsKit::currency_gained) (const char *name, const int32_t amount, PleyCurrencyType type, const int32_t *new_balance, const char *source)

currency_spent

PleyResult(* PleyAnalyticsKit::currency_spent) (const char *name, const int32_t amount, PleyCurrencyType type, const int32_t *new_balance, const char *source)

custom_event

PleyResult(* PleyAnalyticsKit::custom_event) (const char *name, PleyAnalyticsParameter *parameters, int32_t parameters_len)

Returns

Can return the following error: PLEY_RESULT_INVALID_ARGUMENTS

game_loaded

PleyResult(* PleyAnalyticsKit::game_loaded) ()

Returns

Can return the following error: PLEY_RESULT_ATK_EVENT_ALREADY_REPORTED

gameplay_start

PleyResult(* PleyAnalyticsKit::gameplay_start) ()

gameplay_stop

PleyResult(* PleyAnalyticsKit::gameplay_stop) ()

initialize_analytics

PleyResult(* PleyAnalyticsKit::initialize_analytics) (const PleyATKConfig *config)

Returns

Can return the following error: PLEY_RESULT_ATK_ALREADY_INITIALIZED,

is_analytics_initialized

PleyResult(* PleyAnalyticsKit::is_analytics_initialized) (bool *is_initialized)

level_advanced

PleyResult(* PleyAnalyticsKit::level_advanced) (const int32_t level)

loading_start

PleyResult(* PleyAnalyticsKit::loading_start) ()

loading_stop

PleyResult(* PleyAnalyticsKit::loading_stop) ()

offer_shown

PleyResult(* PleyAnalyticsKit::offer_shown) (const char *offer)

remove_user_property

PleyResult(* PleyAnalyticsKit::remove_user_property) (const char *name)

Returns

Can return the following error: PLEY_RESULT_INVALID_ARGUMENTS

scene_changed

PleyResult(* PleyAnalyticsKit::scene_changed) (const PleyATKScene *new_scene)

set_user_property

PleyResult(* PleyAnalyticsKit::set_user_property) (const char *name, const PleyVariant *variant)

Returns

Can return the following error: PLEY_RESULT_INVALID_ARGUMENTS

store_opened

PleyResult(* PleyAnalyticsKit::store_opened) ()

tutorial_advanced

PleyResult(* PleyAnalyticsKit::tutorial_advanced) (const char *step)

tutorial_completed

PleyResult(* PleyAnalyticsKit::tutorial_completed) ()

Returns

Can return the following error: PLEY_RESULT_ATK_EVENT_ALREADY_REPORTED

tutorial_skipped

PleyResult(* PleyAnalyticsKit::tutorial_skipped) ()

Returns

Can return the following error: PLEY_RESULT_ATK_EVENT_ALREADY_REPORTED

tutorial_started

PleyResult(* PleyAnalyticsKit::tutorial_started) ()

user_engaged

PleyResult(* PleyAnalyticsKit::user_engaged) ()

Returns

Can return the following error: PLEY_RESULT_ATK_EVENT_ALREADY_REPORTED

user_interacted

PleyResult(* PleyAnalyticsKit::user_interacted) ()

Returns

Can return the following error: PLEY_RESULT_ATK_EVENT_ALREADY_REPORTED

Typedef Documentation

PleyAnalyticsKit

typedef struct PleyAnalyticsKit PleyAnalyticsKit

PleyAnalyticsParameter

typedef struct PleyAnalyticsParameter PleyAnalyticsParameter

PleyATKConfig

typedef struct PleyATKConfig PleyATKConfig

PleyATKGetUserPropertyCB

typedef void(* PleyATKGetUserPropertyCB) (PleyResult result, const char *name, const PleyVariant *variant, void *callback_data)

PleyATKScene

typedef struct PleyATKScene PleyATKScene

PleyCurrency

typedef struct PleyCurrency PleyCurrency

PleyCurrencyType

typedef int32_t PleyCurrencyType

PleyVariant

typedef struct PleyVariant PleyVariant

PleyVariantType

typedef int32_t PleyVariantType

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
PLEY_CURRENCY_TYPE_NORMAL
PLEY_CURRENCY_TYPE_PREMIUM

anonymous enum

anonymous enum

Enumerator
PLEY_VARIANT_TYPE_INT
PLEY_VARIANT_TYPE_LONG
PLEY_VARIANT_TYPE_FLOAT
PLEY_VARIANT_TYPE_DOUBLE
PLEY_VARIANT_TYPE_STRING
PLEY_VARIANT_TYPE_BOOL