godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (2e7fc81)

Browse Source
This commit is contained in:
Godot Organization
2024-02-24 03:20:02 +00:00
parent 4f21f44632
commit 8978497bb6
938 changed files with 42729 additions and 36889 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
classes/class_multiplayersynchronizer.rst
View File

@@ -1,5 +1,8 @@
:github_url: hide
.. meta::
:keywords: network
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
@@ -59,17 +62,17 @@ Methods
.. table::
:widths: auto
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_visibility_filter<class_MultiplayerSynchronizer_method_add_visibility_filter>` **(** :ref:`Callable<class_Callable>` filter **)** |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_visibility_for<class_MultiplayerSynchronizer_method_get_visibility_for>` **(** :ref:`int<class_int>` peer **)** |const| |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_visibility_filter<class_MultiplayerSynchronizer_method_remove_visibility_filter>` **(** :ref:`Callable<class_Callable>` filter **)** |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_visibility_for<class_MultiplayerSynchronizer_method_set_visibility_for>` **(** :ref:`int<class_int>` peer, :ref:`bool<class_bool>` visible **)** |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_visibility<class_MultiplayerSynchronizer_method_update_visibility>` **(** :ref:`int<class_int>` for_peer=0 **)** |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_visibility_filter<class_MultiplayerSynchronizer_method_add_visibility_filter>`\ (\ filter\: :ref:`Callable<class_Callable>`\ ) |
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_visibility_for<class_MultiplayerSynchronizer_method_get_visibility_for>`\ (\ peer\: :ref:`int<class_int>`\ ) |const| |
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`remove_visibility_filter<class_MultiplayerSynchronizer_method_remove_visibility_filter>`\ (\ filter\: :ref:`Callable<class_Callable>`\ ) |
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_visibility_for<class_MultiplayerSynchronizer_method_set_visibility_for>`\ (\ peer\: :ref:`int<class_int>`, visible\: :ref:`bool<class_bool>`\ ) |
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`update_visibility<class_MultiplayerSynchronizer_method_update_visibility>`\ (\ for_peer\: :ref:`int<class_int>` = 0\ ) |
+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@@ -84,7 +87,7 @@ Signals
.. rst-class:: classref-signal
**delta_synchronized** **(** **)**
**delta_synchronized**\ (\ )
Emitted when a new delta synchronization state is received by this synchronizer after the properties have been updated.
@@ -96,7 +99,7 @@ Emitted when a new delta synchronization state is received by this synchronizer
.. rst-class:: classref-signal
**synchronized** **(** **)**
**synchronized**\ (\ )
Emitted when a new synchronization state is received by this synchronizer after the properties have been updated.
@@ -108,7 +111,7 @@ Emitted when a new synchronization state is received by this synchronizer after
.. rst-class:: classref-signal
**visibility_changed** **(** :ref:`int<class_int>` for_peer **)**
**visibility_changed**\ (\ for_peer\: :ref:`int<class_int>`\ )
Emitted when visibility of ``for_peer`` is updated. See :ref:`update_visibility<class_MultiplayerSynchronizer_method_update_visibility>`.
@@ -168,8 +171,8 @@ Property Descriptions
.. rst-class:: classref-property-setget
- void **set_delta_interval** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_delta_interval** **(** **)**
- |void| **set_delta_interval**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_delta_interval**\ (\ )
Time interval between delta synchronizations. When set to ``0.0`` (the default), delta synchronizations happen every network process frame.
@@ -185,8 +188,8 @@ Time interval between delta synchronizations. When set to ``0.0`` (the default),
.. rst-class:: classref-property-setget
- void **set_visibility_public** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_visibility_public** **(** **)**
- |void| **set_visibility_public**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_visibility_public**\ (\ )
Whether synchronization should be visible to all peers by default. See :ref:`set_visibility_for<class_MultiplayerSynchronizer_method_set_visibility_for>` and :ref:`add_visibility_filter<class_MultiplayerSynchronizer_method_add_visibility_filter>` for ways of configuring fine-grained visibility options.
@@ -202,8 +205,8 @@ Whether synchronization should be visible to all peers by default. See :ref:`set
.. rst-class:: classref-property-setget
- void **set_replication_config** **(** :ref:`SceneReplicationConfig<class_SceneReplicationConfig>` value **)**
- :ref:`SceneReplicationConfig<class_SceneReplicationConfig>` **get_replication_config** **(** **)**
- |void| **set_replication_config**\ (\ value\: :ref:`SceneReplicationConfig<class_SceneReplicationConfig>`\ )
- :ref:`SceneReplicationConfig<class_SceneReplicationConfig>` **get_replication_config**\ (\ )
Resource containing which properties to synchronize.
@@ -219,8 +222,8 @@ Resource containing which properties to synchronize.
.. rst-class:: classref-property-setget
- void **set_replication_interval** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_replication_interval** **(** **)**
- |void| **set_replication_interval**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_replication_interval**\ (\ )
Time interval between synchronizations. When set to ``0.0`` (the default), synchronizations happen every network process frame.
@@ -236,8 +239,8 @@ Time interval between synchronizations. When set to ``0.0`` (the default), synch
.. rst-class:: classref-property-setget
- void **set_root_path** **(** :ref:`NodePath<class_NodePath>` value **)**
- :ref:`NodePath<class_NodePath>` **get_root_path** **(** **)**
- |void| **set_root_path**\ (\ value\: :ref:`NodePath<class_NodePath>`\ )
- :ref:`NodePath<class_NodePath>` **get_root_path**\ (\ )
Node path that replicated properties are relative to.
@@ -255,8 +258,8 @@ If :ref:`root_path<class_MultiplayerSynchronizer_property_root_path>` was spawne
.. rst-class:: classref-property-setget
- void **set_visibility_update_mode** **(** :ref:`VisibilityUpdateMode<enum_MultiplayerSynchronizer_VisibilityUpdateMode>` value **)**
- :ref:`VisibilityUpdateMode<enum_MultiplayerSynchronizer_VisibilityUpdateMode>` **get_visibility_update_mode** **(** **)**
- |void| **set_visibility_update_mode**\ (\ value\: :ref:`VisibilityUpdateMode<enum_MultiplayerSynchronizer_VisibilityUpdateMode>`\ )
- :ref:`VisibilityUpdateMode<enum_MultiplayerSynchronizer_VisibilityUpdateMode>` **get_visibility_update_mode**\ (\ )
Specifies when visibility filters are updated (see :ref:`VisibilityUpdateMode<enum_MultiplayerSynchronizer_VisibilityUpdateMode>` for options).
@@ -273,7 +276,7 @@ Method Descriptions
.. rst-class:: classref-method
void **add_visibility_filter** **(** :ref:`Callable<class_Callable>` filter **)**
|void| **add_visibility_filter**\ (\ filter\: :ref:`Callable<class_Callable>`\ )
Adds a peer visibility filter for this synchronizer.
@@ -287,7 +290,7 @@ Adds a peer visibility filter for this synchronizer.
.. rst-class:: classref-method
:ref:`bool<class_bool>` **get_visibility_for** **(** :ref:`int<class_int>` peer **)** |const|
:ref:`bool<class_bool>` **get_visibility_for**\ (\ peer\: :ref:`int<class_int>`\ ) |const|
Queries the current visibility for peer ``peer``.
@@ -299,7 +302,7 @@ Queries the current visibility for peer ``peer``.
.. rst-class:: classref-method
void **remove_visibility_filter** **(** :ref:`Callable<class_Callable>` filter **)**
|void| **remove_visibility_filter**\ (\ filter\: :ref:`Callable<class_Callable>`\ )
Removes a peer visibility filter from this synchronizer.
@@ -311,7 +314,7 @@ Removes a peer visibility filter from this synchronizer.
.. rst-class:: classref-method
void **set_visibility_for** **(** :ref:`int<class_int>` peer, :ref:`bool<class_bool>` visible **)**
|void| **set_visibility_for**\ (\ peer\: :ref:`int<class_int>`, visible\: :ref:`bool<class_bool>`\ )
Sets the visibility of ``peer`` to ``visible``. If ``peer`` is ``0``, the value of :ref:`public_visibility<class_MultiplayerSynchronizer_property_public_visibility>` will be updated instead.
@@ -323,7 +326,7 @@ Sets the visibility of ``peer`` to ``visible``. If ``peer`` is ``0``, the value
.. rst-class:: classref-method
void **update_visibility** **(** :ref:`int<class_int>` for_peer=0 **)**
|void| **update_visibility**\ (\ for_peer\: :ref:`int<class_int>` = 0\ )
Updates the visibility of ``for_peer`` according to visibility filters. If ``for_peer`` is ``0`` (the default), all peers' visibilties are updated.
@@ -334,3 +337,4 @@ Updates the visibility of ``for_peer`` according to visibility filters. If ``for
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`