Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update docs with authoritative lobby #15

Merged
merged 1 commit into from
Dec 15, 2024
Merged

update docs with authoritative lobby #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
653 changes: 643 additions & 10 deletions classes/class_authoritativeclient.rst
View file
Open in desktop

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions classes/class_lobbycallresponse.rst → classes/class_authoritativeresponse.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
.. 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/LobbyCallResponse.xml.
.. XML source: https://github.com/blazium-engine/blazium/tree/4.3/modules/blazium_sdk/doc_classes/AuthoritativeResponse.xml.

.. _class_LobbyCallResponse:
.. _class_AuthoritativeResponse:

LobbyCallResponse
=================
AuthoritativeResponse
=====================

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

Expand All @@ -19,7 +19,7 @@ Response from a :ref:`AuthoritativeClient.lobby_call<class_AuthoritativeClient_m
Description
-----------

Response from a :ref:`AuthoritativeClient.lobby_call<class_AuthoritativeClient_method_lobby_call>` call. Await on :ref:`finished<class_LobbyCallResponse_signal_finished>` signal to get the :ref:`LobbyCallResult<class_LobbyCallResult>`.
Response from a :ref:`AuthoritativeClient.lobby_call<class_AuthoritativeClient_method_lobby_call>` call. Await on :ref:`finished<class_AuthoritativeResponse_signal_finished>` signal to get the :ref:`AuthoritativeResult<class_AuthoritativeResult>`.

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

Expand All @@ -30,11 +30,11 @@ Response from a :ref:`AuthoritativeClient.lobby_call<class_AuthoritativeClient_m
Signals
-------

.. _class_LobbyCallResponse_signal_finished:
.. _class_AuthoritativeResponse_signal_finished:

.. rst-class:: classref-signal

**finished**\ (\ result\: :ref:`LobbyCallResult<class_LobbyCallResult>`\ ) :ref:`🔗<class_LobbyCallResponse_signal_finished>`
**finished**\ (\ result\: :ref:`AuthoritativeResult<class_AuthoritativeResult>`\ ) :ref:`🔗<class_AuthoritativeResponse_signal_finished>`

Signal emitted when the request is finished.

Expand Down
40 changes: 20 additions & 20 deletions classes/class_lobbycallresult.rst → classes/class_authoritativeresult.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@
.. 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/LobbyCallResult.xml.
.. XML source: https://github.com/blazium-engine/blazium/tree/4.3/modules/blazium_sdk/doc_classes/AuthoritativeResult.xml.

.. _class_LobbyCallResult:
.. _class_AuthoritativeResult:

LobbyCallResult
===============
AuthoritativeResult
===================

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

A result from a :ref:`LobbyCallResponse<class_LobbyCallResponse>`.
A result from a :ref:`AuthoritativeResponse<class_AuthoritativeResponse>`.

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

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

A result from a :ref:`LobbyCallResponse<class_LobbyCallResponse>`. Contains either result or error.
A result from a :ref:`AuthoritativeResponse<class_AuthoritativeResponse>`. Contains either result or error.

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

Expand All @@ -29,9 +29,9 @@ Properties
.. table::
:widths: auto

+-----------------------------+----------------------------------------------------+--------+
| :ref:`String<class_String>` | :ref:`error<class_LobbyCallResult_property_error>` | ``""`` |
+-----------------------------+----------------------------------------------------+--------+
+-----------------------------+--------------------------------------------------------+--------+
| :ref:`String<class_String>` | :ref:`error<class_AuthoritativeResult_property_error>` | ``""`` |
+-----------------------------+--------------------------------------------------------+--------+

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

Expand All @@ -41,11 +41,11 @@ Methods
.. table::
:widths: auto

+-------------------------------+--------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`get_result<class_LobbyCallResult_method_get_result>`\ (\ ) |const| |
+-------------------------------+--------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_error<class_LobbyCallResult_method_has_error>`\ (\ ) |const| |
+-------------------------------+--------------------------------------------------------------------------+
+-------------------------------+------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`get_result<class_AuthoritativeResult_method_get_result>`\ (\ ) |const| |
+-------------------------------+------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_error<class_AuthoritativeResult_method_has_error>`\ (\ ) |const| |
+-------------------------------+------------------------------------------------------------------------------+

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

Expand All @@ -56,11 +56,11 @@ Methods
Property Descriptions
---------------------

.. _class_LobbyCallResult_property_error:
.. _class_AuthoritativeResult_property_error:

.. rst-class:: classref-property

:ref:`String<class_String>` **error** = ``""`` :ref:`🔗<class_LobbyCallResult_property_error>`
:ref:`String<class_String>` **error** = ``""`` :ref:`🔗<class_AuthoritativeResult_property_error>`

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

Expand All @@ -77,23 +77,23 @@ Gets the error message.
Method Descriptions
-------------------

.. _class_LobbyCallResult_method_get_result:
.. _class_AuthoritativeResult_method_get_result:

.. rst-class:: classref-method

:ref:`Variant<class_Variant>` **get_result**\ (\ ) |const| :ref:`🔗<class_LobbyCallResult_method_get_result>`
:ref:`Variant<class_Variant>` **get_result**\ (\ ) |const| :ref:`🔗<class_AuthoritativeResult_method_get_result>`

Result of the function call.

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

----

.. _class_LobbyCallResult_method_has_error:
.. _class_AuthoritativeResult_method_has_error:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_error**\ (\ ) |const| :ref:`🔗<class_LobbyCallResult_method_has_error>`
:ref:`bool<class_bool>` **has_error**\ (\ ) |const| :ref:`🔗<class_AuthoritativeResult_method_has_error>`

Returns true if there is an error.

Expand Down
2 changes: 1 addition & 1 deletion classes/class_blaziumclient.rst
View file
Open in desktop
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:`LoginClient<class_LoginClient>`, :ref:`MasterServerClient<class_MasterServerClient>`, :ref:`POGRClient<class_POGRClient>`
**Inherited By:** :ref:`AuthoritativeClient<class_AuthoritativeClient>`, :ref:`LobbyClient<class_LobbyClient>`, :ref:`LoginClient<class_LoginClient>`, :ref:`MasterServerClient<class_MasterServerClient>`, :ref:`POGRClient<class_POGRClient>`

Base node for connecting to the Blazium services.

Expand Down
14 changes: 14 additions & 0 deletions classes/class_editorexportplatformandroid.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,8 @@ Properties
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`launcher_icons/adaptive_foreground_432x432<class_EditorExportPlatformAndroid_property_launcher_icons/adaptive_foreground_432x432>` |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`launcher_icons/adaptive_monochrome_432x432<class_EditorExportPlatformAndroid_property_launcher_icons/adaptive_monochrome_432x432>` |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`launcher_icons/main_192x192<class_EditorExportPlatformAndroid_property_launcher_icons/main_192x192>` |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`package/app_category<class_EditorExportPlatformAndroid_property_package/app_category>` |
Expand Down Expand Up @@ -768,6 +770,18 @@ Foreground layer of the application adaptive icon file. See `Design adaptive ico

----

.. _class_EditorExportPlatformAndroid_property_launcher_icons/adaptive_monochrome_432x432:

.. rst-class:: classref-property

:ref:`String<class_String>` **launcher_icons/adaptive_monochrome_432x432** :ref:`🔗<class_EditorExportPlatformAndroid_property_launcher_icons/adaptive_monochrome_432x432>`

Monochrome layer of the application adaptive icon file. See `Design adaptive icons <https://developer.android.com/develop/ui/views/launch/icon_design_adaptive#design-adaptive-icons>`__.

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

----

.. _class_EditorExportPlatformAndroid_property_launcher_icons/main_192x192:

.. rst-class:: classref-property
Expand Down
2 changes: 0 additions & 2 deletions classes/class_lobbyclient.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ LobbyClient

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

**Inherited By:** :ref:`AuthoritativeClient<class_AuthoritativeClient>`

Node for connecting to the Blazium Lobby service. Offers non-authoritative lobby making features.

.. rst-class:: classref-introduction-group
Expand Down
Loading