class_offlinemultiplayerpeer.rst 2.2 KB

12345678910111213141516171819202122232425262728293031323334
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/OfflineMultiplayerPeer.xml.
  6. .. _class_OfflineMultiplayerPeer:
  7. OfflineMultiplayerPeer
  8. ======================
  9. **Inherits:** :ref:`MultiplayerPeer<class_MultiplayerPeer>` **<** :ref:`PacketPeer<class_PacketPeer>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. A :ref:`MultiplayerPeer<class_MultiplayerPeer>` which is always connected and acts as a server.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. This is the default :ref:`MultiplayerAPI.multiplayer_peer<class_MultiplayerAPI_property_multiplayer_peer>` for the :ref:`Node.multiplayer<class_Node_property_multiplayer>`. It mimics the behavior of a server with no peers connected.
  15. This means that the :ref:`SceneTree<class_SceneTree>` will act as the multiplayer authority by default. Calls to :ref:`MultiplayerAPI.is_server<class_MultiplayerAPI_method_is_server>` will return ``true``, and calls to :ref:`MultiplayerAPI.get_unique_id<class_MultiplayerAPI_method_get_unique_id>` will return :ref:`MultiplayerPeer.TARGET_PEER_SERVER<class_MultiplayerPeer_constant_TARGET_PEER_SERVER>`.
  16. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  17. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  18. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  19. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  20. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  21. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  22. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  23. .. |void| replace:: :abbr:`void (No return value.)`