Skip to content

Commit 5fa8f41

Browse files
authored
Merge pull request godotengine#7573 from godotengine/classref/sync-c83f912
classref: Sync with current master branch (c83f912)
2 parents 82dde48 + 029de78 commit 5fa8f41

10 files changed

+242
-235
lines changed

classes/[email protected]

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -663,13 +663,13 @@ Mark the following property as assigned when the :ref:`Node<class_Node>` is read
663663

664664
Mark the following method for remote procedure calls. See :doc:`High-level multiplayer <../tutorials/networking/high_level_multiplayer>`.
665665

666-
The accepted values:
666+
If ``mode`` is set as ``"any_peer"``, allows any peer to call this RPC function. Otherwise, only the authority peer is allowed to call it and ``mode`` should be kept as ``"authority"``. When configuring functions as RPCs with :ref:`Node.rpc_config<class_Node_method_rpc_config>`, each of these modes respectively corresponds to the :ref:`MultiplayerAPI.RPC_MODE_AUTHORITY<class_MultiplayerAPI_constant_RPC_MODE_AUTHORITY>` and :ref:`MultiplayerAPI.RPC_MODE_ANY_PEER<class_MultiplayerAPI_constant_RPC_MODE_ANY_PEER>` RPC modes. See :ref:`RPCMode<enum_MultiplayerAPI_RPCMode>`. If a peer that is not the authority tries to call a function that is only allowed for the authority, the function will not be executed. If the error can be detected locally (when the RPC configuration is consistent between the local and the remote peer), an error message will be displayed on the sender peer. Otherwise, the remote peer will detect the error and print an error there.
667667

668-
- for ``mode`` are ``"any_peer"`` or ``"authority"``;
668+
If ``sync`` is set as ``"call_remote"``, the function will only be executed on the remote peer, but not locally. To run this function locally too, set ``sync`` to ``"call_local"``. When configuring functions as RPCs with :ref:`Node.rpc_config<class_Node_method_rpc_config>`, this is equivalent to setting `call_local` to `true`.
669669

670-
- for ``sync`` are ``"call_remote"`` or ``"call_local"``;
670+
The ``transfer_mode`` accepted values are ``"unreliable"``, ``"unreliable_ordered"``, or ``"reliable"``. It sets the transfer mode of the underlying :ref:`MultiplayerPeer<class_MultiplayerPeer>`. See :ref:`MultiplayerPeer.transfer_mode<class_MultiplayerPeer_property_transfer_mode>`.
671671

672-
- and for ``transfer_mode`` are ``"unreliable"``, ``"unreliable_ordered"``, or ``"reliable"``.
672+
The ``transfer_channel`` defines the channel of the underlying :ref:`MultiplayerPeer<class_MultiplayerPeer>`. See :ref:`MultiplayerPeer.transfer_channel<class_MultiplayerPeer_property_transfer_channel>`.
673673

674674
The order of ``mode``, ``sync`` and ``transfer_mode`` does not matter, but values related to the same argument must not be used more than once. ``transfer_channel`` always has to be the 4th argument (you must specify 3 preceding arguments).
675675

classes/[email protected]

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4899,7 +4899,7 @@ The :ref:`NavigationServer2D<class_NavigationServer2D>` singleton.
48994899

49004900
:ref:`NavigationServer3D<class_NavigationServer3D>` **NavigationServer3D**
49014901

4902-
The :ref:`NavigationServer2D<class_NavigationServer2D>` singleton.
4902+
The :ref:`NavigationServer3D<class_NavigationServer3D>` singleton.
49034903

49044904
.. rst-class:: classref-item-separator
49054905

classes/class_callable.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ Returns ``true`` if the callable's object exists and has a valid method name ass
402402

403403
void **rpc** **(** ... **)** |vararg| |const|
404404

405-
Perform an RPC (Remote Procedure Call). This is used for multiplayer and is normally not available, unless the function being called has been marked as *RPC*. Calling this method on unsupported functions will result in an error. See :ref:`Node.rpc<class_Node_method_rpc>`.
405+
Perform an RPC (Remote Procedure Call) on all connected peers. This is used for multiplayer and is normally not available, unless the function being called has been marked as *RPC* (using :ref:`@GDScript.@rpc<class_@GDScript_annotation_@rpc>` or :ref:`Node.rpc_config<class_Node_method_rpc_config>`). Calling this method on unsupported functions will result in an error. See :ref:`Node.rpc<class_Node_method_rpc>`.
406406

407407
.. rst-class:: classref-item-separator
408408

@@ -414,7 +414,7 @@ Perform an RPC (Remote Procedure Call). This is used for multiplayer and is norm
414414

415415
void **rpc_id** **(** :ref:`int<class_int>` peer_id, ... **)** |vararg| |const|
416416

417-
Perform an RPC (Remote Procedure Call) on a specific peer ID (see multiplayer documentation for reference). This is used for multiplayer and is normally not available unless the function being called has been marked as *RPC*. Calling this method on unsupported functions will result in an error. See :ref:`Node.rpc_id<class_Node_method_rpc_id>`.
417+
Perform an RPC (Remote Procedure Call) on a specific peer ID (see multiplayer documentation for reference). This is used for multiplayer and is normally not available unless the function being called has been marked as *RPC* (using :ref:`@GDScript.@rpc<class_@GDScript_annotation_@rpc>` or :ref:`Node.rpc_config<class_Node_method_rpc_config>`). Calling this method on unsupported functions will result in an error. See :ref:`Node.rpc_id<class_Node_method_rpc_id>`.
418418

419419
.. rst-class:: classref-item-separator
420420

classes/class_editorimportplugin.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,10 @@ Below is an example EditorImportPlugin that imports a :ref:`Mesh<class_Mesh>` fr
5151
func _get_preset_count():
5252
return 1
5353

54-
func _get_preset_name(i):
54+
func _get_preset_name(preset_index):
5555
return "Default"
5656

57-
func _get_import_options(i):
57+
func _get_import_options(path, preset_index):
5858
return [{"name": "my_option", "default_value": false}]
5959

6060
func _import(source_file, save_path, options, platform_variants, gen_files):

classes/class_mutex.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Locks this **Mutex**, blocks until it is unlocked by the current owner.
8787

8888
Tries locking this **Mutex**, but does not block. Returns ``true`` on success, ``false`` otherwise.
8989

90-
\ **Note:** This function returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if the thread already has ownership of the mutex.
90+
\ **Note:** This function returns ``true`` if the thread already has ownership of the mutex.
9191

9292
.. rst-class:: classref-item-separator
9393

0 commit comments

Comments
 (0)