godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/MultiplayerPeerExtension.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

163 lines
7.4 KiB
XML
Raw Normal View History

[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="MultiplayerPeerExtension" inherits="MultiplayerPeer" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<brief_description>
Document the MultiplayerPeerExtension class
2021-12-08 11:49:22 +00:00
Class that can be inherited to implement custom multiplayer API networking layers via GDExtension.
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</brief_description>
<description>
Document the MultiplayerPeerExtension class
2021-12-08 11:49:22 +00:00
This class is designed to be inherited from a GDExtension plugin to implement custom networking layers for the multiplayer API (such as WebRTC). All the methods below [b]must[/b] be implemented to have a working custom multiplayer implementation. See also [MultiplayerAPI].
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
<tutorials>
</tutorials>
<methods>
[MP] Add MultiplayerPeer disconnect_peer, close. Update ENet, WebRTC, and WebSocket to support peer disconnection and unify the close function.
2022-10-22 15:49:40 +00:00
<method name="_close" qualifiers="virtual">
<return type="void" />
<description>
Called when the multiplayer peer should be immediately closed (see [method MultiplayerPeer.close]).
</description>
</method>
<method name="_disconnect_peer" qualifiers="virtual">
<return type="void" />
<param index="0" name="p_peer" type="int" />
<param index="1" name="p_force" type="bool" />
<description>
Called when the connected [param p_peer] should be forcibly disconnected (see [method MultiplayerPeer.disconnect_peer]).
</description>
</method>
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<method name="_get_available_packet_count" qualifiers="virtual const">
<return type="int" />
<description>
Document the MultiplayerPeerExtension class
2021-12-08 11:49:22 +00:00
Called when the available packet count is internally requested by the [MultiplayerAPI].
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
<method name="_get_connection_status" qualifiers="virtual const">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 03:09:07 +00:00
<return type="int" enum="MultiplayerPeer.ConnectionStatus" />
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<description>
Document the MultiplayerPeerExtension class
2021-12-08 11:49:22 +00:00
Called when the connection status is requested on the [MultiplayerPeer] (see [method MultiplayerPeer.get_connection_status]).
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
<method name="_get_max_packet_size" qualifiers="virtual const">
<return type="int" />
<description>
Document the MultiplayerPeerExtension class
2021-12-08 11:49:22 +00:00
Called when the maximum allowed packet size (in bytes) is requested by the [MultiplayerAPI].
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
<method name="_get_packet" qualifiers="virtual">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 03:09:07 +00:00
<return type="int" enum="Error" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="r_buffer" type="const uint8_t **" />
<param index="1" name="r_buffer_size" type="int32_t*" />
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
Called when a packet needs to be received by the [MultiplayerAPI], with [param r_buffer_size] being the size of the binary [param r_buffer] in bytes.
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
Add missing documentation for MultiplayerPeerExtension (cherry picked from commit 4d13be3c5eab71b04f6d7a0ed9d7e8679b377494)
2023-03-19 19:41:25 +00:00
<method name="_get_packet_channel" qualifiers="virtual const">
<return type="int" />
<description>
Called to get the channel over which the next available packet was received. See [method MultiplayerPeer.get_packet_channel].
</description>
</method>
<method name="_get_packet_mode" qualifiers="virtual const">
<return type="int" enum="MultiplayerPeer.TransferMode" />
<description>
Called to get the [enum MultiplayerPeer.TransferMode] the remote peer used to send the next available packet. See [method MultiplayerPeer.get_packet_mode].
</description>
</method>
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<method name="_get_packet_peer" qualifiers="virtual const">
<return type="int" />
<description>
Document the MultiplayerPeerExtension class
2021-12-08 11:49:22 +00:00
Called when the ID of the [MultiplayerPeer] who sent the most recent packet is requested (see [method MultiplayerPeer.get_packet_peer]).
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
Allow extending MultiplayerPeerExtension from GDScript
2022-07-20 19:43:34 +00:00
<method name="_get_packet_script" qualifiers="virtual">
<return type="PackedByteArray" />
<description>
Called when a packet needs to be received by the [MultiplayerAPI], if [method _get_packet] isn't implemented. Use this when extending this class via GDScript.
</description>
</method>
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<method name="_get_transfer_channel" qualifiers="virtual const">
<return type="int" />
<description>
Document the MultiplayerPeerExtension class
2021-12-08 11:49:22 +00:00
Called when the transfer channel to use is read on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_channel]).
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
<method name="_get_transfer_mode" qualifiers="virtual const">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 03:09:07 +00:00
<return type="int" enum="MultiplayerPeer.TransferMode" />
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<description>
Document the MultiplayerPeerExtension class
2021-12-08 11:49:22 +00:00
Called when the transfer mode to use is read on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_mode]).
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
<method name="_get_unique_id" qualifiers="virtual const">
<return type="int" />
<description>
Add missing documentation for MultiplayerPeerExtension (cherry picked from commit 4d13be3c5eab71b04f6d7a0ed9d7e8679b377494)
2023-03-19 19:41:25 +00:00
Called when the unique ID of this [MultiplayerPeer] is requested (see [method MultiplayerPeer.get_unique_id]). The value must be between [code]1[/code] and [code]2147483647[/code].
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
<method name="_is_refusing_new_connections" qualifiers="virtual const">
<return type="bool" />
<description>
Document the MultiplayerPeerExtension class
2021-12-08 11:49:22 +00:00
Called when the "refuse new connections" status is requested on this [MultiplayerPeer] (see [member MultiplayerPeer.refuse_new_connections]).
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
<method name="_is_server" qualifiers="virtual const">
<return type="bool" />
<description>
Document the MultiplayerPeerExtension class
2021-12-08 11:49:22 +00:00
Called when the "is server" status is requested on the [MultiplayerAPI]. See [method MultiplayerAPI.is_server].
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
Add missing documentation for MultiplayerPeerExtension (cherry picked from commit 4d13be3c5eab71b04f6d7a0ed9d7e8679b377494)
2023-03-19 19:41:25 +00:00
<method name="_is_server_relay_supported" qualifiers="virtual const">
<return type="bool" />
<description>
Called to check if the server can act as a relay in the current configuration. See [method MultiplayerPeer.is_server_relay_supported].
</description>
</method>
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<method name="_poll" qualifiers="virtual">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 03:09:07 +00:00
<return type="void" />
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<description>
Document the MultiplayerPeerExtension class
2021-12-08 11:49:22 +00:00
Called when the [MultiplayerAPI] is polled. See [method MultiplayerAPI.poll].
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
<method name="_put_packet" qualifiers="virtual">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 03:09:07 +00:00
<return type="int" enum="Error" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="p_buffer" type="const uint8_t*" />
<param index="1" name="p_buffer_size" type="int" />
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 13:36:48 +00:00
Called when a packet needs to be sent by the [MultiplayerAPI], with [param p_buffer_size] being the size of the binary [param p_buffer] in bytes.
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
Allow extending MultiplayerPeerExtension from GDScript
2022-07-20 19:43:34 +00:00
<method name="_put_packet_script" qualifiers="virtual">
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 03:09:07 +00:00
<return type="int" enum="Error" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="p_buffer" type="PackedByteArray" />
Allow extending MultiplayerPeerExtension from GDScript
2022-07-20 19:43:34 +00:00
<description>
Called when a packet needs to be sent by the [MultiplayerAPI], if [method _put_packet] isn't implemented. Use this when extending this class via GDScript.
</description>
</method>
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<method name="_set_refuse_new_connections" qualifiers="virtual">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="p_enable" type="bool" />
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<description>
Document the MultiplayerPeerExtension class
2021-12-08 11:49:22 +00:00
Called when the "refuse new connections" status is set on this [MultiplayerPeer] (see [member MultiplayerPeer.refuse_new_connections]).
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
<method name="_set_target_peer" qualifiers="virtual">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="p_peer" type="int" />
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<description>
Document the MultiplayerPeerExtension class
2021-12-08 11:49:22 +00:00
Called when the target peer to use is set for this [MultiplayerPeer] (see [method MultiplayerPeer.set_target_peer]).
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
<method name="_set_transfer_channel" qualifiers="virtual">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="p_channel" type="int" />
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<description>
Document the MultiplayerPeerExtension class
2021-12-08 11:49:22 +00:00
Called when the channel to use is set for this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_channel]).
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
<method name="_set_transfer_mode" qualifiers="virtual">
<return type="void" />
Simplify network GDExtension bindings using EXBIND macros. Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
2022-09-01 03:09:07 +00:00
<param index="0" name="p_mode" type="int" enum="MultiplayerPeer.TransferMode" />
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
<description>
Document the MultiplayerPeerExtension class
2021-12-08 11:49:22 +00:00
Called when the transfer mode is set on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_mode]).
[Net/Docs] Update extensions documentation.
2021-09-07 23:50:22 +00:00
</description>
</method>
</methods>
</class>