Skip to content

Commit 2f43fd3

Browse files
mhilbrunnermhilbrunner
authored
Merge pull request #11485 from godotengine/classref/sync-235a32a
classref: Sync with current master branch (235a32a)
2 parents 700efb2 + 6da2fd7 commit 2f43fd3

32 files changed

+808
-205
lines changed

‎classes/class_aimmodifier3d.rst‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ Methods
4848
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
4949
| :ref:`Axis<enum_Vector3_Axis>` | :ref:`get_primary_rotation_axis<class_AimModifier3D_method_get_primary_rotation_axis>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
5050
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
51+
| :ref:`bool<class_bool>` | :ref:`is_relative<class_AimModifier3D_method_is_relative>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
52+
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
5153
| :ref:`bool<class_bool>` | :ref:`is_using_euler<class_AimModifier3D_method_is_using_euler>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
5254
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
5355
| :ref:`bool<class_bool>` | :ref:`is_using_secondary_rotation<class_AimModifier3D_method_is_using_secondary_rotation>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
@@ -56,6 +58,8 @@ Methods
5658
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
5759
| |void| | :ref:`set_primary_rotation_axis<class_AimModifier3D_method_set_primary_rotation_axis>`\ (\ index\: :ref:`int<class_int>`, axis\: :ref:`Axis<enum_Vector3_Axis>`\ ) |
5860
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
61+
| |void| | :ref:`set_relative<class_AimModifier3D_method_set_relative>`\ (\ index\: :ref:`int<class_int>`, enabled\: :ref:`bool<class_bool>`\ ) |
62+
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
5963
| |void| | :ref:`set_use_euler<class_AimModifier3D_method_set_use_euler>`\ (\ index\: :ref:`int<class_int>`, enabled\: :ref:`bool<class_bool>`\ ) |
6064
+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
6165
| |void| | :ref:`set_use_secondary_rotation<class_AimModifier3D_method_set_use_secondary_rotation>`\ (\ index\: :ref:`int<class_int>`, enabled\: :ref:`bool<class_bool>`\ ) |
@@ -116,6 +120,18 @@ Returns the axis of the first rotation. It is enabled only if :ref:`is_using_eul
116120

117121
----
118122

123+
.. _class_AimModifier3D_method_is_relative:
124+
125+
.. rst-class:: classref-method
126+
127+
:ref:`bool<class_bool>` **is_relative**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_AimModifier3D_method_is_relative>`
128+
129+
Returns ``true`` if the relative option is enabled in the setting at ``index``.
130+
131+
.. rst-class:: classref-item-separator
132+
133+
----
134+
119135
.. _class_AimModifier3D_method_is_using_euler:
120136

121137
.. rst-class:: classref-method
@@ -164,6 +180,22 @@ Sets the axis of the first rotation. It is enabled only if :ref:`is_using_euler(
164180

165181
----
166182

183+
.. _class_AimModifier3D_method_set_relative:
184+
185+
.. rst-class:: classref-method
186+
187+
|void| **set_relative**\ (\ index\: :ref:`int<class_int>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_AimModifier3D_method_set_relative>`
188+
189+
Sets relative option in the setting at ``index`` to ``enabled``.
190+
191+
If sets ``enabled`` to ``true``, the rotation is applied relative to the pose.
192+
193+
If sets ``enabled`` to ``false``, the rotation is applied relative to the rest. It means to replace the current pose with the **AimModifier3D**'s result.
194+
195+
.. rst-class:: classref-item-separator
196+
197+
----
198+
167199
.. _class_AimModifier3D_method_set_use_euler:
168200

169201
.. rst-class:: classref-method

‎classes/class_atlastexture.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,8 @@ The margin around the :ref:`region<class_AtlasTexture_property_region>`. Useful
118118

119119
The region used to draw the :ref:`atlas<class_AtlasTexture_property_atlas>`. If either dimension of the region's size is ``0``, the value from :ref:`atlas<class_AtlasTexture_property_atlas>` size will be used for that axis instead.
120120

121+
\ **Note:** The image size is always an integer, so the actual region size is rounded down.
122+
121123
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
122124
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
123125
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`

‎classes/class_canvasgroup.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Merges several 2D nodes into a single draw operation.
1919
Description
2020
-----------
2121

22-
Child :ref:`CanvasItem<class_CanvasItem>` nodes of a **CanvasGroup** are drawn as a single object. It allows to e.g. draw overlapping translucent 2D nodes without blending (set :ref:`CanvasItem.self_modulate<class_CanvasItem_property_self_modulate>` property of **CanvasGroup** to achieve this effect).
22+
Child :ref:`CanvasItem<class_CanvasItem>` nodes of a **CanvasGroup** are drawn as a single object. It allows to e.g. draw overlapping translucent 2D nodes without causing the overlapping sections to be more opaque than intended (set the :ref:`CanvasItem.self_modulate<class_CanvasItem_property_self_modulate>` property on the **CanvasGroup** to achieve this effect).
2323

24-
\ **Note:** The **CanvasGroup** uses a custom shader to read from the backbuffer to draw its children. Assigning a :ref:`Material<class_Material>` to the **CanvasGroup** overrides the builtin shader. To duplicate the behavior of the builtin shader in a custom :ref:`Shader<class_Shader>` use the following:
24+
\ **Note:** The **CanvasGroup** uses a custom shader to read from the backbuffer to draw its children. Assigning a :ref:`Material<class_Material>` to the **CanvasGroup** overrides the built-in shader. To duplicate the behavior of the built-in shader in a custom :ref:`Shader<class_Shader>`, use the following:
2525

2626
::
2727

‎classes/class_editordock.rst‎

Lines changed: 105 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Properties
6767
:widths: auto
6868

6969
+-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+
70-
| |bitfield|\[:ref:`DockLayout<enum_EditorDock_DockLayout>`\] | :ref:`available_layouts<class_EditorDock_property_available_layouts>` | ``1`` |
70+
| |bitfield|\[:ref:`DockLayout<enum_EditorDock_DockLayout>`\] | :ref:`available_layouts<class_EditorDock_property_available_layouts>` | ``5`` |
7171
+-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+
7272
| :ref:`bool<class_bool>` | clip_contents | ``true`` (overrides :ref:`Control<class_Control_property_clip_contents>`) |
7373
+-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+
@@ -77,12 +77,18 @@ Properties
7777
+-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+
7878
| :ref:`Shortcut<class_Shortcut>` | :ref:`dock_shortcut<class_EditorDock_property_dock_shortcut>` | |
7979
+-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+
80+
| :ref:`bool<class_bool>` | :ref:`global<class_EditorDock_property_global>` | ``true`` |
81+
+-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+
8082
| :ref:`StringName<class_StringName>` | :ref:`icon_name<class_EditorDock_property_icon_name>` | ``&""`` |
8183
+-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+
8284
| :ref:`String<class_String>` | :ref:`layout_key<class_EditorDock_property_layout_key>` | ``""`` |
8385
+-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+
8486
| :ref:`String<class_String>` | :ref:`title<class_EditorDock_property_title>` | ``""`` |
8587
+-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+
88+
| :ref:`Color<class_Color>` | :ref:`title_color<class_EditorDock_property_title_color>` | ``Color(0, 0, 0, 0)`` |
89+
+-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+
90+
| :ref:`bool<class_bool>` | :ref:`transient<class_EditorDock_property_transient>` | ``false`` |
91+
+-------------------------------------------------------------+-----------------------------------------------------------------------+---------------------------------------------------------------------------+
8692

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

@@ -99,6 +105,10 @@ Methods
99105
+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
100106
| |void| | :ref:`_update_layout<class_EditorDock_private_method__update_layout>`\ (\ layout\: :ref:`int<class_int>`\ ) |virtual| |
101107
+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
108+
| |void| | :ref:`close<class_EditorDock_method_close>`\ (\ ) |
109+
+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
110+
| |void| | :ref:`open<class_EditorDock_method_open>`\ (\ ) |
111+
+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
102112

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

@@ -123,15 +133,29 @@ flags **DockLayout**: :ref:`🔗<enum_EditorDock_DockLayout>`
123133

124134
Allows placing the dock in the vertical dock slots on either side of the editor.
125135

126-
\ **Note:** Currently this flag has no effect because the bottom panel is not a proper dock slot. This means that the dock can always be vertical.
127-
128136
.. _class_EditorDock_constant_DOCK_LAYOUT_HORIZONTAL:
129137

130138
.. rst-class:: classref-enumeration-constant
131139

132140
:ref:`DockLayout<enum_EditorDock_DockLayout>` **DOCK_LAYOUT_HORIZONTAL** = ``2``
133141

134-
Allows placing the dock in the editor's bottom panel. Implement :ref:`_update_layout()<class_EditorDock_private_method__update_layout>` to handle changing layouts.
142+
Allows placing the dock in the editor's bottom panel.
143+
144+
.. _class_EditorDock_constant_DOCK_LAYOUT_FLOATING:
145+
146+
.. rst-class:: classref-enumeration-constant
147+
148+
:ref:`DockLayout<enum_EditorDock_DockLayout>` **DOCK_LAYOUT_FLOATING** = ``4``
149+
150+
Allows making the dock floating (opened as a separate window).
151+
152+
.. _class_EditorDock_constant_DOCK_LAYOUT_ALL:
153+
154+
.. rst-class:: classref-enumeration-constant
155+
156+
:ref:`DockLayout<enum_EditorDock_DockLayout>` **DOCK_LAYOUT_ALL** = ``7``
157+
158+
Allows placing the dock in all available slots.
135159

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

@@ -146,16 +170,14 @@ Property Descriptions
146170

147171
.. rst-class:: classref-property
148172

149-
|bitfield|\[:ref:`DockLayout<enum_EditorDock_DockLayout>`\] **available_layouts** = ``1`` :ref:`🔗<class_EditorDock_property_available_layouts>`
173+
|bitfield|\[:ref:`DockLayout<enum_EditorDock_DockLayout>`\] **available_layouts** = ``5`` :ref:`🔗<class_EditorDock_property_available_layouts>`
150174

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

153177
- |void| **set_available_layouts**\ (\ value\: |bitfield|\[:ref:`DockLayout<enum_EditorDock_DockLayout>`\]\ )
154178
- |bitfield|\[:ref:`DockLayout<enum_EditorDock_DockLayout>`\] **get_available_layouts**\ (\ )
155179

156-
The available layouts for this dock, as a bitmask.
157-
158-
If you want to make all layouts available, use ``available_layouts = DOCK_LAYOUT_VERTICAL | DOCK_LAYOUT_HORIZONTAL``.
180+
The available layouts for this dock, as a bitmask. By default, the dock allows vertical and floating layouts.
159181

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

@@ -214,6 +236,23 @@ The shortcut used to open the dock. This property can only be set before this do
214236

215237
----
216238

239+
.. _class_EditorDock_property_global:
240+
241+
.. rst-class:: classref-property
242+
243+
:ref:`bool<class_bool>` **global** = ``true`` :ref:`🔗<class_EditorDock_property_global>`
244+
245+
.. rst-class:: classref-property-setget
246+
247+
- |void| **set_global**\ (\ value\: :ref:`bool<class_bool>`\ )
248+
- :ref:`bool<class_bool>` **is_global**\ (\ )
249+
250+
If ``true``, the dock appears in the **Editor > Editor Docks** menu and can be closed. Non-global docks can still be closed using :ref:`close()<class_EditorDock_method_close>`.
251+
252+
.. rst-class:: classref-item-separator
253+
254+
----
255+
217256
.. _class_EditorDock_property_icon_name:
218257

219258
.. rst-class:: classref-property
@@ -261,6 +300,40 @@ The key representing this dock in the editor's layout file. If empty, the dock's
261300

262301
The title of the dock's tab. If empty, the dock's :ref:`Node.name<class_Node_property_name>` will be used. If the name is auto-generated (contains ``@``), the first child's name will be used instead.
263302

303+
.. rst-class:: classref-item-separator
304+
305+
----
306+
307+
.. _class_EditorDock_property_title_color:
308+
309+
.. rst-class:: classref-property
310+
311+
:ref:`Color<class_Color>` **title_color** = ``Color(0, 0, 0, 0)`` :ref:`🔗<class_EditorDock_property_title_color>`
312+
313+
.. rst-class:: classref-property-setget
314+
315+
- |void| **set_title_color**\ (\ value\: :ref:`Color<class_Color>`\ )
316+
- :ref:`Color<class_Color>` **get_title_color**\ (\ )
317+
318+
The color of the dock tab's title. If its alpha is ``0.0``, the default font color will be used.
319+
320+
.. rst-class:: classref-item-separator
321+
322+
----
323+
324+
.. _class_EditorDock_property_transient:
325+
326+
.. rst-class:: classref-property
327+
328+
:ref:`bool<class_bool>` **transient** = ``false`` :ref:`🔗<class_EditorDock_property_transient>`
329+
330+
.. rst-class:: classref-property-setget
331+
332+
- |void| **set_transient**\ (\ value\: :ref:`bool<class_bool>`\ )
333+
- :ref:`bool<class_bool>` **is_transient**\ (\ )
334+
335+
If ``true``, the dock is not automatically opened or closed when loading an editor layout, only moved. It also can't be opened using a shortcut. This is meant for docks that are opened and closed in specific cases, such as when selecting a :ref:`TileMap<class_TileMap>` or :ref:`AnimationTree<class_AnimationTree>` node.
336+
264337
.. rst-class:: classref-section-separator
265338

266339
----
@@ -307,6 +380,30 @@ Implement this method to handle the layout switching for this dock. ``layout`` i
307380
_update_layout(layout):
308381
box_container.vertical = (layout == DOCK_LAYOUT_VERTICAL)
309382

383+
.. rst-class:: classref-item-separator
384+
385+
----
386+
387+
.. _class_EditorDock_method_close:
388+
389+
.. rst-class:: classref-method
390+
391+
|void| **close**\ (\ ) :ref:`🔗<class_EditorDock_method_close>`
392+
393+
Closes the dock, making its tab hidden.
394+
395+
.. rst-class:: classref-item-separator
396+
397+
----
398+
399+
.. _class_EditorDock_method_open:
400+
401+
.. rst-class:: classref-method
402+
403+
|void| **open**\ (\ ) :ref:`🔗<class_EditorDock_method_open>`
404+
405+
Opens the dock. It will appear in the last used dock slot. If the dock has no default slot, it will be opened floating.
406+
310407
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
311408
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
312409
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`

0 commit comments

Comments
 (0)