From 1ed38d59bf4544de60a745439255eac132992f80 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Wed, 8 Feb 2023 15:10:32 +0100 Subject: [PATCH] classref: Sync with current master branch (c4fb119f0) --- classes/class_@gdscript.rst | 23 +++- classes/class_@globalscope.rst | 10 +- classes/class_audiostreamplayer2d.rst | 6 +- classes/class_audiostreamplayer3d.rst | 20 ++-- classes/class_editorexportplugin.rst | 104 ++++++++++-------- classes/class_generic6dofjoint3d.rst | 6 +- classes/class_multiplayerapi.rst | 2 +- classes/class_physicsserver2d.rst | 8 +- classes/class_physicsserver3d.rst | 10 +- .../class_skeletonmodification2djiggle.rst | 4 +- 10 files changed, 117 insertions(+), 76 deletions(-) diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 9e650387e6e..5eb5ae93e4b 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -199,7 +199,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_DIR` names, ... **)** |vararg| -Export an :ref:`int` or :ref:`String` property as an enumerated list of options. If the property is an :ref:`int`, then the index of the value is stored, in the same order the values are provided. You can add specific identifiers for allowed values using a colon. If the property is a :ref:`String`, then the value is stored. +Export an :ref:`int` or :ref:`String` property as an enumerated list of options. If the property is an :ref:`int`, then the index of the value is stored, in the same order the values are provided. You can add explicit values using a colon. If the property is a :ref:`String`, then the value is stored. See also :ref:`@GlobalScope.PROPERTY_HINT_ENUM`. @@ -281,6 +281,27 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_FLAGS`, the previous explicit value is not taken into account. In the following example, A is 16, B is 2, C is 4. + +:: + + @export_flags("A:16", "B", "C") var x + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 392dae68ee6..cbb09cdbaf7 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -3419,7 +3419,7 @@ Additionally, other keywords can be included: ``"exp"`` for exponential range ed Hints that an :ref:`int` or :ref:`String` property is an enumerated value to pick in a list specified via a hint string. -The hint string is a comma separated list of names such as ``"Hello,Something,Else"``. Whitespaces are **not** removed from either end of a name. For integer and float properties, the first name in the list has value 0, the next 1, and so on. Explicit values can also be specified by appending ``:integer`` to the name, e.g. ``"Zero,One,Three:3,Four,Six:6"``. +The hint string is a comma separated list of names such as ``"Hello,Something,Else"``. Whitespaces are **not** removed from either end of a name. For integer properties, the first name in the list has value 0, the next 1, and so on. Explicit values can also be specified by appending ``:integer`` to the name, e.g. ``"Zero,One,Three:3,Four,Six:6"``. .. _class_@GlobalScope_constant_PROPERTY_HINT_ENUM_SUGGESTION: @@ -3453,7 +3453,13 @@ Hints that a vector property should allow its components to be linked. For examp :ref:`PropertyHint` **PROPERTY_HINT_FLAGS** = ``6`` -Hints that an :ref:`int` property is a bitmask with named bit flags. For example, to allow toggling bits 0, 1, 2 and 4, the hint could be something like ``"Bit0,Bit1,Bit2,,Bit4"``. +Hints that an :ref:`int` property is a bitmask with named bit flags. + +The hint string is a comma separated list of names such as ``"Bit0,Bit1,Bit2,Bit3"``. Whitespaces are **not** removed from either end of a name. The first name in the list has value 1, the next 2, then 4, 8, 16 and so on. Explicit values can also be specified by appending ``:integer`` to the name, e.g. ``"A:4,B:8,C:16"``. You can also combine several flags (``"A:4,B:8,AB:12,C:16"``). + +\ **Note:** A flag value must be at least ``1`` and at most ``2 ** 32 - 1``. + +\ **Note:** Unlike :ref:`PROPERTY_HINT_ENUM`, the previous explicit value is not taken into account. For the hint ``"A:16,B,C"``, A is 16, B is 2, C is 4. .. _class_@GlobalScope_constant_PROPERTY_HINT_LAYERS_2D_RENDER: diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index 02e5ba92f0e..83929230842 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -19,7 +19,7 @@ Plays positional sound in 2D space. Description ----------- -Plays audio that dampens with distance from a given position. +Plays audio that is attenuated with distance to the listener. By default, audio is heard from the screen center. This can be changed by adding an :ref:`AudioListener2D` node to the scene and enabling it by calling :ref:`AudioListener2D.make_current` on it. @@ -144,7 +144,7 @@ Determines which :ref:`Area2D` layers affect the sound for reverb - void **set_attenuation** **(** :ref:`float` value **)** - :ref:`float` **get_attenuation** **(** **)** -Dampens audio over distance with this as an exponent. +The volume is attenuated over distance with this as an exponent. .. rst-class:: classref-item-separator @@ -315,7 +315,7 @@ If ``true``, the playback is paused. You can resume it by setting ``stream_pause - void **set_volume_db** **(** :ref:`float` value **)** - :ref:`float` **get_volume_db** **(** **)** -Base volume without dampening. +Base volume before attenuation. .. rst-class:: classref-section-separator diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index cf435d48901..1432d3183bc 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -19,7 +19,7 @@ Plays positional sound in 3D space. Description ----------- -Plays a sound effect with directed sound effects, dampens with distance if needed, generates effect of hearable position in space. For greater realism, a low-pass filter is automatically applied to distant sounds. This can be disabled by setting :ref:`attenuation_filter_cutoff_hz` to ``20500``. +Plays audio with positional sound effects, based on the relative position of the audio listener. Positional effects include distance attenuation, directionality, and the Doppler effect. For greater realism, a low-pass filter is applied to distant sounds. This can be disabled by setting :ref:`attenuation_filter_cutoff_hz` to ``20500``. By default, audio is heard from the camera position. This can be changed by adding an :ref:`AudioListener3D` node to the scene and enabling it by calling :ref:`AudioListener3D.make_current` on it. @@ -144,7 +144,7 @@ enum **AttenuationModel**: :ref:`AttenuationModel` **ATTENUATION_INVERSE_DISTANCE** = ``0`` -Linear dampening of loudness according to distance. +Attenuation of loudness according to linear distance. .. _class_AudioStreamPlayer3D_constant_ATTENUATION_INVERSE_SQUARE_DISTANCE: @@ -152,7 +152,7 @@ Linear dampening of loudness according to distance. :ref:`AttenuationModel` **ATTENUATION_INVERSE_SQUARE_DISTANCE** = ``1`` -Squared dampening of loudness according to distance. +Attenuation of loudness according to squared distance. .. _class_AudioStreamPlayer3D_constant_ATTENUATION_LOGARITHMIC: @@ -160,7 +160,7 @@ Squared dampening of loudness according to distance. :ref:`AttenuationModel` **ATTENUATION_LOGARITHMIC** = ``2`` -Logarithmic dampening of loudness according to distance. +Attenuation of loudness according to logarithmic distance. .. _class_AudioStreamPlayer3D_constant_ATTENUATION_DISABLED: @@ -168,7 +168,7 @@ Logarithmic dampening of loudness according to distance. :ref:`AttenuationModel` **ATTENUATION_DISABLED** = ``3`` -No dampening of loudness according to distance. The sound will still be heard positionally, unlike an :ref:`AudioStreamPlayer`. :ref:`ATTENUATION_DISABLED` can be combined with a :ref:`max_distance` value greater than ``0.0`` to achieve linear attenuation clamped to a sphere of a defined size. +No attenuation of loudness according to distance. The sound will still be heard positionally, unlike an :ref:`AudioStreamPlayer`. :ref:`ATTENUATION_DISABLED` can be combined with a :ref:`max_distance` value greater than ``0.0`` to achieve linear attenuation clamped to a sphere of a defined size. .. rst-class:: classref-item-separator @@ -241,7 +241,7 @@ Determines which :ref:`Area3D` layers affect the sound for reverb - void **set_attenuation_filter_cutoff_hz** **(** :ref:`float` value **)** - :ref:`float` **get_attenuation_filter_cutoff_hz** **(** **)** -Dampens audio using a low-pass filter above this frequency, in Hz. To disable the dampening effect entirely, set this to ``20500`` as this frequency is above the human hearing limit. +The cutoff frequency of the attenuation low-pass filter, in Hz. A sound above this frequency is attenuated more than a sound below this frequency. To disable this effect, set this to ``20500`` as this frequency is above the human hearing limit. .. rst-class:: classref-item-separator @@ -345,7 +345,7 @@ Decides in which step the Doppler effect should be calculated. - void **set_emission_angle** **(** :ref:`float` value **)** - :ref:`float` **get_emission_angle** **(** **)** -The angle in which the audio reaches cameras undampened. +The angle in which the audio reaches a listener unattenuated. .. rst-class:: classref-item-separator @@ -362,7 +362,7 @@ The angle in which the audio reaches cameras undampened. - void **set_emission_angle_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_emission_angle_enabled** **(** **)** -If ``true``, the audio should be dampened according to the direction of the sound. +If ``true``, the audio should be attenuated according to the direction of the sound. .. rst-class:: classref-item-separator @@ -379,7 +379,7 @@ If ``true``, the audio should be dampened according to the direction of the soun - void **set_emission_angle_filter_attenuation_db** **(** :ref:`float` value **)** - :ref:`float` **get_emission_angle_filter_attenuation_db** **(** **)** -Dampens audio if camera is outside of :ref:`emission_angle_degrees` and :ref:`emission_angle_enabled` is set by this factor, in decibels. +Attenuation factor used if listener is outside of :ref:`emission_angle_degrees` and :ref:`emission_angle_enabled` is set, in decibels. .. rst-class:: classref-item-separator @@ -548,7 +548,7 @@ The factor for the attenuation effect. Higher values make the sound audible over - void **set_volume_db** **(** :ref:`float` value **)** - :ref:`float` **get_volume_db** **(** **)** -The base sound level unaffected by dampening, in decibels. +The base sound level before attenuation, in decibels. .. rst-class:: classref-section-separator diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index be985726642..bfa42f92f9b 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -31,51 +31,53 @@ Methods .. table:: :widths: auto - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_begin_customize_resources` **(** :ref:`EditorExportPlatform` platform, :ref:`PackedStringArray` features **)** |virtual| |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`bool` | :ref:`_begin_customize_scenes` **(** :ref:`EditorExportPlatform` platform, :ref:`PackedStringArray` features **)** |virtual| |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Resource` | :ref:`_customize_resource` **(** :ref:`Resource` resource, :ref:`String` path **)** |virtual| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Node` | :ref:`_customize_scene` **(** :ref:`Node` scene, :ref:`String` path **)** |virtual| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_end_customize_resources` **(** **)** |virtual| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_end_customize_scenes` **(** **)** |virtual| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_export_begin` **(** :ref:`PackedStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** |virtual| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_export_end` **(** **)** |virtual| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PackedStringArray` features **)** |virtual| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`_get_customization_configuration_hash` **(** **)** |virtual| |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`String` | :ref:`_get_name` **(** **)** |virtual| |const| | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_file` **(** :ref:`String` path, :ref:`PackedByteArray` file, :ref:`bool` remap **)** | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_ios_bundle_file` **(** :ref:`String` path **)** | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_ios_cpp_code` **(** :ref:`String` code **)** | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_ios_embedded_framework` **(** :ref:`String` path **)** | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_ios_framework` **(** :ref:`String` path **)** | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_ios_linker_flags` **(** :ref:`String` flags **)** | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_ios_plist_content` **(** :ref:`String` plist_content **)** | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_ios_project_static_lib` **(** :ref:`String` path **)** | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_macos_plugin_file` **(** :ref:`String` path **)** | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`add_shared_object` **(** :ref:`String` path, :ref:`PackedStringArray` tags, :ref:`String` target **)** | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | void | :ref:`skip` **(** **)** | - +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_begin_customize_resources` **(** :ref:`EditorExportPlatform` platform, :ref:`PackedStringArray` features **)** |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`_begin_customize_scenes` **(** :ref:`EditorExportPlatform` platform, :ref:`PackedStringArray` features **)** |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Resource` | :ref:`_customize_resource` **(** :ref:`Resource` resource, :ref:`String` path **)** |virtual| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Node` | :ref:`_customize_scene` **(** :ref:`Node` scene, :ref:`String` path **)** |virtual| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_end_customize_resources` **(** **)** |virtual| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_end_customize_scenes` **(** **)** |virtual| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_export_begin` **(** :ref:`PackedStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** |virtual| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_export_end` **(** **)** |virtual| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PackedStringArray` features **)** |virtual| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`_get_customization_configuration_hash` **(** **)** |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_export_features` **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`_get_name` **(** **)** |virtual| |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_file` **(** :ref:`String` path, :ref:`PackedByteArray` file, :ref:`bool` remap **)** | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_ios_bundle_file` **(** :ref:`String` path **)** | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_ios_cpp_code` **(** :ref:`String` code **)** | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_ios_embedded_framework` **(** :ref:`String` path **)** | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_ios_framework` **(** :ref:`String` path **)** | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_ios_linker_flags` **(** :ref:`String` flags **)** | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_ios_plist_content` **(** :ref:`String` plist_content **)** | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_ios_project_static_lib` **(** :ref:`String` path **)** | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_macos_plugin_file` **(** :ref:`String` path **)** | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`add_shared_object` **(** :ref:`String` path, :ref:`PackedStringArray` tags, :ref:`String` target **)** | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`skip` **(** **)** | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator @@ -210,6 +212,18 @@ Return a hash based on the configuration passed (for both scenes and resources). ---- +.. _class_EditorExportPlugin_method__get_export_features: + +.. rst-class:: classref-method + +:ref:`PackedStringArray` **_get_export_features** **(** :ref:`EditorExportPlatform` platform, :ref:`bool` debug **)** |virtual| |const| + +Return a :ref:`PackedStringArray` of additional features this preset, for the given ``platform``, should have. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorExportPlugin_method__get_name: .. rst-class:: classref-method diff --git a/classes/class_generic6dofjoint3d.rst b/classes/class_generic6dofjoint3d.rst index a3db1486226..a154d1572a9 100644 --- a/classes/class_generic6dofjoint3d.rst +++ b/classes/class_generic6dofjoint3d.rst @@ -358,7 +358,7 @@ The speed of all rotations across the axes. :ref:`Param` **PARAM_ANGULAR_DAMPING** = ``13`` -The amount of rotational damping across the axes. The lower, the more dampening occurs. +The amount of rotational damping across the axes. The lower, the more damping occurs. .. _class_Generic6DOFJoint3D_constant_PARAM_ANGULAR_RESTITUTION: @@ -656,7 +656,7 @@ The minimum rotation in positive direction to break loose and rotate around the - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| -The amount of rotational damping across the Y axis. The lower, the more dampening occurs. +The amount of rotational damping across the Y axis. The lower, the more damping occurs. .. rst-class:: classref-item-separator @@ -792,7 +792,7 @@ The minimum rotation in positive direction to break loose and rotate around the - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| -The amount of rotational damping across the Z axis. The lower, the more dampening occurs. +The amount of rotational damping across the Z axis. The lower, the more damping occurs. .. rst-class:: classref-item-separator diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index 147bd0ce6c2..8c48b99eff4 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -169,7 +169,7 @@ Used with :ref:`Node.rpc_config` to disable a meth :ref:`RPCMode` **RPC_MODE_ANY_PEER** = ``1`` -Used with :ref:`Node.rpc_config` to set a method to be callable remotely by any peer. Analogous to the ``@rpc("any")`` annotation. Calls are accepted from all remote peers, no matter if they are node's authority or not. +Used with :ref:`Node.rpc_config` to set a method to be callable remotely by any peer. Analogous to the ``@rpc("any_peer")`` annotation. Calls are accepted from all remote peers, no matter if they are node's authority or not. .. _class_MultiplayerAPI_constant_RPC_MODE_AUTHORITY: diff --git a/classes/class_physicsserver2d.rst b/classes/class_physicsserver2d.rst index 1da5612099f..8304cb9272c 100644 --- a/classes/class_physicsserver2d.rst +++ b/classes/class_physicsserver2d.rst @@ -682,7 +682,7 @@ Constant to set/get a body's gravity multiplier. :ref:`BodyParameter` **BODY_PARAM_LINEAR_DAMP_MODE** = ``6`` -Constant to set/get a body's linear dampening mode. See :ref:`BodyDampMode` for possible values. +Constant to set/get a body's linear damping mode. See :ref:`BodyDampMode` for possible values. .. _class_PhysicsServer2D_constant_BODY_PARAM_ANGULAR_DAMP_MODE: @@ -690,7 +690,7 @@ Constant to set/get a body's linear dampening mode. See :ref:`BodyDampMode` **BODY_PARAM_ANGULAR_DAMP_MODE** = ``7`` -Constant to set/get a body's angular dampening mode. See :ref:`BodyDampMode` for possible values. +Constant to set/get a body's angular damping mode. See :ref:`BodyDampMode` for possible values. .. _class_PhysicsServer2D_constant_BODY_PARAM_LINEAR_DAMP: @@ -698,7 +698,7 @@ Constant to set/get a body's angular dampening mode. See :ref:`BodyDampMode` **BODY_PARAM_LINEAR_DAMP** = ``8`` -Constant to set/get a body's linear dampening factor. +Constant to set/get a body's linear damping factor. .. _class_PhysicsServer2D_constant_BODY_PARAM_ANGULAR_DAMP: @@ -706,7 +706,7 @@ Constant to set/get a body's linear dampening factor. :ref:`BodyParameter` **BODY_PARAM_ANGULAR_DAMP** = ``9`` -Constant to set/get a body's angular dampening factor. +Constant to set/get a body's angular damping factor. .. _class_PhysicsServer2D_constant_BODY_PARAM_MAX: diff --git a/classes/class_physicsserver3d.rst b/classes/class_physicsserver3d.rst index 4469194f230..579a08a3354 100644 --- a/classes/class_physicsserver3d.rst +++ b/classes/class_physicsserver3d.rst @@ -852,7 +852,7 @@ A factor that gets multiplied onto all rotations across the axes. :ref:`G6DOFJointAxisParam` **G6DOF_JOINT_ANGULAR_DAMPING** = ``13`` -The amount of rotational damping across the axes. The lower, the more dampening occurs. +The amount of rotational damping across the axes. The lower, the more damping occurs. .. _class_PhysicsServer3D_constant_G6DOF_JOINT_ANGULAR_RESTITUTION: @@ -1314,7 +1314,7 @@ Constant to set/get a body's gravity multiplier. :ref:`BodyParameter` **BODY_PARAM_LINEAR_DAMP_MODE** = ``6`` -Constant to set/get a body's linear dampening mode. See :ref:`BodyDampMode` for possible values. +Constant to set/get a body's linear damping mode. See :ref:`BodyDampMode` for possible values. .. _class_PhysicsServer3D_constant_BODY_PARAM_ANGULAR_DAMP_MODE: @@ -1322,7 +1322,7 @@ Constant to set/get a body's linear dampening mode. See :ref:`BodyDampMode` **BODY_PARAM_ANGULAR_DAMP_MODE** = ``7`` -Constant to set/get a body's angular dampening mode. See :ref:`BodyDampMode` for possible values. +Constant to set/get a body's angular damping mode. See :ref:`BodyDampMode` for possible values. .. _class_PhysicsServer3D_constant_BODY_PARAM_LINEAR_DAMP: @@ -1330,7 +1330,7 @@ Constant to set/get a body's angular dampening mode. See :ref:`BodyDampMode` **BODY_PARAM_LINEAR_DAMP** = ``8`` -Constant to set/get a body's linear dampening factor. +Constant to set/get a body's linear damping factor. .. _class_PhysicsServer3D_constant_BODY_PARAM_ANGULAR_DAMP: @@ -1338,7 +1338,7 @@ Constant to set/get a body's linear dampening factor. :ref:`BodyParameter` **BODY_PARAM_ANGULAR_DAMP** = ``9`` -Constant to set/get a body's angular dampening factor. +Constant to set/get a body's angular damping factor. .. _class_PhysicsServer3D_constant_BODY_PARAM_MAX: diff --git a/classes/class_skeletonmodification2djiggle.rst b/classes/class_skeletonmodification2djiggle.rst index 26b33dc4073..8a2794a35b9 100644 --- a/classes/class_skeletonmodification2djiggle.rst +++ b/classes/class_skeletonmodification2djiggle.rst @@ -119,7 +119,7 @@ Property Descriptions - void **set_damping** **(** :ref:`float` value **)** - :ref:`float` **get_damping** **(** **)** -The default amount of dampening applied to the Jiggle joints, if they are not overridden. Higher values lead to more of the calculated velocity being applied. +The default amount of damping applied to the Jiggle joints, if they are not overridden. Higher values lead to more of the calculated velocity being applied. .. rst-class:: classref-item-separator @@ -394,7 +394,7 @@ Sets the bone index, ``bone_idx``, of the Jiggle joint at ``joint_idx``. When po void **set_jiggle_joint_damping** **(** :ref:`int` joint_idx, :ref:`float` damping **)** -Sets the amount of dampening of the Jiggle joint at ``joint_idx``. +Sets the amount of damping of the Jiggle joint at ``joint_idx``. .. rst-class:: classref-item-separator