godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #64585 from dsnopek/multiplayer-custom-docs-improvements-2 

[3.x] Update NetworkedMultiplayerCustom.xml with more explicit documentation to guide usage
This commit is contained in:
Rémi Verschelde 2023-06-02 17:20:51 +02:00
parent 9cbf7971e4 d3ae6566b4
commit 56df1841f1
No known key found for this signature in database
GPG Key ID: C3336907360768E1
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/classes/NetworkedMultiplayerCustom.xml
View File

@ -23,7 +23,7 @@
<return type="void" /> <return type="void" />
<argument index="0" name="self_peer_id" type="int" /> <argument index="0" name="self_peer_id" type="int" />
<description> <description>
Initialize the peer with the given [code]peer_id[/code] (must be between 1 and 2147483647). Initialize the peer with the given [code]self_peer_id[/code] (must be between 1 and 2147483647).
Can only be called if the connection status is [constant NetworkedMultiplayerPeer.CONNECTION_CONNECTING]. See [method set_connection_status]. Can only be called if the connection status is [constant NetworkedMultiplayerPeer.CONNECTION_CONNECTING]. See [method set_connection_status].
</description> </description>
</method> </method>
@ -50,7 +50,7 @@
<argument index="1" name="buffer" type="PoolByteArray" /> <argument index="1" name="buffer" type="PoolByteArray" />
<argument index="2" name="transfer_mode" type="int" /> <argument index="2" name="transfer_mode" type="int" />
<description> <description>
Emitted when the local [MultiplayerAPI] generates a packet. Emitted when the local [MultiplayerAPI] generates a packet (e.g. when calling [method Node.rpc]).
Your script should take this packet and send it to the requested peer over the network (which should call [method deliver_packet] with the data when it's received). Your script should take this packet and send it to the requested peer over the network (which should call [method deliver_packet] with the data when it's received).
</description> </description>
</signal> </signal>