mirror of
https://github.com/Relintai/pandemonium_engine_docs.git
synced 2025-01-21 15:07:22 +01:00
95 lines
4.1 KiB
ReStructuredText
95 lines
4.1 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.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>`
|
|
|
|
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-------------------------------------------+---------------------------------------------------------------+-----------------------+
|
|
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data_array<class_StreamPeerBuffer_property_data_array>` | ``PoolByteArray( )`` |
|
|
+-------------------------------------------+---------------------------------------------------------------+-----------------------+
|
|
|
|
Methods
|
|
-------
|
|
|
|
+-------------------------------------------------+--------------------------------------------------------------------------------------------+
|
|
| void | :ref:`clear<class_StreamPeerBuffer_method_clear>` **(** **)** |
|
|
+-------------------------------------------------+--------------------------------------------------------------------------------------------+
|
|
| :ref:`StreamPeerBuffer<class_StreamPeerBuffer>` | :ref:`duplicate<class_StreamPeerBuffer_method_duplicate>` **(** **)** |const| |
|
|
+-------------------------------------------------+--------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_position<class_StreamPeerBuffer_method_get_position>` **(** **)** |const| |
|
|
+-------------------------------------------------+--------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_size<class_StreamPeerBuffer_method_get_size>` **(** **)** |const| |
|
|
+-------------------------------------------------+--------------------------------------------------------------------------------------------+
|
|
| void | :ref:`resize<class_StreamPeerBuffer_method_resize>` **(** :ref:`int<class_int>` size **)** |
|
|
+-------------------------------------------------+--------------------------------------------------------------------------------------------+
|
|
| void | :ref:`seek<class_StreamPeerBuffer_method_seek>` **(** :ref:`int<class_int>` position **)** |
|
|
+-------------------------------------------------+--------------------------------------------------------------------------------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_StreamPeerBuffer_property_data_array:
|
|
|
|
- :ref:`PoolByteArray<class_PoolByteArray>` **data_array**
|
|
|
|
+-----------+-----------------------+
|
|
| *Default* | ``PoolByteArray( )`` |
|
|
+-----------+-----------------------+
|
|
| *Setter* | set_data_array(value) |
|
|
+-----------+-----------------------+
|
|
| *Getter* | get_data_array() |
|
|
+-----------+-----------------------+
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_StreamPeerBuffer_method_clear:
|
|
|
|
- void **clear** **(** **)**
|
|
|
|
----
|
|
|
|
.. _class_StreamPeerBuffer_method_duplicate:
|
|
|
|
- :ref:`StreamPeerBuffer<class_StreamPeerBuffer>` **duplicate** **(** **)** |const|
|
|
|
|
----
|
|
|
|
.. _class_StreamPeerBuffer_method_get_position:
|
|
|
|
- :ref:`int<class_int>` **get_position** **(** **)** |const|
|
|
|
|
----
|
|
|
|
.. _class_StreamPeerBuffer_method_get_size:
|
|
|
|
- :ref:`int<class_int>` **get_size** **(** **)** |const|
|
|
|
|
----
|
|
|
|
.. _class_StreamPeerBuffer_method_resize:
|
|
|
|
- void **resize** **(** :ref:`int<class_int>` size **)**
|
|
|
|
----
|
|
|
|
.. _class_StreamPeerBuffer_method_seek:
|
|
|
|
- void **seek** **(** :ref:`int<class_int>` position **)**
|
|
|
|
.. |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.)`
|