godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch

Browse Source
This commit is contained in:
Rémi Verschelde
2017-04-07 22:11:07 +02:00
parent 447b439db5
commit c282b77a58
392 changed files with 14087 additions and 12472 deletions
Download Patch File Download Diff File Expand all files Collapse all files

134
classes/class_streampeer.rst
View File

@@ -20,71 +20,71 @@ Abstraction and base class for stream-based protocols.
Member Functions
----------------
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_16<class_StreamPeer_get_16>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_32<class_StreamPeer_get_32>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_64<class_StreamPeer_get_64>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_8<class_StreamPeer_get_8>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_available_bytes<class_StreamPeer_get_available_bytes>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_data<class_StreamPeer_get_data>` **(** :ref:`int<class_int>` bytes **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_double<class_StreamPeer_get_double>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_float<class_StreamPeer_get_float>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_partial_data<class_StreamPeer_get_partial_data>` **(** :ref:`int<class_int>` bytes **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_string<class_StreamPeer_get_string>` **(** :ref:`int<class_int>` bytes **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_u16<class_StreamPeer_get_u16>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_u32<class_StreamPeer_get_u32>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_u64<class_StreamPeer_get_u64>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_u8<class_StreamPeer_get_u8>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_utf8_string<class_StreamPeer_get_utf8_string>` **(** :ref:`int<class_int>` bytes **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_var<class_StreamPeer_get_var>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_big_endian_enabled<class_StreamPeer_is_big_endian_enabled>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_16<class_StreamPeer_put_16>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_32<class_StreamPeer_put_32>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_64<class_StreamPeer_put_64>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_8<class_StreamPeer_put_8>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`put_data<class_StreamPeer_put_data>` **(** :ref:`RawArray<class_rawarray>` data **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_double<class_StreamPeer_put_double>` **(** :ref:`float<class_float>` val **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_float<class_StreamPeer_put_float>` **(** :ref:`float<class_float>` val **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`put_partial_data<class_StreamPeer_put_partial_data>` **(** :ref:`RawArray<class_rawarray>` data **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_u16<class_StreamPeer_put_u16>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_u32<class_StreamPeer_put_u32>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_u64<class_StreamPeer_put_u64>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_u8<class_StreamPeer_put_u8>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_utf8_string<class_StreamPeer_put_utf8_string>` **(** :ref:`String<class_string>` val **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_var<class_StreamPeer_put_var>` **(** :ref:`Variant<class_variant>` val **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_big_endian<class_StreamPeer_set_big_endian>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------+
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_16<class_StreamPeer_get_16>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_32<class_StreamPeer_get_32>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_64<class_StreamPeer_get_64>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_8<class_StreamPeer_get_8>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_available_bytes<class_StreamPeer_get_available_bytes>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_data<class_StreamPeer_get_data>` **(** :ref:`int<class_int>` bytes **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_double<class_StreamPeer_get_double>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_float<class_StreamPeer_get_float>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_partial_data<class_StreamPeer_get_partial_data>` **(** :ref:`int<class_int>` bytes **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_string<class_StreamPeer_get_string>` **(** :ref:`int<class_int>` bytes **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_u16<class_StreamPeer_get_u16>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_u32<class_StreamPeer_get_u32>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_u64<class_StreamPeer_get_u64>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_u8<class_StreamPeer_get_u8>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_utf8_string<class_StreamPeer_get_utf8_string>` **(** :ref:`int<class_int>` bytes **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_variant>` | :ref:`get_var<class_StreamPeer_get_var>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_big_endian_enabled<class_StreamPeer_is_big_endian_enabled>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_16<class_StreamPeer_put_16>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_32<class_StreamPeer_put_32>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_64<class_StreamPeer_put_64>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_8<class_StreamPeer_put_8>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`put_data<class_StreamPeer_put_data>` **(** :ref:`PoolByteArray<class_poolbytearray>` data **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_double<class_StreamPeer_put_double>` **(** :ref:`float<class_float>` val **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_float<class_StreamPeer_put_float>` **(** :ref:`float<class_float>` val **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`put_partial_data<class_StreamPeer_put_partial_data>` **(** :ref:`PoolByteArray<class_poolbytearray>` data **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_u16<class_StreamPeer_put_u16>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_u32<class_StreamPeer_put_u32>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_u64<class_StreamPeer_put_u64>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_u8<class_StreamPeer_put_u8>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_utf8_string<class_StreamPeer_put_utf8_string>` **(** :ref:`String<class_string>` val **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`put_var<class_StreamPeer_put_var>` **(** :ref:`Variant<class_variant>` val **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_big_endian<class_StreamPeer_set_big_endian>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -222,7 +222,7 @@ Put a signed byte into the stream.
.. _class_StreamPeer_put_data:
- :ref:`int<class_int>` **put_data** **(** :ref:`RawArray<class_rawarray>` data **)**
- :ref:`int<class_int>` **put_data** **(** :ref:`PoolByteArray<class_poolbytearray>` data **)**
Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code.
@@ -240,7 +240,7 @@ Put a single-precision float into the stream.
.. _class_StreamPeer_put_partial_data:
- :ref:`Array<class_array>` **put_partial_data** **(** :ref:`RawArray<class_rawarray>` data **)**
- :ref:`Array<class_array>` **put_partial_data** **(** :ref:`PoolByteArray<class_poolbytearray>` data **)**
Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent.