Skip to content

Commit b4518ad

Browse files
authored
Merge pull request #11244 from godotengine/classref/sync-825ef23
classref: Sync with current master branch (825ef23)
2 parents 6de6560 + 8db5f3e commit b4518ad

File tree

3 files changed

+11
-5
lines changed

3 files changed

+11
-5
lines changed

classes/class_classdb.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ A class information repository.
1919
Description
2020
-----------
2121

22-
Provides access to metadata stored for every available class.
22+
Provides access to metadata stored for every available engine class.
23+
24+
\ **Note:** Script-defined classes with ``class_name`` are not part of **ClassDB**, so they will not return reflection data such as a method or property list. However, :ref:`GDExtension<class_GDExtension>`-defined classes *are* part of **ClassDB**, so they will return reflection data.
2325

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

@@ -439,7 +441,9 @@ Sets ``property`` value of ``object`` to ``value``.
439441

440442
:ref:`PackedStringArray<class_PackedStringArray>` **get_class_list**\ (\ ) |const| :ref:`🔗<class_ClassDB_method_get_class_list>`
441443

442-
Returns the names of all the classes available.
444+
Returns the names of all engine classes available.
445+
446+
\ **Note:** Script-defined classes with ``class_name`` are not included in this list. Use :ref:`ProjectSettings.get_global_class_list()<class_ProjectSettings_method_get_global_class_list>` to get a list of script-defined classes instead.
443447

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

@@ -451,7 +455,7 @@ Returns the names of all the classes available.
451455

452456
:ref:`PackedStringArray<class_PackedStringArray>` **get_inheriters_from_class**\ (\ class\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_ClassDB_method_get_inheriters_from_class>`
453457

454-
Returns the names of all the classes that directly or indirectly inherit from ``class``.
458+
Returns the names of all engine classes that directly or indirectly inherit from ``class``.
455459

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

classes/class_projectsettings.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3004,7 +3004,7 @@ When set to ``warn`` or ``error``, produces a warning or an error respectively w
30043004

30053005
:ref:`int<class_int>` **debug/gdscript/warnings/inferred_declaration** = ``0`` :ref:`🔗<class_ProjectSettings_property_debug/gdscript/warnings/inferred_declaration>`
30063006

3007-
When set to ``warn`` or ``error``, produces a warning or an error respectively when a variable, constant, or parameter has an implicitly inferred static type.
3007+
When set to ``warn`` or ``error``, produces a warning or an error respectively when a variable, constant, or parameter has an implicitly inferred static type. In GDScript, type inference is performed by declaring a variable with ``:=`` instead of ``=`` and leaving out the type specifier. For example, ``var x := 1`` will *infer* the :ref:`int<class_int>` type, while ``var x: int = 1`` explicitly declares the variable as :ref:`int<class_int>`.
30083008

30093009
\ **Note:** This warning is recommended *in addition* to :ref:`debug/gdscript/warnings/untyped_declaration<class_ProjectSettings_property_debug/gdscript/warnings/untyped_declaration>` if you want to always specify the type explicitly. Having ``INFERRED_DECLARATION`` warning level higher than ``UNTYPED_DECLARATION`` warning level makes little sense and is not recommended.
30103010

@@ -13515,7 +13515,7 @@ The ratio of :ref:`WorkerThreadPool<class_WorkerThreadPool>`'s threads that will
1351513515

1351613516
:ref:`int<class_int>` **threading/worker_pool/max_threads** = ``-1`` :ref:`🔗<class_ProjectSettings_property_threading/worker_pool/max_threads>`
1351713517

13518-
Maximum number of threads to be used by :ref:`WorkerThreadPool<class_WorkerThreadPool>`. Value of ``0`` or less means ``1`` on Web, or a number of *logical* CPU cores available on other platforms (see :ref:`OS.get_processor_count()<class_OS_method_get_processor_count>`).
13518+
Maximum number of threads to be used by :ref:`WorkerThreadPool<class_WorkerThreadPool>`. Value of ``-1`` means ``1`` on Web, or a number of *logical* CPU cores available on other platforms (see :ref:`OS.get_processor_count()<class_OS_method_get_processor_count>`).
1351913519

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

classes/class_sprite2d.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,8 @@ The texture's drawing offset.
250250

251251
If ``true``, texture is cut from a larger atlas texture. See :ref:`region_rect<class_Sprite2D_property_region_rect>`.
252252

253+
\ **Note:** When using a custom :ref:`Shader<class_Shader>` on a **Sprite2D**, the ``UV`` shader built-in will refer to the entire texture space. Use the ``REGION_RECT`` built-in to get the currently visible region defined in :ref:`region_rect<class_Sprite2D_property_region_rect>` instead. See :doc:`CanvasItem shaders <../tutorials/shaders/shader_reference/canvas_item_shader>` for details.
254+
253255
.. rst-class:: classref-item-separator
254256

255257
----

0 commit comments

Comments
 (0)