diff options
Diffstat (limited to 'modules/multiplayer')
4 files changed, 30 insertions, 30 deletions
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 @@ <methods> <method name="_spawn_custom" qualifiers="virtual"> <return type="Node" /> - <argument index="0" name="data" type="Variant" /> + <param index="0" name="data" type="Variant" /> <description> 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 @@ </method> <method name="add_spawnable_scene"> <return type="void" /> - <argument index="0" name="path" type="String" /> + <param index="0" name="path" type="String" /> <description> 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]. </description> @@ -36,7 +36,7 @@ </method> <method name="get_spawnable_scene" qualifiers="const"> <return type="String" /> - <argument index="0" name="index" type="int" /> + <param index="0" name="index" type="int" /> <description> Returns the spawnable scene path by index. </description> @@ -49,7 +49,7 @@ </method> <method name="spawn"> <return type="Node" /> - <argument index="0" name="data" type="Variant" default="null" /> + <param index="0" name="data" type="Variant" default="null" /> <description> 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 @@ </members> <signals> <signal name="despawned"> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Emitted when a spawnable scene or custom spawn was despawned by the multiplayer authority. Only called on puppets. </description> </signal> <signal name="spawned"> - <argument index="0" name="node" type="Node" /> + <param index="0" name="node" type="Node" /> <description> Emitted when a spawnable scene or custom spawn was spawned by the multiplayer authority. Only called on puppets. </description> 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 @@ <methods> <method name="add_visibility_filter"> <return type="void" /> - <argument index="0" name="filter" type="Callable" /> + <param index="0" name="filter" type="Callable" /> <description> Adds a peer visibility filter for this synchronizer. @@ -25,29 +25,29 @@ </method> <method name="get_visibility_for" qualifiers="const"> <return type="bool" /> - <argument index="0" name="peer" type="int" /> + <param index="0" name="peer" type="int" /> <description> Queries the current visibility for peer [code]peer[/code]. </description> </method> <method name="remove_visibility_filter"> <return type="void" /> - <argument index="0" name="filter" type="Callable" /> + <param index="0" name="filter" type="Callable" /> <description> Removes a peer visiblity filter from this synchronizer. </description> </method> <method name="set_visibility_for"> <return type="void" /> - <argument index="0" name="peer" type="int" /> - <argument index="1" name="visible" type="bool" /> + <param index="0" name="peer" type="int" /> + <param index="1" name="visible" type="bool" /> <description> 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. </description> </method> <method name="update_visibility"> <return type="void" /> - <argument index="0" name="for_peer" type="int" default="0" /> + <param index="0" name="for_peer" type="int" default="0" /> <description> 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. </description> @@ -73,7 +73,7 @@ </members> <signals> <signal name="visibility_changed"> - <argument index="0" name="for_peer" type="int" /> + <param index="0" name="for_peer" type="int" /> <description> Emitted when visibility of [code]for_peer[/code] is updated. See [method update_visibility]. </description> 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 @@ </method> <method name="send_bytes"> <return type="int" enum="Error" /> - <argument index="0" name="bytes" type="PackedByteArray" /> - <argument index="1" name="id" type="int" default="0" /> - <argument index="2" name="mode" type="int" enum="MultiplayerPeer.TransferMode" default="2" /> - <argument index="3" name="channel" type="int" default="0" /> + <param index="0" name="bytes" type="PackedByteArray" /> + <param index="1" name="id" type="int" default="0" /> + <param index="2" name="mode" type="int" enum="MultiplayerPeer.TransferMode" default="2" /> + <param index="3" name="channel" type="int" default="0" /> <description> 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. </description> @@ -45,8 +45,8 @@ </members> <signals> <signal name="peer_packet"> - <argument index="0" name="id" type="int" /> - <argument index="1" name="packet" type="PackedByteArray" /> + <param index="0" name="id" type="int" /> + <param index="1" name="packet" type="PackedByteArray" /> <description> 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. </description> 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 @@ <methods> <method name="add_property"> <return type="void" /> - <argument index="0" name="path" type="NodePath" /> - <argument index="1" name="index" type="int" default="-1" /> + <param index="0" name="path" type="NodePath" /> + <param index="1" name="index" type="int" default="-1" /> <description> Adds the property identified by the given [code]path[/code] to the list of the properties being synchronized, optionally passing an [code]index[/code]. </description> @@ -24,51 +24,51 @@ </method> <method name="has_property" qualifiers="const"> <return type="bool" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Returns whether the given [code]path[/code] is configured for synchronization. </description> </method> <method name="property_get_index" qualifiers="const"> <return type="int" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Finds the index of the given [code]path[/code]. </description> </method> <method name="property_get_spawn"> <return type="bool" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Returns whether the property identified by the given [code]path[/code] is configured to be synchronized on spawn. </description> </method> <method name="property_get_sync"> <return type="bool" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Returns whether the property identified by the given [code]path[/code] is configured to be synchronized on process. </description> </method> <method name="property_set_spawn"> <return type="void" /> - <argument index="0" name="path" type="NodePath" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="path" type="NodePath" /> + <param index="1" name="enabled" type="bool" /> <description> Sets whether the property identified by the given [code]path[/code] is configured to be synchronized on spawn. </description> </method> <method name="property_set_sync"> <return type="void" /> - <argument index="0" name="path" type="NodePath" /> - <argument index="1" name="enabled" type="bool" /> + <param index="0" name="path" type="NodePath" /> + <param index="1" name="enabled" type="bool" /> <description> Sets whether the property identified by the given [code]path[/code] is configured to be synchronized on process. </description> </method> <method name="remove_property"> <return type="void" /> - <argument index="0" name="path" type="NodePath" /> + <param index="0" name="path" type="NodePath" /> <description> Removes the property identified by the given [code]path[/code] from the configuration. </description> |