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...

MultiplayerPeer

Hérite de : PacketPeer < RefCounted < Object

Hérité par : ENetMultiplayerPeer, MultiplayerPeerExtension, OfflineMultiplayerPeer, WebRTCMultiplayerPeer, WebSocketMultiplayerPeer

Classe abstraite pour les PacketPeers spécialisés utilisés par la MultiplayerAPI.

Description

Manages the connection with one or more remote peers acting as server or client and assigning unique IDs to each of them. See also MultiplayerAPI.

Note: The MultiplayerAPI protocol is an implementation detail and isn't meant to be used by non-Godot servers. It may change without notice.

Note: When exporting to Android, make sure to enable the INTERNET permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.

Tutoriels

Propriétés

bool

refuse_new_connections

false

int

transfer_channel

0

TransferMode

transfer_mode

2

Méthodes

void

close()

void

disconnect_peer(peer: int, force: bool = false)

int

generate_unique_id() const

ConnectionStatus

get_connection_status() const

int

get_packet_channel() const

TransferMode

get_packet_mode() const

int

get_packet_peer() const

int

get_unique_id() const

bool

is_server_relay_supported() const

void

poll()

void

set_target_peer(id: int)

Signaux

peer_connected(id: int) 🔗

Emitted when a remote peer connects.

peer_disconnected(id: int) 🔗

Émis quand un pair distant a déconnecté.

Énumérations

enum ConnectionStatus: 🔗

ConnectionStatus CONNECTION_DISCONNECTED = 0

Le MultiplayerPeer est déconnecté.

ConnectionStatus CONNECTION_CONNECTING = 1

Le MultijoueurPeer se connecte actuellement à un serveur.

ConnectionStatus CONNECTION_CONNECTED = 2

Ce MultiplayerPeer est connecté.

enum TransferMode: 🔗

TransferMode TRANSFER_MODE_UNRELIABLE = 0

Les paquets ne sont pas reconnus, aucune tentative de ré-envoi n'est faite pour les paquets perdus. Les paquets peuvent arriver dans n'importe quelle commande. Peut être plus rapide que TRANSFER_MODE_UNRELIABLE_ORDERED. À utiliser pour des données non critiques, et toujours à considérer si l'ordre compte.

TransferMode TRANSFER_MODE_UNRELIABLE_ORDERED = 1

Les paquets ne sont pas reconnus, aucune tentative de ré-envoi n'est faite pour les paquets perdus. Les paquets sont reçus dans l'ordre où ils ont été envoyés. Peut être plus rapide que TRANSFER_MODE_RELIABLE. À utiliser pour les données non critiques ou qui seraient périmées si elles étaient reçues tardivement à cause du ré-envoi, par exemple pour les données de mouvement et de positionnement.

TransferMode TRANSFER_MODE_RELIABLE = 2

Les paquets doivent être reçus et les tentatives de ré-envoi doivent être faites jusqu'à ce que les paquets soient reconnus. Les paquets doivent être reçus dans l'ordre où ils ont été envoyés. C'est le mode de transfert le plus fiable, mais potentiellement le plus lent en cause de la surcharge. À utiliser pour les données critiques qui doivent être transmises et arriver en ordre, par exemple un élément activé ou un message de discussion. À considérez soigneusement si l'information est vraiment critique, et à utiliser avec parcimonie.

Constantes

TARGET_PEER_BROADCAST = 0 🔗

Les paquets sont envoyés à tous les pairs connectés.

TARGET_PEER_SERVER = 1 🔗

Les paquets sont envoyés au pair distant agissant comme serveur.

Descriptions des propriétés

bool refuse_new_connections = false 🔗

  • void set_refuse_new_connections(value: bool)

  • bool is_refusing_new_connections()

If true, this MultiplayerPeer refuses new connections.

int transfer_channel = 0 🔗

  • void set_transfer_channel(value: int)

  • int get_transfer_channel()

The channel to use to send packets. Many network APIs such as ENet and WebRTC allow the creation of multiple independent channels which behaves, in a way, like separate connections. This means that reliable data will only block delivery of other packets on that channel, and ordering will only be in respect to the channel the packet is being sent on. Using different channels to send different and independent state updates is a common way to optimize network usage and decrease latency in fast-paced games.

Note: The default channel (0) actually works as 3 separate channels (one for each TransferMode) so that TRANSFER_MODE_RELIABLE and TRANSFER_MODE_UNRELIABLE_ORDERED does not interact with each other by default. Refer to the specific network API documentation (e.g. ENet or WebRTC) to learn how to set up channels correctly.

TransferMode transfer_mode = 2 🔗

The manner in which to send packets to the target peer. See the set_target_peer() method.

Descriptions des méthodes

void close() 🔗

Immediately close the multiplayer peer returning to the state CONNECTION_DISCONNECTED. Connected peers will be dropped without emitting peer_disconnected.

void disconnect_peer(peer: int, force: bool = false) 🔗

Disconnects the given peer from this host. If force is true the peer_disconnected signal will not be emitted for this peer.

int generate_unique_id() const 🔗

Returns a randomly generated integer that can be used as a network unique ID.

ConnectionStatus get_connection_status() const 🔗

Renvoie l'état actuel de la connexion.

int get_packet_channel() const 🔗

Returns the channel over which the next available packet was received. See PacketPeer.get_available_packet_count().

TransferMode get_packet_mode() const 🔗

Returns the transfer mode the remote peer used to send the next available packet. See PacketPeer.get_available_packet_count().

int get_packet_peer() const 🔗

Returns the ID of the MultiplayerPeer who sent the next available packet. See PacketPeer.get_available_packet_count().

int get_unique_id() const 🔗

Returns the ID of this MultiplayerPeer.

bool is_server_relay_supported() const 🔗

Returns true if the server can act as a relay in the current configuration. That is, if the higher level MultiplayerAPI should notify connected clients of other peers, and implement a relay protocol to allow communication between them.

void poll() 🔗

Attend jusqu'à 1 seconde de recevoir un nouvel événement réseau.

void set_target_peer(id: int) 🔗

Sets the peer to which packets will be sent.

The id can be one of: TARGET_PEER_BROADCAST to send to all connected peers, TARGET_PEER_SERVER to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. By default, the target peer is TARGET_PEER_BROADCAST.