services.h

#include <modkit/services.h>41 functions · 10 structs · 12 enums · 25 typedefs · 10 macros

Optional platform game services: identity, achievements, stats, leaderboards, and cloud save.

Enabled with MODKIT_ENABLE_SERVICES. Disabled builds keep the same API and answer MK_ERROR_UNSUPPORTED. One backend runs at a time Steamworks, Game Center, Play Games, a developer-hosted web service, an in-memory fake for tests, or none chosen at runtime, because whether a platform service is actually reachable is not something a build can decide. Query mk_services_capabilities() instead of testing platform macros. The platforms genuinely differ: Game Center has no stats, Steam has no leaderboard time windows and no cloud conflict API, and Play Games stats are write-only. Every entry point whose capability bit is clear returns MK_ERROR_UNSUPPORTED. Asynchronous calls return immediately with an mk_async_request_t and complete on the main thread from mk_services_poll(), which mk_app_run() drives.

Functions

`mk_services_achievement_at`function

mk_result mk_services_achievement_at(uint32_t index, mk_services_achievement *out_info)

Perform the services achievement at operation.

Parameter	Type	Description
`index`	`uint32_t`	Zero-based index.
`out_info`	`mk_services_achievement *`	Receives the info.

Returns MK_SUCCESS or an error result.

`mk_services_achievement_clear`function

mk_result mk_services_achievement_clear(const char *id)

Clear the services achievement.

Parameter	Type	Description
`id`	`const char *`	Value for ID.

Returns MK_SUCCESS or an error result.

`mk_services_achievement_count`function

uint32_t mk_services_achievement_count(void)

Perform the services achievement count operation.

Returns The resulting value.

`mk_services_achievement_get`function

mk_result mk_services_achievement_get(const char *id, mk_services_achievement *out_info)

Get state from the services achievement.

Parameter	Type	Description
`id`	`const char *`	Value for ID.
`out_info`	`mk_services_achievement *`	Receives the info.

Returns MK_SUCCESS or an error result.

`mk_services_achievement_init`function

void mk_services_achievement_init(mk_services_achievement *info)

Initialize the services achievement.

Parameter	Type	Description
`info`	`mk_services_achievement *`	Value for info.

`mk_services_achievement_set_progress`function

mk_result mk_services_achievement_set_progress(const char *id, uint32_t steps, uint32_t total_steps)

Set progress on the services achievement.

Parameter	Type	Description
`id`	`const char *`	Value for ID.
`steps`	`uint32_t`	Value for steps.
`total_steps`	`uint32_t`	Value for total steps.

Returns MK_SUCCESS or an error result.

`mk_services_achievement_unlock`function

mk_result mk_services_achievement_unlock(const char *id)

Perform the services achievement unlock operation.

Parameter	Type	Description
`id`	`const char *`	Value for ID.

Returns MK_SUCCESS or an error result.

`mk_services_auth`function

mk_services_auth_state mk_services_auth(void)

Perform the services auth operation.

Returns The resulting value.

`mk_services_auth_ticket_async`function

mk_result mk_services_auth_ticket_async(const char *audience, mk_services_ticket_fn callback, void *user_data, mk_async_request_t *out_request)

Fetch a token your server can verify with the platform.

Maps to Steam GetAuthTicketForWebApi, Game Center identity verification, and Play requestServerSideAccess.

Parameter	Type	Description
`audience`	`const char *`	Value for audience.
`callback`	`mk_services_ticket_fn`	Completion callback.
`user_data`	`void *`	Caller-provided context.
`out_request`	`mk_async_request_t *`	Receives the request.

Returns MK_SUCCESS or an error result.

`mk_services_backend_kind`function

mk_services_backend mk_services_backend_kind(void)

The backend that actually started.

Returns The resulting value.

`mk_services_backend_name`function

const char * mk_services_backend_name(void)

Stable lowercase name: "steam", "game_center", "play_games", "web", "fake", "none", "disabled".

Returns A borrowed pointer, or NULL when unavailable.

`mk_services_capabilities`function

mk_services_capabilities_t mk_services_capabilities(void)

Perform the services capabilities operation.

Returns The resulting handle or value.

`mk_services_cloud_delete_async`function

mk_result mk_services_cloud_delete_async(const char *slot, mk_services_done_fn callback, void *user_data, mk_async_request_t *out_request)

Perform the services cloud delete async operation.

Parameter	Type	Description
`slot`	`const char *`	Value for slot.
`callback`	`mk_services_done_fn`	Completion callback.
`user_data`	`void *`	Caller-provided context.
`out_request`	`mk_async_request_t *`	Receives the request.

Returns MK_SUCCESS or an error result.

`mk_services_cloud_list_async`function

mk_result mk_services_cloud_list_async(mk_services_list_fn callback, void *user_data, mk_async_request_t *out_request)

Perform the services cloud list async operation.

Parameter	Type	Description
`callback`	`mk_services_list_fn`	Completion callback.
`user_data`	`void *`	Caller-provided context.
`out_request`	`mk_async_request_t *`	Receives the request.

Returns MK_SUCCESS or an error result.

`mk_services_cloud_quota`function

mk_result mk_services_cloud_quota(uint64_t *out_used, uint64_t *out_total)

Perform the services cloud quota operation.

Parameter	Type	Description
`out_used`	`uint64_t *`	Receives the used.
`out_total`	`uint64_t *`	Receives the total.

Returns MK_SUCCESS or an error result.

`mk_services_cloud_read_async`function

mk_result mk_services_cloud_read_async(const char *slot, mk_services_read_fn callback, void *user_data, mk_async_request_t *out_request)

Read async for the services cloud.

Parameter	Type	Description
`slot`	`const char *`	Value for slot.
`callback`	`mk_services_read_fn`	Completion callback.
`user_data`	`void *`	Caller-provided context.
`out_request`	`mk_async_request_t *`	Receives the request.

Returns MK_SUCCESS or an error result.

`mk_services_cloud_write_async`function

mk_result mk_services_cloud_write_async(const char *slot, const mk_services_write_desc *desc, mk_services_done_fn callback, void *user_data, mk_async_request_t *out_request)

Write async for the services cloud.

Parameter	Type	Description
`slot`	`const char *`	Value for slot.
`desc`	`const mk_services_write_desc *`	Configuration descriptor.
`callback`	`mk_services_done_fn`	Completion callback.
`user_data`	`void *`	Caller-provided context.
`out_request`	`mk_async_request_t *`	Receives the request.

Returns MK_SUCCESS or an error result.

`mk_services_desc_init`function

void mk_services_desc_init(mk_services_desc *desc)

Initialize the services desc.

Parameter	Type	Description
`desc`	`mk_services_desc *`	Configuration descriptor.

`mk_services_flush_async`function

mk_result mk_services_flush_async(mk_services_done_fn callback, void *user_data, mk_async_request_t *out_request)

Commit locally-set achievements and stats to the platform.

Every backend needs a commit step (Steam StoreStats, Game Center report), so it is explicit rather than hidden behind each setter.

Parameter	Type	Description
`callback`	`mk_services_done_fn`	Completion callback.
`user_data`	`void *`	Caller-provided context.
`out_request`	`mk_async_request_t *`	Receives the request.

Returns MK_SUCCESS or an error result.

`mk_services_init`function

mk_result mk_services_init(const mk_services_desc *desc)

Select and start a backend.

With MK_SERVICES_BACKEND_AUTO a failed probe falls back rather than failing, so a machine without Steam still initializes with the none backend. An explicit backend that cannot start returns MK_ERROR_UNSUPPORTED.

Parameter	Type	Description
`desc`	`const mk_services_desc *`	Configuration descriptor.

Returns MK_SUCCESS or an error result.

`mk_services_is_initialized`function

bool mk_services_is_initialized(void)

Test whether the services is initialized.

Returns True when the condition holds.

`mk_services_last_error`function

mk_services_error mk_services_last_error(void)

The most recent immediate (non-callback) failure.

Returns The resulting value.

`mk_services_leaderboard_scores_async`function

mk_result mk_services_leaderboard_scores_async(const mk_services_score_query *query, mk_services_scores_fn callback, void *user_data, mk_async_request_t *out_request)

Perform the services leaderboard scores async operation.

Parameter	Type	Description
`query`	`const mk_services_score_query *`	Value for query.
`callback`	`mk_services_scores_fn`	Completion callback.
`user_data`	`void *`	Caller-provided context.
`out_request`	`mk_async_request_t *`	Receives the request.

Returns MK_SUCCESS or an error result.

`mk_services_leaderboard_submit_async`function

mk_result mk_services_leaderboard_submit_async(const mk_services_submit_desc *desc, mk_services_submit_fn callback, void *user_data, mk_async_request_t *out_request)

Submit async for the services leaderboard.

Parameter	Type	Description
`desc`	`const mk_services_submit_desc *`	Configuration descriptor.
`callback`	`mk_services_submit_fn`	Completion callback.
`user_data`	`void *`	Caller-provided context.
`out_request`	`mk_async_request_t *`	Receives the request.

Returns MK_SUCCESS or an error result.

`mk_services_player`function

mk_result mk_services_player(mk_services_player_info *out_info)

Perform the services player operation.

Parameter	Type	Description
`out_info`	`mk_services_player_info *`	Receives the info.

Returns MK_SUCCESS or an error result.

`mk_services_player_info_init`function

void mk_services_player_info_init(mk_services_player_info *info)

Initialize the services player info.

Parameter	Type	Description
`info`	`mk_services_player_info *`	Value for info.

`mk_services_poll`function

uint32_t mk_services_poll(void)

Deliver completed requests.

Called for you from the frame loop; call it directly in headless tools and tests. Returns the number of callbacks run.

Returns The resulting value.

`mk_services_refresh_async`function

mk_result mk_services_refresh_async(mk_services_done_fn callback, void *user_data, mk_async_request_t *out_request)

Re-read achievements and stats from the platform.

Parameter	Type	Description
`callback`	`mk_services_done_fn`	Completion callback.
`user_data`	`void *`	Caller-provided context.
`out_request`	`mk_async_request_t *`	Receives the request.

Returns MK_SUCCESS or an error result.

`mk_services_score_query_init`function

void mk_services_score_query_init(mk_services_score_query *query)

Query init for the services score.

Parameter	Type	Description
`query`	`mk_services_score_query *`	Value for query.

`mk_services_show_ui`function

mk_result mk_services_show_ui(mk_services_ui view, const char *id)

Show a platform overlay.

Parameter	Type	Description
`view`	`mk_services_ui`	Value for view.
`id`	`const char *`	Value for ID.

Returns MK_SUCCESS or an error result.

`mk_services_shutdown`function

void mk_services_shutdown(void)

Perform the services shutdown operation.

`mk_services_sign_in`function

mk_result mk_services_sign_in(void)

Ensure the player is signed in, presenting platform UI if the backend has it.

Returns MK_SUCCESS or an error result.

`mk_services_sign_in_silent`function

mk_result mk_services_sign_in_silent(void)

Returns MK_SUCCESS or an error result.

`mk_services_sign_out`function

mk_result mk_services_sign_out(void)

Perform the services sign out operation.

Returns MK_SUCCESS or an error result.

`mk_services_stat_add_int`function

mk_result mk_services_stat_add_int(const char *id, int64_t delta)

Add int for the services stat.

Parameter	Type	Description
`id`	`const char *`	Value for ID.
`delta`	`int64_t`	Value for delta.

Returns MK_SUCCESS or an error result.

`mk_services_stat_get_float`function

mk_result mk_services_stat_get_float(const char *id, double *out_value)

Get float from the services stat.

Parameter	Type	Description
`id`	`const char *`	Value for ID.
`out_value`	`double *`	Receives the value.

Returns MK_SUCCESS or an error result.

`mk_services_stat_get_int`function

mk_result mk_services_stat_get_int(const char *id, int64_t *out_value)

Get int from the services stat.

Parameter	Type	Description
`id`	`const char *`	Value for ID.
`out_value`	`int64_t *`	Receives the value.

Returns MK_SUCCESS or an error result.

`mk_services_stat_set_float`function

mk_result mk_services_stat_set_float(const char *id, double value)

Set float on the services stat.

Parameter	Type	Description
`id`	`const char *`	Value for ID.
`value`	`double`	Value to use.

Returns MK_SUCCESS or an error result.

`mk_services_stat_set_int`function

mk_result mk_services_stat_set_int(const char *id, int64_t value)

Set int on the services stat.

Parameter	Type	Description
`id`	`const char *`	Value for ID.
`value`	`int64_t`	Value to use.

Returns MK_SUCCESS or an error result.

`mk_services_submit_desc_init`function

void mk_services_submit_desc_init(mk_services_submit_desc *desc)

Submit desc init for the services.

Parameter	Type	Description
`desc`	`mk_services_submit_desc *`	Configuration descriptor.

`mk_services_write_desc_init`function

void mk_services_write_desc_init(mk_services_write_desc *desc)

Write desc init for the services.

Parameter	Type	Description
`desc`	`mk_services_write_desc *`	Configuration descriptor.

Structs

`mk_services_achievement`struct

Data for services achievement.

Field	Type	Description
`struct_size`	`uint32_t`	The struct size.
`struct_version`	`uint32_t`	The struct version.
`available`	`uint32_t`	The available.
`id`	`char`	Logical id.
`name`	`char`	The name.
`description`	`char`	The description.
`unlocked`	`bool`	The unlocked.
`hidden`	`bool`	The hidden.
`steps`	`uint32_t`	Current progress; zero when unsupported.
`total_steps`	`uint32_t`	Zero for a binary achievement.
`unlock_time`	`uint64_t`	Unix seconds, or zero if unknown.

`mk_services_desc`struct

Data for services desc.

Field	Type	Description
`struct_size`	`uint32_t`	The struct size.
`struct_version`	`uint32_t`	The struct version.
`preferred_backend`	`mk_services_backend`	AUTO probes; anything else must succeed.
`steam_app_id`	`uint32_t`	Zero uses steam_appid.txt or the launch env.
`auto_sign_in`	`bool`	Attempt a silent sign-in during init.
`web_base_url`	`const char *`	Endpoint for the web backend.
`achievement_ids`	`const mk_services_id_map *`	The achievement IDs.
`achievement_id_count`	`uint32_t`	The achievement ID count.
`stat_ids`	`const mk_services_id_map *`	The stat IDs.
`stat_id_count`	`uint32_t`	The stat ID count.
`leaderboard_ids`	`const mk_services_id_map *`	The leaderboard IDs.
`leaderboard_id_count`	`uint32_t`	The leaderboard ID count.
`auth_changed`	`mk_services_auth_changed_fn`	The auth changed.
`auth_changed_user_data`	`void *`	The auth changed user data.
`fake_latency_ms`	`uint32_t`	FAKE backend only; delays completions to expose ordering bugs.

`mk_services_error`struct

Detail carried alongside mk_result on every completion.

Field	Type	Description
`code`	`mk_services_error_code`	The code.
`platform_code`	`int32_t`	Backend error value, or zero if unavailable.
`message`	`char`	Null-terminated diagnostic text.

`mk_services_id_map`struct

Maps an id the game uses to the id a store uses.

The same achievement is "ACH_WIN" on Steam, "grp.win" on Game Center, and an opaque string on Play. Supply the mapping once at init and use the logical id everywhere else. An id with no mapping is passed through unchanged.

Field	Type	Description
`logical_id`	`const char *`	The logical ID.
`platform_id`	`const char *`	The platform ID.

`mk_services_player_info`struct

Data for services player info.

Field	Type	Description
`struct_size`	`uint32_t`	The struct size.
`struct_version`	`uint32_t`	The struct version.
`available`	`uint32_t`	mk_services_player_field bits.
`id`	`char`	The ID.
`display_name`	`char`	The display name.
`country`	`char`	The country.
`language`	`char`	The language.

`mk_services_score`struct

Data for services score.

Field	Type	Description
`struct_size`	`uint32_t`	The struct size.
`struct_version`	`uint32_t`	The struct version.
`available`	`uint32_t`	The available.
`player_id`	`char`	The player ID.
`display_name`	`char`	The display name.
`score`	`int64_t`	The score.
`rank`	`uint32_t`	One-based; zero if unknown.
`timestamp`	`uint64_t`	Unix seconds.

`mk_services_score_query`struct

Data for services score query.

Field	Type	Description
`struct_size`	`uint32_t`	The struct size.
`struct_version`	`uint32_t`	The struct version.
`id`	`const char *`	Logical leaderboard id.
`scope`	`mk_services_score_scope`	The scope.
`window`	`mk_services_score_window`	The window.
`start_rank`	`uint32_t`	One-based; ignored for AROUND_PLAYER.
`max_entries`	`uint32_t`	Backends clamp this.

`mk_services_slot`struct

Data for services slot.

Field	Type	Description
`struct_size`	`uint32_t`	The struct size.
`struct_version`	`uint32_t`	The struct version.
`available`	`uint32_t`	The available.
`name`	`char`	The name.
`size`	`uint64_t`	The size.
`modified_time`	`uint64_t`	Unix seconds.
`description`	`char`	Play Snapshots only.
`has_conflict`	`bool`	The has conflict.

`mk_services_submit_desc`struct

Data for services submit desc.

Field	Type	Description
`struct_size`	`uint32_t`	The struct size.
`struct_version`	`uint32_t`	The struct version.
`id`	`const char *`	The ID.
`score`	`int64_t`	The score.
`window`	`mk_services_score_window`	The window.
`policy`	`mk_services_submit_policy`	The policy.

`mk_services_write_desc`struct

Data for services write desc.

Field	Type	Description
`struct_size`	`uint32_t`	The struct size.
`struct_version`	`uint32_t`	The struct version.
`data`	`const void *`	The data.
`size`	`size_t`	The size.
`description`	`const char *`	Play Snapshots only; ignored elsewhere.
`expected_modified_time`	`uint64_t`	The modified_time the app last saw for this slot, or zero to write unconditionally.

Enums

`mk_services_achievement_field`enum

Which mk_services_achievement fields the backend filled in.

Value	Description
`MK_SERVICES_ACHIEVEMENT_NAME`	Selects name.
`MK_SERVICES_ACHIEVEMENT_DESCRIPTION`	Selects description.
`MK_SERVICES_ACHIEVEMENT_HIDDEN`	Selects hidden.
`MK_SERVICES_ACHIEVEMENT_PROGRESS`	Selects progress.
`MK_SERVICES_ACHIEVEMENT_UNLOCK_TIME`	Selects unlock time.

`mk_services_auth_state`enum

Sign-in state.

Mirrors the audio capture-permission shape.

Value	Description
`MK_SERVICES_AUTH_UNKNOWN`	Selects unknown.
`MK_SERVICES_AUTH_PENDING`	Selects pending.
`MK_SERVICES_AUTH_SIGNED_IN`	Selects signed in.
`MK_SERVICES_AUTH_SIGNED_OUT`	Selects signed out.
`MK_SERVICES_AUTH_UNAVAILABLE`	Selects unavailable.

`mk_services_backend`enum

Which implementation is (or should be) running.

Value	Description
`MK_SERVICES_BACKEND_AUTO`	Probe the platform, then web, then none.
`MK_SERVICES_BACKEND_NONE`	Everything reports unsupported.
`MK_SERVICES_BACKEND_FAKE`	In-memory; for tests and offline development.
`MK_SERVICES_BACKEND_STEAM`	Selects steam.
`MK_SERVICES_BACKEND_GAME_CENTER`	Selects game center.
`MK_SERVICES_BACKEND_PLAY_GAMES`	Selects play games.
`MK_SERVICES_BACKEND_WEB`	Selects web.

`mk_services_capability`enum

Runtime capability bits for the selected backend.

Value	Description
`MK_SERVICES_CAP_IDENTITY`	Local player is readable.
`MK_SERVICES_CAP_SIGN_IN_INTERACTIVE`	Sign-in may present platform UI.
`MK_SERVICES_CAP_SIGN_OUT`	Selects sign out.
`MK_SERVICES_CAP_AUTH_TICKET`	Server-verifiable identity token.
`MK_SERVICES_CAP_ACHIEVEMENTS`	Selects achievements.
`MK_SERVICES_CAP_ACHIEVEMENT_PROGRESS`	Selects achievement progress.
`MK_SERVICES_CAP_ACHIEVEMENT_METADATA`	Names/descriptions readable.
`MK_SERVICES_CAP_ACHIEVEMENT_RESET`	Selects achievement reset.
`MK_SERVICES_CAP_STATS`	Selects stats.
`MK_SERVICES_CAP_STATS_FLOAT`	Selects stats float.
`MK_SERVICES_CAP_STATS_READ`	Clear on write-only backends.
`MK_SERVICES_CAP_LEADERBOARDS`	Selects leaderboards.
`MK_SERVICES_CAP_LEADERBOARD_FRIENDS`	Selects leaderboard friends.
`MK_SERVICES_CAP_LEADERBOARD_WINDOWS`	Daily/weekly scopes.
`MK_SERVICES_CAP_CLOUD_SAVE`	Selects cloud save.
`MK_SERVICES_CAP_CLOUD_LIST`	Selects cloud list.
`MK_SERVICES_CAP_CLOUD_CONFLICTS`	Clear on Steam.
`MK_SERVICES_CAP_CLOUD_QUOTA`	Selects cloud quota.
`MK_SERVICES_CAP_NATIVE_UI`	Overlay / Game Center UI.

`mk_services_error_code`enum

Portable category for the most recent services failure.

Value	Description
`MK_SERVICES_ERROR_NONE`	Selects none.
`MK_SERVICES_ERROR_UNSUPPORTED`	Capability bit is clear on this backend.
`MK_SERVICES_ERROR_NOT_SIGNED_IN`	Selects not signed in.
`MK_SERVICES_ERROR_SIGN_IN_CANCELLED`	Selects sign in cancelled.
`MK_SERVICES_ERROR_NETWORK`	Selects network.
`MK_SERVICES_ERROR_TIMEOUT`	Selects timeout.
`MK_SERVICES_ERROR_RATE_LIMITED`	Selects rate limited.
`MK_SERVICES_ERROR_NOT_FOUND`	Unknown achievement, leaderboard, or slot.
`MK_SERVICES_ERROR_CONFLICT`	Cloud slot diverged; resolve it.
`MK_SERVICES_ERROR_QUOTA`	Selects quota.
`MK_SERVICES_ERROR_PERMISSION`	Underage, parental, or privacy restriction.
`MK_SERVICES_ERROR_BACKEND_MISSING`	Platform library or service unavailable.
`MK_SERVICES_ERROR_PLATFORM`	Native failure; see platform_code.

`mk_services_player_field`enum

Which mk_services_player_info fields the backend filled in.

Value	Description
`MK_SERVICES_PLAYER_ID`	Selects ID.
`MK_SERVICES_PLAYER_DISPLAY_NAME`	Selects display name.
`MK_SERVICES_PLAYER_COUNTRY`	Selects country.
`MK_SERVICES_PLAYER_LANGUAGE`	Selects language.

`mk_services_score_field`enum

Which mk_services_score fields the backend filled in.

Value	Description
`MK_SERVICES_SCORE_PLAYER_ID`	Selects player ID.
`MK_SERVICES_SCORE_DISPLAY_NAME`	Selects display name.
`MK_SERVICES_SCORE_RANK`	Selects rank.
`MK_SERVICES_SCORE_TIMESTAMP`	Selects timestamp.

`mk_services_score_scope`enum

Values for services score scope.

Value	Description
`MK_SERVICES_SCOPE_GLOBAL`	Selects global.
`MK_SERVICES_SCOPE_FRIENDS`	Selects friends.
`MK_SERVICES_SCOPE_AROUND_PLAYER`	Selects around player.

`mk_services_score_window`enum

Values for services score window.

Value	Description
`MK_SERVICES_WINDOW_ALL_TIME`	Selects all time.
`MK_SERVICES_WINDOW_WEEKLY`	Selects weekly.
`MK_SERVICES_WINDOW_DAILY`	Selects daily.

`mk_services_slot_field`enum

Which mk_services_slot fields the backend filled in.

Value	Description
`MK_SERVICES_SLOT_SIZE`	Selects size.
`MK_SERVICES_SLOT_MODIFIED_TIME`	Selects modified time.
`MK_SERVICES_SLOT_DESCRIPTION`	Selects description.
`MK_SERVICES_SLOT_CONFLICT`	Selects conflict.

`mk_services_submit_policy`enum

Values for services submit policy.

Value	Description
`MK_SERVICES_SUBMIT_KEEP_BEST`	Selects keep best.
`MK_SERVICES_SUBMIT_OVERWRITE`	Selects overwrite.

`mk_services_ui`enum

Values for services UI.

Value	Description
`MK_SERVICES_UI_ACHIEVEMENTS`	Selects achievements.
`MK_SERVICES_UI_LEADERBOARD`	Selects leaderboard.
`MK_SERVICES_UI_PLAYER_PROFILE`	Selects player profile.
`MK_SERVICES_UI_FRIENDS`	Selects friends.

Typedefs

`mk_services_achievement`typedef

typedef struct mk_services_achievement mk_services_achievement

Data for services achievement.

`mk_services_auth_changed_fn`typedef

typedef void(*) mk_services_auth_changed_fn(mk_services_auth_state state, void *user_data)

Sign-in state changed.

Invoked from mk_services_poll(). Not optional polish: Game Center can sign the player out mid-session.

`mk_services_auth_state`typedef

typedef enum mk_services_auth_state mk_services_auth_state

Sign-in state.

Mirrors the audio capture-permission shape.

`mk_services_backend`typedef

typedef enum mk_services_backend mk_services_backend

Which implementation is (or should be) running.

`mk_services_capabilities_t`typedef

typedef uint64_t mk_services_capabilities_t

Bitmask returned by mk_services_capabilities().

`mk_services_desc`typedef

typedef struct mk_services_desc mk_services_desc

Data for services desc.

`mk_services_done_fn`typedef

typedef void(*) mk_services_done_fn(mk_async_request_t request, mk_result result, const mk_services_error *error, void *user_data)

Completion with no payload.

error is NULL on success.

`mk_services_error`typedef

typedef struct mk_services_error mk_services_error

Detail carried alongside mk_result on every completion.

`mk_services_error_code`typedef

typedef enum mk_services_error_code mk_services_error_code

Portable category for the most recent services failure.

`mk_services_id_map`typedef

typedef struct mk_services_id_map mk_services_id_map

Maps an id the game uses to the id a store uses.

`mk_services_list_fn`typedef

typedef void(*) mk_services_list_fn(mk_async_request_t request, mk_result result, const mk_services_error *error, const mk_services_slot *slots, uint32_t count, void *user_data)

Slot listing.

slots is valid for the duration of the callback only.

`mk_services_player_info`typedef

typedef struct mk_services_player_info mk_services_player_info

Data for services player info.

`mk_services_read_fn`typedef

typedef void(*) mk_services_read_fn(mk_async_request_t request, mk_result result, const mk_services_error *error, const char *slot, const void *data, size_t size, void *user_data)

Slot contents.

data is valid for the duration of the callback only.

`mk_services_score`typedef

typedef struct mk_services_score mk_services_score

Data for services score.

`mk_services_score_query`typedef

typedef struct mk_services_score_query mk_services_score_query

Data for services score query.

`mk_services_score_scope`typedef

typedef enum mk_services_score_scope mk_services_score_scope

Values for services score scope.

`mk_services_score_window`typedef

typedef enum mk_services_score_window mk_services_score_window

Values for services score window.

`mk_services_scores_fn`typedef

typedef void(*) mk_services_scores_fn(mk_async_request_t request, mk_result result, const mk_services_error *error, const mk_services_score *scores, uint32_t count, void *user_data)

Score list.

scores is valid for the duration of the callback only.

`mk_services_slot`typedef

typedef struct mk_services_slot mk_services_slot

Data for services slot.

`mk_services_submit_desc`typedef

typedef struct mk_services_submit_desc mk_services_submit_desc

Data for services submit desc.

`mk_services_submit_fn`typedef

typedef void(*) mk_services_submit_fn(mk_async_request_t request, mk_result result, const mk_services_error *error, const mk_services_score *score, bool changed, void *user_data)

Submit result.

changed is false when a keep-best policy rejected the score.

`mk_services_submit_policy`typedef

typedef enum mk_services_submit_policy mk_services_submit_policy

Values for services submit policy.

`mk_services_ticket_fn`typedef

typedef void(*) mk_services_ticket_fn(mk_async_request_t request, mk_result result, const mk_services_error *error, const void *ticket, size_t size, void *user_data)

Completion for mk_services_auth_ticket_async().

Bytes are valid for the call only.

`mk_services_ui`typedef

typedef enum mk_services_ui mk_services_ui

Values for services UI.

`mk_services_write_desc`typedef

typedef struct mk_services_write_desc mk_services_write_desc

Data for services write desc.

Macros

`MK_SERVICES_ACHIEVEMENT_VERSION`define

MK_SERVICES_ACHIEVEMENT_VERSION

ABI or format version for services achievement.

`MK_SERVICES_DESC_VERSION`define

MK_SERVICES_DESC_VERSION

ABI or format version for services desc.

`MK_SERVICES_MAX_ID`define

MK_SERVICES_MAX_ID

Maximum supported services ID.

`MK_SERVICES_MAX_NAME`define

MK_SERVICES_MAX_NAME

Maximum supported services name.

`MK_SERVICES_PLAYER_INFO_VERSION`define

MK_SERVICES_PLAYER_INFO_VERSION

ABI or format version for services player info.

`MK_SERVICES_QUERY_VERSION`define

MK_SERVICES_QUERY_VERSION

ABI or format version for services query.

`MK_SERVICES_SCORE_VERSION`define

MK_SERVICES_SCORE_VERSION

ABI or format version for services score.

`MK_SERVICES_SLOT_VERSION`define

MK_SERVICES_SLOT_VERSION

ABI or format version for services slot.

`MK_SERVICES_SUBMIT_VERSION`define

MK_SERVICES_SUBMIT_VERSION

ABI or format version for services submit.

`MK_SERVICES_WRITE_VERSION`define

MK_SERVICES_WRITE_VERSION

ABI or format version for services write.

services.h

Functions

mk_services_achievement_atfunction

mk_services_achievement_clearfunction

mk_services_achievement_countfunction

mk_services_achievement_getfunction

mk_services_achievement_initfunction

mk_services_achievement_set_progressfunction

mk_services_achievement_unlockfunction

mk_services_authfunction

mk_services_auth_ticket_asyncfunction

mk_services_backend_kindfunction

mk_services_backend_namefunction

mk_services_capabilitiesfunction

mk_services_cloud_delete_asyncfunction

mk_services_cloud_list_asyncfunction

mk_services_cloud_quotafunction

mk_services_cloud_read_asyncfunction

mk_services_cloud_write_asyncfunction

mk_services_desc_initfunction

mk_services_flush_asyncfunction

mk_services_initfunction

mk_services_is_initializedfunction

mk_services_last_errorfunction

mk_services_leaderboard_scores_asyncfunction

mk_services_leaderboard_submit_asyncfunction

mk_services_playerfunction

mk_services_player_info_initfunction

mk_services_pollfunction

mk_services_refresh_asyncfunction

mk_services_score_query_initfunction

mk_services_show_uifunction

mk_services_shutdownfunction

mk_services_sign_infunction

mk_services_sign_in_silentfunction

mk_services_sign_outfunction

mk_services_stat_add_intfunction

mk_services_stat_get_floatfunction

mk_services_stat_get_intfunction

mk_services_stat_set_floatfunction

mk_services_stat_set_intfunction

mk_services_submit_desc_initfunction

mk_services_write_desc_initfunction

Structs

mk_services_achievementstruct

mk_services_descstruct

mk_services_errorstruct

mk_services_id_mapstruct

mk_services_player_infostruct

mk_services_scorestruct

mk_services_score_querystruct

mk_services_slotstruct

mk_services_submit_descstruct

mk_services_write_descstruct

Enums

mk_services_achievement_fieldenum

mk_services_auth_stateenum

mk_services_backendenum

mk_services_capabilityenum

mk_services_error_codeenum

mk_services_player_fieldenum

mk_services_score_fieldenum

mk_services_score_scopeenum

mk_services_score_windowenum

mk_services_slot_fieldenum

mk_services_submit_policyenum

mk_services_uienum

Typedefs

mk_services_achievementtypedef

mk_services_auth_changed_fntypedef

mk_services_auth_statetypedef

mk_services_backendtypedef

mk_services_capabilities_ttypedef

mk_services_desctypedef

mk_services_done_fntypedef

mk_services_errortypedef

mk_services_error_codetypedef

mk_services_id_maptypedef

mk_services_list_fntypedef

mk_services_player_infotypedef

`mk_services_achievement_at`function

`mk_services_achievement_clear`function

`mk_services_achievement_count`function

`mk_services_achievement_get`function

`mk_services_achievement_init`function

`mk_services_achievement_set_progress`function

`mk_services_achievement_unlock`function

`mk_services_auth`function

`mk_services_auth_ticket_async`function

`mk_services_backend_kind`function

`mk_services_backend_name`function

`mk_services_capabilities`function

`mk_services_cloud_delete_async`function

`mk_services_cloud_list_async`function

`mk_services_cloud_quota`function

`mk_services_cloud_read_async`function

`mk_services_cloud_write_async`function

`mk_services_desc_init`function

`mk_services_flush_async`function

`mk_services_init`function

`mk_services_is_initialized`function

`mk_services_last_error`function

`mk_services_leaderboard_scores_async`function

`mk_services_leaderboard_submit_async`function

`mk_services_player`function

`mk_services_player_info_init`function

`mk_services_poll`function

`mk_services_refresh_async`function

`mk_services_score_query_init`function

`mk_services_show_ui`function

`mk_services_shutdown`function

`mk_services_sign_in`function

`mk_services_sign_in_silent`function

`mk_services_sign_out`function

`mk_services_stat_add_int`function

`mk_services_stat_get_float`function

`mk_services_stat_get_int`function

`mk_services_stat_set_float`function

`mk_services_stat_set_int`function

`mk_services_submit_desc_init`function

`mk_services_write_desc_init`function

`mk_services_achievement`struct

`mk_services_desc`struct

`mk_services_error`struct

`mk_services_id_map`struct

`mk_services_player_info`struct

`mk_services_score`struct

`mk_services_score_query`struct

`mk_services_slot`struct

`mk_services_submit_desc`struct

`mk_services_write_desc`struct

`mk_services_achievement_field`enum

`mk_services_auth_state`enum

`mk_services_backend`enum

`mk_services_capability`enum

`mk_services_error_code`enum

`mk_services_player_field`enum

`mk_services_score_field`enum

`mk_services_score_scope`enum

`mk_services_score_window`enum

`mk_services_slot_field`enum

`mk_services_submit_policy`enum

`mk_services_ui`enum

`mk_services_achievement`typedef

`mk_services_auth_changed_fn`typedef

`mk_services_auth_state`typedef

`mk_services_backend`typedef

`mk_services_capabilities_t`typedef

`mk_services_desc`typedef

`mk_services_done_fn`typedef

`mk_services_error`typedef

`mk_services_error_code`typedef

`mk_services_id_map`typedef

`mk_services_list_fn`typedef

`mk_services_player_info`typedef

`mk_services_read_fn`typedef

`mk_services_score`typedef

`mk_services_score_query`typedef

`mk_services_score_scope`typedef

`mk_services_score_window`typedef