Skip to content
Merged
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
4 changes: 4 additions & 0 deletions classes/class_@globalscope.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ Singletons are also documented here, since they can be accessed from anywhere.

For the entries related to GDScript which can be accessed in any script see :ref:`@GDScript<class_@GDScript>`.

.. note::

There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.

.. rst-class:: classref-introduction-group

Tutorials
Expand Down
4 changes: 4 additions & 0 deletions classes/class_aabb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ Negative values for :ref:`size<class_AABB_property_size>` are not supported and

\ **Note:** Unlike :ref:`Rect2<class_Rect2>`, **AABB** does not have a variant that uses integer coordinates.

.. note::

There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.

.. rst-class:: classref-introduction-group

Tutorials
Expand Down
2 changes: 1 addition & 1 deletion classes/class_animationnodeadd3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Blends two of three animations additively inside of an :ref:`AnimationNodeBlendT
Description
-----------

A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Blends two animations out of three additively out of three based on the amounmt value.
A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Blends two animations out of three additively out of three based on the amount value.

This animation node has three inputs:

Expand Down
2 changes: 1 addition & 1 deletion classes/class_animationnodeblend3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Blends two of three animations linearly inside of an :ref:`AnimationNodeBlendTre
Description
-----------

A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Blends two animations out of three linearly out of three based on the amounmt value.
A resource to add to an :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`. Blends two animations out of three linearly out of three based on the amount value.

This animation node has three inputs:

Expand Down
4 changes: 4 additions & 0 deletions classes/class_array.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ Arrays can be concatenated using the ``+`` operator:

\ **Note:** Erasing elements while iterating over arrays is **not** supported and will result in unpredictable behavior.

.. note::

There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.

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

Constructors
Expand Down
2 changes: 1 addition & 1 deletion classes/class_audiostreamoggvorbis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Property Descriptions
- void **set_loop** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **has_loop** **(** **)**

If ``true``, the stream will automatically loop when it reaches the end.
If ``true``, the audio will play again from the specified :ref:`loop_offset<class_AudioStreamOggVorbis_property_loop_offset>` once it is done playing. Useful for ambient sounds and background music.

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

Expand Down
4 changes: 4 additions & 0 deletions classes/class_basis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ Basis can also be accessed as an array of 3D vectors. These vectors are usually

For more information, read the "Matrices and transforms" documentation article.

.. note::

There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.

.. rst-class:: classref-introduction-group

Tutorials
Expand Down
2 changes: 1 addition & 1 deletion classes/class_boneattachment3d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ Sets the :ref:`NodePath<class_NodePath>` to the external skeleton that the BoneA

void **set_use_external_skeleton** **(** :ref:`bool<class_bool>` use_external_skeleton **)**

Sets whether the BoneAttachment3D node will use an extenral :ref:`Skeleton3D<class_Skeleton3D>` node rather than attenpting to use its parent node as the :ref:`Skeleton3D<class_Skeleton3D>`. When set to ``true``, the BoneAttachment3D node will use the external :ref:`Skeleton3D<class_Skeleton3D>` node set in :ref:`set_external_skeleton<class_BoneAttachment3D_method_set_external_skeleton>`.
Sets whether the BoneAttachment3D node will use an external :ref:`Skeleton3D<class_Skeleton3D>` node rather than attempting to use its parent node as the :ref:`Skeleton3D<class_Skeleton3D>`. When set to ``true``, the BoneAttachment3D node will use the external :ref:`Skeleton3D<class_Skeleton3D>` node set in :ref:`set_external_skeleton<class_BoneAttachment3D_method_set_external_skeleton>`.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
Expand Down
4 changes: 4 additions & 0 deletions classes/class_callable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,10 @@ In GDScript, it's possible to create lambda functions within a method. Lambda fu
# This will work, as lambdas are custom callables.
create_tween().tween_callback(func(): my_dictionary.clear())

.. note::

There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.

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

Constructors
Expand Down
14 changes: 14 additions & 0 deletions classes/class_camera3d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ Methods
+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_current<class_Camera3D_method_clear_current>` **(** :ref:`bool<class_bool>` enable_next=true **)** |
+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Projection<class_Projection>` | :ref:`get_camera_projection<class_Camera3D_method_get_camera_projection>` **(** **)** |const| |
+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`get_camera_rid<class_Camera3D_method_get_camera_rid>` **(** **)** |const| |
+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform3D<class_Transform3D>` | :ref:`get_camera_transform<class_Camera3D_method_get_camera_transform>` **(** **)** |const| |
Expand Down Expand Up @@ -497,6 +499,18 @@ If this is the current camera, remove it from being current. If ``enable_next``

----

.. _class_Camera3D_method_get_camera_projection:

.. rst-class:: classref-method

:ref:`Projection<class_Projection>` **get_camera_projection** **(** **)** |const|

Returns the projection matrix that this camera uses to render to its associated viewport. The camera must be part of the scene tree to function.

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

----

.. _class_Camera3D_method_get_camera_rid:

.. rst-class:: classref-method
Expand Down
4 changes: 4 additions & 0 deletions classes/class_color.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ Colors can be created in various ways: By the various **Color** constructors, by

\ `Color constants cheatsheet <https://raw.githubusercontent.com/godotengine/godot-docs/master/img/color_constants.png>`__

.. note::

There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.

.. rst-class:: classref-introduction-group

Tutorials
Expand Down
17 changes: 17 additions & 0 deletions classes/class_cpuparticles2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,23 @@ Methods

.. rst-class:: classref-descriptions-group

Signals
-------

.. _class_CPUParticles2D_signal_finished:

.. rst-class:: classref-signal

**finished** **(** **)**

Emitted when all active particles have finished processing. When :ref:`one_shot<class_CPUParticles2D_property_one_shot>` is disabled, particles will process continuously, so this is never emitted.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Enumerations
------------

Expand Down
17 changes: 17 additions & 0 deletions classes/class_cpuparticles3d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,23 @@ Methods

.. rst-class:: classref-descriptions-group

Signals
-------

.. _class_CPUParticles3D_signal_finished:

.. rst-class:: classref-signal

**finished** **(** **)**

Emitted when all active particles have finished processing. When :ref:`one_shot<class_CPUParticles3D_property_one_shot>` is disabled, particles will process continuously, so this is never emitted.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Enumerations
------------

Expand Down
4 changes: 4 additions & 0 deletions classes/class_dictionary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,10 @@ The keys of a dictionary can be iterated with the ``for`` keyword:

\ **Note:** Erasing elements while iterating over dictionaries is **not** supported and will result in unpredictable behavior.

.. note::

There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.

.. rst-class:: classref-introduction-group

Tutorials
Expand Down
Loading