.. 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/JamClientApi.xml. .. _class_JamClientApi: JamClientApi ============ **Inherits:** :ref:`JamHttpBase` **<** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------+-----------------------------------------------------+ | :ref:`String` | :ref:`game_id` | +-----------------------------+-----------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`JamHttpBase.Result` | :ref:`create_game_session` **(** :ref:`String` region="us-east-2" **)** | +-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`JamHttpBase.Result` | :ref:`join_game_session` **(** :ref:`String` join_id **)** | +-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`JamClientApi.GameSessionResult` | :ref:`get_game_session` **(** :ref:`String` session_id **)** | +-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`JamHttpBase.Result` | :ref:`leave_game_session` **(** :ref:`String` session_id **)** | +-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`JamHttpBase.Result` | :ref:`get_guest_jwt` **(** :ref:`String` game_id **)** | +-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`JamHttpBase.Result` | :ref:`check_guests_allowed` **(** :ref:`String` game_id **)** | +-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_JamClientApi_SessionStatus: .. rst-class:: classref-enumeration enum **SessionStatus**: .. _class_JamClientApi_constant_INIT: .. rst-class:: classref-enumeration-constant :ref:`SessionStatus` **INIT** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamClientApi_constant_UNKNOWN: .. rst-class:: classref-enumeration-constant :ref:`SessionStatus` **UNKNOWN** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamClientApi_constant_PROVISIONING: .. rst-class:: classref-enumeration-constant :ref:`SessionStatus` **PROVISIONING** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamClientApi_constant_PENDING: .. rst-class:: classref-enumeration-constant :ref:`SessionStatus` **PENDING** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamClientApi_constant_ACTIVATING: .. rst-class:: classref-enumeration-constant :ref:`SessionStatus` **ACTIVATING** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamClientApi_constant_RUNNING: .. rst-class:: classref-enumeration-constant :ref:`SessionStatus` **RUNNING** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamClientApi_constant_READY: .. rst-class:: classref-enumeration-constant :ref:`SessionStatus` **READY** = ``6`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamClientApi_constant_DEACTIVATING: .. rst-class:: classref-enumeration-constant :ref:`SessionStatus` **DEACTIVATING** = ``7`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamClientApi_constant_STOPPING: .. rst-class:: classref-enumeration-constant :ref:`SessionStatus` **STOPPING** = ``8`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamClientApi_constant_DEPROVISIONING: .. rst-class:: classref-enumeration-constant :ref:`SessionStatus` **DEPROVISIONING** = ``9`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamClientApi_constant_STOPPED: .. rst-class:: classref-enumeration-constant :ref:`SessionStatus` **STOPPED** = ``10`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_JamClientApi_property_game_id: .. rst-class:: classref-property :ref:`String` **game_id** .. 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_JamClientApi_method_create_game_session: .. rst-class:: classref-method :ref:`JamHttpBase.Result` **create_game_session** **(** :ref:`String` region="us-east-2" **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClientApi_method_join_game_session: .. rst-class:: classref-method :ref:`JamHttpBase.Result` **join_game_session** **(** :ref:`String` join_id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClientApi_method_get_game_session: .. rst-class:: classref-method :ref:`JamClientApi.GameSessionResult` **get_game_session** **(** :ref:`String` session_id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClientApi_method_leave_game_session: .. rst-class:: classref-method :ref:`JamHttpBase.Result` **leave_game_session** **(** :ref:`String` session_id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClientApi_method_get_guest_jwt: .. rst-class:: classref-method :ref:`JamHttpBase.Result` **get_guest_jwt** **(** :ref:`String` game_id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamClientApi_method_check_guests_allowed: .. rst-class:: classref-method :ref:`JamHttpBase.Result` **check_guests_allowed** **(** :ref:`String` game_id **)** .. 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.)`