Platform (required)

You are reading the documentation for Bridge SDK v2. If you need the obsolete v1 documentation, see Documentation (v1).

The Platform module exposes host-platform data and lets the game report lifecycle events back to the host.

Implementation order

Required — Read platform.language and apply localization.
Required — Send platform.sendMessage('game_ready') when the first playable frame is ready.
Required — On game start, check platform.isAudioEnabled and mute the game if it is false. Also react to audio and pause state events to mute or pause the game when the user switches tabs or the platform requests it.
Recommended — Send additional sendMessage lifecycle events (level_started, level_completed, etc.).

Language

Read this after initialization and use it as the source language for your localization system.

Returns the language selected by the user on the host platform. If the platform does not provide a language, Bridge falls back to the browser language.

bridge.platform.language

If the platform provides user language data, this will be the language set by the user on the platform. If not, it will be the browser language.

Format: ISO 639-1. Example: ru, en.

Platform support · all 26 platforms

Supports: crazy_games, discord, dlightek, facebook, game_distribution, gamepush, gamesnacks, huawei, jio_games, lagged, microsoft_store, msn, ok, playdeck, playgama, poki, portal, reddit, samsung, telegram, tiktok, vk, xiaomi, y8, yandex, youtube

Sending a Message to the Platform

Send lifecycle messages to the host platform. game_ready is required; the other messages help the platform understand gameplay state.

bridge.platform.sendMessage("game_ready")

Add the PlaygamaBridge Send Message to Platform action and pick a message from the list (see the table below). Send Game Ready once the first playable frame is ready.

Copy This Example

{"is-c3-clipboard-data":true,"type":"events","items":[{"eventType":"block","conditions":[{"id":"on-start-of-layout","objectClass":"System"}],"actions":[{"id":"send-message","objectClass":"PlaygamaBridge","parameters":{"message":"game-ready"}}]}]}

Add the Send Message action and pick a message from the list (see the table below). Send Game Ready once the first playable frame is ready.

Copy This Example

{"000kind":"GDEVELOP_EventsAndInstructions_CLIPBOARD_KIND-jsBdHbLy912y8Rc","content":{"eventsList":[{"type":"BuiltinCommonInstructions::Standard","conditions":[],"actions":[{"type":{"value":"PlaygamaBridge::SendMessage"},"parameters":["","\"GAME_READY\""]}]}],"eventsCount":1,"actionsList":[],"actionsCount":0,"conditionsList":[],"conditionsCount":0}}

sendGameReadyMessage() {
    bridge.platform.sendMessage(PLATFORM_MESSAGE.GAME_READY)
        .then(() => {
            console.log("Game ready message sent.");
        })
        .catch((error) => {
            console.error("Failed to send game ready message:", error);
        });
}

Message

Parameters

Description

game_ready

No parameters

The game has loaded, all loading screens have passed, the player can interact with the game.

in_game_loading_started

No parameters

Any loading within the game has started. For example, when a level is loading.

in_game_loading_stopped

No parameters

In-game loading has finished.

player_got_achievement

No parameters

The player reached a significant moment. For example, defeating a boss, setting a record, etc.

level_started