PixelPAD 2D - multiplayer

init_multiplayer() -> None

Example
Description
Must be called in order to have a multiplayer game. Note that this does NOT connect you to a server, only initializes the other multiplayer functionality.
Parameters
None
No parameters.

Return
No return value.

create_server(size: int) -> None

Example
Description
Creates a multiplayer server. If no one has joined the server within 5 seconds it will be deleted.
Parameters
size
The maximum number of players that can be connected to the server at any given time. Must be between 2 and 20 inclusive.

Return
No return value. Because of delay the result of the function can be found with get_server_event(), where the event type will be "type": "server_created".

join_server(server_id: str) -> None

Example
Description
Attempts to connect to the server with the specified server id. If the user is already connected to a server they will be disconnected as you can only be connected to one server at a time.
Parameters
server_id
The ID of the server the user should attempt to join.

Return
No return value. Because of delay the result of the function can be found with get_server_event(), where the event type will be "type": "self_joined".

inspect_server(server_id: str) -> None

Example
Description
Gets information about a specific server without joining it
Parameters
server_id
The ID of the server to get information about.

Return
No return value. Because of delay the result of the function can be found with get_server_event(), where the event type will be "type": "server_info".

get_server_event() -> dict

Example
Description
Checks for asynchronous (delayed) responses from create_server(), join_server(), and inspect_server() on the current frame.
Parameters
None
No parameters.

Return
A dictionary with the type of event that was received on the frame, or None if there is no event. If the event type is not None, the dict will also contain the boolean field "status", detailing whether the request was successful or not, as well as the field "message", containing a string with the event message, such as a server id from a "server_created" event.

send_message(data: str) -> None

Example
Description
Sends data to all other users connected to the same server.
Parameters
data
The string to send. Must be of length less than or equal to 256 characters.

Return
No return value.

get_messages() -> list

Example
Description
Get all the messages that have been received from the current server since get_messages() was last called.
Parameters
None
No parameters.

Return
A list of string messages that have been received, in order from oldest to most recently received. Returns an empty list if no messages have been received.

get_player_count() -> int

Example
Description
Checks how many people are in the currently connected server.
Parameters
None
No parameters.

Return
The number of people connected to the current server, 0 if there is no connection.

leave_server() -> None

Example
Description
Disconnects the current user from any servers they are in.
Parameters
None
No parameters.

Return
No return value.

get_servers() -> list

Example
Description
Gets a list of existing servers for the current game
Parameters
None
No parameters.

Return
A list with all active server IDs for the same game, or an empty list if there are none.

Multiplayer and Servers

Multiplayer games are games you can play together with other people. Sometimes this is done by having multiple people use the same keyboard, but in can also be done over the internet, so people can use their own computers and play games together even when they are in different places. Pixelpad allows you to create such games by using servers.

A server is a computer designed to process and respond to requests from other computers, often known as clients. Servers are used for a huge variety of purposes, including this website, but they are also used for making multiplayer games. Pixelpad has functions to create and join servers, to inspect and see all servers for a game, and to send and receive messages in the servers.