From c5d7115038de5f83cb83e08748615a84fc26bee2 Mon Sep 17 00:00:00 2001 From: Yuri Sizov Date: Sat, 6 Aug 2022 21:11:48 +0300 Subject: Rename the argument tag to param in XML documentation --- .../multiplayer/doc_classes/MultiplayerSpawner.xml | 12 ++++++------ .../doc_classes/MultiplayerSynchronizer.xml | 14 +++++++------- .../multiplayer/doc_classes/SceneMultiplayer.xml | 12 ++++++------ .../doc_classes/SceneReplicationConfig.xml | 22 +++++++++++----------- 4 files changed, 30 insertions(+), 30 deletions(-) (limited to 'modules/multiplayer') diff --git a/modules/multiplayer/doc_classes/MultiplayerSpawner.xml b/modules/multiplayer/doc_classes/MultiplayerSpawner.xml index 881796ed26..c0265c9161 100644 --- a/modules/multiplayer/doc_classes/MultiplayerSpawner.xml +++ b/modules/multiplayer/doc_classes/MultiplayerSpawner.xml @@ -14,7 +14,7 @@ - + Method called on all peers when a custom spawn was requested by the authority using [method spawn]. Should return a [Node] that is not in the scene tree. @@ -23,7 +23,7 @@ - + Adds a scene path to spawnable scenes, making it automatically replicated from the multiplayer authority to other peers when added as children of the node pointed by [member spawn_path]. @@ -36,7 +36,7 @@ - + Returns the spawnable scene path by index. @@ -49,7 +49,7 @@ - + Requests a custom spawn, with [code]data[/code] passed to [method _spawn_custom] on all peers. Returns the locally spawned node instance already inside the scene tree, and added as a child of the node pointed by [member spawn_path]. @@ -69,13 +69,13 @@ - + Emitted when a spawnable scene or custom spawn was despawned by the multiplayer authority. Only called on puppets. - + Emitted when a spawnable scene or custom spawn was spawned by the multiplayer authority. Only called on puppets. diff --git a/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml b/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml index a2ea64061c..9a4d755d64 100644 --- a/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml +++ b/modules/multiplayer/doc_classes/MultiplayerSynchronizer.xml @@ -16,7 +16,7 @@ - + Adds a peer visibility filter for this synchronizer. @@ -25,29 +25,29 @@ - + Queries the current visibility for peer [code]peer[/code]. - + Removes a peer visiblity filter from this synchronizer. - - + + Sets the visibility of [code]peer[/code] to [code]visible[/code]. If [code]peer[/code] is [code]0[/code], the value of [member public_visibility] will be updated instead. - + Updates the visibility of [code]peer[/code] according to visibility filters. If [code]peer[/code] is [code]0[/code] (the default), all peers' visibilties are updated. @@ -73,7 +73,7 @@ - + Emitted when visibility of [code]for_peer[/code] is updated. See [method update_visibility]. diff --git a/modules/multiplayer/doc_classes/SceneMultiplayer.xml b/modules/multiplayer/doc_classes/SceneMultiplayer.xml index 0c3ed2d784..62bb396d15 100644 --- a/modules/multiplayer/doc_classes/SceneMultiplayer.xml +++ b/modules/multiplayer/doc_classes/SceneMultiplayer.xml @@ -21,10 +21,10 @@ - - - - + + + + Sends the given raw [code]bytes[/code] to a specific peer identified by [code]id[/code] (see [method MultiplayerPeer.set_target_peer]). Default ID is [code]0[/code], i.e. broadcast to all peers. @@ -45,8 +45,8 @@ - - + + Emitted when this MultiplayerAPI's [member MultiplayerAPI.multiplayer_peer] receives a [code]packet[/code] with custom data (see [method send_bytes]). ID is the peer ID of the peer that sent the packet. diff --git a/modules/multiplayer/doc_classes/SceneReplicationConfig.xml b/modules/multiplayer/doc_classes/SceneReplicationConfig.xml index fc91592c7a..fdc441e9c3 100644 --- a/modules/multiplayer/doc_classes/SceneReplicationConfig.xml +++ b/modules/multiplayer/doc_classes/SceneReplicationConfig.xml @@ -10,8 +10,8 @@ - - + + Adds the property identified by the given [code]path[/code] to the list of the properties being synchronized, optionally passing an [code]index[/code]. @@ -24,51 +24,51 @@ - + Returns whether the given [code]path[/code] is configured for synchronization. - + Finds the index of the given [code]path[/code]. - + Returns whether the property identified by the given [code]path[/code] is configured to be synchronized on spawn. - + Returns whether the property identified by the given [code]path[/code] is configured to be synchronized on process. - - + + Sets whether the property identified by the given [code]path[/code] is configured to be synchronized on spawn. - - + + Sets whether the property identified by the given [code]path[/code] is configured to be synchronized on process. - + Removes the property identified by the given [code]path[/code] from the configuration. -- cgit v1.2.3