Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions classes/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -5416,7 +5416,7 @@ Decodes a byte array back to a :ref:`Variant<class_Variant>` value. Decoding obj

:ref:`Variant<class_Variant>` **ceil** **(** :ref:`Variant<class_Variant>` x **)**

Rounds ``x`` upward (towards positive infinity), returning the smallest whole number that is not less than ``x``. Supported types: :ref:`int<class_int>`, :ref:`float<class_float>`, :ref:`Vector2<class_Vector2>`, :ref:`Vector3<class_Vector3>`, :ref:`Vector4<class_Vector4>`.
Rounds ``x`` upward (towards positive infinity), returning the smallest whole number that is not less than ``x``. Supported types: :ref:`int<class_int>`, :ref:`float<class_float>`, :ref:`Vector2<class_Vector2>`, :ref:`Vector2i<class_Vector2i>`, :ref:`Vector3<class_Vector3>`, :ref:`Vector3i<class_Vector3i>`, :ref:`Vector4<class_Vector4>`, :ref:`Vector4i<class_Vector4i>`.

::

Expand Down Expand Up @@ -5718,7 +5718,7 @@ For exponents to other bases use the method :ref:`pow<class_@GlobalScope_method_

:ref:`Variant<class_Variant>` **floor** **(** :ref:`Variant<class_Variant>` x **)**

Rounds ``x`` downward (towards negative infinity), returning the largest whole number that is not more than ``x``. Supported types: :ref:`int<class_int>`, :ref:`float<class_float>`, :ref:`Vector2<class_Vector2>`, :ref:`Vector3<class_Vector3>`, :ref:`Vector4<class_Vector4>`.
Rounds ``x`` downward (towards negative infinity), returning the largest whole number that is not more than ``x``. Supported types: :ref:`int<class_int>`, :ref:`float<class_float>`, :ref:`Vector2<class_Vector2>`, :ref:`Vector2i<class_Vector2i>`, :ref:`Vector3<class_Vector3>`, :ref:`Vector3i<class_Vector3i>`, :ref:`Vector4<class_Vector4>`, :ref:`Vector4i<class_Vector4i>`.

::

Expand Down Expand Up @@ -6825,7 +6825,7 @@ If ``delta`` is negative, this function will rotate away from ``to``, toward the

:ref:`Variant<class_Variant>` **round** **(** :ref:`Variant<class_Variant>` x **)**

Rounds ``x`` to the nearest whole number, with halfway cases rounded away from 0. Supported types: :ref:`int<class_int>`, :ref:`float<class_float>`, :ref:`Vector2<class_Vector2>`, :ref:`Vector3<class_Vector3>`, :ref:`Vector4<class_Vector4>`.
Rounds ``x`` to the nearest whole number, with halfway cases rounded away from 0. Supported types: :ref:`int<class_int>`, :ref:`float<class_float>`, :ref:`Vector2<class_Vector2>`, :ref:`Vector2i<class_Vector2i>`, :ref:`Vector3<class_Vector3>`, :ref:`Vector3i<class_Vector3i>`, :ref:`Vector4<class_Vector4>`, :ref:`Vector4i<class_Vector4i>`.

::

Expand Down
6 changes: 5 additions & 1 deletion classes/class_aabb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -585,7 +585,11 @@ Returns ``true`` if the AABBs are not equal.

:ref:`AABB<class_AABB>` **operator *** **(** :ref:`Transform3D<class_Transform3D>` right **)**

Inversely transforms (multiplies) the **AABB** by the given :ref:`Transform3D<class_Transform3D>` transformation matrix.
Inversely transforms (multiplies) the **AABB** by the given :ref:`Transform3D<class_Transform3D>` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not).

\ ``aabb * transform`` is equivalent to ``transform.inverse() * aabb``. See :ref:`Transform3D.inverse<class_Transform3D_method_inverse>`.

For transforming by inverse of an affine transformation (e.g. with scaling) ``transform.affine_inverse() * aabb`` can be used instead. See :ref:`Transform3D.affine_inverse<class_Transform3D_method_affine_inverse>`.

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

Expand Down
4 changes: 1 addition & 3 deletions classes/class_button.rst
Original file line number Diff line number Diff line change
Expand Up @@ -598,9 +598,7 @@ Font size of the **Button**'s text.

:ref:`Texture2D<class_Texture2D>` **icon**

.. container:: contribute

There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Default icon for the **Button**. Appears only if :ref:`icon<class_Button_property_icon>` is not assigned.

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

Expand Down
6 changes: 2 additions & 4 deletions classes/class_graphedit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1100,7 +1100,7 @@ Disallows to disconnect nodes when dragging from the right port of the :ref:`Gra

void **set_connection_activity** **(** :ref:`StringName<class_StringName>` from_node, :ref:`int<class_int>` from_port, :ref:`StringName<class_StringName>` to_node, :ref:`int<class_int>` to_port, :ref:`float<class_float>` amount **)**

Sets the coloration of the connection between ``from_node``'s ``from_port`` and ``to_node``'s ``to_port`` with the color provided in the :ref:`activity<class_GraphEdit_theme_color_activity>` theme property.
Sets the coloration of the connection between ``from_node``'s ``from_port`` and ``to_node``'s ``to_port`` with the color provided in the :ref:`activity<class_GraphEdit_theme_color_activity>` theme property. The color is linearly interpolated between the connection color and the activity color using ``amount`` as weight.

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

Expand Down Expand Up @@ -1129,9 +1129,7 @@ Theme Property Descriptions

:ref:`Color<class_Color>` **activity** = ``Color(1, 1, 1, 1)``

.. container:: contribute

There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Color of the connection's activity (see :ref:`set_connection_activity<class_GraphEdit_method_set_connection_activity>`).

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

Expand Down
2 changes: 1 addition & 1 deletion classes/class_lineedit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -998,7 +998,7 @@ If ``true``, every character is replaced with the secret character (see :ref:`se
- void **set_secret_character** **(** :ref:`String<class_String>` value **)**
- :ref:`String<class_String>` **get_secret_character** **(** **)**

The character to use to mask secret input (defaults to "•"). Only a single character can be used as the secret character.
The character to use to mask secret input. Only a single character can be used as the secret character. If it is longer than one character, only the first one will be used. If it is empty, a space will be used instead.

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

Expand Down
7 changes: 4 additions & 3 deletions classes/class_object.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Description

An advanced :ref:`Variant<class_Variant>` type. All classes in the engine inherit from Object. Each class may define new properties, methods or signals, which are available to all inheriting classes. For example, a :ref:`Sprite2D<class_Sprite2D>` instance is able to call :ref:`Node.add_child<class_Node_method_add_child>` because it inherits from :ref:`Node<class_Node>`.

You can create new instances, using ``Object.new()`` in GDScript, or ``new Object`` in C#.
You can create new instances, using ``Object.new()`` in GDScript, or ``new GodotObject`` in C#.

To delete an Object instance, call :ref:`free<class_Object_method_free>`. This is necessary for most classes inheriting Object, because they do not manage memory on their own, and will otherwise cause memory leaks when no longer in use. There are a few classes that perform memory management. For example, :ref:`RefCounted<class_RefCounted>` (and by extension :ref:`Resource<class_Resource>`) deletes itself when no longer referenced, and :ref:`Node<class_Node>` deletes its children when freed.

Expand Down Expand Up @@ -449,7 +449,7 @@ The example below displays ``hammer_type`` in the Inspector dock, only if ``hold

void **_init** **(** **)** |virtual|

Called when the object's script is instantiated, oftentimes after the object is initialized in memory (through ``Object.new()`` in GDScript, or ``new Object`` in C#). It can be also defined to take in parameters. This method is similar to a constructor in most programming languages.
Called when the object's script is instantiated, oftentimes after the object is initialized in memory (through ``Object.new()`` in GDScript, or ``new GodotObject`` in C#). It can be also defined to take in parameters. This method is similar to a constructor in most programming languages.

\ **Note:** If :ref:`_init<class_Object_method__init>` is defined with *required* parameters, the Object with script may only be created directly. If any other means (such as :ref:`PackedScene.instantiate<class_PackedScene_method_instantiate>` or :ref:`Node.duplicate<class_Node_method_duplicate>`) are used, the script's initialization will fail.

Expand Down Expand Up @@ -542,6 +542,7 @@ Combined with :ref:`_get<class_Object_method__get>` and :ref:`_get_property_list
# Storing the value in the fake property.
internal_data["fake_property"] = value
return true
return false

func _get_property_list():
return [
Expand All @@ -552,7 +553,7 @@ Combined with :ref:`_get<class_Object_method__get>` and :ref:`_get_property_list

private Godot.Collections.Dictionary _internalData = new Godot.Collections.Dictionary();

public override void _Set(StringName property, Variant value)
public override bool _Set(StringName property, Variant value)
{
if (property == "FakeProperty")
{
Expand Down
6 changes: 5 additions & 1 deletion classes/class_packedvector2array.rst
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,11 @@ Returns ``true`` if contents of the arrays differ.

:ref:`PackedVector2Array<class_PackedVector2Array>` **operator *** **(** :ref:`Transform2D<class_Transform2D>` right **)**

Transforms (multiplies) all vectors in the array by the :ref:`Transform2D<class_Transform2D>` matrix.
Returns a new **PackedVector2Array** with all vectors in this array inversely transformed (multiplied) by the given :ref:`Transform2D<class_Transform2D>` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not).

\ ``array * transform`` is equivalent to ``transform.inverse() * array``. See :ref:`Transform2D.inverse<class_Transform2D_method_inverse>`.

For transforming by inverse of an affine transformation (e.g. with scaling) ``transform.affine_inverse() * array`` can be used instead. See :ref:`Transform2D.affine_inverse<class_Transform2D_method_affine_inverse>`.

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

Expand Down
6 changes: 5 additions & 1 deletion classes/class_packedvector3array.rst
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,11 @@ Returns ``true`` if contents of the arrays differ.

:ref:`PackedVector3Array<class_PackedVector3Array>` **operator *** **(** :ref:`Transform3D<class_Transform3D>` right **)**

Transforms (multiplies) all vectors in the array by the :ref:`Transform3D<class_Transform3D>` matrix.
Returns a new **PackedVector3Array** with all vectors in this array inversely transformed (multiplied) by the given :ref:`Transform3D<class_Transform3D>` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not).

\ ``array * transform`` is equivalent to ``transform.inverse() * array``. See :ref:`Transform3D.inverse<class_Transform3D_method_inverse>`.

For transforming by inverse of an affine transformation (e.g. with scaling) ``transform.affine_inverse() * array`` can be used instead. See :ref:`Transform3D.affine_inverse<class_Transform3D_method_affine_inverse>`.

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

Expand Down
2 changes: 2 additions & 0 deletions classes/class_plane.rst
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,8 @@ Returns ``true`` if the planes are not equal.

Inversely transforms (multiplies) the **Plane** by the given :ref:`Transform3D<class_Transform3D>` transformation matrix.

\ ``plane * transform`` is equivalent to ``transform.affine_inverse() * plane``. See :ref:`Transform3D.affine_inverse<class_Transform3D_method_affine_inverse>`.

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

----
Expand Down
30 changes: 30 additions & 0 deletions classes/class_projectsettings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,10 @@ Properties
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`audio/general/3d_panning_strength<class_ProjectSettings_property_audio/general/3d_panning_strength>` | ``0.5`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`audio/general/ios/mix_with_others<class_ProjectSettings_property_audio/general/ios/mix_with_others>` | ``false`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`audio/general/ios/session_category<class_ProjectSettings_property_audio/general/ios/session_category>` | ``0`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`audio/general/text_to_speech<class_ProjectSettings_property_audio/general/text_to_speech>` | ``false`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`audio/video/video_delay_compensation_ms<class_ProjectSettings_property_audio/video/video_delay_compensation_ms>` | ``0`` |
Expand Down Expand Up @@ -2184,6 +2188,32 @@ The default value of ``0.5`` is tuned for headphones. When using speakers, you m

----

.. _class_ProjectSettings_property_audio/general/ios/mix_with_others:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **audio/general/ios/mix_with_others** = ``false``

Sets the `mixWithOthers <https://developer.apple.com/documentation/avfaudio/avaudiosession/categoryoptions/1616611-mixwithothers>`__ option for the AVAudioSession on iOS. This will override the mix behavior, if the category is set to ``Play and Record``, ``Playback``, or ``Multi Route``.

\ ``Ambient`` always has this set per default.

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

----

.. _class_ProjectSettings_property_audio/general/ios/session_category:

.. rst-class:: classref-property

:ref:`int<class_int>` **audio/general/ios/session_category** = ``0``

Sets the `AVAudioSessionCategory <https://developer.apple.com/documentation/avfaudio/avaudiosessioncategory>`__ on iOS. Use the ``Playback`` category to get sound output, even if the phone is in silent mode.

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

----

.. _class_ProjectSettings_property_audio/general/text_to_speech:

.. rst-class:: classref-property
Expand Down
6 changes: 5 additions & 1 deletion classes/class_rect2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -520,7 +520,11 @@ Returns ``true`` if the :ref:`position<class_Rect2_property_position>` or :ref:`

:ref:`Rect2<class_Rect2>` **operator *** **(** :ref:`Transform2D<class_Transform2D>` right **)**

Inversely transforms (multiplies) the **Rect2** by the given :ref:`Transform2D<class_Transform2D>` transformation matrix.
Inversely transforms (multiplies) the **Rect2** by the given :ref:`Transform2D<class_Transform2D>` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not).

\ ``rect * transform`` is equivalent to ``transform.inverse() * rect``. See :ref:`Transform2D.inverse<class_Transform2D_method_inverse>`.

For transforming by inverse of an affine transformation (e.g. with scaling) ``transform.affine_inverse() * rect`` can be used instead. See :ref:`Transform2D.affine_inverse<class_Transform2D_method_affine_inverse>`.

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

Expand Down
16 changes: 0 additions & 16 deletions classes/class_scrollbar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,6 @@ Theme Properties
+-----------------------------------+----------------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`grabber_pressed<class_ScrollBar_theme_style_grabber_pressed>` |
+-----------------------------------+----------------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`hscroll<class_ScrollBar_theme_style_hscroll>` |
+-----------------------------------+----------------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`scroll<class_ScrollBar_theme_style_scroll>` |
+-----------------------------------+----------------------------------------------------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`scroll_focus<class_ScrollBar_theme_style_scroll_focus>` |
Expand Down Expand Up @@ -227,20 +225,6 @@ Used when the grabber is being dragged.

----

.. _class_ScrollBar_theme_style_hscroll:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **hscroll**

.. container:: contribute

There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

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

----

.. _class_ScrollBar_theme_style_scroll:

.. rst-class:: classref-themeproperty
Expand Down
Loading