# 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 <a href="#platform-id" id="platform-id"></a>

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

```lua
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`, `microsoft_store`, `poki`, `qa_tool`, `discord`, `gamepush`, `bitquest`, `huawei`, `jio_games`, `reddit`, `youtube`, `mock`, `xiaomi`.

#### <img src="https://1088849411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5ukgSPDBOdbQp4FYtbz1%2Fuploads%2F9BooaofCI33U9Np5oeif%2FFrame%203%20(1).png?alt=media&#x26;token=0750b56a-a069-4759-bda9-29951f06cd30" alt="" data-size="line"> Language <a href="#language" id="language"></a>

{% hint style="warning" %}
Check the language to display proper text labels.&#x20;
{% endhint %}

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

```lua
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 <a href="#url-parameter" id="url-parameter"></a>

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

```lua
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\\_i&#x64;**#your-info>\*\*                       |
| Yandex      | <http://yandex.com/games/app/game\\_i&#x64;**?payload=your-info>\*\* |
| Crazy Games | crazygames.com/game/game\_nam&#x65;**?payload=your-info**            |
| Mock        | site.com/game\_nam&#x65;**?payload=your-info**                       |

#### Domain Information <a href="#domain-information" id="domain-information"></a>

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

```lua
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.

```lua
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.

```lua
bridge.platform.is_get_game_by_id_supported()
```

#### Get All Games

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

```lua
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.

```lua
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
```

#### <img src="https://1088849411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5ukgSPDBOdbQp4FYtbz1%2Fuploads%2F9BooaofCI33U9Np5oeif%2FFrame%203%20(1).png?alt=media&#x26;token=0750b56a-a069-4759-bda9-29951f06cd30" alt="" data-size="line"> Sending a Message to the Platform <a href="#sending-a-message-to-the-platform" id="sending-a-message-to-the-platform"></a>

{% hint style="danger" %}
The call to <mark style="color:purple;">send\_message</mark> with the parameter <mark style="color:orange;">game\_ready</mark> is mandatory!

Don't forget to implement it. Send this message only when the game is fully loaded.
{% endhint %}

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

```javascript
bridge.platform.send_message("game_ready")
```

| 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             | <p>Optional. "world" <br>Optional. "level"</p> | Gameplay has started. For example, the player has entered a level from the main menu.          |
| level\_completed           | <p>Optional. "world" <br>Optional. "level"</p> | Gameplay has completed. For example, the player won level.                                     |
| level\_failed              | <p>Optional. "world" <br>Optional. "level"</p> | Gameplay has failed. For example, the player lost level.                                       |
| level\_paused              | <p>Optional. "world" <br>Optional. "level"</p> | Gameplay has paused. Opened settings menu or used pause button                                 |
| level\_resumed             | <p>Optional. "world" <br>Optional. "level"</p> | Gameplay has resumed. Returned from settings menu or hit unpause button                        |

#### Is Audio Enabled

Check if the audio is turned on on the platform.

```lua
bridge.platform.is_audio_enabled()
```

```javascript
// Listen for state changes
local bridge = require("bridge.bridge")

function init(self)
    bridge.platform.on("audio_state_changed", function (_, is_enabled)
        print("Is audio enabled: ", is_enabled)
    end)
end
```

#### Pause

```javascript
// Listen for state changes
local bridge = require("bridge.bridge")

function init(self)
    bridge.platform.on("pause_state_changed", function (_, is_paused)
        print("Is paused: ", is_paused)
    end)
end
```

#### Server Time <a href="#server-time" id="server-time"></a>

```lua
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 <a href="#current-visibility-state" id="current-visibility-state"></a>

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

```lua
bridge.game.visibility_state()
```

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

{% hint style="info" %}
React to visibility state changes. For example, mute the game sound when `hidden` and unmute when `visible`.
{% endhint %}

```lua
local bridge = require("bridge.bridge")

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