.. 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/JamClient.xml. .. _class_JamClient: JamClient ========= **Inherits:** :ref:`CanvasLayer` **<** :ref:`Node` **<** :ref:`Object` A :ref:`CanvasLayer` that provides client-specific multiplayer capabilities as the child of a :ref:`JamConnect` Node .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`JamClientUI` | :ref:`client_ui` | | +-----------------------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`current_client_token` | | +-----------------------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`Dictionary` | :ref:`peer_usernames` | ``{}`` | +-----------------------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`test_client_number` | ``1`` | +-----------------------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`session_id` | ``""`` | +-----------------------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`gjwt_fetch_busy` | ``false`` | +-----------------------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`JamJwt` | :ref:`jwt` | ``new()`` | +-----------------------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`JamClientApi` | :ref:`api` | | +-----------------------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`ClientKeys` | :ref:`keys` | | +-----------------------------------------+----------------------------------------------------------------------------+-----------+ | :ref:`JamConnect` | :ref:`_jc` | | +-----------------------------------------+----------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_init` **(** **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_ready` **(** **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_setup_test_gjwt` **(** **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_gjwt` **(** :ref:`String` gjwt **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`persist_gjwt` **(** **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`client_start` **(** **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`client_session_request` **(** :ref:`String` host, :ref:`int` port, :ref:`String` token **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`leave_game` **(** **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_on_client_connect_fail` **(** **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_on_client_authentication_failed` **(** **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_on_client_authenticating` **(** :ref:`int` peer_id **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_on_auth` **(** :ref:`int` peer_id, :ref:`PackedByteArray` _data **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_on_client_connect` **(** **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_on_server_disconnect` **(** **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_on_game_init_finalized` **(** **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_on_player_joined` **(** :ref:`int` peer_id, :ref:`String` username **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_on_player_left` **(** :ref:`int` peer_id, :ref:`String` _username **)** | +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_JamClient_signal_fetching_test_gjwt: .. rst-class:: classref-signal **fetching_test_gjwt** **(** :ref:`bool` busy **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_JamClient_property_client_ui: .. rst-class:: classref-property :ref:`JamClientUI` **client_ui** The client UI used to configure and initiate sessions .. rst-class:: classref-item-separator ---- .. _class_JamClient_property_current_client_token: .. rst-class:: classref-property :ref:`String` **current_client_token** The client token for the active session. The token is used to verify identity with the server. .. rst-class:: classref-item-separator ---- .. _class_JamClient_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_JamClient_property_test_client_number: .. rst-class:: classref-property :ref:`int` **test_client_number** = ``1`` .. rst-class:: classref-property-setget - void **@test_client_number_setter** **(** :ref:`int` value **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClient_property_session_id: .. rst-class:: classref-property :ref:`String` **session_id** = ``""`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClient_property_gjwt_fetch_busy: .. rst-class:: classref-property :ref:`bool` **gjwt_fetch_busy** = ``false`` .. rst-class:: classref-property-setget - void **@gjwt_fetch_busy_setter** **(** :ref:`bool` value **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClient_property_jwt: .. rst-class:: classref-property :ref:`JamJwt` **jwt** = ``new()`` The Game JWT for this client - used to authenticate with the Jam Launch API .. rst-class:: classref-item-separator ---- .. _class_JamClient_property_api: .. rst-class:: classref-property :ref:`JamClientApi` **api** Interface for calling the Jam Launch session API .. rst-class:: classref-item-separator ---- .. _class_JamClient_property_keys: .. rst-class:: classref-property :ref:`ClientKeys` **keys** Helper object for acquiring a Game JWT for authentication .. rst-class:: classref-item-separator ---- .. _class_JamClient_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_JamClient_private_method__init: .. rst-class:: classref-method void **_init** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClient_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_JamClient_private_method__setup_test_gjwt: .. rst-class:: classref-method void **_setup_test_gjwt** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClient_method_set_gjwt: .. rst-class:: classref-method void **set_gjwt** **(** :ref:`String` gjwt **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClient_method_persist_gjwt: .. rst-class:: classref-method :ref:`bool` **persist_gjwt** **(** **)** Persists the GJWT so that it can be retrieved in the next run .. rst-class:: classref-item-separator ---- .. _class_JamClient_method_client_start: .. rst-class:: classref-method void **client_start** **(** **)** Configures and starts client functionality .. rst-class:: classref-item-separator ---- .. _class_JamClient_method_client_session_request: .. rst-class:: classref-method void **client_session_request** **(** :ref:`String` host, :ref:`int` port, :ref:`String` token **)** Initiates a connection to a provisioned server .. rst-class:: classref-item-separator ---- .. _class_JamClient_method_leave_game: .. rst-class:: classref-method void **leave_game** **(** **)** Elegantly leaves the game by disconnecting from the server and notifying the Jam Launch API .. rst-class:: classref-item-separator ---- .. _class_JamClient_private_method__on_client_connect_fail: .. rst-class:: classref-method void **_on_client_connect_fail** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClient_private_method__on_client_authentication_failed: .. rst-class:: classref-method void **_on_client_authentication_failed** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClient_private_method__on_client_authenticating: .. rst-class:: classref-method void **_on_client_authenticating** **(** :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_JamClient_private_method__on_auth: .. rst-class:: classref-method void **_on_auth** **(** :ref:`int` peer_id, :ref:`PackedByteArray` _data **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClient_private_method__on_client_connect: .. rst-class:: classref-method void **_on_client_connect** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClient_private_method__on_server_disconnect: .. rst-class:: classref-method void **_on_server_disconnect** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClient_private_method__on_game_init_finalized: .. rst-class:: classref-method void **_on_game_init_finalized** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClient_private_method__on_player_joined: .. rst-class:: classref-method void **_on_player_joined** **(** :ref:`int` peer_id, :ref:`String` username **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClient_private_method__on_player_left: .. rst-class:: classref-method void **_on_player_left** **(** :ref:`int` peer_id, :ref:`String` _username **)** .. 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.)`