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

68 lines
2.0 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Sync with current source Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage).
2018-01-25 07:50:56 +00:00
<class name="PacketPeer" inherits="Reference" category="Core" version="3.0-stable">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Abstraction and base class for packet-based protocols.
</brief_description>
<description>
PacketPeer is an abstraction and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low level bytes or having to worry about network ordering.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="get_available_packet_count" qualifiers="const">
<return type="int">
</return>
<description>
Return the number of packets currently available in the ring-buffer.
</description>
</method>
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00:00
<method name="get_packet">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<return type="PoolByteArray">
</return>
<description>
Get a raw packet.
</description>
</method>
<method name="get_packet_error" qualifiers="const">
<return type="int" enum="Error">
</return>
<description>
Return the error state of the last packet received (via [method get_packet] and [method get_var]).
</description>
</method>
Bind TextEdit.deselect and update documentation
2017-12-16 19:34:16 +00:00
<method name="get_var">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<return type="Variant">
</return>
<description>
Get a Variant.
</description>
</method>
<method name="put_packet">
<return type="int" enum="Error">
</return>
<argument index="0" name="buffer" type="PoolByteArray">
</argument>
<description>
Send a raw packet.
</description>
</method>
<method name="put_var">
<return type="int" enum="Error">
</return>
<argument index="0" name="var" type="Variant">
</argument>
<description>
Send a Variant as a packet.
</description>
</method>
</methods>
Update docs [ci skip]
2018-01-11 22:38:35 +00:00
<members>
<member name="allow_object_decoding" type="bool" setter="set_allow_object_decoding" getter="is_object_decoding_allowed">
</member>
</members>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<constants>
</constants>
</class>