Class MultiplayerPeerExtension

Class that can be inherited to implement custom multiplayer API networking layers via GDExtension.

Inheritance

MultiplayerPeer

PacketPeer

RefCounted

Object

MultiplayerPeerExtension

Remarks

This class is designed to be inherited from a GDExtension plugin to implement custom networking layers for the multiplayer API (such as WebRTC). All the methods below must be implemented to have a working custom multiplayer implementation. See also MultiplayerAPI.

Methods

_close

Qualifiers: virtual

Called when the multiplayer peer should be immediately closed (see close).

void _close

_disconnect_peer(int, bool)

Qualifiers: virtual

Called when the connected p_peer should be forcibly disconnected (see MultiplayerPeer.disconnect_peer).

void _disconnect_peer(int p_peer, bool p_force)

Parameters

p_peer int

p_force bool

_get_available_packet_count

Qualifiers: virtualconst

Called when the available packet count is internally requested by the MultiplayerAPI.

int _get_available_packet_count

_get_connection_status

Qualifiers: virtualconst

Called when the connection status is requested on the MultiplayerPeer (see get_connection_status).

int _get_connection_status

_get_max_packet_size

Qualifiers: virtualconst

Called when the maximum allowed packet size (in bytes) is requested by the MultiplayerAPI.

int _get_max_packet_size

_get_packet(const uint8_t **, int32_t*)

Qualifiers: virtual

Called when a packet needs to be received by the MultiplayerAPI, with r_buffer_size being the size of the binary r_buffer in bytes.

int _get_packet(const uint8_t ** r_buffer, int32_t* r_buffer_size)

Parameters

r_buffer const uint8_t **

r_buffer_size int32_t*

_get_packet_channel

Qualifiers: virtualconst

Called to get the channel over which the next available packet was received. See get_packet_channel.

int _get_packet_channel

_get_packet_mode

Qualifiers: virtualconst

Called to get the transfer mode the remote peer used to send the next available packet. See get_packet_mode.

int _get_packet_mode

_get_packet_peer

Qualifiers: virtualconst

Called when the ID of the MultiplayerPeer who sent the most recent packet is requested (see get_packet_peer).

int _get_packet_peer

_get_packet_script

Qualifiers: virtual

Called when a packet needs to be received by the MultiplayerAPI, if MultiplayerPeerExtension._get_packet isn't implemented. Use this when extending this class via GDScript.

PackedByteArray _get_packet_script

_get_transfer_channel

Qualifiers: virtualconst

Called when the transfer channel to use is read on this MultiplayerPeer (see transfer_channel).

int _get_transfer_channel

_get_transfer_mode

Qualifiers: virtualconst

Called when the transfer mode to use is read on this MultiplayerPeer (see transfer_mode).

int _get_transfer_mode

_get_unique_id

Qualifiers: virtualconst

Called when the unique ID of this MultiplayerPeer is requested (see get_unique_id). The value must be between 1 and 2147483647.

int _get_unique_id

_is_refusing_new_connections

Qualifiers: virtualconst

Called when the "refuse new connections" status is requested on this MultiplayerPeer (see refuse_new_connections).

bool _is_refusing_new_connections

_is_server

Qualifiers: virtualconst

Called when the "is server" status is requested on the MultiplayerAPI. See is_server.

bool _is_server

_is_server_relay_supported

Qualifiers: virtualconst

Called to check if the server can act as a relay in the current configuration. See is_server_relay_supported.

bool _is_server_relay_supported

_poll

Qualifiers: virtual

Called when the MultiplayerAPI is polled. See poll.

void _poll

_put_packet(const uint8_t*, int)

Qualifiers: virtual

Called when a packet needs to be sent by the MultiplayerAPI, with p_buffer_size being the size of the binary p_buffer in bytes.

int _put_packet(const uint8_t* p_buffer, int p_buffer_size)

Parameters

p_buffer const uint8_t*

p_buffer_size int

_put_packet_script(PackedByteArray)

Qualifiers: virtual

Called when a packet needs to be sent by the MultiplayerAPI, if MultiplayerPeerExtension._put_packet isn't implemented. Use this when extending this class via GDScript.

int _put_packet_script(PackedByteArray p_buffer)

Parameters

p_buffer PackedByteArray

_set_refuse_new_connections(bool)

Qualifiers: virtual

Called when the "refuse new connections" status is set on this MultiplayerPeer (see refuse_new_connections).

void _set_refuse_new_connections(bool p_enable)

Parameters

p_enable bool

_set_target_peer(int)

Qualifiers: virtual

Called when the target peer to use is set for this MultiplayerPeer (see MultiplayerPeer.set_target_peer).

void _set_target_peer(int p_peer)

Parameters

p_peer int

_set_transfer_channel(int)

Qualifiers: virtual

Called when the channel to use is set for this MultiplayerPeer (see transfer_channel).

void _set_transfer_channel(int p_channel)

Parameters

p_channel int

_set_transfer_mode(int)

Qualifiers: virtual

Called when the transfer mode is set on this MultiplayerPeer (see transfer_mode).

void _set_transfer_mode(int p_mode)

Parameters

p_mode int