Skip to content

Commit 5a9aca0

Browse files
author
Godot Organization
committed
classref: Sync with current master branch (80bfca2)
1 parent 010d41e commit 5a9aca0

34 files changed

+690
-172
lines changed

‎classes/[email protected]‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -625,7 +625,7 @@ See also :ref:`@GlobalScope.PROPERTY_USAGE_SUBGROUP<class_@GlobalScope_constant_
625625

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

628-
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.
628+
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.
629629

630630
::
631631

‎classes/[email protected]‎

Lines changed: 96 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -135,12 +135,18 @@ Methods
135135
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
136136
| :ref:`float<class_float>` | :ref:`acos<class_@GlobalScope_method_acos>` **(** :ref:`float<class_float>` x **)** |
137137
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
138+
| :ref:`float<class_float>` | :ref:`acosh<class_@GlobalScope_method_acosh>` **(** :ref:`float<class_float>` x **)** |
139+
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
138140
| :ref:`float<class_float>` | :ref:`asin<class_@GlobalScope_method_asin>` **(** :ref:`float<class_float>` x **)** |
139141
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
142+
| :ref:`float<class_float>` | :ref:`asinh<class_@GlobalScope_method_asinh>` **(** :ref:`float<class_float>` x **)** |
143+
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
140144
| :ref:`float<class_float>` | :ref:`atan<class_@GlobalScope_method_atan>` **(** :ref:`float<class_float>` x **)** |
141145
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
142146
| :ref:`float<class_float>` | :ref:`atan2<class_@GlobalScope_method_atan2>` **(** :ref:`float<class_float>` y, :ref:`float<class_float>` x **)** |
143147
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
148+
| :ref:`float<class_float>` | :ref:`atanh<class_@GlobalScope_method_atanh>` **(** :ref:`float<class_float>` x **)** |
149+
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
144150
| :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 **)** |
145151
+-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
146152
| :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 **)** |
@@ -1685,6 +1691,38 @@ Launch Shortcut E key.
16851691

16861692
Launch Shortcut F key.
16871693

1694+
.. _class_@GlobalScope_constant_KEY_GLOBE:
1695+
1696+
.. rst-class:: classref-enumeration-constant
1697+
1698+
:ref:`Key<enum_@GlobalScope_Key>` **KEY_GLOBE** = ``4194416``
1699+
1700+
"Globe" key on Mac / iPad keyboard.
1701+
1702+
.. _class_@GlobalScope_constant_KEY_KEYBOARD:
1703+
1704+
.. rst-class:: classref-enumeration-constant
1705+
1706+
:ref:`Key<enum_@GlobalScope_Key>` **KEY_KEYBOARD** = ``4194417``
1707+
1708+
"On-screen keyboard" key on iPad keyboard.
1709+
1710+
.. _class_@GlobalScope_constant_KEY_JIS_EISU:
1711+
1712+
.. rst-class:: classref-enumeration-constant
1713+
1714+
:ref:`Key<enum_@GlobalScope_Key>` **KEY_JIS_EISU** = ``4194418``
1715+
1716+
英数 key on Mac keyboard.
1717+
1718+
.. _class_@GlobalScope_constant_KEY_JIS_KANA:
1719+
1720+
.. rst-class:: classref-enumeration-constant
1721+
1722+
:ref:`Key<enum_@GlobalScope_Key>` **KEY_JIS_KANA** = ``4194419``
1723+
1724+
かな key on Mac keyboard.
1725+
16881726
.. _class_@GlobalScope_constant_KEY_UNKNOWN:
16891727

16901728
.. rst-class:: classref-enumeration-constant
@@ -2261,38 +2299,6 @@ Z key.
22612299

22622300
§ key.
22632301

2264-
.. _class_@GlobalScope_constant_KEY_GLOBE:
2265-
2266-
.. rst-class:: classref-enumeration-constant
2267-
2268-
:ref:`Key<enum_@GlobalScope_Key>` **KEY_GLOBE** = ``4194416``
2269-
2270-
"Globe" key on Mac / iPad keyboard.
2271-
2272-
.. _class_@GlobalScope_constant_KEY_KEYBOARD:
2273-
2274-
.. rst-class:: classref-enumeration-constant
2275-
2276-
:ref:`Key<enum_@GlobalScope_Key>` **KEY_KEYBOARD** = ``4194417``
2277-
2278-
"On-screen keyboard" key iPad keyboard.
2279-
2280-
.. _class_@GlobalScope_constant_KEY_JIS_EISU:
2281-
2282-
.. rst-class:: classref-enumeration-constant
2283-
2284-
:ref:`Key<enum_@GlobalScope_Key>` **KEY_JIS_EISU** = ``4194418``
2285-
2286-
英数 key on Mac keyboard.
2287-
2288-
.. _class_@GlobalScope_constant_KEY_JIS_KANA:
2289-
2290-
.. rst-class:: classref-enumeration-constant
2291-
2292-
:ref:`Key<enum_@GlobalScope_Key>` **KEY_JIS_KANA** = ``4194419``
2293-
2294-
かな key on Mac keyboard.
2295-
22962302
.. rst-class:: classref-item-separator
22972303

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

52205226
----
52215227

5228+
.. _class_@GlobalScope_method_acosh:
5229+
5230+
.. rst-class:: classref-method
5231+
5232+
:ref:`float<class_float>` **acosh** **(** :ref:`float<class_float>` x **)**
5233+
5234+
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>`.
5235+
5236+
::
5237+
5238+
var a = acosh(2) # Returns 1.31695789692482
5239+
cosh(a) # Returns 2
5240+
5241+
var b = acosh(-1) # Returns 0
5242+
5243+
.. rst-class:: classref-item-separator
5244+
5245+
----
5246+
52225247
.. _class_@GlobalScope_method_asin:
52235248

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

52375262
----
52385263

5264+
.. _class_@GlobalScope_method_asinh:
5265+
5266+
.. rst-class:: classref-method
5267+
5268+
:ref:`float<class_float>` **asinh** **(** :ref:`float<class_float>` x **)**
5269+
5270+
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.
5271+
5272+
::
5273+
5274+
var a = asinh(0.9) # Returns 0.8088669356527824
5275+
sinh(a) # Returns 0.9
5276+
5277+
.. rst-class:: classref-item-separator
5278+
5279+
----
5280+
52395281
.. _class_@GlobalScope_method_atan:
52405282

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

52755317
----
52765318

5319+
.. _class_@GlobalScope_method_atanh:
5320+
5321+
.. rst-class:: classref-method
5322+
5323+
:ref:`float<class_float>` **atanh** **(** :ref:`float<class_float>` x **)**
5324+
5325+
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).
5326+
5327+
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>`.
5328+
5329+
::
5330+
5331+
var a = atanh(0.9) # Returns 1.47221948958322
5332+
tanh(a) # Returns 0.9
5333+
5334+
var b = atanh(-2) # Returns -inf
5335+
tanh(b) # Returns -1
5336+
5337+
.. rst-class:: classref-item-separator
5338+
5339+
----
5340+
52775341
.. _class_@GlobalScope_method_bezier_derivative:
52785342

52795343
.. rst-class:: classref-method

‎classes/class_callbacktweener.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ Description
2121

2222
**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.
2323

24+
The tweener will finish automatically if the callback's target object is freed.
25+
2426
\ **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.
2527

2628
.. rst-class:: classref-reftable-group

0 commit comments

Comments
 (0)