.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/StreamPeer.xml. .. _class_StreamPeer: StreamPeer ========== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` **Inherited By:** :ref:`StreamPeerBuffer`, :ref:`StreamPeerExtension`, :ref:`StreamPeerGZIP`, :ref:`StreamPeerTCP`, :ref:`StreamPeerTLS` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------+---------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`big_endian` | ``false`` | +-------------------------+---------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_8` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_16` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_32` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_64` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_available_bytes` **(** **)** |const| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_data` **(** :ref:`int` bytes **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_double` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_float` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_partial_data` **(** :ref:`int` bytes **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_string` **(** :ref:`int` bytes=-1 **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_u8` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_u16` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_u32` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_u64` **(** **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_utf8_string` **(** :ref:`int` bytes=-1 **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_var` **(** :ref:`bool` allow_objects=false **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_8` **(** :ref:`int` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_16` **(** :ref:`int` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_32` **(** :ref:`int` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_64` **(** :ref:`int` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`put_data` **(** :ref:`PackedByteArray` data **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_double` **(** :ref:`float` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_float` **(** :ref:`float` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`put_partial_data` **(** :ref:`PackedByteArray` data **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_string` **(** :ref:`String` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_u8` **(** :ref:`int` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_u16` **(** :ref:`int` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_u32` **(** :ref:`int` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_u64` **(** :ref:`int` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_utf8_string` **(** :ref:`String` value **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`put_var` **(** :ref:`Variant` value, :ref:`bool` full_objects=false **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_StreamPeer_property_big_endian: .. rst-class:: classref-property :ref:`bool` **big_endian** = ``false`` .. rst-class:: classref-property-setget - void **set_big_endian** **(** :ref:`bool` value **)** - :ref:`bool` **is_big_endian_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_StreamPeer_method_get_8: .. rst-class:: classref-method :ref:`int` **get_8** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_get_16: .. rst-class:: classref-method :ref:`int` **get_16** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_get_32: .. rst-class:: classref-method :ref:`int` **get_32** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_get_64: .. rst-class:: classref-method :ref:`int` **get_64** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_get_available_bytes: .. rst-class:: classref-method :ref:`int` **get_available_bytes** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_get_data: .. rst-class:: classref-method :ref:`Array` **get_data** **(** :ref:`int` bytes **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_get_double: .. rst-class:: classref-method :ref:`float` **get_double** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_get_float: .. rst-class:: classref-method :ref:`float` **get_float** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_get_partial_data: .. rst-class:: classref-method :ref:`Array` **get_partial_data** **(** :ref:`int` bytes **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_get_string: .. rst-class:: classref-method :ref:`String` **get_string** **(** :ref:`int` bytes=-1 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_get_u8: .. rst-class:: classref-method :ref:`int` **get_u8** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_get_u16: .. rst-class:: classref-method :ref:`int` **get_u16** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_get_u32: .. rst-class:: classref-method :ref:`int` **get_u32** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_get_u64: .. rst-class:: classref-method :ref:`int` **get_u64** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_get_utf8_string: .. rst-class:: classref-method :ref:`String` **get_utf8_string** **(** :ref:`int` bytes=-1 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_get_var: .. rst-class:: classref-method :ref:`Variant` **get_var** **(** :ref:`bool` allow_objects=false **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_put_8: .. rst-class:: classref-method void **put_8** **(** :ref:`int` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_put_16: .. rst-class:: classref-method void **put_16** **(** :ref:`int` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_put_32: .. rst-class:: classref-method void **put_32** **(** :ref:`int` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_put_64: .. rst-class:: classref-method void **put_64** **(** :ref:`int` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_put_data: .. rst-class:: classref-method :ref:`Error` **put_data** **(** :ref:`PackedByteArray` data **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_put_double: .. rst-class:: classref-method void **put_double** **(** :ref:`float` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_put_float: .. rst-class:: classref-method void **put_float** **(** :ref:`float` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_put_partial_data: .. rst-class:: classref-method :ref:`Array` **put_partial_data** **(** :ref:`PackedByteArray` data **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_put_string: .. rst-class:: classref-method void **put_string** **(** :ref:`String` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_put_u8: .. rst-class:: classref-method void **put_u8** **(** :ref:`int` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_put_u16: .. rst-class:: classref-method void **put_u16** **(** :ref:`int` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_put_u32: .. rst-class:: classref-method void **put_u32** **(** :ref:`int` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_put_u64: .. rst-class:: classref-method void **put_u64** **(** :ref:`int` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_put_utf8_string: .. rst-class:: classref-method void **put_utf8_string** **(** :ref:`String` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_StreamPeer_method_put_var: .. rst-class:: classref-method void **put_var** **(** :ref:`Variant` value, :ref:`bool` full_objects=false **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`