You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: classes/class_@gdscript.rst
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1183,7 +1183,7 @@ Returns ``true`` if ``value`` is an instance of ``type``. The ``type`` value mus
1183
1183
1184
1184
- A :ref:`Script<class_Script>` (you can use any class, including inner one).
1185
1185
1186
-
Unlike the right operand of the ``is`` operator, ``type`` can be a non-constant value. The ``is`` operator supports more features (such as typed arrays). Use the operator instead of this method if you do not need to check the type dynamically.
1186
+
Unlike the right operand of the ``is`` operator, ``type`` can be a non-constant value. The ``is`` operator supports more features (such as typed arrays and dictionaries). Use the operator instead of this method if you do not need to check the type dynamically.
1187
1187
1188
1188
\ **Examples:**\
1189
1189
@@ -1196,7 +1196,7 @@ Unlike the right operand of the ``is`` operator, ``type`` can be a non-constant
1196
1196
1197
1197
\ **Note:** If ``value`` and/or ``type`` are freed objects (see :ref:`@GlobalScope.is_instance_valid()<class_@GlobalScope_method_is_instance_valid>`), or ``type`` is not one of the above options, this method will raise a runtime error.
1198
1198
1199
-
See also :ref:`@GlobalScope.typeof()<class_@GlobalScope_method_typeof>`, :ref:`type_exists()<class_@GDScript_method_type_exists>`, :ref:`Array.is_same_typed()<class_Array_method_is_same_typed>` (and other :ref:`Array<class_Array>` methods).
1199
+
See also :ref:`@GlobalScope.typeof()<class_@GlobalScope_method_typeof>`, :ref:`Object.is_class()<class_Object_method_is_class>`, :ref:`Object.get_script()<class_Object_method_get_script>`, :ref:`Array.is_same_typed()<class_Array_method_is_same_typed>` (and other :ref:`Array<class_Array>` methods), :ref:`Dictionary.is_same_typed()<class_Dictionary_method_is_same_typed>` (and other :ref:`Dictionary<class_Dictionary>` methods).
**Deprecated:** Use :ref:`ClassDB.class_exists()<class_ClassDB_method_class_exists>` instead.
1406
+
1405
1407
Returns ``true`` if the given :ref:`Object<class_Object>`-derived class exists in :ref:`ClassDB<class_ClassDB>`. Note that :ref:`Variant<class_Variant>` data types are not registered in :ref:`ClassDB<class_ClassDB>`.
**Experimental:** This signal may be changed or removed in future versions.
153
+
154
+
Emitted by :ref:`AnimationNodeAnimation<class_AnimationNodeAnimation>` when its :ref:`AnimationNodeAnimation.animation<class_AnimationNodeAnimation_property_animation>` resource is changed, or by :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>` when its connections change.
Virtual method to be implemented by the user. Returns the cursor shape for the position ``at_position`` in the control's local coordinates, which will typically be used while hovering over this control. See :ref:`get_cursor_shape()<class_Control_method_get_cursor_shape>`.
2557
+
2558
+
If not overridden, defaults to :ref:`mouse_default_cursor_shape<class_Control_property_mouse_default_cursor_shape>`.
2559
+
2560
+
.. rst-class:: classref-item-separator
2561
+
2562
+
----
2563
+
2548
2564
.. _class_Control_private_method__get_drag_data:
2549
2565
2550
2566
.. rst-class:: classref-method
@@ -2604,7 +2620,7 @@ If not overridden, defaults to :ref:`Vector2.ZERO<class_Vector2_constant_ZERO>`.
Virtual method to be implemented by the user. Returns the tooltip text for the position ``at_position`` in control's local coordinates, which will typically appear when the cursor is resting over this control. See :ref:`get_tooltip()<class_Control_method_get_tooltip>`.
2623
+
Virtual method to be implemented by the user. Returns the tooltip text for the position ``at_position`` in the control's local coordinates, which will typically appear when the cursor is resting over this control. See :ref:`get_tooltip()<class_Control_method_get_tooltip>`.
2608
2624
2609
2625
\ **Note:** If this method returns an empty :ref:`String<class_String>` and :ref:`_make_custom_tooltip()<class_Control_private_method__make_custom_tooltip>` is not overridden, no tooltip is displayed.
2610
2626
@@ -2673,7 +2689,7 @@ If the ``event`` inherits :ref:`InputEventMouse<class_InputEventMouse>`, this me
2673
2689
2674
2690
Virtual method to be implemented by the user. Returns whether the given ``point`` is inside this control.
2675
2691
2676
-
If not overridden, default behavior is checking if the point is within control's Rect.
2692
+
If not overridden, default behavior is checking if the point is within the control's Rect.
2677
2693
2678
2694
\ **Note:** If you want to check if a point is inside the control, you can use ``Rect2(Vector2.ZERO, size).has_point(point)``.
2679
2695
@@ -3069,9 +3085,11 @@ Returns the combined value of :ref:`pivot_offset<class_Control_property_pivot_of
Returns the mouse cursor shape for this control when hovered over ``at_position`` in local coordinates. For most controls, this is the same as :ref:`mouse_default_cursor_shape<class_Control_property_mouse_default_cursor_shape>`, but some built-in controls implement more complex logic.
3073
3091
3074
-
Returns the mouse cursor shape for this control when hovered over ``position`` in local coordinates. For most controls, this is the same as :ref:`mouse_default_cursor_shape<class_Control_property_mouse_default_cursor_shape>`, but some built-in controls implement more complex logic.
3092
+
You can override :ref:`_get_cursor_shape()<class_Control_private_method__get_cursor_shape>` to implement custom behavior for this method.
3075
3093
3076
3094
.. rst-class:: classref-item-separator
3077
3095
@@ -3388,9 +3406,9 @@ See :ref:`get_theme_color()<class_Control_method_get_theme_color>` for details.
Returns the tooltip text for the position ``at_position`` in control's local coordinates, which will typically appear when the cursor is resting over this control. By default, it returns :ref:`tooltip_text<class_Control_property_tooltip_text>`.
3409
+
Returns the tooltip text for the position ``at_position`` in the control's local coordinates, which will typically appear when the cursor is resting over this control. By default, it returns :ref:`tooltip_text<class_Control_property_tooltip_text>`.
3392
3410
3393
-
This method can be overridden to customize its behavior. See :ref:`_get_tooltip()<class_Control_private_method__get_tooltip>`.
3411
+
You can override :ref:`_get_tooltip()<class_Control_private_method__get_tooltip>` to implement custom behavior for this method.
3394
3412
3395
3413
\ **Note:** If this method returns an empty :ref:`String<class_String>` and :ref:`_make_custom_tooltip()<class_Control_private_method__make_custom_tooltip>` is not overridden, no tooltip is displayed.
Copy file name to clipboardExpand all lines: classes/class_editorexportplugin.rst
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,9 +19,9 @@ A script that is executed when exporting the project.
19
19
Description
20
20
-----------
21
21
22
-
**EditorExportPlugin**\ s are automatically invoked whenever the user exports the project. Their most common use is to determine what files are being included in the exported project. For each plugin, :ref:`_export_begin()<class_EditorExportPlugin_private_method__export_begin>` is called at the beginning of the export process and then :ref:`_export_file()<class_EditorExportPlugin_private_method__export_file>` is called for each exported file.
22
+
**EditorExportPlugin**\ s are automatically invoked whenever the user exports the project. They can be used to modify scenes and resources during project export based on what :doc:`Feature Tags <../tutorials/export/feature_tags>` are set. For each plugin, :ref:`_export_begin()<class_EditorExportPlugin_private_method__export_begin>` is called at the beginning of the export process and then :ref:`_export_file()<class_EditorExportPlugin_private_method__export_file>` is called for each exported file.
23
23
24
-
To use **EditorExportPlugin**, register it using the:ref:`EditorPlugin.add_export_plugin()<class_EditorPlugin_method_add_export_plugin>` method first.
24
+
Register a **EditorExportPlugin** by creating a new:ref:`EditorPlugin<class_EditorPlugin>` and calling its :ref:`EditorPlugin.add_export_plugin()<class_EditorPlugin_method_add_export_plugin>` method.
25
25
26
26
.. rst-class:: classref-introduction-group
27
27
@@ -213,6 +213,8 @@ Customize a scene. If changes are made to it, return the same or a new scene. Ot
213
213
214
214
Implementing this method is required if :ref:`_begin_customize_scenes()<class_EditorExportPlugin_private_method__begin_customize_scenes>` returns ``true``.
215
215
216
+
\ **Note:** To change a variable in your scene, use the ``@export`` annotation when declaring it.
217
+
216
218
.. rst-class:: classref-item-separator
217
219
218
220
----
@@ -395,6 +397,8 @@ Return a hash based on the configuration passed (for both scenes and resources).
395
397
396
398
Implementing this method is required if :ref:`_begin_customize_resources()<class_EditorExportPlugin_private_method__begin_customize_resources>` returns ``true``.
397
399
400
+
\ **Note:** :ref:`_customize_resource()<class_EditorExportPlugin_private_method__customize_resource>` and :ref:`_customize_scene()<class_EditorExportPlugin_private_method__customize_scene>` will not be called when the **EditorExportPlugin** script is modified unless this hash changes too.
0 commit comments