diff --git a/doc/classes/NetworkedMultiplayerPeer.xml b/doc/classes/NetworkedMultiplayerPeer.xml index 33ffce9cf9b..a7350b3863b 100644 --- a/doc/classes/NetworkedMultiplayerPeer.xml +++ b/doc/classes/NetworkedMultiplayerPeer.xml @@ -1,8 +1,10 @@ + A high-level network interface to simplify multiplayer interactions. + Manages the connection to network peers. Assigns unique IDs to each client connected to the server. @@ -13,31 +15,35 @@ + Returns the current state of the connection. See [enum ConnectionStatus]. + Returns the ID of the [code]NetworkedMultiplayerPeer[/code] who sent the most recent packet. + Returns the ID of this [code]NetworkedMultiplayerPeer[/code]. - Return whether this [code]NetworkedMultiplayerPeer[/code] is refusing new connections. + Returns [code]true[/code] if this [code]NetworkedMultiplayerPeer[/code] refuses new connections. Default value: [code]false[/code]. + Waits up to 1 second to receive a new network event. @@ -46,7 +52,7 @@ - If [code]endable[/code] is true, this [code]NetworkedMultiplayerPeer[/code] will refuse new connections. + If [code]true[/code] this [code]NetworkedMultiplayerPeer[/code] refuses new connections. Default value: [code]false[/code]. @@ -55,6 +61,7 @@ + The peer to which packets will be sent. Default value: [code]0[/code]. @@ -63,56 +70,65 @@ + The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode]. - Emitted when failed to connect to server. + Emitted when a connection attempt fails. - Emitted when successfully connected to server. + Emitted when a connection attempt succeeds. - Emitted by the server when a client is connected. + Emitted by the server when a client connects. - Emitted by the server when a client is disconnected. + Emitted by the server when a client disconnects. - Emitted by clients when server is disconnected. + Emitted by clients when the server disconnects. + Packets are sent via unordered UDP packets. + Packets are sent via ordered UDP packets. + Packets are sent via TCP packets. + The ongoing connection disconnected. + A connection attempt is ongoing. + The connection attempt succeeded. + Packets are sent to the server and then redistributed to other peers. + Packets are sent to the server alone.