Platform Parameters

At any time, you can retrieve values for specific parameters that you might use in your game, such as the user's browser language.

Platform ID

Identify the platform on which the game is currently running to customize features and settings accordingly.

bridge.platform.id()

Returns the ID of the platform on which the game is currently running. Possible values: playgama, vk, ok, yandex, facebook, crazy_games, game_distribution, wortal, playdeck, telegram, y8, lagged, msn, poki, qa_tool, mock.

Language

Check the language to display proper text labels.

Get the language set by the user on the platform or the browser language if not provided by the platform, to localize game content.

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.

URL Parameter

Embed auxiliary information into the game URL to pass additional data or settings when launching the game.

bridge.platform.payload()

This parameter allows embedding auxiliary information into the game URL. If there is no data – nil.

Platform	URL Format
VK	http://vk.com/game_id#your-info
Yandex	http://yandex.com/games/app/game_id?payload=your-info
Crazy Games	crazygames.com/game/game_name?payload=your-info
Mock	site.com/game_name?payload=your-info

Domain Information

Retrieve the top-level domain of the platform to handle domain-specific configurations and behavior.

bridge.platform.tld()

Returns the top-level domain (TLD) of the platform. If there is no data – nil. If the data is available – com, ru, etc.

Is Get All Games Supported

Verify whether the platform supports the bridge.platform.get_all_games() method to retrieve the correct links to the developer's other games.

bridge.platform.is_get_all_games_supported()

Is Get Game By Id Supported

Verify whether the platform supports the bridge.platform.get_game_by_id() method to retrieve the correct link to a specific game.

bridge.platform.is_get_game_by_id_supported()

Get All Games

This method retrieves the correct links to the developer's other games.

local bridge = require("bridge.bridge")

function init(self)
    bridge.platform.get_all_games(function (_, data)
        -- success
    end, function ()
        -- error
    end)
end

Get Game By Id

This method retrieves the correct link to a specific game from the developer.

local bridge = require("bridge.bridge")

function init(self)
    local options = {
        yandex = {
            gameId = "GAME_ID"
        }
    }

    bridge.platform.get_game_by_id(options, function (_, data)
        print("Game data: ", data)
    end, function ()
        -- error
    end)
end

Sending a Message to the Platform

The call to send_message with the parameter game_ready is mandatory!

Don't forget to implement it.

Send predefined messages to the platform to trigger specific actions or events, such as signaling that the game is ready.

bridge.platform.send_message("game_ready")

Message	Description
game_ready	The game has loaded, all loading screens have passed, the player can interact with the game.
in_game_loading_started	Any loading within the game has started. For example, when a level is loading.
in_game_loading_stopped	In-game loading has finished.
gameplay_started	Gameplay has started. For example, the player has entered a level from the main menu.
gameplay_stopped	Gameplay has ended/paused. For example, when exiting a level to the main menu, opening the pause menu, etc.
player_got_achievement	The player reached a significant moment. For example, defeating a boss, setting a record, etc.

Server Time

local bridge = require("bridge.bridge")

function init(self)
	bridge.platform.get_server_time(function (_, data)
		print("Server time: ", data)
	end, 
	function ()
		-- error
	end)
end

Current Visibility State

Check if the game tab is visible or hidden, and adjust game behavior accordingly, such as muting sound when hidden.

bridge.game.visibility_state()

Returns the current visibility state of the game (the tab with the game). Possible values: visible, hidden.

React to visibility state changes. For example, mute the game sound when hidden and unmute when visible.

local bridge = require("bridge.bridge")

function init(self)
	bridge.game.on("visibility_state_changed", function (_, state)
		print("Visibility state changed: ", state)
	end)
end