Stats: Yes2SDK.stats

← Back to overview

Numeric player statistics: read, set, and atomically increment named counters (matches played, distance travelled, coins earned). Optional. Guard with isSupported().

Available on Yandex today (getStats / setStats / incrementStats). Other platforms report isSupported() === false and every call rejects with FEATURE_NOT_SUPPORTED, so guard your calls with isSupported() to keep one codebase running everywhere.

Methods (Core)

SignatureDescription
getStatsAsync(keys: string[]): Promise<Record<string, number>>Get stats for the given keys.
setStatsAsync(stats: Record<string, number>): Promise<void>Set stats as name → value pairs.
incrementStatsAsync(increments: Record<string, number>): Promise<Record<string, number>>Atomically increment stats by the given deltas; returns the updated values.
isSupported(): booleanWhether stats are supported.

Platform support

MethodPokiGameDistributionCrazyGamesYandexYouTubeJest
getStatsAsyncNoneNoneNoneReadyNoneNone¹
setStatsAsyncNoneNoneNoneReadyNoneNone¹
incrementStatsAsyncNoneNoneNoneReadyNoneNone¹
isSupportedNoneNoneNoneReadyNoneNone

Yandex maps to its native stats API. On every other platform isSupported() returns false. Guard your calls with isSupported().

¹ Jest has no stats API: every call rejects with FEATURE_NOT_SUPPORTED. Keep counters in the data module instead.

Usage

if (Yes2SDK.stats.isSupported()) {
    // Read current stats
    const stats = await Yes2SDK.stats.getStatsAsync(["gamesPlayed", "coins"]);

    // Atomically bump counters; the updated values come back
    const updated = await Yes2SDK.stats.incrementStatsAsync({ gamesPlayed: 1, coins: 50 });
    console.log(`Games played: ${updated.gamesPlayed}`);
}

Defold (Lua)

Map arguments are passed as JSON strings; async results arrive as JSON strings. Decode with json.decode.

SignatureDescription
yes2sdk.stats_get(keys_json, callback)keys_json = JSON array string. callback(self, success, stats_json).
yes2sdk.stats_set(stats_json, callback)stats_json = JSON object string (name → value). callback(self, success, err): err nil on success.
yes2sdk.stats_increment(increments_json, callback)increments_json = JSON object string of deltas. callback(self, success, stats_json): updated values.
yes2sdk.stats_is_supported()Returns true where stats exist (Yandex today).
Get started