WebSocketClient

Category: Core

A WebSocket client implementation

Properties

Signals

• connection_closed ( was_clean_close )

Emitted when the connection to the server is closed. will be true if the connection was shutdown cleanly.

• connection_error ( )

Emitted when the connection to the server fails.

• data_received ( )

Emitted when a WebSocket message is received. Note: This signal is NOT emitted when used as high level multiplayer peer.

• server_close_request ( int code, reason )

Emitted when the server requests a clean close. You should keep polling until you get a connection_closed signal to achieve the clean close. See for more details.

This class implements a WebSocket client compatible with any RFC 6455 complaint WebSocket server.

This client can be optionally used as a network peer for the MultiplayerAPI.

You will received appropriate signals when connecting, disconnecting, or when new data is available.

Property Descriptions

• verify_ssl

Enable or disable SSL certificate verification. Note: You must specify the certificates to be used in the project settings for it to work when exported.

• Error connect_to_url ( url, PoolStringArray protocols=PoolStringArray( ), gd_mp_api=false )

Connect to the given URL requesting one of the given as sub-protocol.

If true is passed as gd_mp_api, the client will behave like a network peer for the MultiplayerAPI, connections to non Godot servers will not work, and will not be emitted.

Disconnect this client from the connected host. See WebSocketPeer.close for more info.