Files
godot-docs/classes/class_streampeerbuffer.rst
2018-09-21 09:49:38 +02:00

83 lines
3.5 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the StreamPeerBuffer.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_StreamPeerBuffer:
StreamPeerBuffer
================
**Inherits:** :ref:`StreamPeer<class_StreamPeer>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
Properties
----------
+-------------------------------------------+------------------------------------------------------+
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data_array<class_StreamPeerBuffer_data_array>` |
+-------------------------------------------+------------------------------------------------------+
Methods
-------
+--------------------------------------------------+-------------------------------------------------------------------------------------+
| void | :ref:`clear<class_StreamPeerBuffer_clear>` **(** **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`StreamPeerBuffer<class_StreamPeerBuffer>` | :ref:`duplicate<class_StreamPeerBuffer_duplicate>` **(** **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_position<class_StreamPeerBuffer_get_position>` **(** **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_size<class_StreamPeerBuffer_get_size>` **(** **)** const |
+--------------------------------------------------+-------------------------------------------------------------------------------------+
| void | :ref:`resize<class_StreamPeerBuffer_resize>` **(** :ref:`int<class_int>` size **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------+
| void | :ref:`seek<class_StreamPeerBuffer_seek>` **(** :ref:`int<class_int>` position **)** |
+--------------------------------------------------+-------------------------------------------------------------------------------------+
Property Descriptions
---------------------
.. _class_StreamPeerBuffer_data_array:
- :ref:`PoolByteArray<class_PoolByteArray>` **data_array**
+----------+-----------------------+
| *Setter* | set_data_array(value) |
+----------+-----------------------+
| *Getter* | get_data_array() |
+----------+-----------------------+
Method Descriptions
-------------------
.. _class_StreamPeerBuffer_clear:
- void **clear** **(** **)**
.. _class_StreamPeerBuffer_duplicate:
- :ref:`StreamPeerBuffer<class_StreamPeerBuffer>` **duplicate** **(** **)** const
.. _class_StreamPeerBuffer_get_position:
- :ref:`int<class_int>` **get_position** **(** **)** const
.. _class_StreamPeerBuffer_get_size:
- :ref:`int<class_int>` **get_size** **(** **)** const
.. _class_StreamPeerBuffer_resize:
- void **resize** **(** :ref:`int<class_int>` size **)**
.. _class_StreamPeerBuffer_seek:
- void **seek** **(** :ref:`int<class_int>` position **)**