Skip to content

Commit c8d799d

Browse files
mhilbrunnermhilbrunner
authored
Merge pull request #9008 from godotengine/classref/sync-2e7fc81
classref: Sync with current master branch (2e7fc81)
2 parents 4f21f44 + 8978497 commit c8d799d

File tree

938 files changed

+42729
-36889
lines changed

Some content is hidden

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

938 files changed

+42729
-36889
lines changed

‎classes/[email protected]‎

Lines changed: 77 additions & 76 deletions
Large diffs are not rendered by default.

‎classes/[email protected]‎

Lines changed: 348 additions & 363 deletions
Large diffs are not rendered by default.

‎classes/class_aabb.rst‎

Lines changed: 97 additions & 96 deletions
Large diffs are not rendered by default.

‎classes/class_acceptdialog.rst‎

Lines changed: 33 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -63,19 +63,19 @@ Methods
6363
.. table::
6464
:widths: auto
6565

66-
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
67-
| :ref:`Button<class_Button>` | :ref:`add_button<class_AcceptDialog_method_add_button>` **(** :ref:`String<class_String>` text, :ref:`bool<class_bool>` right=false, :ref:`String<class_String>` action="" **)** |
68-
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
69-
| :ref:`Button<class_Button>` | :ref:`add_cancel_button<class_AcceptDialog_method_add_cancel_button>` **(** :ref:`String<class_String>` name **)** |
70-
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
71-
| :ref:`Label<class_Label>` | :ref:`get_label<class_AcceptDialog_method_get_label>` **(** **)** |
72-
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
73-
| :ref:`Button<class_Button>` | :ref:`get_ok_button<class_AcceptDialog_method_get_ok_button>` **(** **)** |
74-
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
75-
| void | :ref:`register_text_enter<class_AcceptDialog_method_register_text_enter>` **(** :ref:`Control<class_Control>` line_edit **)** |
76-
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
77-
| void | :ref:`remove_button<class_AcceptDialog_method_remove_button>` **(** :ref:`Control<class_Control>` button **)** |
78-
+-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
66+
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
67+
| :ref:`Button<class_Button>` | :ref:`add_button<class_AcceptDialog_method_add_button>`\ (\ text\: :ref:`String<class_String>`, right\: :ref:`bool<class_bool>` = false, action\: :ref:`String<class_String>` = ""\ ) |
68+
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
69+
| :ref:`Button<class_Button>` | :ref:`add_cancel_button<class_AcceptDialog_method_add_cancel_button>`\ (\ name\: :ref:`String<class_String>`\ ) |
70+
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
71+
| :ref:`Label<class_Label>` | :ref:`get_label<class_AcceptDialog_method_get_label>`\ (\ ) |
72+
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
73+
| :ref:`Button<class_Button>` | :ref:`get_ok_button<class_AcceptDialog_method_get_ok_button>`\ (\ ) |
74+
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
75+
| |void| | :ref:`register_text_enter<class_AcceptDialog_method_register_text_enter>`\ (\ line_edit\: :ref:`Control<class_Control>`\ ) |
76+
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
77+
| |void| | :ref:`remove_button<class_AcceptDialog_method_remove_button>`\ (\ button\: :ref:`Control<class_Control>`\ ) |
78+
+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
7979

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

@@ -104,7 +104,7 @@ Signals
104104

105105
.. rst-class:: classref-signal
106106

107-
**canceled** **(** **)**
107+
**canceled**\ (\ )
108108

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

@@ -116,7 +116,7 @@ Emitted when the dialog is closed or the button created with :ref:`add_cancel_bu
116116

117117
.. rst-class:: classref-signal
118118

119-
**confirmed** **(** **)**
119+
**confirmed**\ (\ )
120120

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

@@ -128,7 +128,7 @@ Emitted when the dialog is accepted, i.e. the OK button is pressed.
128128

129129
.. rst-class:: classref-signal
130130

131-
**custom_action** **(** :ref:`StringName<class_StringName>` action **)**
131+
**custom_action**\ (\ action\: :ref:`StringName<class_StringName>`\ )
132132

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

@@ -149,8 +149,8 @@ Property Descriptions
149149

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

152-
- void **set_autowrap** **(** :ref:`bool<class_bool>` value **)**
153-
- :ref:`bool<class_bool>` **has_autowrap** **(** **)**
152+
- |void| **set_autowrap**\ (\ value\: :ref:`bool<class_bool>`\ )
153+
- :ref:`bool<class_bool>` **has_autowrap**\ (\ )
154154

155155
Sets autowrapping for the text in the dialog.
156156

@@ -166,8 +166,8 @@ Sets autowrapping for the text in the dialog.
166166

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

169-
- void **set_close_on_escape** **(** :ref:`bool<class_bool>` value **)**
170-
- :ref:`bool<class_bool>` **get_close_on_escape** **(** **)**
169+
- |void| **set_close_on_escape**\ (\ value\: :ref:`bool<class_bool>`\ )
170+
- :ref:`bool<class_bool>` **get_close_on_escape**\ (\ )
171171

172172
If ``true``, the dialog will be hidden when the escape key (:ref:`@GlobalScope.KEY_ESCAPE<class_@GlobalScope_constant_KEY_ESCAPE>`) is pressed.
173173

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

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

186-
- void **set_hide_on_ok** **(** :ref:`bool<class_bool>` value **)**
187-
- :ref:`bool<class_bool>` **get_hide_on_ok** **(** **)**
186+
- |void| **set_hide_on_ok**\ (\ value\: :ref:`bool<class_bool>`\ )
187+
- :ref:`bool<class_bool>` **get_hide_on_ok**\ (\ )
188188

189189
If ``true``, the dialog is hidden when the OK button is pressed. You can set it to ``false`` if you want to do e.g. input validation when receiving the :ref:`confirmed<class_AcceptDialog_signal_confirmed>` signal, and handle hiding the dialog in your own logic.
190190

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

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

205-
- void **set_text** **(** :ref:`String<class_String>` value **)**
206-
- :ref:`String<class_String>` **get_text** **(** **)**
205+
- |void| **set_text**\ (\ value\: :ref:`String<class_String>`\ )
206+
- :ref:`String<class_String>` **get_text**\ (\ )
207207

208208
The text displayed by the dialog.
209209

@@ -219,8 +219,8 @@ The text displayed by the dialog.
219219

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

222-
- void **set_ok_button_text** **(** :ref:`String<class_String>` value **)**
223-
- :ref:`String<class_String>` **get_ok_button_text** **(** **)**
222+
- |void| **set_ok_button_text**\ (\ value\: :ref:`String<class_String>`\ )
223+
- :ref:`String<class_String>` **get_ok_button_text**\ (\ )
224224

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

@@ -237,7 +237,7 @@ Method Descriptions
237237

238238
.. rst-class:: classref-method
239239

240-
:ref:`Button<class_Button>` **add_button** **(** :ref:`String<class_String>` text, :ref:`bool<class_bool>` right=false, :ref:`String<class_String>` action="" **)**
240+
:ref:`Button<class_Button>` **add_button**\ (\ text\: :ref:`String<class_String>`, right\: :ref:`bool<class_bool>` = false, action\: :ref:`String<class_String>` = ""\ )
241241

242242
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.
243243

@@ -253,7 +253,7 @@ You can use :ref:`remove_button<class_AcceptDialog_method_remove_button>` method
253253

254254
.. rst-class:: classref-method
255255

256-
:ref:`Button<class_Button>` **add_cancel_button** **(** :ref:`String<class_String>` name **)**
256+
:ref:`Button<class_Button>` **add_cancel_button**\ (\ name\: :ref:`String<class_String>`\ )
257257

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

@@ -267,7 +267,7 @@ You can use :ref:`remove_button<class_AcceptDialog_method_remove_button>` method
267267

268268
.. rst-class:: classref-method
269269

270-
:ref:`Label<class_Label>` **get_label** **(** **)**
270+
:ref:`Label<class_Label>` **get_label**\ (\ )
271271

272272
Returns the label used for built-in text.
273273

@@ -281,7 +281,7 @@ Returns the label used for built-in text.
281281

282282
.. rst-class:: classref-method
283283

284-
:ref:`Button<class_Button>` **get_ok_button** **(** **)**
284+
:ref:`Button<class_Button>` **get_ok_button**\ (\ )
285285

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

@@ -295,7 +295,7 @@ Returns the OK :ref:`Button<class_Button>` instance.
295295

296296
.. rst-class:: classref-method
297297

298-
void **register_text_enter** **(** :ref:`Control<class_Control>` line_edit **)**
298+
|void| **register_text_enter**\ (\ line_edit\: :ref:`Control<class_Control>`\ )
299299

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

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

308308
.. rst-class:: classref-method
309309

310-
void **remove_button** **(** :ref:`Control<class_Control>` button **)**
310+
|void| **remove_button**\ (\ button\: :ref:`Control<class_Control>`\ )
311311

312312
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.
313313

@@ -347,3 +347,4 @@ The panel that fills the background of the window.
347347
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
348348
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
349349
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
350+
.. |void| replace:: :abbr:`void (No return value.)`

‎classes/class_aescontext.rst‎

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -104,15 +104,15 @@ Methods
104104
.. table::
105105
:widths: auto
106106

107-
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
108-
| void | :ref:`finish<class_AESContext_method_finish>` **(** **)** |
109-
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
110-
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`get_iv_state<class_AESContext_method_get_iv_state>` **(** **)** |
111-
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
112-
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`start<class_AESContext_method_start>` **(** :ref:`Mode<enum_AESContext_Mode>` mode, :ref:`PackedByteArray<class_PackedByteArray>` key, :ref:`PackedByteArray<class_PackedByteArray>` iv=PackedByteArray() **)** |
113-
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
114-
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`update<class_AESContext_method_update>` **(** :ref:`PackedByteArray<class_PackedByteArray>` src **)** |
115-
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
107+
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
108+
| |void| | :ref:`finish<class_AESContext_method_finish>`\ (\ ) |
109+
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
110+
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`get_iv_state<class_AESContext_method_get_iv_state>`\ (\ ) |
111+
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
112+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`start<class_AESContext_method_start>`\ (\ mode\: :ref:`Mode<enum_AESContext_Mode>`, key\: :ref:`PackedByteArray<class_PackedByteArray>`, iv\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray()\ ) |
113+
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
114+
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`update<class_AESContext_method_update>`\ (\ src\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |
115+
+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
116116

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

@@ -182,7 +182,7 @@ Method Descriptions
182182

183183
.. rst-class:: classref-method
184184

185-
void **finish** **(** **)**
185+
|void| **finish**\ (\ )
186186

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

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

195195
.. rst-class:: classref-method
196196

197-
:ref:`PackedByteArray<class_PackedByteArray>` **get_iv_state** **(** **)**
197+
:ref:`PackedByteArray<class_PackedByteArray>` **get_iv_state**\ (\ )
198198

199199
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.
200200

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

209209
.. rst-class:: classref-method
210210

211-
:ref:`Error<enum_@GlobalScope_Error>` **start** **(** :ref:`Mode<enum_AESContext_Mode>` mode, :ref:`PackedByteArray<class_PackedByteArray>` key, :ref:`PackedByteArray<class_PackedByteArray>` iv=PackedByteArray() **)**
211+
:ref:`Error<enum_@GlobalScope_Error>` **start**\ (\ mode\: :ref:`Mode<enum_AESContext_Mode>`, key\: :ref:`PackedByteArray<class_PackedByteArray>`, iv\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray()\ )
212212

213213
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>`.
214214

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

221221
.. rst-class:: classref-method
222222

223-
:ref:`PackedByteArray<class_PackedByteArray>` **update** **(** :ref:`PackedByteArray<class_PackedByteArray>` src **)**
223+
:ref:`PackedByteArray<class_PackedByteArray>` **update**\ (\ src\: :ref:`PackedByteArray<class_PackedByteArray>`\ )
224224

225225
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.
226226

@@ -233,3 +233,4 @@ Run the desired operation for this AES context. Will return a :ref:`PackedByteAr
233233
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
234234
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
235235
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
236+
.. |void| replace:: :abbr:`void (No return value.)`

0 commit comments

Comments
 (0)