godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-04 12:00:25 +00:00
Code Releases Wiki Activity

[MP] Move OfflineMultiplayerPeer docs to the module

Browse Source 
Was missing from the module config, causing the XML to be added to the
main doc folder
This commit is contained in:
Fabio Alessandrelli
2024-11-27 13:18:33 +01:00
parent bbc54692c0
commit f511ef26f1
2 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
modules/multiplayer/config.py
View File

@@ -12,6 +12,7 @@ def get_doc_classes():
"SceneMultiplayer",
"MultiplayerSpawner",
"MultiplayerSynchronizer",
"OfflineMultiplayerPeer",
]

12
modules/multiplayer/doc_classes/OfflineMultiplayerPeer.xml Normal file
View File

@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="OfflineMultiplayerPeer" inherits="MultiplayerPeer" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
A [MultiplayerPeer] which is always connected and acts as a server.
</brief_description>
<description>
This is the default [member MultiplayerAPI.multiplayer_peer] for the [member Node.multiplayer]. It mimics the behavior of a server with no peers connected.
This means that the [SceneTree] will act as the multiplayer authority by default. Calls to [method MultiplayerAPI.is_server] will return [code]true[/code], and calls to [method MultiplayerAPI.get_unique_id] will return [constant MultiplayerPeer.TARGET_PEER_SERVER].
</description>
<tutorials>
</tutorials>
</class>