class_packetpeerstream.rst 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_PacketPeerStream:
  4. PacketPeerStream
  5. ================
  6. **Inherits:** :ref:`PacketPeer<class_packetpeer>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Wrapper to use a PacketPeer over a StreamPeer.
  11. Member Functions
  12. ----------------
  13. +-------+-----------------------------------------------------------------------------------------------------------------------+
  14. | void | :ref:`set_stream_peer<class_PacketPeerStream_set_stream_peer>` **(** :ref:`StreamPeer<class_streampeer>` peer **)** |
  15. +-------+-----------------------------------------------------------------------------------------------------------------------+
  16. Description
  17. -----------
  18. PacketStreamPeer provides a wrapper for working using packets over a stream. This allows for using packet based code with StreamPeers. PacketPeerStream implements a custom protocol over the StreamPeer, so the user should not read or write to the wrapped StreamPeer directly.
  19. Member Function Description
  20. ---------------------------
  21. .. _class_PacketPeerStream_set_stream_peer:
  22. - void **set_stream_peer** **(** :ref:`StreamPeer<class_streampeer>` peer **)**
  23. Set the StreamPeer object to be wrapped