Description

Base class for WebSocket server and client, allowing them to be used as multiplayer peer for theMultiplayerAPI.

Note: When exporting to Android, make sure to enable theINTERNET 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

Methods

Property Descriptions

PackedStringArrayhandshake_headers =PackedStringArray()🔗

• voidset_handshake_headers(value:PackedStringArray)

• PackedStringArrayget_handshake_headers()

The extra headers to use during handshake. SeeWebSocketPeer.handshake_headers for more details.

Note: The returned array iscopied and any changes to it will not update the original property value. SeePackedStringArray for more details.

floathandshake_timeout =3.0🔗

• voidset_handshake_timeout(value:float)

• floatget_handshake_timeout()

The maximum time each peer can stay in a connecting state before being dropped.

intinbound_buffer_size =65535🔗

• voidset_inbound_buffer_size(value:int)

• intget_inbound_buffer_size()

The inbound buffer size for connected peers. SeeWebSocketPeer.inbound_buffer_size for more details.

intmax_queued_packets =4096🔗

• voidset_max_queued_packets(value:int)

• intget_max_queued_packets()

The maximum number of queued packets for connected peers. SeeWebSocketPeer.max_queued_packets for more details.

intoutbound_buffer_size =65535🔗

• voidset_outbound_buffer_size(value:int)

• intget_outbound_buffer_size()

The outbound buffer size for connected peers. SeeWebSocketPeer.outbound_buffer_size for more details.

PackedStringArraysupported_protocols =PackedStringArray()🔗

• voidset_supported_protocols(value:PackedStringArray)

• PackedStringArrayget_supported_protocols()

The supported WebSocket sub-protocols. SeeWebSocketPeer.supported_protocols for more details.

Note: The returned array iscopied and any changes to it will not update the original property value. SeePackedStringArray for more details.

Method Descriptions

Errorcreate_client(url:String, tls_client_options:TLSOptions = null)🔗

Starts a new multiplayer client connecting to the givenurl. TLS certificates will be verified against the hostname when connecting using thewss:// protocol. You can pass the optionaltls_client_options parameter to customize the trusted certification authorities, or disable the common name verification. SeeTLSOptions.client() andTLSOptions.client_unsafe().

Note: It is recommended to specify the scheme part of the URL, i.e. theurl should start with eitherws:// orwss://.

Errorcreate_server(port:int, bind_address:String = "*", tls_server_options:TLSOptions = null)🔗

Starts a new multiplayer server listening on the givenport. You can optionally specify abind_address, and provide validtls_server_options to use TLS. SeeTLSOptions.server().

WebSocketPeerget_peer(peer_id:int)const🔗

Returns theWebSocketPeer associated to the givenpeer_id.

Stringget_peer_address(id:int)const🔗

Returns the IP address of the given peer.

intget_peer_port(id:int)const🔗

Returns the remote port of the given peer.