Class reference
WebSocketMultiplayerPeer
Inherits MultiplayerPeer
Base class for WebSocket server and client.
Description
Base class for WebSocket server and client, allowing them to be used as multiplayer peer for the MultiplayerAPI. Note: When exporting to Android, make sure to enable the INTERNET permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.
Properties
PackedStringArray handshake_headers = PackedStringArray()
PackedStringArray handshake_headers = PackedStringArray()The extra headers to use during handshake. See WebSocketPeer.handshake_headers for more details.
float handshake_timeout = 3.0
float handshake_timeout = 3.0The maximum time each peer can stay in a connecting state before being dropped.
int inbound_buffer_size = 65535
int inbound_buffer_size = 65535The inbound buffer size for connected peers. See WebSocketPeer.inbound_buffer_size for more details.
int max_queued_packets = 4096
int max_queued_packets = 4096The maximum number of queued packets for connected peers. See WebSocketPeer.max_queued_packets for more details.
int outbound_buffer_size = 65535
int outbound_buffer_size = 65535The outbound buffer size for connected peers. See WebSocketPeer.outbound_buffer_size for more details.
PackedStringArray supported_protocols = PackedStringArray()
PackedStringArray supported_protocols = PackedStringArray()The supported WebSocket sub-protocols. See WebSocketPeer.supported_protocols for more details.
Methods
int create_client(String url, TLSOptions tls_client_options = null)
int create_client(String url, TLSOptions tls_client_options = null)Starts a new multiplayer client connecting to the given url. TLS certificates will be verified against the hostname when connecting using the wss:// protocol. You can pass the optional tls_client_options parameter to customize the trusted certification authorities, or disable the common name verification. See TLSOptions.client() and TLSOptions.client_unsafe(). Note: It is recommended to specify the scheme part of the URL, i.e. the url should start with either ws:// or wss://.
int create_server(int port, String bind_address = "*", TLSOptions tls_server_options = null)
int create_server(int port, String bind_address = "*", TLSOptions tls_server_options = null)Starts a new multiplayer server listening on the given port. You can optionally specify a bind_address, and provide valid tls_server_options to use TLS. See TLSOptions.server().
WebSocketPeer get_peer(int peer_id) const
WebSocketPeer get_peer(int peer_id) constReturns the WebSocketPeer associated to the given peer_id.
String get_peer_address(int id) const
String get_peer_address(int id) constReturns the IP address of the given peer.
int get_peer_port(int id) const
int get_peer_port(int id) constReturns the remote port of the given peer.