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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
145 changes: 104 additions & 41 deletions classes/class_@gdscript.rst

Large diffs are not rendered by default.

446 changes: 290 additions & 156 deletions classes/class_@globalscope.rst

Large diffs are not rendered by default.

90 changes: 45 additions & 45 deletions classes/class_aabb.rst

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions classes/class_acceptdialog.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AcceptDialog.xml.
.. Generated automatically from Redot engine sources.
.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/AcceptDialog.xml.

.. _class_AcceptDialog:

Expand All @@ -21,7 +21,7 @@ A base dialog used for user notification.
Description
-----------

The default use of **AcceptDialog** is to allow it to only be accepted or closed, with the same result. However, the :ref:`confirmed<class_AcceptDialog_signal_confirmed>` and :ref:`canceled<class_AcceptDialog_signal_canceled>` signals allow to make the two actions different, and the :ref:`add_button<class_AcceptDialog_method_add_button>` method allows to add custom buttons and actions.
The default use of **AcceptDialog** is to allow it to only be accepted or closed, with the same result. However, the :ref:`confirmed<class_AcceptDialog_signal_confirmed>` and :ref:`canceled<class_AcceptDialog_signal_canceled>` signals allow to make the two actions different, and the :ref:`add_button()<class_AcceptDialog_method_add_button>` method allows to add custom buttons and actions.

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

Expand Down Expand Up @@ -110,7 +110,7 @@ Signals

**canceled**\ (\ ) :ref:`🔗<class_AcceptDialog_signal_canceled>`

Emitted when the dialog is closed or the button created with :ref:`add_cancel_button<class_AcceptDialog_method_add_cancel_button>` is pressed.
Emitted when the dialog is closed or the button created with :ref:`add_cancel_button()<class_AcceptDialog_method_add_cancel_button>` is pressed.

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

Expand All @@ -134,7 +134,7 @@ Emitted when the dialog is accepted, i.e. the OK button is pressed.

**custom_action**\ (\ action\: :ref:`StringName<class_StringName>`\ ) :ref:`🔗<class_AcceptDialog_signal_custom_action>`

Emitted when a custom button is pressed. See :ref:`add_button<class_AcceptDialog_method_add_button>`.
Emitted when a custom button is pressed. See :ref:`add_button()<class_AcceptDialog_method_add_button>`.

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

Expand Down Expand Up @@ -226,7 +226,7 @@ The text displayed by the dialog.
- |void| **set_ok_button_text**\ (\ value\: :ref:`String<class_String>`\ )
- :ref:`String<class_String>` **get_ok_button_text**\ (\ )

The text displayed by the OK button (see :ref:`get_ok_button<class_AcceptDialog_method_get_ok_button>`).
The text displayed by the OK button (see :ref:`get_ok_button()<class_AcceptDialog_method_get_ok_button>`).

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

Expand All @@ -247,7 +247,7 @@ Adds a button with label ``text`` and a custom ``action`` to the dialog and retu

If ``true``, ``right`` will place the button to the right of any sibling buttons.

You can use :ref:`remove_button<class_AcceptDialog_method_remove_button>` method to remove a button created with this method from the dialog.
You can use :ref:`remove_button()<class_AcceptDialog_method_remove_button>` method to remove a button created with this method from the dialog.

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

Expand All @@ -261,7 +261,7 @@ You can use :ref:`remove_button<class_AcceptDialog_method_remove_button>` method

Adds a button with label ``name`` and a cancel action to the dialog and returns the created button.

You can use :ref:`remove_button<class_AcceptDialog_method_remove_button>` method to remove a button created with this method from the dialog.
You can use :ref:`remove_button()<class_AcceptDialog_method_remove_button>` method to remove a button created with this method from the dialog.

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

Expand Down Expand Up @@ -313,7 +313,7 @@ Registers a :ref:`LineEdit<class_LineEdit>` in the dialog. When the enter key is

|void| **remove_button**\ (\ button\: :ref:`Button<class_Button>`\ ) :ref:`🔗<class_AcceptDialog_method_remove_button>`

Removes the ``button`` from the dialog. Does NOT free the ``button``. The ``button`` must be a :ref:`Button<class_Button>` added with :ref:`add_button<class_AcceptDialog_method_add_button>` or :ref:`add_cancel_button<class_AcceptDialog_method_add_cancel_button>` method. After removal, pressing the ``button`` will no longer emit this dialog's :ref:`custom_action<class_AcceptDialog_signal_custom_action>` or :ref:`canceled<class_AcceptDialog_signal_canceled>` signals.
Removes the ``button`` from the dialog. Does NOT free the ``button``. The ``button`` must be a :ref:`Button<class_Button>` added with :ref:`add_button()<class_AcceptDialog_method_add_button>` or :ref:`add_cancel_button()<class_AcceptDialog_method_add_cancel_button>` method. After removal, pressing the ``button`` will no longer emit this dialog's :ref:`custom_action<class_AcceptDialog_signal_custom_action>` or :ref:`canceled<class_AcceptDialog_signal_canceled>` signals.

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

Expand Down
12 changes: 6 additions & 6 deletions classes/class_aescontext.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AESContext.xml.
.. Generated automatically from Redot engine sources.
.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/AESContext.xml.

.. _class_AESContext:

Expand Down Expand Up @@ -184,7 +184,7 @@ Method Descriptions

|void| **finish**\ (\ ) :ref:`🔗<class_AESContext_method_finish>`

Close this AES context so it can be started again. See :ref:`start<class_AESContext_method_start>`.
Close this AES context so it can be started again. See :ref:`start()<class_AESContext_method_start>`.

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

Expand All @@ -196,7 +196,7 @@ Close this AES context so it can be started again. See :ref:`start<class_AESCont

:ref:`PackedByteArray<class_PackedByteArray>` **get_iv_state**\ (\ ) :ref:`🔗<class_AESContext_method_get_iv_state>`

Get the current IV state for this context (IV gets updated when calling :ref:`update<class_AESContext_method_update>`). You normally don't need this function.
Get the current IV state for this context (IV gets updated when calling :ref:`update()<class_AESContext_method_update>`). You normally don't need this function.

\ **Note:** This function only makes sense when the context is started with :ref:`MODE_CBC_ENCRYPT<class_AESContext_constant_MODE_CBC_ENCRYPT>` or :ref:`MODE_CBC_DECRYPT<class_AESContext_constant_MODE_CBC_DECRYPT>`.

Expand All @@ -222,7 +222,7 @@ Start the AES context in the given ``mode``. A ``key`` of either 16 or 32 bytes

:ref:`PackedByteArray<class_PackedByteArray>` **update**\ (\ src\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`🔗<class_AESContext_method_update>`

Run the desired operation for this AES context. Will return a :ref:`PackedByteArray<class_PackedByteArray>` containing the result of encrypting (or decrypting) the given ``src``. See :ref:`start<class_AESContext_method_start>` for mode of operation.
Run the desired operation for this AES context. Will return a :ref:`PackedByteArray<class_PackedByteArray>` containing the result of encrypting (or decrypting) the given ``src``. See :ref:`start()<class_AESContext_method_start>` for mode of operation.

\ **Note:** The size of ``src`` must be a multiple of 16. Apply some padding if needed.

Expand Down
8 changes: 4 additions & 4 deletions classes/class_animatablebody2d.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimatableBody2D.xml.
.. Generated automatically from Redot engine sources.
.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/AnimatableBody2D.xml.

.. _class_AnimatableBody2D:

Expand Down Expand Up @@ -55,7 +55,7 @@ Property Descriptions
- |void| **set_sync_to_physics**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_sync_to_physics_enabled**\ (\ )

If ``true``, the body's movement will be synchronized to the physics frame. This is useful when animating movement via :ref:`AnimationPlayer<class_AnimationPlayer>`, for example on moving platforms. Do **not** use together with :ref:`PhysicsBody2D.move_and_collide<class_PhysicsBody2D_method_move_and_collide>`.
If ``true``, the body's movement will be synchronized to the physics frame. This is useful when animating movement via :ref:`AnimationPlayer<class_AnimationPlayer>`, for example on moving platforms. Do **not** use together with :ref:`PhysicsBody2D.move_and_collide()<class_PhysicsBody2D_method_move_and_collide>`.

.. |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
8 changes: 4 additions & 4 deletions classes/class_animatablebody3d.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimatableBody3D.xml.
.. Generated automatically from Redot engine sources.
.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/AnimatableBody3D.xml.

.. _class_AnimatableBody3D:

Expand Down Expand Up @@ -66,7 +66,7 @@ Property Descriptions
- |void| **set_sync_to_physics**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_sync_to_physics_enabled**\ (\ )

If ``true``, the body's movement will be synchronized to the physics frame. This is useful when animating movement via :ref:`AnimationPlayer<class_AnimationPlayer>`, for example on moving platforms. Do **not** use together with :ref:`PhysicsBody3D.move_and_collide<class_PhysicsBody3D_method_move_and_collide>`.
If ``true``, the body's movement will be synchronized to the physics frame. This is useful when animating movement via :ref:`AnimationPlayer<class_AnimationPlayer>`, for example on moving platforms. Do **not** use together with :ref:`PhysicsBody3D.move_and_collide()<class_PhysicsBody3D_method_move_and_collide>`.

.. |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
22 changes: 11 additions & 11 deletions classes/class_animatedsprite2d.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/AnimatedSprite2D.xml.
.. Generated automatically from Redot engine sources.
.. Generator: https://github.com/Redot-Engine/redot-engine/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/Redot-Engine/redot-engine/tree/master/doc/classes/AnimatedSprite2D.xml.

.. _class_AnimatedSprite2D:

Expand Down Expand Up @@ -258,7 +258,7 @@ If ``true``, texture is flipped vertically.
- |void| **set_frame**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_frame**\ (\ )

The displayed animation frame's index. Setting this property also resets :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>`. If this is not desired, use :ref:`set_frame_and_progress<class_AnimatedSprite2D_method_set_frame_and_progress>`.
The displayed animation frame's index. Setting this property also resets :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>`. If this is not desired, use :ref:`set_frame_and_progress()<class_AnimatedSprite2D_method_set_frame_and_progress>`.

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

Expand Down Expand Up @@ -345,7 +345,7 @@ Method Descriptions

:ref:`float<class_float>` **get_playing_speed**\ (\ ) |const| :ref:`🔗<class_AnimatedSprite2D_method_get_playing_speed>`

Returns the actual playing speed of current animation or ``0`` if not playing. This speed is the :ref:`speed_scale<class_AnimatedSprite2D_property_speed_scale>` property multiplied by ``custom_speed`` argument specified when calling the :ref:`play<class_AnimatedSprite2D_method_play>` method.
Returns the actual playing speed of current animation or ``0`` if not playing. This speed is the :ref:`speed_scale<class_AnimatedSprite2D_property_speed_scale>` property multiplied by ``custom_speed`` argument specified when calling the :ref:`play()<class_AnimatedSprite2D_method_play>` method.

Returns a negative value if the current animation is playing backwards.

Expand All @@ -371,9 +371,9 @@ Returns ``true`` if an animation is currently playing (even if :ref:`speed_scale

|void| **pause**\ (\ ) :ref:`🔗<class_AnimatedSprite2D_method_pause>`

Pauses the currently playing animation. The :ref:`frame<class_AnimatedSprite2D_property_frame>` and :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>` will be kept and calling :ref:`play<class_AnimatedSprite2D_method_play>` or :ref:`play_backwards<class_AnimatedSprite2D_method_play_backwards>` without arguments will resume the animation from the current playback position.
Pauses the currently playing animation. The :ref:`frame<class_AnimatedSprite2D_property_frame>` and :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>` will be kept and calling :ref:`play()<class_AnimatedSprite2D_method_play>` or :ref:`play_backwards()<class_AnimatedSprite2D_method_play_backwards>` without arguments will resume the animation from the current playback position.

See also :ref:`stop<class_AnimatedSprite2D_method_stop>`.
See also :ref:`stop()<class_AnimatedSprite2D_method_stop>`.

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

Expand All @@ -385,7 +385,7 @@ See also :ref:`stop<class_AnimatedSprite2D_method_stop>`.

|void| **play**\ (\ name\: :ref:`StringName<class_StringName>` = &"", custom_speed\: :ref:`float<class_float>` = 1.0, from_end\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_AnimatedSprite2D_method_play>`

Plays the animation with key ``name``. If ``custom_speed`` is negative and ``from_end`` is ``true``, the animation will play backwards (which is equivalent to calling :ref:`play_backwards<class_AnimatedSprite2D_method_play_backwards>`).
Plays the animation with key ``name``. If ``custom_speed`` is negative and ``from_end`` is ``true``, the animation will play backwards (which is equivalent to calling :ref:`play_backwards()<class_AnimatedSprite2D_method_play_backwards>`).

If this method is called with that same animation ``name``, or with no ``name`` parameter, the assigned animation will resume playing if it was paused.

Expand All @@ -401,7 +401,7 @@ If this method is called with that same animation ``name``, or with no ``name``

Plays the animation with key ``name`` in reverse.

This method is a shorthand for :ref:`play<class_AnimatedSprite2D_method_play>` with ``custom_speed = -1.0`` and ``from_end = true``, so see its description for more information.
This method is a shorthand for :ref:`play()<class_AnimatedSprite2D_method_play>` with ``custom_speed = -1.0`` and ``from_end = true``, so see its description for more information.

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

Expand All @@ -415,7 +415,7 @@ This method is a shorthand for :ref:`play<class_AnimatedSprite2D_method_play>` w

Sets :ref:`frame<class_AnimatedSprite2D_property_frame>` the :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>` to the given values. Unlike setting :ref:`frame<class_AnimatedSprite2D_property_frame>`, this method does not reset the :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>` to ``0.0`` implicitly.

\ **Example:** Change the animation while keeping the same :ref:`frame<class_AnimatedSprite2D_property_frame>` and :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>`.
\ **Example:** Change the animation while keeping the same :ref:`frame<class_AnimatedSprite2D_property_frame>` and :ref:`frame_progress<class_AnimatedSprite2D_property_frame_progress>`:


.. tabs::
Expand All @@ -439,7 +439,7 @@ Sets :ref:`frame<class_AnimatedSprite2D_property_frame>` the :ref:`frame_progres

|void| **stop**\ (\ ) :ref:`🔗<class_AnimatedSprite2D_method_stop>`

Stops the currently playing animation. The animation position is reset to ``0`` and the ``custom_speed`` is reset to ``1.0``. See also :ref:`pause<class_AnimatedSprite2D_method_pause>`.
Stops the currently playing animation. The animation position is reset to ``0`` and the ``custom_speed`` is reset to ``1.0``. See also :ref:`pause()<class_AnimatedSprite2D_method_pause>`.

.. |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
Loading