Skip to content

Commit 8583311

Browse files
author
Godot Organization
committed
classref: Sync with current master branch (893bbdf)
1 parent bac98a0 commit 8583311

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+1340
-376
lines changed

classes/[email protected]

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1753,119 +1753,119 @@ Space key.
17531753

17541754
:ref:`Key<enum_@GlobalScope_Key>` **KEY_EXCLAM** = ``33``
17551755

1756-
! key.
1756+
Exclamation mark (``!``) key.
17571757

17581758
.. _class_@GlobalScope_constant_KEY_QUOTEDBL:
17591759

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

17621762
:ref:`Key<enum_@GlobalScope_Key>` **KEY_QUOTEDBL** = ``34``
17631763

1764-
" key.
1764+
Double quotation mark (``"``) key.
17651765

17661766
.. _class_@GlobalScope_constant_KEY_NUMBERSIGN:
17671767

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

17701770
:ref:`Key<enum_@GlobalScope_Key>` **KEY_NUMBERSIGN** = ``35``
17711771

1772-
# key.
1772+
Number sign or *hash* (``#``) key.
17731773

17741774
.. _class_@GlobalScope_constant_KEY_DOLLAR:
17751775

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

17781778
:ref:`Key<enum_@GlobalScope_Key>` **KEY_DOLLAR** = ``36``
17791779

1780-
$ key.
1780+
Dollar sign (``$``) key.
17811781

17821782
.. _class_@GlobalScope_constant_KEY_PERCENT:
17831783

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

17861786
:ref:`Key<enum_@GlobalScope_Key>` **KEY_PERCENT** = ``37``
17871787

1788-
% key.
1788+
Percent sign (``%``) key.
17891789

17901790
.. _class_@GlobalScope_constant_KEY_AMPERSAND:
17911791

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

17941794
:ref:`Key<enum_@GlobalScope_Key>` **KEY_AMPERSAND** = ``38``
17951795

1796-
& key.
1796+
Ampersand (``&``) key.
17971797

17981798
.. _class_@GlobalScope_constant_KEY_APOSTROPHE:
17991799

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

18021802
:ref:`Key<enum_@GlobalScope_Key>` **KEY_APOSTROPHE** = ``39``
18031803

1804-
' key.
1804+
Apostrophe (``'``) key.
18051805

18061806
.. _class_@GlobalScope_constant_KEY_PARENLEFT:
18071807

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

18101810
:ref:`Key<enum_@GlobalScope_Key>` **KEY_PARENLEFT** = ``40``
18111811

1812-
( key.
1812+
Left parenthesis (``(``) key.
18131813

18141814
.. _class_@GlobalScope_constant_KEY_PARENRIGHT:
18151815

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

18181818
:ref:`Key<enum_@GlobalScope_Key>` **KEY_PARENRIGHT** = ``41``
18191819

1820-
) key.
1820+
Right parenthesis (``)``) key.
18211821

18221822
.. _class_@GlobalScope_constant_KEY_ASTERISK:
18231823

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

18261826
:ref:`Key<enum_@GlobalScope_Key>` **KEY_ASTERISK** = ``42``
18271827

1828-
\* key.
1828+
Asterisk (``*``) key.
18291829

18301830
.. _class_@GlobalScope_constant_KEY_PLUS:
18311831

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

18341834
:ref:`Key<enum_@GlobalScope_Key>` **KEY_PLUS** = ``43``
18351835

1836-
+ key.
1836+
Plus (``+``) key.
18371837

18381838
.. _class_@GlobalScope_constant_KEY_COMMA:
18391839

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

18421842
:ref:`Key<enum_@GlobalScope_Key>` **KEY_COMMA** = ``44``
18431843

1844-
, key.
1844+
Comma (``,``) key.
18451845

18461846
.. _class_@GlobalScope_constant_KEY_MINUS:
18471847

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

18501850
:ref:`Key<enum_@GlobalScope_Key>` **KEY_MINUS** = ``45``
18511851

1852-
- key.
1852+
Minus (``-``) key.
18531853

18541854
.. _class_@GlobalScope_constant_KEY_PERIOD:
18551855

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

18581858
:ref:`Key<enum_@GlobalScope_Key>` **KEY_PERIOD** = ``46``
18591859

1860-
. key.
1860+
Period (``.``) key.
18611861

18621862
.. _class_@GlobalScope_constant_KEY_SLASH:
18631863

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

18661866
:ref:`Key<enum_@GlobalScope_Key>` **KEY_SLASH** = ``47``
18671867

1868-
/ key.
1868+
Slash (``/``) key.
18691869

18701870
.. _class_@GlobalScope_constant_KEY_0:
18711871

@@ -1953,55 +1953,55 @@ Number 9 key.
19531953

19541954
:ref:`Key<enum_@GlobalScope_Key>` **KEY_COLON** = ``58``
19551955

1956-
: key.
1956+
Colon (``:``) key.
19571957

19581958
.. _class_@GlobalScope_constant_KEY_SEMICOLON:
19591959

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

19621962
:ref:`Key<enum_@GlobalScope_Key>` **KEY_SEMICOLON** = ``59``
19631963

1964-
; key.
1964+
Semicolon (``;``) key.
19651965

19661966
.. _class_@GlobalScope_constant_KEY_LESS:
19671967

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

19701970
:ref:`Key<enum_@GlobalScope_Key>` **KEY_LESS** = ``60``
19711971

1972-
< key.
1972+
Less-than sign (``<``) key.
19731973

19741974
.. _class_@GlobalScope_constant_KEY_EQUAL:
19751975

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

19781978
:ref:`Key<enum_@GlobalScope_Key>` **KEY_EQUAL** = ``61``
19791979

1980-
= key.
1980+
Equal sign (``=``) key.
19811981

19821982
.. _class_@GlobalScope_constant_KEY_GREATER:
19831983

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

19861986
:ref:`Key<enum_@GlobalScope_Key>` **KEY_GREATER** = ``62``
19871987

1988-
> key.
1988+
Greater-than sign (``>``) key.
19891989

19901990
.. _class_@GlobalScope_constant_KEY_QUESTION:
19911991

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

19941994
:ref:`Key<enum_@GlobalScope_Key>` **KEY_QUESTION** = ``63``
19951995

1996-
? key.
1996+
Question mark (``?``) key.
19971997

19981998
.. _class_@GlobalScope_constant_KEY_AT:
19991999

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

20022002
:ref:`Key<enum_@GlobalScope_Key>` **KEY_AT** = ``64``
20032003

2004-
@ key.
2004+
At sign (``@``) key.
20052005

20062006
.. _class_@GlobalScope_constant_KEY_A:
20072007

@@ -2217,95 +2217,95 @@ Z key.
22172217

22182218
:ref:`Key<enum_@GlobalScope_Key>` **KEY_BRACKETLEFT** = ``91``
22192219

2220-
[ key.
2220+
Left bracket (``[lb]``) key.
22212221

22222222
.. _class_@GlobalScope_constant_KEY_BACKSLASH:
22232223

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

22262226
:ref:`Key<enum_@GlobalScope_Key>` **KEY_BACKSLASH** = ``92``
22272227

2228-
\\ key.
2228+
Backslash (``\``) key.
22292229

22302230
.. _class_@GlobalScope_constant_KEY_BRACKETRIGHT:
22312231

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

22342234
:ref:`Key<enum_@GlobalScope_Key>` **KEY_BRACKETRIGHT** = ``93``
22352235

2236-
] key.
2236+
Right bracket (``[rb]``) key.
22372237

22382238
.. _class_@GlobalScope_constant_KEY_ASCIICIRCUM:
22392239

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

22422242
:ref:`Key<enum_@GlobalScope_Key>` **KEY_ASCIICIRCUM** = ``94``
22432243

2244-
^ key.
2244+
Caret (``^``) key.
22452245

22462246
.. _class_@GlobalScope_constant_KEY_UNDERSCORE:
22472247

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

22502250
:ref:`Key<enum_@GlobalScope_Key>` **KEY_UNDERSCORE** = ``95``
22512251

2252-
\_ key.
2252+
Underscore (``_``) key.
22532253

22542254
.. _class_@GlobalScope_constant_KEY_QUOTELEFT:
22552255

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

22582258
:ref:`Key<enum_@GlobalScope_Key>` **KEY_QUOTELEFT** = ``96``
22592259

2260-
` key.
2260+
Backtick (`````) key.
22612261

22622262
.. _class_@GlobalScope_constant_KEY_BRACELEFT:
22632263

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

22662266
:ref:`Key<enum_@GlobalScope_Key>` **KEY_BRACELEFT** = ``123``
22672267

2268-
{ key.
2268+
Left brace (``{``) key.
22692269

22702270
.. _class_@GlobalScope_constant_KEY_BAR:
22712271

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

22742274
:ref:`Key<enum_@GlobalScope_Key>` **KEY_BAR** = ``124``
22752275

2276-
| key.
2276+
Vertical bar or *pipe* (``|``) key.
22772277

22782278
.. _class_@GlobalScope_constant_KEY_BRACERIGHT:
22792279

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

22822282
:ref:`Key<enum_@GlobalScope_Key>` **KEY_BRACERIGHT** = ``125``
22832283

2284-
} key.
2284+
Right brace (``}``) key.
22852285

22862286
.. _class_@GlobalScope_constant_KEY_ASCIITILDE:
22872287

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

22902290
:ref:`Key<enum_@GlobalScope_Key>` **KEY_ASCIITILDE** = ``126``
22912291

2292-
~ key.
2292+
Tilde (``~``) key.
22932293

22942294
.. _class_@GlobalScope_constant_KEY_YEN:
22952295

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

22982298
:ref:`Key<enum_@GlobalScope_Key>` **KEY_YEN** = ``165``
22992299

2300-
¥ key.
2300+
Yen symbol (``¥``) key.
23012301

23022302
.. _class_@GlobalScope_constant_KEY_SECTION:
23032303

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

23062306
:ref:`Key<enum_@GlobalScope_Key>` **KEY_SECTION** = ``167``
23072307

2308-
§ key.
2308+
Section sign (``§``) key.
23092309

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

@@ -5741,7 +5741,7 @@ Returns an "eased" value of ``x`` based on an easing function defined with ``cur
57415741
.. code:: text
57425742
57435743
- Lower than -1.0 (exclusive): Ease in-out
5744-
- 1.0: Linear
5744+
- -1.0: Linear
57455745
- Between -1.0 and 0.0 (exclusive): Ease out-in
57465746
- 0.0: Constant
57475747
- Between 0.0 to 1.0 (exclusive): Ease out

classes/class_animationlibrary.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ Methods
4343
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
4444
| :ref:`Array<class_Array>`\[:ref:`StringName<class_StringName>`\] | :ref:`get_animation_list<class_AnimationLibrary_method_get_animation_list>`\ (\ ) |const| |
4545
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
46+
| :ref:`int<class_int>` | :ref:`get_animation_list_size<class_AnimationLibrary_method_get_animation_list_size>`\ (\ ) |const| |
47+
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
4648
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationLibrary_method_has_animation>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| |
4749
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
4850
| |void| | :ref:`remove_animation<class_AnimationLibrary_method_remove_animation>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |
@@ -150,6 +152,18 @@ Returns the keys for the :ref:`Animation<class_Animation>`\ s stored in the libr
150152

151153
----
152154

155+
.. _class_AnimationLibrary_method_get_animation_list_size:
156+
157+
.. rst-class:: classref-method
158+
159+
:ref:`int<class_int>` **get_animation_list_size**\ (\ ) |const| :ref:`🔗<class_AnimationLibrary_method_get_animation_list_size>`
160+
161+
Returns the key count for the :ref:`Animation<class_Animation>`\ s stored in the library.
162+
163+
.. rst-class:: classref-item-separator
164+
165+
----
166+
153167
.. _class_AnimationLibrary_method_has_animation:
154168

155169
.. rst-class:: classref-method

classes/class_animationnodeoneshot.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ If ``true``, breaks the loop at the end of the loop cycle for transition, even i
272272
- |void| **set_fadein_curve**\ (\ value\: :ref:`Curve<class_Curve>`\ )
273273
- :ref:`Curve<class_Curve>` **get_fadein_curve**\ (\ )
274274

275-
Determines how cross-fading between animations is eased. If empty, the transition will be linear.
275+
Determines how cross-fading between animations is eased. If empty, the transition will be linear. Should be a unit :ref:`Curve<class_Curve>`.
276276

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

@@ -308,7 +308,7 @@ The fade-in duration. For example, setting this to ``1.0`` for a 5 second length
308308
- |void| **set_fadeout_curve**\ (\ value\: :ref:`Curve<class_Curve>`\ )
309309
- :ref:`Curve<class_Curve>` **get_fadeout_curve**\ (\ )
310310

311-
Determines how cross-fading between animations is eased. If empty, the transition will be linear.
311+
Determines how cross-fading between animations is eased. If empty, the transition will be linear. Should be a unit :ref:`Curve<class_Curve>`.
312312

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

classes/class_animationnodestatemachinetransition.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,7 @@ The transition type.
300300
- |void| **set_xfade_curve**\ (\ value\: :ref:`Curve<class_Curve>`\ )
301301
- :ref:`Curve<class_Curve>` **get_xfade_curve**\ (\ )
302302

303-
Ease curve for better control over cross-fade between this state and the next.
303+
Ease curve for better control over cross-fade between this state and the next. Should be a unit :ref:`Curve<class_Curve>`.
304304

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

classes/class_animationnodetransition.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ The number of enabled input ports for this animation node.
163163
- |void| **set_xfade_curve**\ (\ value\: :ref:`Curve<class_Curve>`\ )
164164
- :ref:`Curve<class_Curve>` **get_xfade_curve**\ (\ )
165165

166-
Determines how cross-fading between animations is eased. If empty, the transition will be linear.
166+
Determines how cross-fading between animations is eased. If empty, the transition will be linear. Should be a unit :ref:`Curve<class_Curve>`.
167167

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

classes/class_basematerial3d.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1536,7 +1536,7 @@ The strength of the anisotropy effect. This is multiplied by :ref:`anisotropy_fl
15361536
- |void| **set_feature**\ (\ feature\: :ref:`Feature<enum_BaseMaterial3D_Feature>`, enable\: :ref:`bool<class_bool>`\ )
15371537
- :ref:`bool<class_bool>` **get_feature**\ (\ feature\: :ref:`Feature<enum_BaseMaterial3D_Feature>`\ ) |const|
15381538

1539-
If ``true``, anisotropy is enabled. Anisotropy changes the shape of the specular blob and aligns it to tangent space. This is useful for brushed aluminium and hair reflections.
1539+
If ``true``, anisotropy is enabled. Anisotropy changes the shape of the specular blob and aligns it to tangent space. This is useful for brushed aluminum and hair reflections.
15401540

15411541
\ **Note:** Mesh tangents are needed for anisotropy to work. If the mesh does not contain tangents, the anisotropy effect will appear broken.
15421542

@@ -1731,8 +1731,6 @@ If ``true``, the shader will keep the scale set for the mesh. Otherwise, the sca
17311731

17321732
Controls how the object faces the camera. See :ref:`BillboardMode<enum_BaseMaterial3D_BillboardMode>`.
17331733

1734-
\ **Note:** When billboarding is enabled and the material also casts shadows, billboards will face **the** camera in the scene when rendering shadows. In scenes with multiple cameras, the intended shadow cannot be determined and this will result in undefined behavior. See `GitHub Pull Request #72638 <https://github.com/godotengine/godot/pull/72638>`__ for details.
1735-
17361734
\ **Note:** Billboard mode is not suitable for VR because the left-right vector of the camera is not horizontal when the screen is attached to your head instead of on the table. See `GitHub issue #41567 <https://github.com/godotengine/godot/issues/41567>`__ for details.
17371735

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

0 commit comments

Comments
 (0)