diff options
author | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2022-11-15 10:24:20 +0100 |
---|---|---|
committer | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2022-11-20 14:17:20 +0100 |
commit | b19c1a2e4f9ce5ac66daa55382322b62a2a12d1f (patch) | |
tree | e4ee12eed862329ca8b7c1b21b870b22773f4438 /doc/classes | |
parent | 8aafcf9d2ae43e83636d60dbfd5f10e50fcdb324 (diff) |
[MP] New default multiplayer_peer acting as server.
Adds a OfflineMultiplayerPeer class which behaves like a server with no
connected peers.
Use OfflineMultiplayerPeer as default for SceneMultiplayer.
This means that the SceneTree will act as the multiplayer authority by
default.
Calls to is_server will return true, and calls to get_unique_id will
return TARGET_PEER_SERVER.
Diffstat (limited to 'doc/classes')
-rw-r--r-- | doc/classes/OfflineMultiplayerPeer.xml | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/classes/OfflineMultiplayerPeer.xml b/doc/classes/OfflineMultiplayerPeer.xml new file mode 100644 index 0000000000..5e15992d54 --- /dev/null +++ b/doc/classes/OfflineMultiplayerPeer.xml @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="OfflineMultiplayerPeer" inherits="MultiplayerPeer" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../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> |