.. 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/JamWebRTCSignalling.xml. .. _class_JamWebRTCSignalling: JamWebRTCSignalling =================== **Inherits:** :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:`WebSocketPeer` | :ref:`ws` | ``new()`` | +-------------------------------------------+----------------------------------------------------------+---------------+ | :ref:`Variant` | :ref:`code` | ``1000`` | +-------------------------------------------+----------------------------------------------------------+---------------+ | :ref:`Variant` | :ref:`reason` | ``"Unknown"`` | +-------------------------------------------+----------------------------------------------------------+---------------+ | :ref:`State` | :ref:`state` | ``3`` | +-------------------------------------------+----------------------------------------------------------+---------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`JamError` | :ref:`connect_to_url` **(** :ref:`String` url **)** | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** **)** | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_process` **(** :ref:`Variant` _delta **)** | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_update_ws_state` **(** **)** | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_on_ws_opened` **(** **)** | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_on_ws_closed` **(** **)** | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`JamError` | :ref:`_parse_msg` **(** **)** | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`join_session` **(** **)** | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`seal_lobby` **(** **)** | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`send_candidate` **(** :ref:`int` id, :ref:`String` mid, :ref:`int` index, :ref:`String` sdp **)** | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`send_offer` **(** :ref:`int` id, :ref:`String` offer **)** | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`send_answer` **(** :ref:`int` id, :ref:`String` answer **)** | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_send_msg` **(** :ref:`int` type, :ref:`int` id, :ref:`String` data="" **)** | +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_JamWebRTCSignalling_signal_session_joined: .. rst-class:: classref-signal **session_joined** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_signal_connected: .. rst-class:: classref-signal **connected** **(** :ref:`int` id, :ref:`Dictionary` pinfo **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_signal_disconnected: .. rst-class:: classref-signal **disconnected** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_signal_peer_connected: .. rst-class:: classref-signal **peer_connected** **(** :ref:`int` id, :ref:`Dictionary` pinfo **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_signal_peer_disconnected: .. rst-class:: classref-signal **peer_disconnected** **(** :ref:`int` id **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_signal_offer_received: .. rst-class:: classref-signal **offer_received** **(** :ref:`int` id, :ref:`String` offer **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_signal_answer_received: .. rst-class:: classref-signal **answer_received** **(** :ref:`int` id, :ref:`String` answer **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_signal_candidate_received: .. rst-class:: classref-signal **candidate_received** **(** :ref:`int` id, :ref:`String` mid, :ref:`int` index, :ref:`String` sdp **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_signal_session_sealed: .. rst-class:: classref-signal **session_sealed** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_signal_ws_connecting: .. rst-class:: classref-signal **ws_connecting** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_signal_ws_opened: .. rst-class:: classref-signal **ws_opened** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_signal_ws_closing: .. rst-class:: classref-signal **ws_closing** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_signal_ws_closed: .. rst-class:: classref-signal **ws_closed** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_signal_ws_opened_or_closed: .. rst-class:: classref-signal **ws_opened_or_closed** **(** :ref:`State` state **)** .. 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 Enumerations ------------ .. _enum_JamWebRTCSignalling_Message: .. rst-class:: classref-enumeration enum **Message**: .. _class_JamWebRTCSignalling_constant_JOIN: .. rst-class:: classref-enumeration-constant :ref:`Message` **JOIN** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamWebRTCSignalling_constant_ID: .. rst-class:: classref-enumeration-constant :ref:`Message` **ID** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamWebRTCSignalling_constant_PEER_CONNECT: .. rst-class:: classref-enumeration-constant :ref:`Message` **PEER_CONNECT** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamWebRTCSignalling_constant_PEER_DISCONNECT: .. rst-class:: classref-enumeration-constant :ref:`Message` **PEER_DISCONNECT** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamWebRTCSignalling_constant_OFFER: .. rst-class:: classref-enumeration-constant :ref:`Message` **OFFER** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamWebRTCSignalling_constant_ANSWER: .. rst-class:: classref-enumeration-constant :ref:`Message` **ANSWER** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamWebRTCSignalling_constant_CANDIDATE: .. rst-class:: classref-enumeration-constant :ref:`Message` **CANDIDATE** = ``6`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamWebRTCSignalling_constant_SEAL: .. rst-class:: classref-enumeration-constant :ref:`Message` **SEAL** = ``7`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_JamWebRTCSignalling_constant_PING: .. rst-class:: classref-enumeration-constant :ref:`Message` **PING** = ``8`` .. 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_JamWebRTCSignalling_property_ws: .. rst-class:: classref-property :ref:`WebSocketPeer` **ws** = ``new()`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_property_code: .. rst-class:: classref-property :ref:`Variant` **code** = ``1000`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_property_reason: .. rst-class:: classref-property :ref:`Variant` **reason** = ``"Unknown"`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_property_state: .. rst-class:: classref-property :ref:`State` **state** = ``3`` .. 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_JamWebRTCSignalling_method_connect_to_url: .. rst-class:: classref-method :ref:`JamError` **connect_to_url** **(** :ref:`String` url **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_method_close: .. rst-class:: classref-method void **close** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_private_method__process: .. rst-class:: classref-method void **_process** **(** :ref:`Variant` _delta **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_private_method__update_ws_state: .. rst-class:: classref-method void **_update_ws_state** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_private_method__on_ws_opened: .. rst-class:: classref-method void **_on_ws_opened** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_private_method__on_ws_closed: .. rst-class:: classref-method void **_on_ws_closed** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_private_method__parse_msg: .. rst-class:: classref-method :ref:`JamError` **_parse_msg** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_method_join_session: .. rst-class:: classref-method :ref:`Variant` **join_session** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_method_seal_lobby: .. rst-class:: classref-method :ref:`Variant` **seal_lobby** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_method_send_candidate: .. rst-class:: classref-method :ref:`int` **send_candidate** **(** :ref:`int` id, :ref:`String` mid, :ref:`int` index, :ref:`String` sdp **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_method_send_offer: .. rst-class:: classref-method :ref:`int` **send_offer** **(** :ref:`int` id, :ref:`String` offer **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_method_send_answer: .. rst-class:: classref-method :ref:`int` **send_answer** **(** :ref:`int` id, :ref:`String` answer **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCSignalling_private_method__send_msg: .. rst-class:: classref-method :ref:`int` **_send_msg** **(** :ref:`int` type, :ref:`int` id, :ref:`String` data="" **)** .. 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.)`