Skip to content
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

classref: Sync with current master branch (a0943ac) #101

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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions classes/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -3878,15 +3878,15 @@ The property is not stored, and does not display in the editor. This is the defa

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_STORAGE** = ``2``

The property is serialized and saved in the scene file (default).
The property is serialized and saved in the scene file (default for exported properties).

.. _class_@GlobalScope_constant_PROPERTY_USAGE_EDITOR:

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

:ref:`PropertyUsageFlags<enum_@GlobalScope_PropertyUsageFlags>` **PROPERTY_USAGE_EDITOR** = ``4``

The property is shown in the :ref:`EditorInspector<class_EditorInspector>` (default).
The property is shown in the :ref:`EditorInspector<class_EditorInspector>` (default for exported properties).

.. _class_@GlobalScope_constant_PROPERTY_USAGE_INTERNAL:

Expand Down
2 changes: 1 addition & 1 deletion classes/class_aabb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,7 @@ For an example, see :ref:`get_longest_axis<class_AABB_method_get_longest_axis>`.

:ref:`Vector3<class_Vector3>` **get_shortest_axis**\ (\ ) |const| :ref:`🔗<class_AABB_method_get_shortest_axis>`

Returns the shortest normaalized axis of this bounding box's :ref:`size<class_AABB_property_size>`, as a :ref:`Vector3<class_Vector3>` (:ref:`Vector3.RIGHT<class_Vector3_constant_RIGHT>`, :ref:`Vector3.UP<class_Vector3_constant_UP>`, or :ref:`Vector3.BACK<class_Vector3_constant_BACK>`).
Returns the shortest normalized axis of this bounding box's :ref:`size<class_AABB_property_size>`, as a :ref:`Vector3<class_Vector3>` (:ref:`Vector3.RIGHT<class_Vector3_constant_RIGHT>`, :ref:`Vector3.UP<class_Vector3_constant_UP>`, or :ref:`Vector3.BACK<class_Vector3_constant_BACK>`).


.. tabs::
Expand Down
2 changes: 1 addition & 1 deletion classes/class_atlastexture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ The margin around the :ref:`region<class_AtlasTexture_property_region>`. Useful
- |void| **set_region**\ (\ value\: :ref:`Rect2<class_Rect2>`\ )
- :ref:`Rect2<class_Rect2>` **get_region**\ (\ )

The region used to draw the :ref:`atlas<class_AtlasTexture_property_atlas>`.
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.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
Expand Down
2 changes: 2 additions & 0 deletions classes/class_canvasitem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1470,6 +1470,8 @@ Returns ``true`` if global transform notifications are communicated to children.

Returns ``true`` if the node is present in the :ref:`SceneTree<class_SceneTree>`, its :ref:`visible<class_CanvasItem_property_visible>` property is ``true`` and all its ancestors are also visible. If any ancestor is hidden, this node will not be visible in the scene tree, and is therefore not drawn (see :ref:`_draw<class_CanvasItem_private_method__draw>`).

Visibility is checked only in parent nodes that inherit from **CanvasItem**, :ref:`CanvasLayer<class_CanvasLayer>`, and :ref:`Window<class_Window>`. If the parent is of any other type (such as :ref:`Node<class_Node>`, :ref:`AnimationPlayer<class_AnimationPlayer>`, or :ref:`Node3D<class_Node3D>`), it is assumed to be visible.

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

----
Expand Down
46 changes: 46 additions & 0 deletions classes/class_displayserver.rst

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions classes/class_editorfilesystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,18 @@ Emitted if a resource is reimported.

----

.. _class_EditorFileSystem_signal_resources_reimporting:

.. rst-class:: classref-signal

**resources_reimporting**\ (\ resources\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) :ref:`🔗<class_EditorFileSystem_signal_resources_reimporting>`

Emitted before a resource is reimported.

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

----

.. _class_EditorFileSystem_signal_resources_reload:

.. rst-class:: classref-signal
Expand Down
36 changes: 36 additions & 0 deletions classes/class_editorsettings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,10 @@ Properties
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`filesystem/tools/oidn/oidn_denoise_path<class_EditorSettings_property_filesystem/tools/oidn/oidn_denoise_path>` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`input/buffering/agile_event_flushing<class_EditorSettings_property_input/buffering/agile_event_flushing>` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`input/buffering/use_accumulated_input<class_EditorSettings_property_input/buffering/use_accumulated_input>` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`interface/editor/accept_dialog_cancel_ok_buttons<class_EditorSettings_property_interface/editor/accept_dialog_cancel_ok_buttons>` |
+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`interface/editor/automatically_open_screenshots<class_EditorSettings_property_interface/editor/automatically_open_screenshots>` |
Expand Down Expand Up @@ -2361,6 +2365,38 @@ To enable this feature for your specific project, use :ref:`ProjectSettings.rend

----

.. _class_EditorSettings_property_input/buffering/agile_event_flushing:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **input/buffering/agile_event_flushing** :ref:`🔗<class_EditorSettings_property_input/buffering/agile_event_flushing>`

If ``true``, input events will be flushed just before every idle and physics frame.

If ``false``, these events will be flushed only once per process frame, between iterations of the engine.

Enabling this setting can greatly improve input responsiveness, especially in devices that struggle to run at the project's intended frame rate.

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

----

.. _class_EditorSettings_property_input/buffering/use_accumulated_input:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **input/buffering/use_accumulated_input** :ref:`🔗<class_EditorSettings_property_input/buffering/use_accumulated_input>`

If ``true``, similar input events sent by the operating system are accumulated. When input accumulation is enabled, all input events generated during a frame will be merged and emitted when the frame is done rendering. Therefore, this limits the number of input method calls per second to the rendering FPS.

Input accumulation can be disabled to get slightly more precise/reactive input at the cost of increased CPU usage.

\ **Note:** Input accumulation is *enabled* by default.

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

----

.. _class_EditorSettings_property_interface/editor/accept_dialog_cancel_ok_buttons:

.. rst-class:: classref-property
Expand Down
16 changes: 12 additions & 4 deletions classes/class_enetconnection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ Sets the compression method used for network packets. These have different trade

Initiates a connection to a foreign ``address`` using the specified ``port`` and allocating the requested ``channels``. Optional ``data`` can be passed during connection in the form of a 32 bit integer.

\ **Note:** You must call either :ref:`create_host<class_ENetConnection_method_create_host>` or :ref:`create_host_bound<class_ENetConnection_method_create_host_bound>` before calling this method.
\ **Note:** You must call either :ref:`create_host<class_ENetConnection_method_create_host>` or :ref:`create_host_bound<class_ENetConnection_method_create_host_bound>` on both ends before calling this method.

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

Expand All @@ -302,7 +302,11 @@ Initiates a connection to a foreign ``address`` using the specified ``port`` and

:ref:`Error<enum_@GlobalScope_Error>` **create_host**\ (\ max_peers\: :ref:`int<class_int>` = 32, max_channels\: :ref:`int<class_int>` = 0, in_bandwidth\: :ref:`int<class_int>` = 0, out_bandwidth\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_ENetConnection_method_create_host>`

Create an ENetHost that will allow up to ``max_peers`` connected peers, each allocating up to ``max_channels`` channels, optionally limiting bandwidth to ``in_bandwidth`` and ``out_bandwidth``.
Creates an ENetHost that allows up to ``max_peers`` connected peers, each allocating up to ``max_channels`` channels, optionally limiting bandwidth to ``in_bandwidth`` and ``out_bandwidth`` (if greater than zero).

This method binds a random available dynamic UDP port on the host machine at the *unspecified* address. Use :ref:`create_host_bound<class_ENetConnection_method_create_host_bound>` to specify the address and port.

\ **Note:** It is necessary to create a host in both client and server in order to establish a connection.

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

Expand All @@ -314,7 +318,9 @@ Create an ENetHost that will allow up to ``max_peers`` connected peers, each all

:ref:`Error<enum_@GlobalScope_Error>` **create_host_bound**\ (\ bind_address\: :ref:`String<class_String>`, bind_port\: :ref:`int<class_int>`, max_peers\: :ref:`int<class_int>` = 32, max_channels\: :ref:`int<class_int>` = 0, in_bandwidth\: :ref:`int<class_int>` = 0, out_bandwidth\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_ENetConnection_method_create_host_bound>`

Create an ENetHost like :ref:`create_host<class_ENetConnection_method_create_host>` which is also bound to the given ``bind_address`` and ``bind_port``.
Creates an ENetHost bound to the given ``bind_address`` and ``bind_port`` that allows up to ``max_peers`` connected peers, each allocating up to ``max_channels`` channels, optionally limiting bandwidth to ``in_bandwidth`` and ``out_bandwidth`` (if greater than zero).

\ **Note:** It is necessary to create a host in both client and server in order to establish a connection.

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

Expand Down Expand Up @@ -438,10 +444,12 @@ Configures the DTLS server to automatically drop new connections.

:ref:`Array<class_Array>` **service**\ (\ timeout\: :ref:`int<class_int>` = 0\ ) :ref:`🔗<class_ENetConnection_method_service>`

Waits for events on the specified host and shuttles packets between the host and its peers, with the given ``timeout`` (in milliseconds). The returned :ref:`Array<class_Array>` will have 4 elements. An :ref:`EventType<enum_ENetConnection_EventType>`, the :ref:`ENetPacketPeer<class_ENetPacketPeer>` which generated the event, the event associated data (if any), the event associated channel (if any). If the generated event is :ref:`EVENT_RECEIVE<class_ENetConnection_constant_EVENT_RECEIVE>`, the received packet will be queued to the associated :ref:`ENetPacketPeer<class_ENetPacketPeer>`.
Waits for events on this connection and shuttles packets between the host and its peers, with the given ``timeout`` (in milliseconds). The returned :ref:`Array<class_Array>` will have 4 elements. An :ref:`EventType<enum_ENetConnection_EventType>`, the :ref:`ENetPacketPeer<class_ENetPacketPeer>` which generated the event, the event associated data (if any), the event associated channel (if any). If the generated event is :ref:`EVENT_RECEIVE<class_ENetConnection_constant_EVENT_RECEIVE>`, the received packet will be queued to the associated :ref:`ENetPacketPeer<class_ENetPacketPeer>`.

Call this function regularly to handle connections, disconnections, and to receive new packets.

\ **Note:** This method must be called on both ends involved in the event (sending and receiving hosts).

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

----
Expand Down
16 changes: 16 additions & 0 deletions classes/class_lightmapgi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,22 @@ The user aborted the lightmap baking operation (typically by clicking the **Canc

Lightmap baking failed as the maximum texture size is too small to fit some of the meshes marked for baking.

.. _class_LightmapGI_constant_BAKE_ERROR_LIGHTMAP_TOO_SMALL:

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

:ref:`BakeError<enum_LightmapGI_BakeError>` **BAKE_ERROR_LIGHTMAP_TOO_SMALL** = ``10``

Lightmap baking failed as the lightmap is too small.

.. _class_LightmapGI_constant_BAKE_ERROR_ATLAS_TOO_SMALL:

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

:ref:`BakeError<enum_LightmapGI_BakeError>` **BAKE_ERROR_ATLAS_TOO_SMALL** = ``11``

Lightmap baking failed as the lightmap was unable to fit into an atlas.

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

----
Expand Down
2 changes: 1 addition & 1 deletion classes/class_node.rst
Original file line number Diff line number Diff line change
Expand Up @@ -971,7 +971,7 @@ Implemented on desktop platforms.

Notification received from the OS when a go back request is sent (e.g. pressing the "Back" button on Android).

Implemented only on iOS.
Implemented only on Android.

.. _class_Node_constant_NOTIFICATION_WM_SIZE_CHANGED:

Expand Down
7 changes: 7 additions & 0 deletions classes/class_parallax2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ A **Parallax2D** is used to create a parallax effect. It can move at a different

\ **Note:** Any changes to this node's position made after it enters the scene tree will be overridden if :ref:`ignore_camera_scroll<class_Parallax2D_property_ignore_camera_scroll>` is ``false`` or :ref:`screen_offset<class_Parallax2D_property_screen_offset>` is modified.

.. rst-class:: classref-introduction-group

Tutorials
---------

- :doc:`2D Parallax <../tutorials/2d/2d_parallax>`

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

Properties
Expand Down
28 changes: 0 additions & 28 deletions classes/class_projectsettings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -707,10 +707,6 @@ Properties
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`input_devices/buffering/agile_event_flushing<class_ProjectSettings_property_input_devices/buffering/agile_event_flushing>` | ``false`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`input_devices/buffering/android/use_accumulated_input<class_ProjectSettings_property_input_devices/buffering/android/use_accumulated_input>` | ``true`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`input_devices/buffering/android/use_input_buffering<class_ProjectSettings_property_input_devices/buffering/android/use_input_buffering>` | ``true`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`input_devices/compatibility/legacy_just_pressed_behavior<class_ProjectSettings_property_input_devices/compatibility/legacy_just_pressed_behavior>` | ``false`` |
+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`input_devices/pen_tablet/driver<class_ProjectSettings_property_input_devices/pen_tablet/driver>` | |
Expand Down Expand Up @@ -6028,30 +6024,6 @@ Enabling this can greatly improve the responsiveness to input, specially in devi

----

.. _class_ProjectSettings_property_input_devices/buffering/android/use_accumulated_input:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **input_devices/buffering/android/use_accumulated_input** = ``true`` :ref:`🔗<class_ProjectSettings_property_input_devices/buffering/android/use_accumulated_input>`

If ``true``, multiple input events will be accumulated into a single input event when possible.

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

----

.. _class_ProjectSettings_property_input_devices/buffering/android/use_input_buffering:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **input_devices/buffering/android/use_input_buffering** = ``true`` :ref:`🔗<class_ProjectSettings_property_input_devices/buffering/android/use_input_buffering>`

If ``true``, input events will be buffered prior to being dispatched.

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

----

.. _class_ProjectSettings_property_input_devices/compatibility/legacy_just_pressed_behavior:

.. rst-class:: classref-property
Expand Down
Loading