diff --git a/classes/class_blaziumclient.rst b/classes/class_blaziumclient.rst index 47520f6c2a3..f1d0652a507 100644 --- a/classes/class_blaziumclient.rst +++ b/classes/class_blaziumclient.rst @@ -12,7 +12,7 @@ BlaziumClient **Inherits:** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`LobbyClient`, :ref:`MasterServerClient`, :ref:`POGRClient` +**Inherited By:** :ref:`LobbyClient`, :ref:`LoginClient`, :ref:`MasterServerClient`, :ref:`POGRClient` An abstract base node used to connect to Blazium services. diff --git a/classes/class_loginclient.rst b/classes/class_loginclient.rst new file mode 100644 index 00000000000..3089843a1e1 --- /dev/null +++ b/classes/class_loginclient.rst @@ -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` **<** :ref:`Node` **<** :ref:`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` | :ref:`connected` | ``false`` | + +-----------------------------+----------------------------------------------------------+---------------------------------------+ + | :ref:`String` | :ref:`game_id` | ``""`` | + +-----------------------------+----------------------------------------------------------+---------------------------------------+ + | :ref:`String` | :ref:`server_url` | ``"wss://login.blazium.app/connect"`` | + +-----------------------------+----------------------------------------------------------+---------------------------------------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`connect_to_server`\ (\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | |void| | :ref:`disconnect_from_server`\ (\ ) | + +-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ + | :ref:`LoginResponse` | :ref:`request_login_info`\ (\ login_type\: :ref:`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:`🔗` + +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`\ ) :ref:`🔗` + +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`, logs\: :ref:`String`\ ) :ref:`🔗` + +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`, type\: :ref:`String`\ ) :ref:`🔗` + +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` **connected** = ``false`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- :ref:`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` **game_id** = ``""`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_game_id**\ (\ value\: :ref:`String`\ ) +- :ref:`String` **get_game_id**\ (\ ) + +The game id. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LoginClient_property_server_url: + +.. rst-class:: classref-property + +:ref:`String` **server_url** = ``"wss://login.blazium.app/connect"`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- |void| **set_server_url**\ (\ value\: :ref:`String`\ ) +- :ref:`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` **connect_to_server**\ (\ ) :ref:`🔗` + +Connect to the server. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LoginClient_method_disconnect_from_server: + +.. rst-class:: classref-method + +|void| **disconnect_from_server**\ (\ ) :ref:`🔗` + +Disconnect from the server. + +Generates :ref:`disconnected_from_server` when disconnected. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LoginClient_method_request_login_info: + +.. rst-class:: classref-method + +:ref:`LoginResponse` **request_login_info**\ (\ login_type\: :ref:`String`\ ) :ref:`🔗` + +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.)` diff --git a/classes/class_loginresponse.rst b/classes/class_loginresponse.rst new file mode 100644 index 00000000000..b0c3640601a --- /dev/null +++ b/classes/class_loginresponse.rst @@ -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` **<** :ref:`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`\ ) :ref:`🔗` + +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.)` diff --git a/classes/class_loginresult.rst b/classes/class_loginresult.rst new file mode 100644 index 00000000000..2789faf1b06 --- /dev/null +++ b/classes/class_loginresult.rst @@ -0,0 +1,129 @@ +: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/LoginResult.xml. + +.. _class_LoginResult: + +LoginResult +=========== + +**Inherits:** :ref:`RefCounted` **<** :ref:`Object` + +A result from a :ref:`LoginResponse`. + +.. rst-class:: classref-introduction-group + +Description +----------- + +A result from a :ref:`LoginResponse`. + +.. rst-class:: classref-reftable-group + +Properties +---------- + +.. table:: + :widths: auto + + +-----------------------------+----------------------------------------------------------+--------+ + | :ref:`String` | :ref:`error` | ``""`` | + +-----------------------------+----------------------------------------------------------+--------+ + | :ref:`String` | :ref:`login_type` | ``""`` | + +-----------------------------+----------------------------------------------------------+--------+ + | :ref:`String` | :ref:`login_url` | ``""`` | + +-----------------------------+----------------------------------------------------------+--------+ + +.. rst-class:: classref-reftable-group + +Methods +------- + +.. table:: + :widths: auto + + +-------------------------+--------------------------------------------------------------------+ + | :ref:`bool` | :ref:`has_error`\ (\ ) |const| | + +-------------------------+--------------------------------------------------------------------+ + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Property Descriptions +--------------------- + +.. _class_LoginResult_property_error: + +.. rst-class:: classref-property + +:ref:`String` **error** = ``""`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- :ref:`String` **get_error**\ (\ ) + +The error message. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LoginResult_property_login_type: + +.. rst-class:: classref-property + +:ref:`String` **login_type** = ``""`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- :ref:`String` **get_login_type**\ (\ ) + +The login type. + +.. rst-class:: classref-item-separator + +---- + +.. _class_LoginResult_property_login_url: + +.. rst-class:: classref-property + +:ref:`String` **login_url** = ``""`` :ref:`🔗` + +.. rst-class:: classref-property-setget + +- :ref:`String` **get_login_url**\ (\ ) + +The login url. + +.. rst-class:: classref-section-separator + +---- + +.. rst-class:: classref-descriptions-group + +Method Descriptions +------------------- + +.. _class_LoginResult_method_has_error: + +.. rst-class:: classref-method + +:ref:`bool` **has_error**\ (\ ) |const| :ref:`🔗` + +Returns true if there is an error. + +.. |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.)` diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index c16e595c296..1aa17196f78 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -12,7 +12,7 @@ RefCounted **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioSample`, :ref:`AudioSamplePlayback`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`JavaClass`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`ListLobbyResponse`, :ref:`ListLobbyResult`, :ref:`LobbyCallResponse`, :ref:`LobbyCallResult`, :ref:`LobbyResponse`, :ref:`LobbyResult`, :ref:`MasterServerListResponse`, :ref:`MasterServerListResult`, :ref:`MasterServerResponse`, :ref:`MasterServerResult`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`POGRResponse`, :ref:`POGRResult`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`ViewLobbyResponse`, :ref:`ViewLobbyResult`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` +**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AudioEffectInstance`, :ref:`AudioSample`, :ref:`AudioSamplePlayback`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DirAccess`, :ref:`DTLSServer`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorResourceTooltipPlugin`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EncodedObjectAsID`, :ref:`ENetConnection`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`HashingContext`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`ImageFormatLoader`, :ref:`JavaClass`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`ListLobbyResponse`, :ref:`ListLobbyResult`, :ref:`LobbyCallResponse`, :ref:`LobbyCallResult`, :ref:`LobbyResponse`, :ref:`LobbyResult`, :ref:`LoginResponse`, :ref:`LoginResult`, :ref:`MasterServerListResponse`, :ref:`MasterServerListResult`, :ref:`MasterServerResponse`, :ref:`MasterServerResult`, :ref:`MeshConvexDecompositionSettings`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`OpenXRAPIExtension`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PCKPacker`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`POGRResponse`, :ref:`POGRResult`, :ref:`RandomNumberGenerator`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`RenderSceneBuffers`, :ref:`RenderSceneBuffersConfiguration`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TLSOptions`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`ViewLobbyResponse`, :ref:`ViewLobbyResult`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` Base class for reference-counted objects. diff --git a/classes/index.rst b/classes/index.rst index d822eed4db8..b46c36853d0 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -151,6 +151,7 @@ Nodes class_lineedit class_linkbutton class_lobbyclient + class_loginclient class_margincontainer class_marker2d class_marker3d @@ -803,6 +804,8 @@ Other objects class_lobbycallresult class_lobbyresponse class_lobbyresult + class_loginresponse + class_loginresult class_mainloop class_marshalls class_masterserverlistresponse