Skip to content

Commit

Permalink
Merge pull request #13 from Ughuuu/add-missing-blazium-nodes
Browse files Browse the repository at this point in the history
add missing nodes
  • Loading branch information
Bioblaze authored Dec 14, 2024
2 parents ab31e67 + 56fc000 commit 44efd99
Show file tree
Hide file tree
Showing 6 changed files with 396 additions and 2 deletions.
2 changes: 1 addition & 1 deletion classes/class_blaziumclient.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ BlaziumClient

**Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Inherited By:** :ref:`LobbyClient<class_LobbyClient>`, :ref:`MasterServerClient<class_MasterServerClient>`, :ref:`POGRClient<class_POGRClient>`
**Inherited By:** :ref:`LobbyClient<class_LobbyClient>`, :ref:`LoginClient<class_LoginClient>`, :ref:`MasterServerClient<class_MasterServerClient>`, :ref:`POGRClient<class_POGRClient>`

An abstract base node used to connect to Blazium services.

Expand Down
214 changes: 214 additions & 0 deletions classes/class_loginclient.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,214 @@
:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/blazium-engine/blazium/tree/4.3/doc/tools/make_rst.py.
.. XML source: https://github.com/blazium-engine/blazium/tree/4.3/modules/blazium_sdk/doc_classes/LoginClient.xml.
.. _class_LoginClient:

LoginClient
===========

**Inherits:** :ref:`BlaziumClient<class_BlaziumClient>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

A node used to connect to a login server.

.. rst-class:: classref-introduction-group

Description
-----------

A node used to connect to a login server.

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
:widths: auto

+-----------------------------+----------------------------------------------------------+---------------------------------------+
| :ref:`bool<class_bool>` | :ref:`connected<class_LoginClient_property_connected>` | ``false`` |
+-----------------------------+----------------------------------------------------------+---------------------------------------+
| :ref:`String<class_String>` | :ref:`game_id<class_LoginClient_property_game_id>` | ``""`` |
+-----------------------------+----------------------------------------------------------+---------------------------------------+
| :ref:`String<class_String>` | :ref:`server_url<class_LoginClient_property_server_url>` | ``"wss://login.blazium.app/connect"`` |
+-----------------------------+----------------------------------------------------------+---------------------------------------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
:widths: auto

+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`connect_to_server<class_LoginClient_method_connect_to_server>`\ (\ ) |
+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`disconnect_from_server<class_LoginClient_method_disconnect_from_server>`\ (\ ) |
+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`LoginResponse<class_LoginResponse>` | :ref:`request_login_info<class_LoginClient_method_request_login_info>`\ (\ login_type\: :ref:`String<class_String>`\ ) |
+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Signals
-------

.. _class_LoginClient_signal_connected_to_server:

.. rst-class:: classref-signal

**connected_to_server**\ (\ ) :ref:`🔗<class_LoginClient_signal_connected_to_server>`

Signal emitted when the client connects to the server.

.. rst-class:: classref-item-separator

----

.. _class_LoginClient_signal_disconnected_from_server:

.. rst-class:: classref-signal

**disconnected_from_server**\ (\ reason\: :ref:`String<class_String>`\ ) :ref:`🔗<class_LoginClient_signal_disconnected_from_server>`

Signal emitted when the client disconnects from the server.

.. rst-class:: classref-item-separator

----

.. _class_LoginClient_signal_log_updated:

.. rst-class:: classref-signal

**log_updated**\ (\ command\: :ref:`String<class_String>`, logs\: :ref:`String<class_String>`\ ) :ref:`🔗<class_LoginClient_signal_log_updated>`

Signals a log from a command.

.. rst-class:: classref-item-separator

----

.. _class_LoginClient_signal_received_jwt:

.. rst-class:: classref-signal

**received_jwt**\ (\ jwt\: :ref:`String<class_String>`, type\: :ref:`String<class_String>`\ ) :ref:`🔗<class_LoginClient_signal_received_jwt>`

Signal emitted when a JWT is received.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_LoginClient_property_connected:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **connected** = ``false`` :ref:`🔗<class_LoginClient_property_connected>`

.. rst-class:: classref-property-setget

- :ref:`bool<class_bool>` **get_connected**\ (\ )

True if the client is connected, else false.

.. rst-class:: classref-item-separator

----

.. _class_LoginClient_property_game_id:

.. rst-class:: classref-property

:ref:`String<class_String>` **game_id** = ``""`` :ref:`🔗<class_LoginClient_property_game_id>`

.. rst-class:: classref-property-setget

- |void| **set_game_id**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_game_id**\ (\ )

The game id.

.. rst-class:: classref-item-separator

----

.. _class_LoginClient_property_server_url:

.. rst-class:: classref-property

:ref:`String<class_String>` **server_url** = ``"wss://login.blazium.app/connect"`` :ref:`🔗<class_LoginClient_property_server_url>`

.. rst-class:: classref-property-setget

- |void| **set_server_url**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_server_url**\ (\ )

Set to what url this login should connect to.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_LoginClient_method_connect_to_server:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **connect_to_server**\ (\ ) :ref:`🔗<class_LoginClient_method_connect_to_server>`

Connect to the server.

.. rst-class:: classref-item-separator

----

.. _class_LoginClient_method_disconnect_from_server:

.. rst-class:: classref-method

|void| **disconnect_from_server**\ (\ ) :ref:`🔗<class_LoginClient_method_disconnect_from_server>`

Disconnect from the server.

Generates :ref:`disconnected_from_server<class_LoginClient_signal_disconnected_from_server>` when disconnected.

.. rst-class:: classref-item-separator

----

.. _class_LoginClient_method_request_login_info:

.. rst-class:: classref-method

:ref:`LoginResponse<class_LoginResponse>` **request_login_info**\ (\ login_type\: :ref:`String<class_String>`\ ) :ref:`🔗<class_LoginClient_method_request_login_info>`

Request login info.

.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`
48 changes: 48 additions & 0 deletions classes/class_loginresponse.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/blazium-engine/blazium/tree/4.3/doc/tools/make_rst.py.
.. XML source: https://github.com/blazium-engine/blazium/tree/4.3/modules/blazium_sdk/doc_classes/LoginResponse.xml.
.. _class_LoginResponse:

LoginResponse
=============

**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

Response from a connect request.

.. rst-class:: classref-introduction-group

Description
-----------

Response from a connect request.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Signals
-------

.. _class_LoginResponse_signal_finished:

.. rst-class:: classref-signal

**finished**\ (\ result\: :ref:`LobbyResult<class_LobbyResult>`\ ) :ref:`🔗<class_LoginResponse_signal_finished>`

Signal emitted when the request is finished.

.. |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.)`
.. |void| replace:: :abbr:`void (No return value.)`
Loading

0 comments on commit 44efd99

Please sign in to comment.