Skip to content

classref: Sync with current master branch (80bfca2) #7870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 2, 2023
Merged

classref: Sync with current master branch (80bfca2) #7870

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion classes/class_@gdscript.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,7 +625,7 @@ See also :ref:`@GlobalScope.PROPERTY_USAGE_SUBGROUP<class_@GlobalScope_constant_

**@icon** **(** :ref:`String<class_String>` icon_path **)**

Add a custom icon to the current script. The script must be registered as a global class using the ``class_name`` keyword for this to have a visible effect. The icon specified at ``icon_path`` is displayed in the Scene dock for every node of that class, as well as in various editor dialogs.
Add a custom icon to the current script. The icon specified at ``icon_path`` is displayed in the Scene dock for every node of that class, as well as in various editor dialogs.

::

Expand Down
128 changes: 96 additions & 32 deletions classes/class_@globalscope.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,12 +135,18 @@ Methods
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`acos<class_@GlobalScope_method_acos>` **(** :ref:`float<class_float>` x **)** |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`acosh<class_@GlobalScope_method_acosh>` **(** :ref:`float<class_float>` x **)** |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`asin<class_@GlobalScope_method_asin>` **(** :ref:`float<class_float>` x **)** |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`asinh<class_@GlobalScope_method_asinh>` **(** :ref:`float<class_float>` x **)** |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`atan<class_@GlobalScope_method_atan>` **(** :ref:`float<class_float>` x **)** |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`atan2<class_@GlobalScope_method_atan2>` **(** :ref:`float<class_float>` y, :ref:`float<class_float>` x **)** |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`atanh<class_@GlobalScope_method_atanh>` **(** :ref:`float<class_float>` x **)** |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`bezier_derivative<class_@GlobalScope_method_bezier_derivative>` **(** :ref:`float<class_float>` start, :ref:`float<class_float>` control_1, :ref:`float<class_float>` control_2, :ref:`float<class_float>` end, :ref:`float<class_float>` t **)** |
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`bezier_interpolate<class_@GlobalScope_method_bezier_interpolate>` **(** :ref:`float<class_float>` start, :ref:`float<class_float>` control_1, :ref:`float<class_float>` control_2, :ref:`float<class_float>` end, :ref:`float<class_float>` t **)** |
Expand Down Expand Up @@ -1685,6 +1691,38 @@ Launch Shortcut E key.

Launch Shortcut F key.

.. _class_@GlobalScope_constant_KEY_GLOBE:

.. rst-class:: classref-enumeration-constant

:ref:`Key<enum_@GlobalScope_Key>` **KEY_GLOBE** = ``4194416``

"Globe" key on Mac / iPad keyboard.

.. _class_@GlobalScope_constant_KEY_KEYBOARD:

.. rst-class:: classref-enumeration-constant

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KEYBOARD** = ``4194417``

"On-screen keyboard" key on iPad keyboard.

.. _class_@GlobalScope_constant_KEY_JIS_EISU:

.. rst-class:: classref-enumeration-constant

:ref:`Key<enum_@GlobalScope_Key>` **KEY_JIS_EISU** = ``4194418``

英数 key on Mac keyboard.

.. _class_@GlobalScope_constant_KEY_JIS_KANA:

.. rst-class:: classref-enumeration-constant

:ref:`Key<enum_@GlobalScope_Key>` **KEY_JIS_KANA** = ``4194419``

かな key on Mac keyboard.

.. _class_@GlobalScope_constant_KEY_UNKNOWN:

.. rst-class:: classref-enumeration-constant
Expand Down Expand Up @@ -2261,38 +2299,6 @@ Z key.

§ key.

.. _class_@GlobalScope_constant_KEY_GLOBE:

.. rst-class:: classref-enumeration-constant

:ref:`Key<enum_@GlobalScope_Key>` **KEY_GLOBE** = ``4194416``

"Globe" key on Mac / iPad keyboard.

.. _class_@GlobalScope_constant_KEY_KEYBOARD:

.. rst-class:: classref-enumeration-constant

:ref:`Key<enum_@GlobalScope_Key>` **KEY_KEYBOARD** = ``4194417``

"On-screen keyboard" key iPad keyboard.

.. _class_@GlobalScope_constant_KEY_JIS_EISU:

.. rst-class:: classref-enumeration-constant

:ref:`Key<enum_@GlobalScope_Key>` **KEY_JIS_EISU** = ``4194418``

英数 key on Mac keyboard.

.. _class_@GlobalScope_constant_KEY_JIS_KANA:

.. rst-class:: classref-enumeration-constant

:ref:`Key<enum_@GlobalScope_Key>` **KEY_JIS_KANA** = ``4194419``

かな key on Mac keyboard.

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

----
Expand Down Expand Up @@ -5219,6 +5225,25 @@ Returns the arc cosine of ``x`` in radians. Use to get the angle of cosine ``x``

----

.. _class_@GlobalScope_method_acosh:

.. rst-class:: classref-method

:ref:`float<class_float>` **acosh** **(** :ref:`float<class_float>` x **)**

Returns the hyperbolic arc (also called inverse) cosine of ``x``, returning a value in radians. Use it to get the angle from an angle's cosine in hyperbolic space if ``x`` is larger or equal to 1. For values of ``x`` lower than 1, it will return 0, in order to prevent :ref:`acosh<class_@GlobalScope_method_acosh>` from returning :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>`.

::

var a = acosh(2) # Returns 1.31695789692482
cosh(a) # Returns 2

var b = acosh(-1) # Returns 0

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

----

.. _class_@GlobalScope_method_asin:

.. rst-class:: classref-method
Expand All @@ -5236,6 +5261,23 @@ Returns the arc sine of ``x`` in radians. Use to get the angle of sine ``x``. ``

----

.. _class_@GlobalScope_method_asinh:

.. rst-class:: classref-method

:ref:`float<class_float>` **asinh** **(** :ref:`float<class_float>` x **)**

Returns the hyperbolic arc (also called inverse) sine of ``x``, returning a value in radians. Use it to get the angle from an angle's sine in hyperbolic space.

::

var a = asinh(0.9) # Returns 0.8088669356527824
sinh(a) # Returns 0.9

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

----

.. _class_@GlobalScope_method_atan:

.. rst-class:: classref-method
Expand Down Expand Up @@ -5274,6 +5316,28 @@ Important note: The Y coordinate comes first, by convention.

----

.. _class_@GlobalScope_method_atanh:

.. rst-class:: classref-method

:ref:`float<class_float>` **atanh** **(** :ref:`float<class_float>` x **)**

Returns the hyperbolic arc (also called inverse) tangent of ``x``, returning a value in radians. Use it to get the angle from an angle's tangent in hyperbolic space if ``x`` is between -1 and 1 (non-inclusive).

In mathematics, the inverse hyperbolic tangent is only defined for -1 < ``x`` < 1 in the real set, so values equal or lower to -1 for ``x`` return negative :ref:`@GDScript.INF<class_@GDScript_constant_INF>` and values equal or higher than 1 return positive :ref:`@GDScript.INF<class_@GDScript_constant_INF>` in order to prevent :ref:`atanh<class_@GlobalScope_method_atanh>` from returning :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>`.

::

var a = atanh(0.9) # Returns 1.47221948958322
tanh(a) # Returns 0.9

var b = atanh(-2) # Returns -inf
tanh(b) # Returns -1

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

----

.. _class_@GlobalScope_method_bezier_derivative:

.. rst-class:: classref-method
Expand Down
2 changes: 2 additions & 0 deletions classes/class_callbacktweener.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Description

**CallbackTweener** is used to call a method in a tweening sequence. See :ref:`Tween.tween_callback<class_Tween_method_tween_callback>` for more usage information.

The tweener will finish automatically if the callback's target object is freed.

\ **Note:** :ref:`Tween.tween_callback<class_Tween_method_tween_callback>` is the only correct way to create **CallbackTweener**. Any **CallbackTweener** created manually will not function correctly.

.. rst-class:: classref-reftable-group
Expand Down
Loading