Up to date

This page is up to date for Godot 4.3. If you still find outdated information, please open an issue.

MasterServerClient

Inherits: BlaziumClient < Node < Object

Node for connecting to the Blazium Master Server service. Offers a centralized location for game server association.

Description

The MasterServerClient node provides an interface for connecting to the Blazium Master Server service. There is a free instance hosted on the blazium.app domain that is used by default.

Note: All methods are non blocking and can be awaited in order to get the result.

Properties

String

discord_embedded_app/path

"blazium/masterserver/api/v1"

String

game_id

""

String

server_url

"https://masterserver.blazium.app/api/v1"

Methods

MasterServerResponse

create_game(game_server_info: GameServerInfo)

MasterServerListResponse

recent_games()

MasterServerResponse

update_game(game_server_info: GameServerInfo)

Property Descriptions

String discord_embedded_app/path = "blazium/masterserver/api/v1" 🔗

  • void set_override_discord_path(value: String)

  • String get_override_discord_path()

Set to what path this client should use when connecting to the discord embedded app.

String game_id = "" 🔗

Set what game id this client should use when connecting to the server. If this is missing connection will error.

Can only contain alphanumeric characters.

String server_url = "https://masterserver.blazium.app/api/v1" 🔗

  • void set_server_url(value: String)

  • String get_server_url()

Set to what url this client should connect to.

For discord embedded app environment, replaces the url with client_id.discordsays.com/.proxy/blazium/masterserver/api/v1 if left default, where client_id is the client id from the discord embedded app url (automatically detected).

Method Descriptions

MasterServerResponse create_game(game_server_info: GameServerInfo) 🔗

Create a game server.

Returns a MasterServerResponse object that has a MasterServerResponse.finished signal that is emitted when finished.

MasterServerListResponse recent_games() 🔗

Get a list of recent games.

Returns a MasterServerListResponse object that has a MasterServerListResponse.finished signal that is emitted when finished.

MasterServerResponse update_game(game_server_info: GameServerInfo) 🔗

Update a game server.

Returns a MasterServerResponse object that has a MasterServerResponse.finished signal that is emitted when finished.