asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #13948 from willnationsdev/multiplayernetworkpeer-docs

Browse source 
[DOCS] NetworkedMultiplayerPeer class, methods, & constants

[ci skip]
This commit is contained in:
Rémi Verschelde 2017-12-06 23:22:32 +01:00 committed by GitHub
commit 58abea1ff6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
doc/classes/NetworkedMultiplayerPeer.xml
View file

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="NetworkedMultiplayerPeer" inherits="PacketPeer" category="Core" version="3.0-beta">
<brief_description>
A high-level network interface to simplify multiplayer interactions.
</brief_description>
<description>
Manages the connection to network peers. Assigns unique IDs to each client connected to the server.
</description>
<tutorials>
</tutorials>
@ -13,31 +15,35 @@
<return type="int" enum="NetworkedMultiplayerPeer.ConnectionStatus">
</return>
<description>
Returns the current state of the connection. See [enum ConnectionStatus].
</description>
</method>
<method name="get_packet_peer" qualifiers="const">
<return type="int">
</return>
<description>
Returns the ID of the [code]NetworkedMultiplayerPeer[/code] who sent the most recent packet.
</description>
</method>
<method name="get_unique_id" qualifiers="const">
<return type="int">
</return>
<description>
Returns the ID of this [code]NetworkedMultiplayerPeer[/code].
</description>
</method>
<method name="is_refusing_new_connections" qualifiers="const">
<return type="bool">
</return>
<description>
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].
</description>
</method>
<method name="poll">
<return type="void">
</return>
<description>
Waits up to 1 second to receive a new network event.
</description>
</method>
<method name="set_refuse_new_connections">
@ -46,7 +52,7 @@
<argument index="0" name="enable" type="bool">
</argument>
<description>
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].
</description>
</method>
<method name="set_target_peer">
@ -55,6 +61,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
The peer to which packets will be sent. Default value: [code]0[/code].
</description>
</method>
<method name="set_transfer_mode">
@ -63,56 +70,65 @@
<argument index="0" name="mode" type="int" enum="NetworkedMultiplayerPeer.TransferMode">
</argument>
<description>
The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode].
</description>
</method>
</methods>
<signals>
<signal name="connection_failed">
<description>
Emitted when failed to connect to server.
Emitted when a connection attempt fails.
</description>
</signal>
<signal name="connection_succeeded">
<description>
Emitted when successfully connected to server.
Emitted when a connection attempt succeeds.
</description>
</signal>
<signal name="peer_connected">
<argument index="0" name="id" type="int">
</argument>
<description>
Emitted by the server when a client is connected.
Emitted by the server when a client connects.
</description>
</signal>
<signal name="peer_disconnected">
<argument index="0" name="id" type="int">
</argument>
<description>
Emitted by the server when a client is disconnected.
Emitted by the server when a client disconnects.
</description>
</signal>
<signal name="server_disconnected">
<description>
Emitted by clients when server is disconnected.
Emitted by clients when the server disconnects.
</description>
</signal>
</signals>
<constants>
<constant name="TRANSFER_MODE_UNRELIABLE" value="0" enum="TransferMode">
Packets are sent via unordered UDP packets.
</constant>
<constant name="TRANSFER_MODE_UNRELIABLE_ORDERED" value="1" enum="TransferMode">
Packets are sent via ordered UDP packets.
</constant>
<constant name="TRANSFER_MODE_RELIABLE" value="2" enum="TransferMode">
Packets are sent via TCP packets.
</constant>
<constant name="CONNECTION_DISCONNECTED" value="0" enum="ConnectionStatus">
The ongoing connection disconnected.
</constant>
<constant name="CONNECTION_CONNECTING" value="1" enum="ConnectionStatus">
A connection attempt is ongoing.
</constant>
<constant name="CONNECTION_CONNECTED" value="2" enum="ConnectionStatus">
The connection attempt succeeded.
</constant>
<constant name="TARGET_PEER_BROADCAST" value="0">
Packets are sent to the server and then redistributed to other peers.
</constant>
<constant name="TARGET_PEER_SERVER" value="1">
Packets are sent to the server alone.
</constant>
</constants>
</class>