class_streampeerbuffer.rst 4.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the StreamPeerBuffer.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_StreamPeerBuffer:
  6. StreamPeerBuffer
  7. ================
  8. **Inherits:** :ref:`StreamPeer<class_StreamPeer>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Properties
  10. ----------
  11. +-------------------------------------------+---------------------------------------------------------------+-----------------------+
  12. | :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data_array<class_StreamPeerBuffer_property_data_array>` | ``PoolByteArray( )`` |
  13. +-------------------------------------------+---------------------------------------------------------------+-----------------------+
  14. Methods
  15. -------
  16. +-------------------------------------------------+--------------------------------------------------------------------------------------------+
  17. | void | :ref:`clear<class_StreamPeerBuffer_method_clear>` **(** **)** |
  18. +-------------------------------------------------+--------------------------------------------------------------------------------------------+
  19. | :ref:`StreamPeerBuffer<class_StreamPeerBuffer>` | :ref:`duplicate<class_StreamPeerBuffer_method_duplicate>` **(** **)** |const| |
  20. +-------------------------------------------------+--------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`get_position<class_StreamPeerBuffer_method_get_position>` **(** **)** |const| |
  22. +-------------------------------------------------+--------------------------------------------------------------------------------------------+
  23. | :ref:`int<class_int>` | :ref:`get_size<class_StreamPeerBuffer_method_get_size>` **(** **)** |const| |
  24. +-------------------------------------------------+--------------------------------------------------------------------------------------------+
  25. | void | :ref:`resize<class_StreamPeerBuffer_method_resize>` **(** :ref:`int<class_int>` size **)** |
  26. +-------------------------------------------------+--------------------------------------------------------------------------------------------+
  27. | void | :ref:`seek<class_StreamPeerBuffer_method_seek>` **(** :ref:`int<class_int>` position **)** |
  28. +-------------------------------------------------+--------------------------------------------------------------------------------------------+
  29. Property Descriptions
  30. ---------------------
  31. .. _class_StreamPeerBuffer_property_data_array:
  32. - :ref:`PoolByteArray<class_PoolByteArray>` **data_array**
  33. +-----------+-----------------------+
  34. | *Default* | ``PoolByteArray( )`` |
  35. +-----------+-----------------------+
  36. | *Setter* | set_data_array(value) |
  37. +-----------+-----------------------+
  38. | *Getter* | get_data_array() |
  39. +-----------+-----------------------+
  40. Method Descriptions
  41. -------------------
  42. .. _class_StreamPeerBuffer_method_clear:
  43. - void **clear** **(** **)**
  44. ----
  45. .. _class_StreamPeerBuffer_method_duplicate:
  46. - :ref:`StreamPeerBuffer<class_StreamPeerBuffer>` **duplicate** **(** **)** |const|
  47. ----
  48. .. _class_StreamPeerBuffer_method_get_position:
  49. - :ref:`int<class_int>` **get_position** **(** **)** |const|
  50. ----
  51. .. _class_StreamPeerBuffer_method_get_size:
  52. - :ref:`int<class_int>` **get_size** **(** **)** |const|
  53. ----
  54. .. _class_StreamPeerBuffer_method_resize:
  55. - void **resize** **(** :ref:`int<class_int>` size **)**
  56. ----
  57. .. _class_StreamPeerBuffer_method_seek:
  58. - void **seek** **(** :ref:`int<class_int>` position **)**
  59. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  60. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  61. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`