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

Eredita: MultiplayerPeer < PacketPeer < RefCounted < Object

Classe di base per server WebSocket e client.

Descrizione

Classe di base per server WebSocket e client, permettendo loro di essere utilizzati come peer multigiocatore per il MultiplayerAPI.

Nota: Quando si esporta su Android, assicurarsi di abilitare l'autorizzazione INTERNET nella preimpostazione d'esportazione Android prima di esportare il progetto o di utilizzare la distribuzione con un clic. Altrimenti, qualsiasi tipo di comunicazione di rete sarà bloccata da Android.

Proprietà

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()

Metodi

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

Descrizioni delle proprietà

PackedStringArray handshake_headers = PackedStringArray() 🔗

Gli header aggiuntivi da usare durante l'handshake. Vedi WebSocketPeer.handshake_headers per ulteriori dettagli.

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()

Il tempo massimo che ogni peer può rimanere in uno stato di connessione prima di essere rinunciato.

int inbound_buffer_size = 65535 🔗

  • void set_inbound_buffer_size(value: int)

  • int get_inbound_buffer_size()

La dimensione del buffer in entrata per i peer collegati. Vedi WebSocketPeer.inbound_buffer_size per ulteriori dettagli.

int max_queued_packets = 4096 🔗

  • void set_max_queued_packets(value: int)

  • int get_max_queued_packets()

Il numero massimo di pacchetti in coda per i peer collegati. Vedi WebSocketPeer.max_queued_packets per ulteriori dettagli.

int outbound_buffer_size = 65535 🔗

  • void set_outbound_buffer_size(value: int)

  • int get_outbound_buffer_size()

La dimensione del buffer in uscita per i peer collegati. Vedi WebSocketPeer.outbound_buffer_size per ulteriori dettagli.

PackedStringArray supported_protocols = PackedStringArray() 🔗

I sotto-protocolli dei WebSocket supportati. Vedi WebSocketPeer.supported_protocols per ulteriori dettagli.

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

Descrizioni dei metodi

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

Avvia un nuovo client multigiocatore che si connette al dato url. I certificati TLS saranno verificati contro il nome host durante la connessione utilizzando il protocollo wss://. È possibile passare il parametro opzionale tls_client_options per personalizzare le autorità di certificazione di fiducia, o disabilitare la verifica dei nomi comuni. Vedi TLSOptions.client() e TLSOptions.client_unsafe().

Nota: Si raccomanda di specificare la parte di schema dell'URL, ossia l'url dovrebbe iniziare con ws:// o wss://.

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

Avvia un nuovo server multigiocatore che ascolta la porta port. È possibile specificare facoltativamente un bind_address, e fornire valide opzioni (tls_server_options) per utilizzare TLS. Vedi TLSOptions.server().

WebSocketPeer get_peer(peer_id: int) const 🔗

Restituisce il WebSocketPeer associato al peer_id fornito.

String get_peer_address(id: int) const 🔗

Restituisce l'indirizzo IP del peer fornito.

int get_peer_port(id: int) const 🔗

Restituisce la porta remota del peer fornito.