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.

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

Auth lobby small fixes and rename #202

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions modules/blazium_sdk/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ def get_doc_classes():
"ListLobbyResult",
"ViewLobbyResponse",
"ViewLobbyResult",
"AuthoritativeClient",
"AuthoritativeResponse",
"AuthoritativeResult",
"AuthoritativeLobbyClient",
"AuthoritativeLobbyResponse",
"AuthoritativeLobbyResult",
"POGRClient",
"POGRResult",
"POGRResponse",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AuthoritativeClient" inherits="BlaziumClient" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<class name="AuthoritativeLobbyClient" inherits="BlaziumClient" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Node for connecting to the Blazium Lobby service. Offers authoritative lobby making features.
</brief_description>
<description>
The [AuthoritativeClient] node provides an interface for connecting to the Blazium Authoritative service. There is a free instance hosted on the [url=https://blazium.app]blazium.app[/url] domain that is used by default.
The [AuthoritativeLobbyClient] node provides an interface for connecting to the Blazium Authoritative service. There is a free instance hosted on the [url=https://blazium.app]blazium.app[/url] domain that is used by default.
The normal flow is as follows:
1. Listen to all the signals you are interested in.
2. Connect to the server using [method connect_to_lobby] method.
Expand Down Expand Up @@ -114,7 +114,7 @@
</description>
</method>
<method name="lobby_call">
<return type="AuthoritativeResponse" />
<return type="AuthoritativeLobbyResponse" />
<param index="0" name="method" type="String" />
<param index="1" name="args" type="Array" />
<description>
Expand Down Expand Up @@ -220,7 +220,6 @@
</signal>
<signal name="lobby_notified">
<param index="0" name="data" type="Object" />
<param index="1" name="from_peer" type="LobbyPeer" />
<description>
Signal generated after a notification is received.
</description>
Expand Down
19 changes: 19 additions & 0 deletions modules/blazium_sdk/doc_classes/AuthoritativeLobbyResponse.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AuthoritativeLobbyResponse" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Response from a [method AuthoritativeLobbyClient.lobby_call] call.
</brief_description>
<description>
Response from a [method AuthoritativeLobbyClient.lobby_call] call. Await on [signal finished] signal to get the [AuthoritativeLobbyResult].
</description>
<tutorials>
</tutorials>
<signals>
<signal name="finished">
<param index="0" name="result" type="AuthoritativeLobbyResult" />
<description>
Signal emitted when the request is finished.
</description>
</signal>
</signals>
</class>
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="AuthoritativeResult" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<class name="AuthoritativeLobbyResult" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
A result from a [AuthoritativeResponse].
A result from a [AuthoritativeLobbyResponse].
</brief_description>
<description>
A result from a [AuthoritativeResponse]. Contains either result or error.
A result from a [AuthoritativeLobbyResponse]. Contains either result or error.
</description>
<tutorials>
</tutorials>
Expand Down
19 changes: 0 additions & 19 deletions modules/blazium_sdk/doc_classes/AuthoritativeResponse.xml

This file was deleted.

2 changes: 1 addition & 1 deletion modules/blazium_sdk/icons/POGRClient.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading