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

Успадковує: MultiplayerPeer < PacketPeer < RefCounted < Object

Базовий клас для сервера WebSocket і клієнта.

Опис

Базовий клас для сервера WebSocket і клієнта, що дозволяє використовувати їх як багатокористувацький одноліток для MultiplayerAPI.

Примітка: При експорті до Android, переконайтеся, що ввімкнути INTERNET дозвіл на експорт Android перед експортуванням проекту або за допомогою однієї кнопки розгортання. Інакше, мережевий зв'язок будь-якого роду буде заблокований Android.

Властивості

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

Методи

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

Описи властивостей

PackedStringArray handshake_headers = PackedStringArray() 🔗

Додаткові заголовки для використання під час змії. Див. WebSocketPeer.handshake_headers для отримання більш детальної інформації.

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

Максимальний час кожен одноліток може залишатися в з'єднаному стані перед скиданням.

int inbound_buffer_size = 65535 🔗

  • void set_inbound_buffer_size(value: int)

  • int get_inbound_buffer_size()

Розмір вхідного буфера для підключених однолітків. Див. WebSocketPeer.inbound_buffer_size для отримання більш детальної інформації.

int max_queued_packets = 4096 🔗

  • void set_max_queued_packets(value: int)

  • int get_max_queued_packets()

Максимальна кількість черги для підключених однолітків. Див. WebSocketPeer.max_queued_packets Детальніше.

int outbound_buffer_size = 65535 🔗

  • void set_outbound_buffer_size(value: int)

  • int get_outbound_buffer_size()

Зовнішній розмір буфера для підключених однолітків. Див. WebSocketPeer.outbound_buffer_size для отримання більш детальної інформації.

PackedStringArray supported_protocols = PackedStringArray() 🔗

Підтримувані WebSocket під-протоколи. Див. WebSocketPeer.supported_protocols для отримання більш детальної інформації.

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

Описи методів

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

Запускає новий багатокористувацький клієнт, який підключається до заданого url. Сертифікати TLS перевірятимуться на ім’я хоста під час підключення за допомогою протоколу wss://. Ви можете передати додатковий параметр tls_client_options, щоб налаштувати довірені центри сертифікації, або вимкнути перевірку загального імені. Перегляньте TLSOptions.client() і TLSOptions.client_unsafe().

Примітка: Рекомендується вказувати частину схеми URL-адреси, тобто url має починатися з ws:// або ``wss:// ``.

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

Запускає новий багатокористувацький сервер, який прослуховує вказаний port. Ви можете за бажанням вказати bind_address та надати дійсний tls_server_options для використання TLS. Див. TLSOptions.server().

WebSocketPeer get_peer(peer_id: int) const 🔗

Повертаємо WebSocketPeer, пов'язану з даним class_id.

String get_peer_address(id: int) const 🔗

Повертає IP-адресу даної фірми.

int get_peer_port(id: int) const 🔗

Повернення віддаленого порту заданого однолітків.