Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

WebSocketMultiplayerPeer

Hereda: MultiplayerPeer < PacketPeer < RefCounted < Object

Clase base para el servidor y cliente de WebSocket.

Descripción

Clase base para el servidor y el cliente de WebSocket, que permite utilizarlos como pares multijugador para la MultiplayerAPI.

Nota: Al exportar a Android, asegúrate de habilitar el permiso INTERNET en el preajuste de exportación de Android antes de exportar el proyecto o utilizar la implementación con un solo clic. De lo contrario, la comunicación de red de cualquier tipo será bloqueada por Android.

Propiedades

PackedStringArray

handshake_headers

PackedStringArray()

float

handshake_timeout

3.0

int

inbound_buffer_size

65535

int

max_queued_packets

4096

int

outbound_buffer_size

65535

PackedStringArray

supported_protocols

PackedStringArray()

Métodos

Error

create_client(url: String, tls_client_options: TLSOptions = null)

Error

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

WebSocketPeer

get_peer(peer_id: int) const

String

get_peer_address(id: int) const

int

get_peer_port(id: int) const

Descripciones de Propiedades

PackedStringArray handshake_headers = PackedStringArray() 🔗

Las cabeceras adicionales que se usarán durante el establecimiento de comunicación. Véase WebSocketPeer.handshake_headers para más detalles.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedStringArray for more details.

float handshake_timeout = 3.0 🔗

  • void set_handshake_timeout(value: float)

  • float get_handshake_timeout()

El tiempo máximo que cada par puede permanecer en un estado de conexión antes de ser descartado.

int inbound_buffer_size = 65535 🔗

  • void set_inbound_buffer_size(value: int)

  • int get_inbound_buffer_size()

El tamaño del búfer de entrada para los pares conectados. Véase WebSocketPeer.inbound_buffer_size para más detalles.

int max_queued_packets = 4096 🔗

  • void set_max_queued_packets(value: int)

  • int get_max_queued_packets()

El número máximo de paquetes en cola para los pares conectados. Véase WebSocketPeer.max_queued_packets para más detalles.

int outbound_buffer_size = 65535 🔗

  • void set_outbound_buffer_size(value: int)

  • int get_outbound_buffer_size()

El tamaño del búfer de salida para los pares conectados. Véase WebSocketPeer.outbound_buffer_size para más detalles.

PackedStringArray supported_protocols = PackedStringArray() 🔗

Los subprotocolos WebSocket soportados. Véase WebSocketPeer.supported_protocols para más detalles.

Note: The returned array is copied and any changes to it will not update the original property value. See PackedStringArray for more details.

Descripciones de Métodos

Error create_client(url: String, tls_client_options: TLSOptions = null) 🔗

Inicia un nuevo cliente multijugador que se conecta a la url dada. Los certificados TLS se verificarán con el nombre de host al conectarse usando el protocolo wss://. Puedes pasar el parámetro opcional tls_client_options para personalizar las autoridades de certificación de confianza, o deshabilitar la verificación de nombre común. Véase TLSOptions.client() y TLSOptions.client_unsafe().

Nota: Se recomienda especificar la parte del esquema de la URL, es decir, la url debe comenzar con ws:// o wss://.

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

Inicia un nuevo servidor multijugador escuchando en el port dado. Opcionalmente puedes especificar una bind_address, y proporcionar válidas tls_server_options para usar TLS. Véase TLSOptions.server().

WebSocketPeer get_peer(peer_id: int) const 🔗

Devuelve el WebSocketPeer asociado al peer_id dado.

String get_peer_address(id: int) const 🔗

Devuelve la dirección IP del par dado.

int get_peer_port(id: int) const 🔗

Devuelve el puerto remoto del par dado.