noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Rename the argument tag to param in XML documentation

Browse Source
This commit is contained in:
Yuri Sizov
2022-08-06 21:11:48 +03:00
parent 35c1eae8d7
commit c5d7115038
432 changed files with 10529 additions and 10529 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/classes/MultiplayerAPI.xml
+11 -11
View File
@@ -57,8 +57,8 @@
</method>
<method name="object_configuration_add">
<return type="int" enum="Error" />
<argument index="0" name="object" type="Object" />
<argument index="1" name="configuration" type="Variant" />
<param index="0" name="object" type="Object" />
<param index="1" name="configuration" type="Variant" />
<description>
Notifies the MultiplayerAPI of a new [code]configuration[/code] for the given [code]object[/code]. This method is used internally by [SceneTree] to configure the root path for this MultiplayerAPI (passing [code]null[/code] and a valid [NodePath] as [code]configuration[/code]). This method can be further used by MultiplayerAPI implementations to provide additional features, refer to specific implementation (e.g. [SceneMultiplayer]) for details on how they use it.
[b]Note:[/b] This method is mostly relevant when extending or overriding the MultiplayerAPI behavior via [MultiplayerAPIExtension].
@@ -66,8 +66,8 @@
</method>
<method name="object_configuration_remove">
<return type="int" enum="Error" />
<argument index="0" name="object" type="Object" />
<argument index="1" name="configuration" type="Variant" />
<param index="0" name="object" type="Object" />
<param index="1" name="configuration" type="Variant" />
<description>
Notifies the MultiplayerAPI to remove a [code]configuration[/code] for the given [code]object[/code]. This method is used internally by [SceneTree] to configure the root path for this MultiplayerAPI (passing [code]null[/code] and an empty [NodePath] as [code]configuration[/code]). This method can be further used by MultiplayerAPI implementations to provide additional features, refer to specific implementation (e.g. [SceneMultiplayer]) for details on how they use it.
[b]Note:[/b] This method is mostly relevant when extending or overriding the MultiplayerAPI behavior via [MultiplayerAPIExtension].
@@ -82,10 +82,10 @@
</method>
<method name="rpc">
<return type="int" enum="Error" />
<argument index="0" name="peer" type="int" />
<argument index="1" name="object" type="Object" />
<argument index="2" name="method" type="StringName" />
<argument index="3" name="arguments" type="Array" default="[]" />
<param index="0" name="peer" type="int" />
<param index="1" name="object" type="Object" />
<param index="2" name="method" type="StringName" />
<param index="3" name="arguments" type="Array" default="[]" />
<description>
Sends an RPC to the target [code]peer[/code]. The given [code]method[/code] will be called on the remote [code]object[/code] with the provided [code]arguments[/code]. The RPC may also be called locally depending on the implementation and RPC configuration. See [method Node.rpc] and [method Node.rpc_config].
[b]Note:[/b] Prefer using [method Node.rpc], [method Node.rpc_id], or [code]my_method.rpc(peer, arg1, arg2, ...)[/code] (in GDScript), since they are faster. This method is mostly useful in conjunction with [MultiplayerAPIExtension] when augmenting or replacing the multiplayer capabilities.
@@ -93,7 +93,7 @@
</method>
<method name="set_default_interface" qualifiers="static">
<return type="void" />
<argument index="0" name="interface_name" type="StringName" />
<param index="0" name="interface_name" type="StringName" />
<description>
Sets the default MultiplayerAPI implementation class. This method can be used by modules and extensions to configure which implementation will be used by [SceneTree] when the engine starts.
</description>
@@ -116,13 +116,13 @@
</description>
</signal>
<signal name="peer_connected">
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
Emitted when this MultiplayerAPI's [member multiplayer_peer] connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1).
</description>
</signal>
<signal name="peer_disconnected">
<argument index="0" name="id" type="int" />
<param index="0" name="id" type="int" />
<description>
Emitted when this MultiplayerAPI's [member multiplayer_peer] disconnects from a peer. Clients get notified when other clients disconnect from the same server.
</description>