Skip to Content
defold-typescript libraries
wvdsh

wvdsh/sdk-defold/wavedash

Wavedash Defold API

  • GitHub: wvdsh/sdk-defold — pinned to 1.3.1 (released while Defold 1.14.0 was current)
    1. Pick a release from wvdsh/sdk-defold 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 wavedash from "wavedash"
  • Asset Portal: sdk-defold

Functions

wavedash.init(config: table, callback: function)

Initialize Wavedash.

Parameters

  • config: table
  • callback: function

wavedash.ready_for_events()

Signal that the game is ready to receive events.

wavedash.update_load_progress_zero_to_one(progress: number)

Update the load progress.

Parameters

  • progress: number

wavedash.load_complete()

Signal that loading is complete.

wavedash.toggle_overlay()

Toggle the overlay.

wavedash.is_fullscreen()

Check if fullscreen is enabled.

wavedash.request_fullscreen_async(fullscreen: boolean): function

Request fullscreen mode. This is an asynchronous function. The result will be delivered as an event with id 'requestFullscreen' or as a return value if the function is called from a coroutine.

Parameters

  • fullscreen: boolean

Returns

  • response: function — Returns true if the host reports the fullscreen request succeeded, false otherwise. (Note: Only if called from within a coroutine)

wavedash.toggle_fullscreen_async(): function

Toggle fullscreen mode. This is an asynchronous function. The result will be delivered as an event with id 'toggleFullscreen' or as a return value if the function is called from a coroutine.

Returns

  • response: function — Returns true if the fullscreen toggle succeeded, false otherwise. (Note: Only if called from within a coroutine)

wavedash.get_user()

Get the current user.

wavedash.get_username(user_id?: string)

Get a username.

Parameters

  • user_id?: string

wavedash.get_user_id()

Get the current user id.

wavedash.get_user_language(): string

Get the current user's preferred language code, such as "en" or "pt-BR". Compare it with the LANGUAGE_CODE_* constants.

Returns

  • language: string

wavedash.get_user_jwt_async(): function

Request a user JWT. This is an asynchronous function. The result will be delivered as an event with id 'getUserJwt' or as a return value if the function is called from a coroutine.

Returns

  • response: function — Returns The user's JWT signed by the Wavedash backend. (Note: Only if called from within a coroutine)

wavedash.get_launch_params()

Get launch parameters.

wavedash.list_friends_async(): function

List friends. This is an asynchronous function. The result will be delivered as an event with id 'listFriends' or as a return value if the function is called from a coroutine.

Returns

  • response: function — Returns the current user's friends. (Note: Only if called from within a coroutine)

wavedash.get_user_avatar_url(user_id: string, size?: number)

Get a user avatar URL.

Parameters

  • user_id: string
  • size?: number

wavedash.get_leaderboard_async(name: string): function

Get a leaderboard. This is an asynchronous function. The result will be delivered as an event with id 'getLeaderboard' or as a return value if the function is called from a coroutine.

Parameters

  • name: string

Returns

  • response: function — Returns the leaderboard. (Note: Only if called from within a coroutine)

wavedash.get_or_create_leaderboard_async(name: string, sort_order: number, display_type: number): function

Get or create a leaderboard. This is an asynchronous function. The result will be delivered as an event with id 'getOrCreateLeaderboard' or as a return value if the function is called from a coroutine.

Parameters

  • name: string
  • sort_order: number
  • display_type: number

Returns

  • response: function — Returns the leaderboard. (Note: Only if called from within a coroutine)

wavedash.get_leaderboard_entry_count(leaderboard_id: string)

Get leaderboard entry count.

Parameters

  • leaderboard_id: string

wavedash.get_my_leaderboard_entries_async(leaderboard_id: string): function

Get the current user's leaderboard entries. This is an asynchronous function. The result will be delivered as an event with id 'getMyLeaderboardEntries' or as a return value if the function is called from a coroutine.

Parameters

  • leaderboard_id: string

Returns

  • response: function — Returns the current user's leaderboard entries. (Note: Only if called from within a coroutine)

wavedash.list_leaderboard_entries_around_user_async(leaderboard_id: string, count_ahead: number, count_behind: number, friends_only?: boolean): function

List leaderboard entries around a user. This is an asynchronous function. The result will be delivered as an event with id 'listLeaderboardEntriesAroundUser' or as a return value if the function is called from a coroutine.

Parameters

  • leaderboard_id: string
  • count_ahead: number
  • count_behind: number
  • friends_only?: boolean

Returns

  • response: function — Returns leaderboard entries around the current user. (Note: Only if called from within a coroutine)

wavedash.list_leaderboard_entries_async(leaderboard_id: string, offset: number, limit: number, friends_only?: boolean): function

List leaderboard entries. This is an asynchronous function. The result will be delivered as an event with id 'listLeaderboardEntries' or as a return value if the function is called from a coroutine.

Parameters

  • leaderboard_id: string
  • offset: number
  • limit: number
  • friends_only?: boolean

Returns

  • response: function — Returns leaderboard entries. (Note: Only if called from within a coroutine)

wavedash.upload_leaderboard_score_async(leaderboard_id: string, score: number, keep_best: boolean, ugc_id?: string, metadata?: table): function

Upload a leaderboard score. Pass ugc_id to attach a UGC item, such as a replay, to the entry. Pass metadata to attach small key/value data to the entry: string keys with string, number or boolean values. This is an asynchronous function. The result will be delivered as an event with id 'uploadLeaderboardScore' or as a return value if the function is called from a coroutine.

Parameters

  • leaderboard_id: string
  • score: number
  • keep_best: boolean
  • ugc_id?: string
  • metadata?: table

Returns

  • response: function — Returns the upserted leaderboard entry. (Note: Only if called from within a coroutine)

wavedash.create_ugc_item_async(ugc_type: number, title?: string, description?: string, visibility?: number, file_path?: string): function

Create a UGC item. This is an asynchronous function. The result will be delivered as an event with id 'createUGCItem' or as a return value if the function is called from a coroutine.

Parameters

  • ugc_type: number
  • title?: string
  • description?: string
  • visibility?: number
  • file_path?: string

Returns

  • response: function — Returns the created UGC item id as a string. (Note: Only if called from within a coroutine)

wavedash.update_ugc_item_async(ugc_id: string, title?: string, description?: string, visibility?: number, file_path?: string): function

Update a UGC item. This is an asynchronous function. The result will be delivered as an event with id 'updateUGCItem' or as a return value if the function is called from a coroutine.

Parameters

  • ugc_id: string
  • title?: string
  • description?: string
  • visibility?: number
  • file_path?: string

Returns

  • response: function — Returns the updated UGC item id as a string. (Note: Only if called from within a coroutine)

wavedash.download_ugc_item_async(ugc_id: string, file_path: string): function

Download a UGC item. This is an asynchronous function. The result will be delivered as an event with id 'downloadUGCItem' or as a return value if the function is called from a coroutine.

Parameters

  • ugc_id: string
  • file_path: string

Returns

  • response: function — Returns the downloaded UGC item id as a string. (Note: Only if called from within a coroutine)

wavedash.delete_ugc_item_async(ugc_id: string): function

Delete a UGC item. This is an asynchronous function. The result will be delivered as an event with id 'deleteUGCItem' or as a return value if the function is called from a coroutine.

Parameters

  • ugc_id: string

Returns

  • response: function — Returns the deleted UGC item id as a string. (Note: Only if called from within a coroutine)

wavedash.list_ugc_items_async(filters: table): function

List UGC items. This is an asynchronous function. The result will be delivered as an event with id 'listUGCItems' or as a return value if the function is called from a coroutine.

Parameters

  • filters: table

Returns

  • response: function — Returns a page of UGC items ({ page, isDone, continueCursor }). (Note: Only if called from within a coroutine)

wavedash.delete_remote_file_async(file_path: string): function

Delete a remote file. This is an asynchronous function. The result will be delivered as an event with id 'deleteRemoteFile' or as a return value if the function is called from a coroutine.

Parameters

  • file_path: string

Returns

  • response: function — Returns The path of the remote file that was deleted. (Note: Only if called from within a coroutine)

wavedash.download_remote_file_async(file_path: string): function

Download a remote file. This is an asynchronous function. The result will be delivered as an event with id 'downloadRemoteFile' or as a return value if the function is called from a coroutine.

Parameters

  • file_path: string

Returns

  • response: function — Returns The path of the local file that the remote file was downloaded to. (Note: Only if called from within a coroutine)

wavedash.upload_remote_file_async(file_path: string): function

Upload a remote file. This is an asynchronous function. The result will be delivered as an event with id 'uploadRemoteFile' or as a return value if the function is called from a coroutine.

Parameters

  • file_path: string

Returns

  • response: function — Returns The path of the remote file that the local file was uploaded to. (Note: Only if called from within a coroutine)

wavedash.list_remote_directory_async(path: string): function

List a remote directory. This is an asynchronous function. The result will be delivered as an event with id 'listRemoteDirectory' or as a return value if the function is called from a coroutine.

Parameters

  • path: string

Returns

  • response: function — Returns A list of metadata for each file in the remote directory. (Note: Only if called from within a coroutine)

wavedash.download_remote_directory_async(path: string): function

Download a remote directory. This is an asynchronous function. The result will be delivered as an event with id 'downloadRemoteDirectory' or as a return value if the function is called from a coroutine.

Parameters

  • path: string

Returns

  • response: function — Returns The path of the local directory that the remote directory was downloaded to. (Note: Only if called from within a coroutine)

wavedash.write_local_file_async(file_path: string, data: string): function

Write a local file. This is an asynchronous function. The result will be delivered as an event with id 'writeLocalFile' or as a return value if the function is called from a coroutine.

Parameters

  • file_path: string
  • data: string

Returns

  • response: function — Returns true if the file was written successfully. (Note: Only if called from within a coroutine)

wavedash.read_local_file_async(file_path: string): function

Read a local file. This is an asynchronous function. The result will be delivered as an event with id 'readLocalFile' or as a return value if the function is called from a coroutine.

Parameters

  • file_path: string

Returns

  • response: function — Returns The data read from the local file (byte array). (Note: Only if called from within a coroutine)

wavedash.get_achievement(identifier: string)

Get an achievement.

Parameters

  • identifier: string

wavedash.get_stat(identifier: string)

Get a stat.

Parameters

  • identifier: string

wavedash.set_achievement(identifier: string, store_now?: boolean)

Set an achievement.

Parameters

  • identifier: string
  • store_now?: boolean

wavedash.set_stat(identifier: string, value: number, store_now?: boolean)

Set a stat.

Parameters

  • identifier: string
  • value: number
  • store_now?: boolean

wavedash.request_stats_async(): function

Request stats. This is an asynchronous function. The result will be delivered as an event with id 'requestStats' or as a return value if the function is called from a coroutine.

Returns

  • response: function — Returns true if the stats were requested successfully. (Note: Only if called from within a coroutine)

wavedash.store_stats()

Store stats.

wavedash.get_p2p_max_payload_size()

Get the maximum P2P payload size.

wavedash.get_p2p_max_incoming_messages()

Get the maximum number of incoming P2P messages.

wavedash.get_p2p_outgoing_message_buffer()

Get the P2P outgoing message buffer.

wavedash.send_p2p_message(to_user_id: string | undefined, app_channel: number | undefined, reliable: boolean | undefined, payload: string)

Send a P2P message.

Parameters

  • to_user_id: string | undefined
  • app_channel: number | undefined
  • reliable: boolean | undefined
  • payload: string

wavedash.broadcast_p2p_message(app_channel: number | undefined, reliable: boolean | undefined, payload: string)

Broadcast a P2P message.

Parameters

  • app_channel: number | undefined
  • reliable: boolean | undefined
  • payload: string

wavedash.read_p2p_message_from_channel(app_channel: number)

Read a P2P message from a channel.

Parameters

  • app_channel: number

wavedash.drain_p2p_channel_to_buffer(app_channel: number)

Drain a P2P channel to a buffer.

Parameters

  • app_channel: number

wavedash.create_lobby_async(visibility: number, max_players: number): function

Create a lobby. This is an asynchronous function. The result will be delivered as an event with id 'createLobby' or as a return value if the function is called from a coroutine.

Parameters

  • visibility: number
  • max_players: number

Returns

  • response: function — Returns the created lobby id as a string. Full lobby context is provided via the LobbyJoined event. (Note: Only if called from within a coroutine)

wavedash.join_lobby_async(lobby_id: string): function

Join a lobby. This is an asynchronous function. The result will be delivered as an event with id 'joinLobby' or as a return value if the function is called from a coroutine.

Parameters

  • lobby_id: string

Returns

  • response: function — Returns success/failure. Full lobby context is provided via the LobbyJoined event. (Note: Only if called from within a coroutine)

wavedash.list_available_lobbies_async(friends_only?: boolean): function

List available lobbies. This is an asynchronous function. The result will be delivered as an event with id 'listAvailableLobbies' or as a return value if the function is called from a coroutine.

Parameters

  • friends_only?: boolean

Returns

  • response: function — Returns the available lobbies. (Note: Only if called from within a coroutine)

wavedash.get_lobby_users(lobby_id: string)

Get lobby users.

Parameters

  • lobby_id: string

wavedash.get_num_lobby_users(lobby_id: string)

Get the number of lobby users.

Parameters

  • lobby_id: string

wavedash.get_lobby_host_id(lobby_id: string)

Get the lobby host id.

Parameters

  • lobby_id: string

wavedash.get_lobby_data(lobby_id: string, key: string)

Get lobby data.

Parameters

  • lobby_id: string
  • key: string

wavedash.set_lobby_data(lobby_id: string, key: string, value: string | number | boolean)

Set lobby data. Passing nil deletes the key.

Parameters

  • lobby_id: string
  • key: string
  • value: string | number | boolean

wavedash.delete_lobby_data(lobby_id: string, key: string)

Delete lobby data.

Parameters

  • lobby_id: string
  • key: string

wavedash.leave_lobby_async(lobby_id: string): function

Leave a lobby. This is an asynchronous function. The result will be delivered as an event with id 'leaveLobby' or as a return value if the function is called from a coroutine.

Parameters

  • lobby_id: string

Returns

  • response: function — Returns the lobby id as a string. (Note: Only if called from within a coroutine)

wavedash.send_lobby_message(lobby_id: string, message: string)

Send a lobby message.

Parameters

  • lobby_id: string
  • message: string

wavedash.invite_user_to_lobby_async(lobby_id: string, user_id: string): function

Invite a user to a lobby. This is an asynchronous function. The result will be delivered as an event with id 'inviteUserToLobby' or as a return value if the function is called from a coroutine.

Parameters

  • lobby_id: string
  • user_id: string

Returns

  • response: function — Returns success/failure. (Note: Only if called from within a coroutine)

Get a lobby invite link. This is an asynchronous function. The result will be delivered as an event with id 'getLobbyInviteLink' or as a return value if the function is called from a coroutine.

Parameters

  • copy_to_clipboard?: boolean

Returns

  • response: function — Returns the lobby invite link. (Note: Only if called from within a coroutine)

wavedash.update_user_presence_async(data_json?: string): function

Update user presence. This is an asynchronous function. The result will be delivered as an event with id 'updateUserPresence' or as a return value if the function is called from a coroutine.

Parameters

  • data_json?: string

Returns

  • response: function — Returns true if the presence was updated successfully. (Note: Only if called from within a coroutine)

wavedash.ensure_gameplay_jwt_async(): function

Ensure a gameplay JWT is available. This is an asynchronous function. The result will be delivered as an event with id 'ensureGameplayJwt' or as a return value if the function is called from a coroutine.

Returns

  • response: function — Returns the cached gameplay JWT. (Note: Only if called from within a coroutine)

wavedash.is_entitled_async(content_identifier: string): function

Returns whether the player owns the given paid content. This is a UX hint, not a security check — Wavedash re-verifies ownership when serving the paid files. This is an asynchronous function. The result will be delivered as an event with id 'isEntitled' or as a return value if the function is called from a coroutine.

Parameters

  • content_identifier: string

Returns

  • response: function — Returns whether the player owns the content in data. (Note: Only if called from within a coroutine)

wavedash.get_entitlements_async(): function

Returns every paid content identifier the player owns for this game. This is a UX hint, not a security check — Wavedash re-verifies ownership when serving the paid files. This is an asynchronous function. The result will be delivered as an event with id 'getEntitlements' or as a return value if the function is called from a coroutine.

Returns

  • response: function — Returns the owned content identifiers in data. (Note: Only if called from within a coroutine)

wavedash.trigger_paywall_async(content_identifier: string): function

Open the Wavedash paywall for the given paid content. Resolves immediately with data true if the player already owns it; otherwise resolves with whether the purchase completed. Handle the purchase itself in the PurchaseCompleted event, which also covers purchases made outside the game. This is an asynchronous function. The result will be delivered as an event with id 'triggerPaywall' or as a return value if the function is called from a coroutine.

Parameters

  • content_identifier: string

Returns

  • response: function — Returns whether the purchase completed in data. (Note: Only if called from within a coroutine)

wavedash.get_unfulfilled_purchases_async(): function

Consumable purchases the game hasn't fulfilled, oldest first, each shaped like the PurchaseCompleted payload. These already arrive as PurchaseCompleted events at launch, but each purchase fires once per session: use this to retry one whose fulfill_purchase_async call failed. This is an asynchronous function. The result will be delivered as an event with id 'getUnfulfilledPurchases' or as a return value if the function is called from a coroutine.

Returns

  • response: function — Returns the unfulfilled purchases in data. (Note: Only if called from within a coroutine)

wavedash.fulfill_purchase_async(purchase_id: string): function

Mark a consumable purchase fulfilled once the grant is saved, so it stops being redelivered. A game's backend can do the same with POST /api/purchases/{purchaseId}/fulfill and the purchase's receiptJwt; both are idempotent, so calling either or both is safe. Resolves with a status in data: FULFILLED, ALREADY_FULFILLED (also success), or NOT_FOUND (unknown or refunded: don't grant it). This is an asynchronous function. The result will be delivered as an event with id 'fulfillPurchase' or as a return value if the function is called from a coroutine.

Parameters

  • purchase_id: string

Returns

  • response: function — Returns { status } in data. (Note: Only if called from within a coroutine)

Constants

wavedash.EVENT_LOBBY_MESSAGE

EVENT_LOBBY_MESSAGE

wavedash.EVENT_LOBBY_JOINED

EVENT_LOBBY_JOINED

wavedash.EVENT_LOBBY_KICKED

EVENT_LOBBY_KICKED

wavedash.EVENT_LOBBY_USERS_UPDATED

EVENT_LOBBY_USERS_UPDATED

wavedash.EVENT_LOBBY_DATA_UPDATED

EVENT_LOBBY_DATA_UPDATED

wavedash.EVENT_LOBBY_INVITE

EVENT_LOBBY_INVITE

wavedash.EVENT_P2P_CONNECTION_ESTABLISHED

EVENT_P2P_CONNECTION_ESTABLISHED

wavedash.EVENT_P2P_CONNECTION_FAILED

EVENT_P2P_CONNECTION_FAILED

wavedash.EVENT_P2P_PEER_DISCONNECTED

EVENT_P2P_PEER_DISCONNECTED

wavedash.EVENT_P2P_PEER_RECONNECTING

EVENT_P2P_PEER_RECONNECTING

wavedash.EVENT_P2P_PEER_RECONNECTED

EVENT_P2P_PEER_RECONNECTED

wavedash.EVENT_P2P_PACKET_DROPPED

EVENT_P2P_PACKET_DROPPED

wavedash.EVENT_STATS_STORED

EVENT_STATS_STORED

wavedash.EVENT_BACKEND_CONNECTED

EVENT_BACKEND_CONNECTED

wavedash.EVENT_BACKEND_DISCONNECTED

EVENT_BACKEND_DISCONNECTED

wavedash.EVENT_BACKEND_RECONNECTING

EVENT_BACKEND_RECONNECTING

wavedash.EVENT_FULLSCREEN_CHANGED

EVENT_FULLSCREEN_CHANGED

wavedash.EVENT_ENTITLEMENTS_GRANTED

Deprecated: handle EVENT_PURCHASE_COMPLETED instead, which also covers consumables.

wavedash.EVENT_PURCHASE_COMPLETED

Fired once per purchase made while the game is running (in-game paywall, game page, gift, another tab), plus, at launch, once per consumable still unfulfilled. Payload: { purchaseId, contentIdentifier, type, fulfilled, purchasedAt, receiptJwt }. Durables arrive with fulfilled true, already granted. For a consumable, grant it, then call fulfill_purchase_async(purchaseId); until then it's redelivered every launch, so dedupe on purchaseId if you persist grants.

wavedash.PURCHASE_TYPE_DURABLE

type field on the EVENT_PURCHASE_COMPLETED payload for content purchased once that never expires.

wavedash.PURCHASE_TYPE_CONSUMABLE

type field on the EVENT_PURCHASE_COMPLETED payload for content that can be purchased repeatedly and is fulfilled by the game.

wavedash.FULFILL_PURCHASE_STATUS_FULFILLED

fulfill_purchase_async status: marked fulfilled by this call.

wavedash.FULFILL_PURCHASE_STATUS_ALREADY_FULFILLED

fulfill_purchase_async status: also success. The game or its backend fulfilled it earlier, or it's a durable.

wavedash.FULFILL_PURCHASE_STATUS_NOT_FOUND

fulfill_purchase_async status: unknown purchase, or it was refunded. Don't grant it.

wavedash.LANGUAGE_CODE_ARABIC

Language code: ar.

wavedash.LANGUAGE_CODE_BULGARIAN

Language code: bg.

wavedash.LANGUAGE_CODE_CATALAN

Language code: ca.

wavedash.LANGUAGE_CODE_CHINESE_SIMPLIFIED

Language code: zh-CN.

wavedash.LANGUAGE_CODE_CHINESE_TRADITIONAL

Language code: zh-TW.

wavedash.LANGUAGE_CODE_CROATIAN

Language code: hr.

wavedash.LANGUAGE_CODE_CZECH

Language code: cs.

wavedash.LANGUAGE_CODE_DANISH

Language code: da.

wavedash.LANGUAGE_CODE_DUTCH

Language code: nl.

wavedash.LANGUAGE_CODE_ENGLISH

Language code: en.

wavedash.LANGUAGE_CODE_ESPERANTO

Language code: eo.

wavedash.LANGUAGE_CODE_FINNISH

Language code: fi.

wavedash.LANGUAGE_CODE_FRENCH

Language code: fr.

wavedash.LANGUAGE_CODE_GALICIAN

Language code: gl.

wavedash.LANGUAGE_CODE_GERMAN

Language code: de.

wavedash.LANGUAGE_CODE_GREEK

Language code: el.

wavedash.LANGUAGE_CODE_HUNGARIAN

Language code: hu.

wavedash.LANGUAGE_CODE_INDONESIAN

Language code: id.

wavedash.LANGUAGE_CODE_ITALIAN

Language code: it.

wavedash.LANGUAGE_CODE_JAPANESE

Language code: ja.

wavedash.LANGUAGE_CODE_KOREAN

Language code: ko.

wavedash.LANGUAGE_CODE_LATVIAN

Language code: lv.

wavedash.LANGUAGE_CODE_LITHUANIAN

Language code: lt.

wavedash.LANGUAGE_CODE_MALAY

Language code: ms.

wavedash.LANGUAGE_CODE_NORWEGIAN

Language code: no.

wavedash.LANGUAGE_CODE_POLISH

Language code: pl.

wavedash.LANGUAGE_CODE_PORTUGUESE

Language code: pt.

wavedash.LANGUAGE_CODE_PORTUGUESE_BRAZIL

Language code: pt-BR.

wavedash.LANGUAGE_CODE_ROMANIAN

Language code: ro.

wavedash.LANGUAGE_CODE_RUSSIAN

Language code: ru.

wavedash.LANGUAGE_CODE_SPANISH

Language code: es.

wavedash.LANGUAGE_CODE_SPANISH_LATIN_AMERICA

Language code: es-419.

wavedash.LANGUAGE_CODE_SWEDISH

Language code: sv.

wavedash.LANGUAGE_CODE_THAI

Language code: th.

wavedash.LANGUAGE_CODE_TURKISH

Language code: tr.

wavedash.LANGUAGE_CODE_UKRAINIAN

Language code: uk.

wavedash.LANGUAGE_CODE_VIETNAMESE

Language code: vi.

wavedash.LOBBY_VISIBILITY_PUBLIC

LOBBY_VISIBILITY_PUBLIC

wavedash.LOBBY_VISIBILITY_FRIENDS_ONLY

LOBBY_VISIBILITY_FRIENDS_ONLY

wavedash.LOBBY_VISIBILITY_PRIVATE

LOBBY_VISIBILITY_PRIVATE

wavedash.LEADERBOARD_SORT_ORDER_ASC

LEADERBOARD_SORT_ORDER_ASC

wavedash.LEADERBOARD_SORT_ORDER_DESC

LEADERBOARD_SORT_ORDER_DESC

wavedash.LEADERBOARD_DISPLAY_TYPENUMERIC

LEADERBOARD_DISPLAY_TYPENUMERIC

wavedash.LEADERBOARD_DISPLAY_TYPETIME_SECONDS

LEADERBOARD_DISPLAY_TYPETIME_SECONDS

wavedash.LEADERBOARD_DISPLAY_TYPETIME_MILLISECONDS

LEADERBOARD_DISPLAY_TYPETIME_MILLISECONDS

wavedash.LEADERBOARD_DISPLAY_TYPETIME_GAME_TICKS

LEADERBOARD_DISPLAY_TYPETIME_GAME_TICKS

wavedash.UGC_TYPE_SCREENSHOT

UGC_TYPE_SCREENSHOT

wavedash.UGC_TYPE_VIDEO

UGC_TYPE_VIDEO

wavedash.UGC_TYPE_COMMUNITY

UGC_TYPE_COMMUNITY

wavedash.UGC_TYPE_GAME_MANAGED

UGC_TYPE_GAME_MANAGED

wavedash.UGC_TYPE_OTHER

UGC_TYPE_OTHER

wavedash.UGC_VISIBILITY_PUBLIC

UGC_VISIBILITY_PUBLIC

wavedash.UGC_VISIBILITY_FRIENDS_ONLY

UGC_VISIBILITY_FRIENDS_ONLY

wavedash.UGC_VISIBILITY_PRIVATE

UGC_VISIBILITY_PRIVATE

wavedash.AVATAR_SIZE_SMALL

AVATAR_SIZE_SMALL

wavedash.AVATAR_SIZE_MEDIUM

AVATAR_SIZE_MEDIUM

wavedash.AVATAR_SIZE_LARGE

AVATAR_SIZE_LARGE

wavedash.LOBBY_KICKED_REASON_KICKED

LOBBY_KICKED_REASON_KICKED

wavedash.LOBBY_KICKED_REASON_ERROR

LOBBY_KICKED_REASON_ERROR

wavedash.LOBBY_USER_CHANGE_TYPE_JOINED

LOBBY_USER_CHANGE_TYPE_JOINED

wavedash.LOBBY_USER_CHANGE_TYPE_LEFT

LOBBY_USER_CHANGE_TYPE_LEFT

wavedash.P2P_PACKET_DROP_REASON_QUEUE_FULL

P2P_PACKET_DROP_REASON_QUEUE_FULL

wavedash.P2P_PACKET_DROP_REASON_PAYLOAD_TOO_LARGE

P2P_PACKET_DROP_REASON_PAYLOAD_TOO_LARGE

wavedash.P2P_PACKET_DROP_REASON_INVALID_PAYLOAD_SIZE

P2P_PACKET_DROP_REASON_INVALID_PAYLOAD_SIZE

wavedash.P2P_PACKET_DROP_REASON_INVALID_CHANNEL

P2P_PACKET_DROP_REASON_INVALID_CHANNEL

wavedash.P2P_PACKET_DROP_REASON_MALFORMED

P2P_PACKET_DROP_REASON_MALFORMED

wavedash.P2P_PACKET_DROP_REASON_PEER_NOT_READY

P2P_PACKET_DROP_REASON_PEER_NOT_READY

On this page

Functionswavedash.init(config: table, callback: function)wavedash.ready_for_events()wavedash.update_load_progress_zero_to_one(progress: number)wavedash.load_complete()wavedash.toggle_overlay()wavedash.is_fullscreen()wavedash.request_fullscreen_async(fullscreen: boolean): functionwavedash.toggle_fullscreen_async(): functionwavedash.get_user()wavedash.get_username(user_id?: string)wavedash.get_user_id()wavedash.get_user_language(): stringwavedash.get_user_jwt_async(): functionwavedash.get_launch_params()wavedash.list_friends_async(): functionwavedash.get_user_avatar_url(user_id: string, size?: number)wavedash.get_leaderboard_async(name: string): functionwavedash.get_or_create_leaderboard_async(name: string, sort_order: number, display_type: number): functionwavedash.get_leaderboard_entry_count(leaderboard_id: string)wavedash.get_my_leaderboard_entries_async(leaderboard_id: string): functionwavedash.list_leaderboard_entries_around_user_async(leaderboard_id: string, count_ahead: number, count_behind: number, friends_only?: boolean): functionwavedash.list_leaderboard_entries_async(leaderboard_id: string, offset: number, limit: number, friends_only?: boolean): functionwavedash.upload_leaderboard_score_async(leaderboard_id: string, score: number, keep_best: boolean, ugc_id?: string, metadata?: table): functionwavedash.create_ugc_item_async(ugc_type: number, title?: string, description?: string, visibility?: number, file_path?: string): functionwavedash.update_ugc_item_async(ugc_id: string, title?: string, description?: string, visibility?: number, file_path?: string): functionwavedash.download_ugc_item_async(ugc_id: string, file_path: string): functionwavedash.delete_ugc_item_async(ugc_id: string): functionwavedash.list_ugc_items_async(filters: table): functionwavedash.delete_remote_file_async(file_path: string): functionwavedash.download_remote_file_async(file_path: string): functionwavedash.upload_remote_file_async(file_path: string): functionwavedash.list_remote_directory_async(path: string): functionwavedash.download_remote_directory_async(path: string): functionwavedash.write_local_file_async(file_path: string, data: string): functionwavedash.read_local_file_async(file_path: string): functionwavedash.get_achievement(identifier: string)wavedash.get_stat(identifier: string)wavedash.set_achievement(identifier: string, store_now?: boolean)wavedash.set_stat(identifier: string, value: number, store_now?: boolean)wavedash.request_stats_async(): functionwavedash.store_stats()wavedash.get_p2p_max_payload_size()wavedash.get_p2p_max_incoming_messages()wavedash.get_p2p_outgoing_message_buffer()wavedash.send_p2p_message(to_user_id: string | undefined, app_channel: number | undefined, reliable: boolean | undefined, payload: string)wavedash.broadcast_p2p_message(app_channel: number | undefined, reliable: boolean | undefined, payload: string)wavedash.read_p2p_message_from_channel(app_channel: number)wavedash.drain_p2p_channel_to_buffer(app_channel: number)wavedash.create_lobby_async(visibility: number, max_players: number): functionwavedash.join_lobby_async(lobby_id: string): functionwavedash.list_available_lobbies_async(friends_only?: boolean): functionwavedash.get_lobby_users(lobby_id: string)wavedash.get_num_lobby_users(lobby_id: string)wavedash.get_lobby_host_id(lobby_id: string)wavedash.get_lobby_data(lobby_id: string, key: string)wavedash.set_lobby_data(lobby_id: string, key: string, value: string | number | boolean)wavedash.delete_lobby_data(lobby_id: string, key: string)wavedash.leave_lobby_async(lobby_id: string): functionwavedash.send_lobby_message(lobby_id: string, message: string)wavedash.invite_user_to_lobby_async(lobby_id: string, user_id: string): functionwavedash.get_lobby_invite_link_async(copy_to_clipboard?: boolean): functionwavedash.update_user_presence_async(data_json?: string): functionwavedash.ensure_gameplay_jwt_async(): functionwavedash.is_entitled_async(content_identifier: string): functionwavedash.get_entitlements_async(): functionwavedash.trigger_paywall_async(content_identifier: string): functionwavedash.get_unfulfilled_purchases_async(): functionwavedash.fulfill_purchase_async(purchase_id: string): functionConstantswavedash.EVENT_LOBBY_MESSAGEwavedash.EVENT_LOBBY_JOINEDwavedash.EVENT_LOBBY_KICKEDwavedash.EVENT_LOBBY_USERS_UPDATEDwavedash.EVENT_LOBBY_DATA_UPDATEDwavedash.EVENT_LOBBY_INVITEwavedash.EVENT_P2P_CONNECTION_ESTABLISHEDwavedash.EVENT_P2P_CONNECTION_FAILEDwavedash.EVENT_P2P_PEER_DISCONNECTEDwavedash.EVENT_P2P_PEER_RECONNECTINGwavedash.EVENT_P2P_PEER_RECONNECTEDwavedash.EVENT_P2P_PACKET_DROPPEDwavedash.EVENT_STATS_STOREDwavedash.EVENT_BACKEND_CONNECTEDwavedash.EVENT_BACKEND_DISCONNECTEDwavedash.EVENT_BACKEND_RECONNECTINGwavedash.EVENT_FULLSCREEN_CHANGEDwavedash.EVENT_ENTITLEMENTS_GRANTEDwavedash.EVENT_PURCHASE_COMPLETEDwavedash.PURCHASE_TYPE_DURABLEwavedash.PURCHASE_TYPE_CONSUMABLEwavedash.FULFILL_PURCHASE_STATUS_FULFILLEDwavedash.FULFILL_PURCHASE_STATUS_ALREADY_FULFILLEDwavedash.FULFILL_PURCHASE_STATUS_NOT_FOUNDwavedash.LANGUAGE_CODE_ARABICwavedash.LANGUAGE_CODE_BULGARIANwavedash.LANGUAGE_CODE_CATALANwavedash.LANGUAGE_CODE_CHINESE_SIMPLIFIEDwavedash.LANGUAGE_CODE_CHINESE_TRADITIONALwavedash.LANGUAGE_CODE_CROATIANwavedash.LANGUAGE_CODE_CZECHwavedash.LANGUAGE_CODE_DANISHwavedash.LANGUAGE_CODE_DUTCHwavedash.LANGUAGE_CODE_ENGLISHwavedash.LANGUAGE_CODE_ESPERANTOwavedash.LANGUAGE_CODE_FINNISHwavedash.LANGUAGE_CODE_FRENCHwavedash.LANGUAGE_CODE_GALICIANwavedash.LANGUAGE_CODE_GERMANwavedash.LANGUAGE_CODE_GREEKwavedash.LANGUAGE_CODE_HUNGARIANwavedash.LANGUAGE_CODE_INDONESIANwavedash.LANGUAGE_CODE_ITALIANwavedash.LANGUAGE_CODE_JAPANESEwavedash.LANGUAGE_CODE_KOREANwavedash.LANGUAGE_CODE_LATVIANwavedash.LANGUAGE_CODE_LITHUANIANwavedash.LANGUAGE_CODE_MALAYwavedash.LANGUAGE_CODE_NORWEGIANwavedash.LANGUAGE_CODE_POLISHwavedash.LANGUAGE_CODE_PORTUGUESEwavedash.LANGUAGE_CODE_PORTUGUESE_BRAZILwavedash.LANGUAGE_CODE_ROMANIANwavedash.LANGUAGE_CODE_RUSSIANwavedash.LANGUAGE_CODE_SPANISHwavedash.LANGUAGE_CODE_SPANISH_LATIN_AMERICAwavedash.LANGUAGE_CODE_SWEDISHwavedash.LANGUAGE_CODE_THAIwavedash.LANGUAGE_CODE_TURKISHwavedash.LANGUAGE_CODE_UKRAINIANwavedash.LANGUAGE_CODE_VIETNAMESEwavedash.LOBBY_VISIBILITY_PUBLICwavedash.LOBBY_VISIBILITY_FRIENDS_ONLYwavedash.LOBBY_VISIBILITY_PRIVATEwavedash.LEADERBOARD_SORT_ORDER_ASCwavedash.LEADERBOARD_SORT_ORDER_DESCwavedash.LEADERBOARD_DISPLAY_TYPENUMERICwavedash.LEADERBOARD_DISPLAY_TYPETIME_SECONDSwavedash.LEADERBOARD_DISPLAY_TYPETIME_MILLISECONDSwavedash.LEADERBOARD_DISPLAY_TYPETIME_GAME_TICKSwavedash.UGC_TYPE_SCREENSHOTwavedash.UGC_TYPE_VIDEOwavedash.UGC_TYPE_COMMUNITYwavedash.UGC_TYPE_GAME_MANAGEDwavedash.UGC_TYPE_OTHERwavedash.UGC_VISIBILITY_PUBLICwavedash.UGC_VISIBILITY_FRIENDS_ONLYwavedash.UGC_VISIBILITY_PRIVATEwavedash.AVATAR_SIZE_SMALLwavedash.AVATAR_SIZE_MEDIUMwavedash.AVATAR_SIZE_LARGEwavedash.LOBBY_KICKED_REASON_KICKEDwavedash.LOBBY_KICKED_REASON_ERRORwavedash.LOBBY_USER_CHANGE_TYPE_JOINEDwavedash.LOBBY_USER_CHANGE_TYPE_LEFTwavedash.P2P_PACKET_DROP_REASON_QUEUE_FULLwavedash.P2P_PACKET_DROP_REASON_PAYLOAD_TOO_LARGEwavedash.P2P_PACKET_DROP_REASON_INVALID_PAYLOAD_SIZEwavedash.P2P_PACKET_DROP_REASON_INVALID_CHANNELwavedash.P2P_PACKET_DROP_REASON_MALFORMEDwavedash.P2P_PACKET_DROP_REASON_PEER_NOT_READY