GitHub repository
On this page

indiesoftby/defold-yagames/yagames.yagames

YaGames is the Yandex.Games SDK implementation for the Defold game engine.

  • GitHub: indiesoftby/defold-yagames — pinned to 2fe3aed
    1. Pick a release from indiesoftby/defold-yagames releases and add its Source code (zip) URL (or a packaged .zip asset, if the library ships one) to game.project under [project] dependencies, then Fetch Libraries in the Defold editor.
    2. Run bunx @defold-typescript/cli resolve to materialize its types.
    3. Import it under a namespace alias of your choice:
      import * as yagames from "yagames.yagames"

Functions

init(callback: ApiCallback)

Parameters

  • callback: ApiCallback

adv_show_fullscreen_adv(callbacks: AdvCallbacks)

Parameters

  • callbacks: AdvCallbacks

adv_show_rewarded_video(callbacks: RewardedCallbacks)

Parameters

  • callbacks: RewardedCallbacks

auth_open_auth_dialog(callback: ApiCallback)

Parameters

  • callback: ApiCallback

player_init(options: PlayerInitOptions, callback: ApiCallback)

Parameters

  • options: PlayerInitOptions
  • callback: ApiCallback

player_set_data(data: Record<string, unknown>, flush: boolean, callback: ApiCallback)

Parameters

  • data: Record<string, unknown>
  • flush: boolean
  • callback: ApiCallback

player_get_data(keys: Array<string> | undefined, callback: ApiCallback)

Parameters

  • keys: Array<string> | undefined
  • callback: ApiCallback

player_set_stats(stats: Record<string, number>, callback: ApiCallback)

Parameters

  • stats: Record<string, number>
  • callback: ApiCallback

player_increment_stats(stats: Record<string, number>, callback: ApiCallback)

Parameters

  • stats: Record<string, number>
  • callback: ApiCallback

player_get_stats(keys: Array<string> | undefined, callback: ApiCallback)

Parameters

  • keys: Array<string> | undefined
  • callback: ApiCallback

player_get_id(): string

Returns

  • string

player_get_unique_id(): string

Returns

  • string

player_get_name(): string

Returns

  • string

player_get_ids_per_game(callback: PlayerGetIdsCallback)

Parameters

  • callback: PlayerGetIdsCallback

player_get_photo(size: 'small' | 'medium' | 'large'): string

Parameters

  • size: 'small' | 'medium' | 'large'

Returns

  • string

payments_init(options: { signed?: boolean; } | undefined, callback: ApiCallback)

Parameters

  • options: { signed?: boolean; } | undefined
  • callback: ApiCallback

payments_purchase(options: PaymentsPurchaseOptions | undefined, callback: PaymentsPurchaseCallback)

Parameters

  • options: PaymentsPurchaseOptions | undefined
  • callback: PaymentsPurchaseCallback

payments_get_purchases(callback: PaymentsPurchasesCallback)

Parameters

  • callback: PaymentsPurchasesCallback

payments_get_catalog(callback: PaymentsCatalogCallback)

Parameters

  • callback: PaymentsCatalogCallback

payments_consume_purchase(purchase_token: string, callback: ApiCallback)

Parameters

  • purchase_token: string
  • callback: ApiCallback

leaderboards_init(callback: ApiCallback)

Parameters

  • callback: ApiCallback

leaderboards_get_description(leaderboard_name: string, callback: LeaderboardsDescriptionCallback)

Parameters

  • leaderboard_name: string
  • callback: LeaderboardsDescriptionCallback

leaderboards_get_player_entry(leaderboard_name: string, options: LeaderboardsGetPlayerEntryOptions | undefined, callback: ApiCallback)

Parameters

  • leaderboard_name: string
  • options: LeaderboardsGetPlayerEntryOptions | undefined
  • callback: ApiCallback

leaderboards_get_entries(leaderboard_name: string, options: LeaderboardsGetEntriesOptions | undefined, callback: LeaderboardsGetPlayerEntriesCallback)

Parameters

  • leaderboard_name: string
  • options: LeaderboardsGetEntriesOptions | undefined
  • callback: LeaderboardsGetPlayerEntriesCallback

leaderboards_set_score(leaderboard_name: string, score: number, extra_data: string, callback: ApiCallback)

Parameters

  • leaderboard_name: string
  • score: number
  • extra_data: string
  • callback: ApiCallback

feedback_can_review(callback: FeedbackCanReviewCallback)

Parameters

  • callback: FeedbackCanReviewCallback

feedback_request_review(callback: FeedbackCanReviewCallback)

Parameters

  • callback: FeedbackCanReviewCallback

clipboard_write_text(text: string, callback?: ApiCallback)

Parameters

  • text: string
  • callback?: ApiCallback

device_info_type(): "desktop" | "mobile" | "tablet"

Returns

  • "desktop" | "mobile" | "tablet"

device_info_is_desktop(): boolean

Returns

  • boolean

device_info_is_mobile(): boolean

Returns

  • boolean

device_info_is_tablet(): boolean

Returns

  • boolean

environment(): EnvironmentResults

Returns

  • EnvironmentResults

screen_fullscreen_status(): "on" | "off"

Returns

  • "on" | "off"

screen_fullscreen_request(callback?: ApiCallback)

Parameters

  • callback?: ApiCallback

screen_fullscreen_exit(callback?: ApiCallback)

Parameters

  • callback?: ApiCallback

storage_init(callback: ApiCallback)

Parameters

  • callback: ApiCallback

storage_get_item(key: string): string | undefined

Parameters

  • key: string

Returns

  • string | undefined

storage_set_item(key: string, value: string)

Parameters

  • key: string
  • value: string

storage_remove_item(key: string)

Parameters

  • key: string

storage_clear()

storage_key(n: number): string | undefined

Parameters

  • n: number

Returns

  • string | undefined

storage_length(): number

Returns

  • number

Parameters

  • callback: ApiCallback

Parameters

  • rtb_id: string
  • options: BannerCreateOptions
  • callback?: BannerCreateCallback

Parameters

  • rtb_id: string

Parameters

  • rtb_id: string
  • callback?: BannerCreateCallback

Parameters

  • rtb_id: string
  • property: "stat_id" | "css_styles" | "css_class" | "display"
  • value: string

add_domain(domain: string)

Parameters

  • domain: string

verify_domain(): boolean

Returns

  • boolean

get_current_domain(): string

Returns

  • string

is_release_build(): boolean

Returns

  • boolean

Types

AdvCallbacks.open: (ctx: Context) => void

AdvCallbacks.close: (ctx: Context, was_shown: boolean) => void

AdvCallbacks.offline: (ctx: Context) => void

AdvCallbacks.error: (err: string) => void

RewardedCallbacks.open: (ctx: Context) => void

RewardedCallbacks.rewarded: (ctx: Context) => void

RewardedCallbacks.close: (ctx: Context) => void

RewardedCallbacks.error: (ctx: Context, err: string) => void

PlayerInitOptions.signed: boolean

PlayerInitOptions.scopes: boolean

PaymentsPurchaseOptions.id: string

PaymentsPurchaseOptions.developerPayload: string

LeaderboardsGetPlayerEntryOptions.includeUser: boolean

LeaderboardsGetPlayerEntryOptions.quantityAround: number

LeaderboardsGetPlayerEntryOptions.quantityTop: number

LeaderboardsGetPlayerEntryOptions.getAvatarSrc: "small" | "medium" | "large"

LeaderboardsGetPlayerEntryOptions.getAvatarSrcSet: "small" | "medium" | "large"

LeaderboardsGetEntriesOptions.includeUser: boolean

LeaderboardsGetEntriesOptions.quantityAround: number

LeaderboardsGetEntriesOptions.quantityTop: number

LeaderboardsGetEntriesOptions.getAvatarSrc: "small" | "medium" | "large"

LeaderboardsGetEntriesOptions.getAvatarSrcSet: "small" | "medium" | "large"

EnvironmentResults.app: { id: string; }

EnvironmentResults.browser: { lang: string; }

EnvironmentResults.i18n: { lang: string; tld: string; }

EnvironmentResults.payload: string

BannerCreateOptions.stat_id: number

BannerCreateOptions.css_styles: string

BannerCreateOptions.css_class: string

BannerCreateOptions.display: "none" | "block"