Skip to content

classref: Sync with current master branch (705b7a0) #94

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.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
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
  •  
  •  
  •  
104 changes: 53 additions & 51 deletions classes/[email protected]

Large diffs are not rendered by default.

360 changes: 173 additions & 187 deletions classes/[email protected]

Large diffs are not rendered by default.

64 changes: 32 additions & 32 deletions classes/class_aabb.rst

Large diffs are not rendered by default.

36 changes: 18 additions & 18 deletions classes/class_acceptdialog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Signals

.. rst-class:: classref-signal

**canceled**\ (\ )
**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.

Expand All @@ -120,7 +120,7 @@ Emitted when the dialog is closed or the button created with :ref:`add_cancel_bu

.. rst-class:: classref-signal

**confirmed**\ (\ )
**confirmed**\ (\ ) :ref:`🔗<class_AcceptDialog_signal_confirmed>`

Emitted when the dialog is accepted, i.e. the OK button is pressed.

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

.. rst-class:: classref-signal

**custom_action**\ (\ action\: :ref:`StringName<class_StringName>`\ )
**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>`.

Expand All @@ -149,7 +149,7 @@ Property Descriptions

.. rst-class:: classref-property

:ref:`bool<class_bool>` **dialog_autowrap** = ``false``
:ref:`bool<class_bool>` **dialog_autowrap** = ``false`` :ref:`🔗<class_AcceptDialog_property_dialog_autowrap>`

.. rst-class:: classref-property-setget

Expand All @@ -166,7 +166,7 @@ Sets autowrapping for the text in the dialog.

.. rst-class:: classref-property

:ref:`bool<class_bool>` **dialog_close_on_escape** = ``true``
:ref:`bool<class_bool>` **dialog_close_on_escape** = ``true`` :ref:`🔗<class_AcceptDialog_property_dialog_close_on_escape>`

.. rst-class:: classref-property-setget

Expand All @@ -183,7 +183,7 @@ If ``true``, the dialog will be hidden when the escape key (:ref:`@GlobalScope.K

.. rst-class:: classref-property

:ref:`bool<class_bool>` **dialog_hide_on_ok** = ``true``
:ref:`bool<class_bool>` **dialog_hide_on_ok** = ``true`` :ref:`🔗<class_AcceptDialog_property_dialog_hide_on_ok>`

.. rst-class:: classref-property-setget

Expand All @@ -202,7 +202,7 @@ If ``true``, the dialog is hidden when the OK button is pressed. You can set it

.. rst-class:: classref-property

:ref:`String<class_String>` **dialog_text** = ``""``
:ref:`String<class_String>` **dialog_text** = ``""`` :ref:`🔗<class_AcceptDialog_property_dialog_text>`

.. rst-class:: classref-property-setget

Expand All @@ -219,7 +219,7 @@ The text displayed by the dialog.

.. rst-class:: classref-property

:ref:`String<class_String>` **ok_button_text** = ``"OK"``
:ref:`String<class_String>` **ok_button_text** = ``"OK"`` :ref:`🔗<class_AcceptDialog_property_ok_button_text>`

.. rst-class:: classref-property-setget

Expand All @@ -241,7 +241,7 @@ Method Descriptions

.. rst-class:: classref-method

:ref:`Button<class_Button>` **add_button**\ (\ text\: :ref:`String<class_String>`, right\: :ref:`bool<class_bool>` = false, action\: :ref:`String<class_String>` = ""\ )
:ref:`Button<class_Button>` **add_button**\ (\ text\: :ref:`String<class_String>`, right\: :ref:`bool<class_bool>` = false, action\: :ref:`String<class_String>` = ""\ ) :ref:`🔗<class_AcceptDialog_method_add_button>`

Adds a button with label ``text`` and a custom ``action`` to the dialog and returns the created button. ``action`` will be passed to the :ref:`custom_action<class_AcceptDialog_signal_custom_action>` signal when pressed.

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

.. rst-class:: classref-method

:ref:`Button<class_Button>` **add_cancel_button**\ (\ name\: :ref:`String<class_String>`\ )
:ref:`Button<class_Button>` **add_cancel_button**\ (\ name\: :ref:`String<class_String>`\ ) :ref:`🔗<class_AcceptDialog_method_add_cancel_button>`

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

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

.. rst-class:: classref-method

:ref:`Label<class_Label>` **get_label**\ (\ )
:ref:`Label<class_Label>` **get_label**\ (\ ) :ref:`🔗<class_AcceptDialog_method_get_label>`

Returns the label used for built-in text.

Expand All @@ -285,7 +285,7 @@ Returns the label used for built-in text.

.. rst-class:: classref-method

:ref:`Button<class_Button>` **get_ok_button**\ (\ )
:ref:`Button<class_Button>` **get_ok_button**\ (\ ) :ref:`🔗<class_AcceptDialog_method_get_ok_button>`

Returns the OK :ref:`Button<class_Button>` instance.

Expand All @@ -299,7 +299,7 @@ Returns the OK :ref:`Button<class_Button>` instance.

.. rst-class:: classref-method

|void| **register_text_enter**\ (\ line_edit\: :ref:`LineEdit<class_LineEdit>`\ )
|void| **register_text_enter**\ (\ line_edit\: :ref:`LineEdit<class_LineEdit>`\ ) :ref:`🔗<class_AcceptDialog_method_register_text_enter>`

Registers a :ref:`LineEdit<class_LineEdit>` in the dialog. When the enter key is pressed, the dialog will be accepted.

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

.. rst-class:: classref-method

|void| **remove_button**\ (\ button\: :ref:`Button<class_Button>`\ )
|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.

Expand All @@ -328,7 +328,7 @@ Theme Property Descriptions

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **buttons_min_height** = ``0``
:ref:`int<class_int>` **buttons_min_height** = ``0`` :ref:`🔗<class_AcceptDialog_theme_constant_buttons_min_height>`

The minimum height of each button in the bottom row (such as OK/Cancel) in pixels. This can be increased to make buttons with short texts easier to click/tap.

Expand All @@ -340,7 +340,7 @@ The minimum height of each button in the bottom row (such as OK/Cancel) in pixel

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **buttons_min_width** = ``0``
:ref:`int<class_int>` **buttons_min_width** = ``0`` :ref:`🔗<class_AcceptDialog_theme_constant_buttons_min_width>`

The minimum width of each button in the bottom row (such as OK/Cancel) in pixels. This can be increased to make buttons with short texts easier to click/tap.

Expand All @@ -352,7 +352,7 @@ The minimum width of each button in the bottom row (such as OK/Cancel) in pixels

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **buttons_separation** = ``10``
:ref:`int<class_int>` **buttons_separation** = ``10`` :ref:`🔗<class_AcceptDialog_theme_constant_buttons_separation>`

The size of the vertical space between the dialog's content and the button row.

Expand All @@ -364,7 +364,7 @@ The size of the vertical space between the dialog's content and the button row.

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **panel**
:ref:`StyleBox<class_StyleBox>` **panel** :ref:`🔗<class_AcceptDialog_theme_style_panel>`

The panel that fills the background of the window.

Expand Down
10 changes: 5 additions & 5 deletions classes/class_aescontext.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Enumerations

.. rst-class:: classref-enumeration

enum **Mode**:
enum **Mode**: :ref:`🔗<enum_AESContext_Mode>`

.. _class_AESContext_constant_MODE_ECB_ENCRYPT:

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

.. rst-class:: classref-method

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

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

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

.. rst-class:: classref-method

:ref:`PackedByteArray<class_PackedByteArray>` **get_iv_state**\ (\ )
: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.

Expand All @@ -208,7 +208,7 @@ Get the current IV state for this context (IV gets updated when calling :ref:`up

.. rst-class:: classref-method

:ref:`Error<enum_@GlobalScope_Error>` **start**\ (\ mode\: :ref:`Mode<enum_AESContext_Mode>`, key\: :ref:`PackedByteArray<class_PackedByteArray>`, iv\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray()\ )
:ref:`Error<enum_@GlobalScope_Error>` **start**\ (\ mode\: :ref:`Mode<enum_AESContext_Mode>`, key\: :ref:`PackedByteArray<class_PackedByteArray>`, iv\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray()\ ) :ref:`🔗<class_AESContext_method_start>`

Start the AES context in the given ``mode``. A ``key`` of either 16 or 32 bytes must always be provided, while an ``iv`` (initialization vector) of exactly 16 bytes, is only needed when ``mode`` is either :ref:`MODE_CBC_ENCRYPT<class_AESContext_constant_MODE_CBC_ENCRYPT>` or :ref:`MODE_CBC_DECRYPT<class_AESContext_constant_MODE_CBC_DECRYPT>`.

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

.. rst-class:: classref-method

:ref:`PackedByteArray<class_PackedByteArray>` **update**\ (\ src\: :ref:`PackedByteArray<class_PackedByteArray>`\ )
: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.

Expand Down
2 changes: 1 addition & 1 deletion classes/class_animatablebody2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Property Descriptions

.. rst-class:: classref-property

:ref:`bool<class_bool>` **sync_to_physics** = ``true``
:ref:`bool<class_bool>` **sync_to_physics** = ``true`` :ref:`🔗<class_AnimatableBody2D_property_sync_to_physics>`

.. rst-class:: classref-property-setget

Expand Down
2 changes: 1 addition & 1 deletion classes/class_animatablebody3d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Property Descriptions

.. rst-class:: classref-property

:ref:`bool<class_bool>` **sync_to_physics** = ``true``
:ref:`bool<class_bool>` **sync_to_physics** = ``true`` :ref:`🔗<class_AnimatableBody3D_property_sync_to_physics>`

.. rst-class:: classref-property-setget

Expand Down
Loading