.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/jam_launch/JamServer.xml. .. _class_JamServer: JamServer ========= **Inherits:** :ref:`Node` **<** :ref:`Object` A :ref:`Node` that provides server-specific multiplayer capabilities as the child of a :ref:`JamConnect` Node .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------------+----------------------------------------------------------------+-------------+ | :ref:`Dictionary` | :ref:`peer_usernames` | ``{}`` | +---------------------------------------------+----------------------------------------------------------------+-------------+ | :ref:`bool` | :ref:`dev_mode` | ``false`` | +---------------------------------------------+----------------------------------------------------------------+-------------+ | :ref:`bool` | :ref:`has_dev_keys` | ``false`` | +---------------------------------------------+----------------------------------------------------------------+-------------+ | :ref:`JamCallbackApi` | :ref:`callback_api` | | +---------------------------------------------+----------------------------------------------------------------+-------------+ | :ref:`JamDataApi` | :ref:`data_api` | | +---------------------------------------------+----------------------------------------------------------------+-------------+ | :ref:`String` | :ref:`session_id` | ``"unset"`` | +---------------------------------------------+----------------------------------------------------------------+-------------+ | :ref:`JamConnect` | :ref:`_jc` | | +---------------------------------------------+----------------------------------------------------------------+-------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_ready` **(** **)** | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_notification` **(** :ref:`Variant` what **)** | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`server_start` **(** :ref:`Dictionary` args **)** | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_auth_callback` **(** :ref:`int` peer_id, :ref:`PackedByteArray` data **)** | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`JamError` | :ref:`_check_auth` **(** :ref:`String` username, :ref:`String` join_token **)** | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_on_peer_connect` **(** :ref:`int` peer_id **)** | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_on_peer_disconnect` **(** :ref:`int` pid **)** | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shut_down` **(** :ref:`bool` do_disconnect=true **)** | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_setup_local_dev_keys` **(** **)** | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`_fetch_local_dev_keys` **(** **)** | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_JamServer_constant_MAX_CLIENTS: .. rst-class:: classref-constant **MAX_CLIENTS** = ``100`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_JamServer_constant_DEFAULT_PORT: .. rst-class:: classref-constant **DEFAULT_PORT** = ``7437`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_JamServer_property_peer_usernames: .. rst-class:: classref-property :ref:`Dictionary` **peer_usernames** = ``{}`` A dictionary mapping peer id ``int``\ s to username ``String``\ s .. rst-class:: classref-item-separator ---- .. _class_JamServer_property_dev_mode: .. rst-class:: classref-property :ref:`bool` **dev_mode** = ``false`` True if the server is in developer mode. In developer mode, the clients are not verified and dummy API implementations are used instead of the AWS-driven implementations. .. rst-class:: classref-item-separator ---- .. _class_JamServer_property_has_dev_keys: .. rst-class:: classref-property :ref:`bool` **has_dev_keys** = ``false`` True if the local dev mode server has keys for accessing server APIs like Data and Callback .. rst-class:: classref-item-separator ---- .. _class_JamServer_property_callback_api: .. rst-class:: classref-property :ref:`JamCallbackApi` **callback_api** A callback API client for communicating back to Jam Launch .. rst-class:: classref-item-separator ---- .. _class_JamServer_property_data_api: .. rst-class:: classref-property :ref:`JamDataApi` **data_api** A data API client for persisting project information .. rst-class:: classref-item-separator ---- .. _class_JamServer_property_session_id: .. rst-class:: classref-property :ref:`String` **session_id** = ``"unset"`` .. rst-class:: classref-property-setget - void **@session_id_setter** **(** :ref:`String` value **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamServer_property__jc: .. rst-class:: classref-property :ref:`JamConnect` **_jc** .. rst-class:: classref-property-setget - :ref:`JamConnect` **@_jc_getter** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_JamServer_private_method__ready: .. rst-class:: classref-method void **_ready** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamServer_private_method__notification: .. rst-class:: classref-method void **_notification** **(** :ref:`Variant` what **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamServer_method_server_start: .. rst-class:: classref-method void **server_start** **(** :ref:`Dictionary` args **)** Configures and starts server functionality .. rst-class:: classref-item-separator ---- .. _class_JamServer_private_method__auth_callback: .. rst-class:: classref-method void **_auth_callback** **(** :ref:`int` peer_id, :ref:`PackedByteArray` data **)** Authenticates a player by verifying the provided ``username`` and ``token`` with the Jam Launch callback. In developer mode, a token with the value ``"localdev"`` will always verify successfully. .. rst-class:: classref-item-separator ---- .. _class_JamServer_private_method__check_auth: .. rst-class:: classref-method :ref:`JamError` **_check_auth** **(** :ref:`String` username, :ref:`String` join_token **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamServer_private_method__on_peer_connect: .. rst-class:: classref-method void **_on_peer_connect** **(** :ref:`int` peer_id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamServer_private_method__on_peer_disconnect: .. rst-class:: classref-method void **_on_peer_disconnect** **(** :ref:`int` pid **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamServer_method_shut_down: .. rst-class:: classref-method void **shut_down** **(** :ref:`bool` do_disconnect=true **)** Shuts down the server elegantly .. rst-class:: classref-item-separator ---- .. _class_JamServer_private_method__setup_local_dev_keys: .. rst-class:: classref-method void **_setup_local_dev_keys** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamServer_private_method__fetch_local_dev_keys: .. rst-class:: classref-method :ref:`Variant` **_fetch_local_dev_keys** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`