Skip to content

Commit de83a7f

Browse files
authored
Merge pull request #11041 from godotengine/classref/sync-48f361a
classref: Sync with current master branch (48f361a)
2 parents dd72262 + 798987f commit de83a7f

35 files changed

+1073
-390
lines changed

classes/class_acceptdialog.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Emitted when the dialog is accepted, i.e. the OK button is pressed.
138138

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

141-
Emitted when a custom button is pressed. See :ref:`add_button()<class_AcceptDialog_method_add_button>`.
141+
Emitted when a custom button with an action is pressed. See :ref:`add_button()<class_AcceptDialog_method_add_button>`.
142142

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

@@ -247,7 +247,9 @@ Method Descriptions
247247

248248
: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>`
249249

250-
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.
250+
Adds a button with label ``text`` and a custom ``action`` to the dialog and returns the created button.
251+
252+
If ``action`` is not empty, pressing the button will emit the :ref:`custom_action<class_AcceptDialog_signal_custom_action>` signal with the specified action string.
251253

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

classes/class_displayserver.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2070,6 +2070,8 @@ A single window full screen mode. This mode has less overhead, but only one wind
20702070

20712071
Full screen window covers the entire display area of a screen and has no border or decorations. The display's video mode is not changed.
20722072

2073+
\ **Note:** This mode might not work with screen recording software.
2074+
20732075
\ **On Android:** This enables immersive mode.
20742076

20752077
\ **On Windows:** Depending on video driver, full screen transition might cause screens to go black for a moment.
@@ -2186,7 +2188,7 @@ Window is excluded from screenshots taken by :ref:`screen_get_image()<class_Disp
21862188

21872189
\ **Note:** This flag is implemented on macOS and Windows.
21882190

2189-
\ **Note:** Setting this flag will **NOT** prevent other apps from capturing an image. It should not be used as a security measure.
2191+
\ **Note:** Setting this flag will prevent standard screenshot methods from capturing a window image, but does **NOT** guarantee that other apps won't be able to capture an image. It should not be used as a DRM or security measure.
21902192

21912193
.. _class_DisplayServer_constant_WINDOW_FLAG_POPUP_WM_HINT:
21922194

classes/class_editorexportplatformandroid.rst

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,6 @@ Properties
6262
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
6363
| :ref:`int<class_int>` | :ref:`gradle_build/export_format<class_EditorExportPlatformAndroid_property_gradle_build/export_format>` |
6464
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
65-
| :ref:`bool<class_bool>` | :ref:`gradle_build/google_play_instant<class_EditorExportPlatformAndroid_property_gradle_build/google_play_instant>` |
66-
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
6765
| :ref:`String<class_String>` | :ref:`gradle_build/gradle_build_directory<class_EditorExportPlatformAndroid_property_gradle_build/gradle_build_directory>` |
6866
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
6967
| :ref:`String<class_String>` | :ref:`gradle_build/min_sdk<class_EditorExportPlatformAndroid_property_gradle_build/min_sdk>` |
@@ -632,22 +630,6 @@ Application export format (\*.apk or \*.aab).
632630

633631
----
634632

635-
.. _class_EditorExportPlatformAndroid_property_gradle_build/google_play_instant:
636-
637-
.. rst-class:: classref-property
638-
639-
:ref:`bool<class_bool>` **gradle_build/google_play_instant** :ref:`🔗<class_EditorExportPlatformAndroid_property_gradle_build/google_play_instant>`
640-
641-
If ``true``, configures the exported project for Play Instant Build.
642-
643-
Use this option when targeting Play Instant to allow users to launch the app without installation. See `Google Play Instant <https://developer.android.com/topic/google-play-instant/overview>`__.
644-
645-
\ **Note:** Instant play games also need to be optimized for size. See `Optimizing a build for size <https://docs.godotengine.org/en/stable/contributing/development/compiling/optimizing_for_size.html>`__.
646-
647-
.. rst-class:: classref-item-separator
648-
649-
----
650-
651633
.. _class_EditorExportPlatformAndroid_property_gradle_build/gradle_build_directory:
652634

653635
.. rst-class:: classref-property

classes/class_fontfile.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Properties
110110
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
111111
| :ref:`Dictionary<class_Dictionary>` | :ref:`opentype_feature_overrides<class_FontFile_property_opentype_feature_overrides>` | ``{}`` |
112112
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
113-
| :ref:`float<class_float>` | :ref:`oversampling<class_FontFile_property_oversampling>` | |
113+
| :ref:`float<class_float>` | :ref:`oversampling<class_FontFile_property_oversampling>` | ``0.0`` |
114114
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
115115
| :ref:`String<class_String>` | :ref:`style_name<class_FontFile_property_style_name>` | ``""`` |
116116
+-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+
@@ -603,16 +603,14 @@ Font OpenType feature set override.
603603

604604
.. rst-class:: classref-property
605605

606-
:ref:`float<class_float>` **oversampling** :ref:`🔗<class_FontFile_property_oversampling>`
606+
:ref:`float<class_float>` **oversampling** = ``0.0`` :ref:`🔗<class_FontFile_property_oversampling>`
607607

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

610610
- |void| **set_oversampling**\ (\ value\: :ref:`float<class_float>`\ )
611611
- :ref:`float<class_float>` **get_oversampling**\ (\ )
612612

613-
**Deprecated:** Use the ``oversampling`` argument of the ``draw_*`` methods instead.
614-
615-
Deprecated. This property does nothing.
613+
If set to a positive value, overrides the oversampling factor of the viewport this font is used in. See :ref:`Viewport.oversampling<class_Viewport_property_oversampling>`. This value doesn't override the ``oversampling`` parameter of ``draw_*`` methods.
616614

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

classes/class_instanceplaceholder.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Description
2121

2222
Turning on the option **Load As Placeholder** for an instantiated scene in the editor causes it to be replaced by an **InstancePlaceholder** when running the game, this will not replace the node in the editor. This makes it possible to delay actually loading the scene until calling :ref:`create_instance()<class_InstancePlaceholder_method_create_instance>`. This is useful to avoid loading large scenes all at once by loading parts of it selectively.
2323

24-
The **InstancePlaceholder** does not have a transform. This causes any child nodes to be positioned relatively to the :ref:`Viewport<class_Viewport>` from point (0,0), rather than their parent as displayed in the editor. Replacing the placeholder with a scene with a transform will transform children relatively to their parent again.
24+
\ **Note:** Like :ref:`Node<class_Node>`, **InstancePlaceholder** does not have a transform. This causes any child nodes to be positioned relatively to the :ref:`Viewport<class_Viewport>` origin, rather than their parent as displayed in the editor. Replacing the placeholder with a scene with a transform will transform children relatively to their parent again.
2525

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

classes/class_node3d.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Node3D
1515

1616
**Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
1717

18-
**Inherited By:** :ref:`AudioListener3D<class_AudioListener3D>`, :ref:`AudioStreamPlayer3D<class_AudioStreamPlayer3D>`, :ref:`BoneAttachment3D<class_BoneAttachment3D>`, :ref:`Camera3D<class_Camera3D>`, :ref:`CollisionObject3D<class_CollisionObject3D>`, :ref:`CollisionPolygon3D<class_CollisionPolygon3D>`, :ref:`CollisionShape3D<class_CollisionShape3D>`, :ref:`GridMap<class_GridMap>`, :ref:`ImporterMeshInstance3D<class_ImporterMeshInstance3D>`, :ref:`Joint3D<class_Joint3D>`, :ref:`LightmapProbe<class_LightmapProbe>`, :ref:`Marker3D<class_Marker3D>`, :ref:`NavigationLink3D<class_NavigationLink3D>`, :ref:`NavigationObstacle3D<class_NavigationObstacle3D>`, :ref:`NavigationRegion3D<class_NavigationRegion3D>`, :ref:`OpenXRCompositionLayer<class_OpenXRCompositionLayer>`, :ref:`OpenXRHand<class_OpenXRHand>`, :ref:`Path3D<class_Path3D>`, :ref:`PathFollow3D<class_PathFollow3D>`, :ref:`RayCast3D<class_RayCast3D>`, :ref:`RemoteTransform3D<class_RemoteTransform3D>`, :ref:`ShapeCast3D<class_ShapeCast3D>`, :ref:`Skeleton3D<class_Skeleton3D>`, :ref:`SkeletonModifier3D<class_SkeletonModifier3D>`, :ref:`SpringArm3D<class_SpringArm3D>`, :ref:`SpringBoneCollision3D<class_SpringBoneCollision3D>`, :ref:`VehicleWheel3D<class_VehicleWheel3D>`, :ref:`VisualInstance3D<class_VisualInstance3D>`, :ref:`XRFaceModifier3D<class_XRFaceModifier3D>`, :ref:`XRNode3D<class_XRNode3D>`, :ref:`XROrigin3D<class_XROrigin3D>`
18+
**Inherited By:** :ref:`AudioListener3D<class_AudioListener3D>`, :ref:`AudioStreamPlayer3D<class_AudioStreamPlayer3D>`, :ref:`BoneAttachment3D<class_BoneAttachment3D>`, :ref:`Camera3D<class_Camera3D>`, :ref:`CollisionObject3D<class_CollisionObject3D>`, :ref:`CollisionPolygon3D<class_CollisionPolygon3D>`, :ref:`CollisionShape3D<class_CollisionShape3D>`, :ref:`GridMap<class_GridMap>`, :ref:`ImporterMeshInstance3D<class_ImporterMeshInstance3D>`, :ref:`Joint3D<class_Joint3D>`, :ref:`LightmapProbe<class_LightmapProbe>`, :ref:`Marker3D<class_Marker3D>`, :ref:`NavigationLink3D<class_NavigationLink3D>`, :ref:`NavigationObstacle3D<class_NavigationObstacle3D>`, :ref:`NavigationRegion3D<class_NavigationRegion3D>`, :ref:`OpenXRCompositionLayer<class_OpenXRCompositionLayer>`, :ref:`OpenXRHand<class_OpenXRHand>`, :ref:`OpenXRRenderModel<class_OpenXRRenderModel>`, :ref:`OpenXRRenderModelManager<class_OpenXRRenderModelManager>`, :ref:`Path3D<class_Path3D>`, :ref:`PathFollow3D<class_PathFollow3D>`, :ref:`RayCast3D<class_RayCast3D>`, :ref:`RemoteTransform3D<class_RemoteTransform3D>`, :ref:`ShapeCast3D<class_ShapeCast3D>`, :ref:`Skeleton3D<class_Skeleton3D>`, :ref:`SkeletonModifier3D<class_SkeletonModifier3D>`, :ref:`SpringArm3D<class_SpringArm3D>`, :ref:`SpringBoneCollision3D<class_SpringBoneCollision3D>`, :ref:`VehicleWheel3D<class_VehicleWheel3D>`, :ref:`VisualInstance3D<class_VisualInstance3D>`, :ref:`XRFaceModifier3D<class_XRFaceModifier3D>`, :ref:`XRNode3D<class_XRNode3D>`, :ref:`XROrigin3D<class_XROrigin3D>`
1919

2020
Base object in 3D space, inherited by all 3D nodes.
2121

classes/class_object.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -619,6 +619,8 @@ Called when the object receives a notification, which can be identified in ``wha
619619

620620
\ **Note:** The base **Object** defines a few notifications (:ref:`NOTIFICATION_POSTINITIALIZE<class_Object_constant_NOTIFICATION_POSTINITIALIZE>` and :ref:`NOTIFICATION_PREDELETE<class_Object_constant_NOTIFICATION_PREDELETE>`). Inheriting classes such as :ref:`Node<class_Node>` define a lot more notifications, which are also received by this method.
621621

622+
\ **Note:** Unlike other virtual methods, this method is called automatically for every script that overrides it. This means that the base implementation should not be called via ``super`` in GDScript or its equivalents in other languages.
623+
622624
.. rst-class:: classref-item-separator
623625

624626
----

classes/class_openxrextensionwrapper.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ OpenXRExtensionWrapper
1212

1313
**Inherits:** :ref:`Object<class_Object>`
1414

15-
**Inherited By:** :ref:`OpenXRExtensionWrapperExtension<class_OpenXRExtensionWrapperExtension>`, :ref:`OpenXRFutureExtension<class_OpenXRFutureExtension>`
15+
**Inherited By:** :ref:`OpenXRExtensionWrapperExtension<class_OpenXRExtensionWrapperExtension>`, :ref:`OpenXRFutureExtension<class_OpenXRFutureExtension>`, :ref:`OpenXRRenderModelExtension<class_OpenXRRenderModelExtension>`
1616

1717
Allows implementing OpenXR extensions with GDExtension.
1818

@@ -86,6 +86,8 @@ Methods
8686
+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
8787
| |void| | :ref:`_on_state_visible<class_OpenXRExtensionWrapper_private_method__on_state_visible>`\ (\ ) |virtual| |
8888
+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
89+
| |void| | :ref:`_on_sync_actions<class_OpenXRExtensionWrapper_private_method__on_sync_actions>`\ (\ ) |virtual| |
90+
+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
8991
| |void| | :ref:`_on_viewport_composition_layer_destroyed<class_OpenXRExtensionWrapper_private_method__on_viewport_composition_layer_destroyed>`\ (\ layer\: ``const void*``\ ) |virtual| |
9092
+------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
9193
| :ref:`int<class_int>` | :ref:`_set_android_surface_swapchain_create_info_and_get_next_pointer<class_OpenXRExtensionWrapper_private_method__set_android_surface_swapchain_create_info_and_get_next_pointer>`\ (\ property_values\: :ref:`Dictionary<class_Dictionary>`, next_pointer\: ``void*``\ ) |virtual| |
@@ -464,6 +466,18 @@ Called when the OpenXR session state is changed to visible. This means OpenXR is
464466

465467
----
466468

469+
.. _class_OpenXRExtensionWrapper_private_method__on_sync_actions:
470+
471+
.. rst-class:: classref-method
472+
473+
|void| **_on_sync_actions**\ (\ ) |virtual| :ref:`🔗<class_OpenXRExtensionWrapper_private_method__on_sync_actions>`
474+
475+
Called when OpenXR has performed its action sync.
476+
477+
.. rst-class:: classref-item-separator
478+
479+
----
480+
467481
.. _class_OpenXRExtensionWrapper_private_method__on_viewport_composition_layer_destroyed:
468482

469483
.. rst-class:: classref-method

0 commit comments

Comments
 (0)