MultiplayerPeerExtension

Наследует: MultiplayerPeer < PacketPeer < RefCounted < Object

Класс, который можно унаследовать для реализации пользовательских сетевых уровней многопользовательского API через GDExtension.

Описание

Этот класс предназначен для наследования от плагина GDExtension для реализации пользовательских сетевых слоев для API многопользовательского режима (например, WebRTC). Все методы ниже должны быть реализованы для рабочей реализации пользовательского многопользовательского режима. См. также MultiplayerAPI.

Методы

void	_close() virtual required
void	_disconnect_peer(p_peer: int, p_force: bool) virtual required
int	_get_available_packet_count() virtual required const
ConnectionStatus	_get_connection_status() virtual required const
int	_get_max_packet_size() virtual required const
Error	_get_packet(r_buffer: `const uint8_t *`, r_buffer_size: `int32_t`) virtual
int	_get_packet_channel() virtual required const
TransferMode	_get_packet_mode() virtual required const
int	_get_packet_peer() virtual required const
PackedByteArray	_get_packet_script() virtual
int	_get_transfer_channel() virtual required const
TransferMode	_get_transfer_mode() virtual required const
int	_get_unique_id() virtual required const
bool	_is_refusing_new_connections() virtual const
bool	_is_server() virtual required const
bool	_is_server_relay_supported() virtual const
void	_poll() virtual required
Error	_put_packet(p_buffer: `const uint8_t*`, p_buffer_size: int) virtual
Error	_put_packet_script(p_buffer: PackedByteArray) virtual
void	_set_refuse_new_connections(p_enable: bool) virtual
void	_set_target_peer(p_peer: int) virtual required
void	_set_transfer_channel(p_channel: int) virtual required
void	_set_transfer_mode(p_mode: TransferMode) virtual required

Описания метода

void _close() virtual required 🔗

Вызывается, когда многопользовательский пир должен быть немедленно закрыт (см. MultiplayerPeer.close()).

void _disconnect_peer(p_peer: int, p_force: bool) virtual required 🔗

Вызывается, когда подключенный p_peer должен быть принудительно отключен (см. MultiplayerPeer.disconnect_peer()).

int _get_available_packet_count() virtual required const 🔗

Вызывается, когда MultiplayerAPI внутренне запрашивает доступное количество пакетов.

ConnectionStatus _get_connection_status() virtual required const 🔗

Вызывается при запросе статуса соединения на MultiplayerPeer (см. MultiplayerPeer.get_connection_status()).

int _get_max_packet_size() virtual required const 🔗

Вызывается, когда MultiplayerAPI запрашивает максимально допустимый размер пакета (в байтах).

Error _get_packet(r_buffer: const uint8_t **, r_buffer_size: int32_t*) virtual 🔗

Вызывается, когда MultiplayerAPI необходимо получить пакет, при этом r_buffer_size представляет собой размер двоичного файла r_buffer в байтах.

int _get_packet_channel() virtual required const 🔗

Вызывается для получения канала, по которому был получен следующий доступный пакет. См. MultiplayerPeer.get_packet_channel().

TransferMode _get_packet_mode() virtual required const 🔗

Вызывается для получения режима передачи, который удаленный узел использовал для отправки следующего доступного пакета. См. MultiplayerPeer.get_packet_mode().

int _get_packet_peer() virtual required const 🔗

Вызывается при запросе идентификатора MultiplayerPeer, отправившего последний пакет (см. MultiplayerPeer.get_packet_peer()).

PackedByteArray _get_packet_script() virtual 🔗

Вызывается, когда пакет должен быть получен MultiplayerAPI, если _get_packet() не реализован. Используйте это при расширении этого класса через GDScript.

int _get_transfer_channel() virtual required const 🔗

Вызывается, когда используемый канал передачи считывается на этом MultiplayerPeer (см. MultiplayerPeer.transfer_channel).

TransferMode _get_transfer_mode() virtual required const 🔗

Вызывается, когда используемый режим передачи считывается на этом MultiplayerPeer (см. MultiplayerPeer.transfer_mode).

int _get_unique_id() virtual required const 🔗

Вызывается, когда запрашивается уникальный идентификатор этого MultiplayerPeer (см. MultiplayerPeer.get_unique_id()). Значение должно быть между 1 и 2147483647.

bool _is_refusing_new_connections() virtual const 🔗

Вызывается, когда на этом MultiplayerPeer запрашивается статус «отклонить новые подключения» (см. MultiplayerPeer.refuse_new_connections).

bool _is_server() virtual required const 🔗

Вызывается, когда запрашивается статус «is server» в MultiplayerAPI. См. MultiplayerAPI.is_server().

bool _is_server_relay_supported() virtual const 🔗

Вызывается для проверки, может ли сервер работать как ретранслятор в текущей конфигурации. См. MultiplayerPeer.is_server_relay_supported().

void _poll() virtual required 🔗

Вызывается при опросе MultiplayerAPI. См. MultiplayerAPI.poll().

Error _put_packet(p_buffer: const uint8_t*, p_buffer_size: int) virtual 🔗

Вызывается, когда MultiplayerAPI необходимо отправить пакет, при этом p_buffer_size представляет собой размер двоичного файла p_buffer в байтах.

Error _put_packet_script(p_buffer: PackedByteArray) virtual 🔗

Вызывается, когда пакет должен быть отправлен MultiplayerAPI, если _put_packet() не реализован. Используйте это при расширении этого класса через GDScript.

void _set_refuse_new_connections(p_enable: bool) virtual 🔗

Вызывается, когда на этом MultiplayerPeer установлен статус «отклонять новые подключения» (см. MultiplayerPeer.refuse_new_connections).

void _set_target_peer(p_peer: int) virtual required 🔗

Вызывается, когда для этого MultiplayerPeer задан целевой одноранговый узел (см. MultiplayerPeer.set_target_peer()).

void _set_transfer_channel(p_channel: int) virtual required 🔗

Вызывается, когда для этого MultiplayerPeer задан используемый канал (см. MultiplayerPeer.transfer_channel).

void _set_transfer_mode(p_mode: TransferMode) virtual required 🔗

Вызывается, когда на этом MultiplayerPeer установлен режим передачи (см. MultiplayerPeer.transfer_mode).