godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (7d9923b2e)

Browse Source
This commit is contained in:
Rémi Verschelde
2022-11-17 21:03:53 +01:00
parent c2d9bd8436
commit 34089af20f
256 changed files with 8630 additions and 715 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
classes/class_@globalscope.rst
View File

@@ -2181,10 +2181,6 @@ Since :ref:`OK<class_@GlobalScope_constant_OK>` has value 0, and all other error
.. _class_@GlobalScope_constant_PROPERTY_HINT_COLOR_NO_ALPHA:
.. _class_@GlobalScope_constant_PROPERTY_HINT_IMAGE_COMPRESS_LOSSY:
.. _class_@GlobalScope_constant_PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS:
.. _class_@GlobalScope_constant_PROPERTY_HINT_OBJECT_ID:
.. _class_@GlobalScope_constant_PROPERTY_HINT_TYPE_STRING:
@@ -2287,15 +2283,9 @@ Unlike :ref:`PROPERTY_HINT_ENUM<class_@GlobalScope_constant_PROPERTY_HINT_ENUM>`
- **PROPERTY_HINT_COLOR_NO_ALPHA** = **21** --- Hints that a :ref:`Color<class_Color>` property should be edited without affecting its transparency (:ref:`Color.a<class_Color_property_a>` is not editable).
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **22** --- Hints that an image is compressed using lossy compression. The editor does not internally use this property hint.
- **PROPERTY_HINT_OBJECT_ID** = **22**
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **23** --- Hints that an image is compressed using lossless compression. The editor does not internally use this property hint.
- **PROPERTY_HINT_OBJECT_ID** = **24**
- **PROPERTY_HINT_TYPE_STRING** = **25** --- Hints that a property represents a particular type. If a property is :ref:`TYPE_STRING<class_@GlobalScope_constant_TYPE_STRING>`, allows to set a type from the create dialog. If you need to create an :ref:`Array<class_Array>` to contain elements of a specific type, the ``hint_string`` must encode nested types using ``":"`` and ``"/"`` for specifying :ref:`Resource<class_Resource>` types.
\ **Example:**\
- **PROPERTY_HINT_TYPE_STRING** = **23** --- Hint that a property represents a particular type. If a property is :ref:`TYPE_STRING<class_@GlobalScope_constant_TYPE_STRING>`, allows to set a type from the create dialog. If you need to create an :ref:`Array<class_Array>` to contain elements of a specific type, the ``hint_string`` must encode nested types using ``":"`` and ``"/"`` for specifying :ref:`Resource<class_Resource>` types. For instance:
::
@@ -2306,51 +2296,49 @@ Unlike :ref:`PROPERTY_HINT_ENUM<class_@GlobalScope_constant_PROPERTY_HINT_ENUM>`
\ **Note:** The final colon is required for properly detecting built-in types.
- **PROPERTY_HINT_NODE_PATH_TO_EDITED_NODE** = **26**
- **PROPERTY_HINT_NODE_PATH_TO_EDITED_NODE** = **24**
- **PROPERTY_HINT_METHOD_OF_VARIANT_TYPE** = **27**
- **PROPERTY_HINT_METHOD_OF_VARIANT_TYPE** = **25**
- **PROPERTY_HINT_METHOD_OF_BASE_TYPE** = **28**
- **PROPERTY_HINT_METHOD_OF_BASE_TYPE** = **26**
- **PROPERTY_HINT_METHOD_OF_INSTANCE** = **29**
- **PROPERTY_HINT_METHOD_OF_INSTANCE** = **27**
- **PROPERTY_HINT_METHOD_OF_SCRIPT** = **30**
- **PROPERTY_HINT_METHOD_OF_SCRIPT** = **28**
- **PROPERTY_HINT_PROPERTY_OF_VARIANT_TYPE** = **31**
- **PROPERTY_HINT_PROPERTY_OF_VARIANT_TYPE** = **29**
- **PROPERTY_HINT_PROPERTY_OF_BASE_TYPE** = **32**
- **PROPERTY_HINT_PROPERTY_OF_BASE_TYPE** = **30**
- **PROPERTY_HINT_PROPERTY_OF_INSTANCE** = **33**
- **PROPERTY_HINT_PROPERTY_OF_INSTANCE** = **31**
- **PROPERTY_HINT_PROPERTY_OF_SCRIPT** = **34**
- **PROPERTY_HINT_PROPERTY_OF_SCRIPT** = **32**
- **PROPERTY_HINT_OBJECT_TOO_BIG** = **35** --- Hints that a property's size (in bytes) is too big to be displayed, when debugging a running project. The debugger uses this hint internally.
- **PROPERTY_HINT_OBJECT_TOO_BIG** = **33**
- **PROPERTY_HINT_NODE_PATH_VALID_TYPES** = **36**
- **PROPERTY_HINT_NODE_PATH_VALID_TYPES** = **34**
- **PROPERTY_HINT_SAVE_FILE** = **37**
- **PROPERTY_HINT_SAVE_FILE** = **35**
- **PROPERTY_HINT_GLOBAL_SAVE_FILE** = **38**
- **PROPERTY_HINT_GLOBAL_SAVE_FILE** = **36**
- **PROPERTY_HINT_INT_IS_OBJECTID** = **39**
- **PROPERTY_HINT_INT_IS_OBJECTID** = **37**
- **PROPERTY_HINT_INT_IS_POINTER** = **40**
- **PROPERTY_HINT_INT_IS_POINTER** = **38**
- **PROPERTY_HINT_ARRAY_TYPE** = **41**
- **PROPERTY_HINT_ARRAY_TYPE** = **39**
- **PROPERTY_HINT_LOCALE_ID** = **42** --- Hints that a :ref:`String<class_String>` property is a locale code. Editing it will show a locale dialog for picking language and country.
- **PROPERTY_HINT_LOCALE_ID** = **40** --- Hints that a string property is a locale code. Editing it will show a locale dialog for picking language and country.
- **PROPERTY_HINT_LOCALIZABLE_STRING** = **43** --- Hints that a :ref:`Dictionary<class_Dictionary>` property is string translation map. Dictionary keys are locale codes and, values are translated strings.
- **PROPERTY_HINT_LOCALIZABLE_STRING** = **41** --- Hints that a dictionary property is string translation map. Dictionary keys are locale codes and, values are translated strings.
- **PROPERTY_HINT_NODE_TYPE** = **44**
- **PROPERTY_HINT_NODE_TYPE** = **42**
- **PROPERTY_HINT_HIDE_QUATERNION_EDIT** = **45** --- Hints that a :ref:`Quaternion<class_Quaternion>` property should disable the temporary euler editor.
- **PROPERTY_HINT_HIDE_QUATERNION_EDIT** = **43** --- Hints that a quaternion property should disable the temporary euler editor.
- **PROPERTY_HINT_PASSWORD** = **46** --- Hints that a :ref:`String<class_String>` property is a password. Every character of the string is displayed as the secret character (typically ``*``).
- **PROPERTY_HINT_PASSWORD** = **44** --- Hints that a string property is a password, and every character is replaced with the secret character.
An optional placeholder text can be shown on its input field, similarly to :ref:`PROPERTY_HINT_PLACEHOLDER_TEXT<class_@GlobalScope_constant_PROPERTY_HINT_PLACEHOLDER_TEXT>`.
- **PROPERTY_HINT_MAX** = **47** --- Represents the size of the :ref:`PropertyHint<enum_@GlobalScope_PropertyHint>` enum.
- **PROPERTY_HINT_MAX** = **45**
----

24
classes/class_animatedtexture.rst
View File

@@ -28,17 +28,19 @@ The playback of the animation is controlled by the :ref:`speed_scale<class_Anima
Properties
----------
+---------------------------+--------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`current_frame<class_AnimatedTexture_property_current_frame>` | |
+---------------------------+--------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`frames<class_AnimatedTexture_property_frames>` | ``1`` |
+---------------------------+--------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`one_shot<class_AnimatedTexture_property_one_shot>` | ``false`` |
+---------------------------+--------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`pause<class_AnimatedTexture_property_pause>` | ``false`` |
+---------------------------+--------------------------------------------------------------------+-----------+
| :ref:`float<class_float>` | :ref:`speed_scale<class_AnimatedTexture_property_speed_scale>` | ``1.0`` |
+---------------------------+--------------------------------------------------------------------+-----------+
+---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`current_frame<class_AnimatedTexture_property_current_frame>` | |
+---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`frames<class_AnimatedTexture_property_frames>` | ``1`` |
+---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`one_shot<class_AnimatedTexture_property_one_shot>` | ``false`` |
+---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`pause<class_AnimatedTexture_property_pause>` | ``false`` |
+---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | resource_local_to_scene | ``false`` (overrides :ref:`Resource<class_Resource_property_resource_local_to_scene>`) |
+---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`speed_scale<class_AnimatedTexture_property_speed_scale>` | ``1.0`` |
+---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+
Methods
-------

4
classes/class_animationlibrary.rst
View File

@@ -84,6 +84,10 @@ Property Descriptions
| *Default* | ``{}`` |
+-----------+--------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Method Descriptions
-------------------

12
classes/class_animationnodeoneshot.rst
View File

@@ -121,6 +121,10 @@ If :ref:`autorestart<class_AnimationNodeOneShot_property_autorestart>` is ``true
| *Getter* | get_fadein_time() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AnimationNodeOneShot_property_fadeout_time:
@@ -135,6 +139,10 @@ If :ref:`autorestart<class_AnimationNodeOneShot_property_autorestart>` is ``true
| *Getter* | get_fadeout_time() |
+-----------+-------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AnimationNodeOneShot_property_mix_mode:
@@ -149,6 +157,10 @@ If :ref:`autorestart<class_AnimationNodeOneShot_property_autorestart>` is ``true
| *Getter* | get_mix_mode() |
+-----------+---------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

4
classes/class_animationnodestatemachine.rst
View File

@@ -219,6 +219,10 @@ Renames the given node.
- void **replace_node** **(** :ref:`StringName<class_StringName>` name, :ref:`AnimationNode<class_AnimationNode>` node **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AnimationNodeStateMachine_method_set_graph_offset:

4
classes/class_animationnodestatemachineplayback.rst
View File

@@ -76,6 +76,10 @@ Method Descriptions
- :ref:`float<class_float>` **get_current_length** **(** **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AnimationNodeStateMachinePlayback_method_get_current_node:

2
classes/class_animationnodestatemachinetransition.rst
View File

@@ -12,7 +12,9 @@ AnimationNodeStateMachineTransition
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Tutorials
---------

2
classes/class_animationnodesync.rst
View File

@@ -14,7 +14,9 @@ AnimationNodeSync
**Inherited By:** :ref:`AnimationNodeAdd2<class_AnimationNodeAdd2>`, :ref:`AnimationNodeAdd3<class_AnimationNodeAdd3>`, :ref:`AnimationNodeBlend2<class_AnimationNodeBlend2>`, :ref:`AnimationNodeBlend3<class_AnimationNodeBlend3>`, :ref:`AnimationNodeOneShot<class_AnimationNodeOneShot>`, :ref:`AnimationNodeTransition<class_AnimationNodeTransition>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------

20
classes/class_animationnodetransition.rst
View File

@@ -99,6 +99,10 @@ If ``true``, the destination animation is played back from the beginning when sw
| *Getter* | get_xfade_curve() |
+----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AnimationNodeTransition_property_xfade_time:
@@ -122,24 +126,40 @@ Method Descriptions
- :ref:`String<class_String>` **get_input_caption** **(** :ref:`int<class_int>` input **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AnimationNodeTransition_method_is_input_set_as_auto_advance:
- :ref:`bool<class_bool>` **is_input_set_as_auto_advance** **(** :ref:`int<class_int>` input **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AnimationNodeTransition_method_set_input_as_auto_advance:
- void **set_input_as_auto_advance** **(** :ref:`int<class_int>` input, :ref:`bool<class_bool>` enable **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AnimationNodeTransition_method_set_input_caption:
- void **set_input_caption** **(** :ref:`int<class_int>` input, :ref:`String<class_String>` caption **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

2
classes/class_animationrootnode.rst
View File

@@ -14,7 +14,9 @@ AnimationRootNode
**Inherited By:** :ref:`AnimationNodeAnimation<class_AnimationNodeAnimation>`, :ref:`AnimationNodeBlendSpace1D<class_AnimationNodeBlendSpace1D>`, :ref:`AnimationNodeBlendSpace2D<class_AnimationNodeBlendSpace2D>`, :ref:`AnimationNodeBlendTree<class_AnimationNodeBlendTree>`, :ref:`AnimationNodeStateMachine<class_AnimationNodeStateMachine>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`

2
classes/class_animationtrackeditplugin.rst
View File

@@ -12,7 +12,9 @@ AnimationTrackEditPlugin
**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`

4
classes/class_animationtree.rst
View File

@@ -204,6 +204,10 @@ Retrieve the motion of the :ref:`root_motion_track<class_AnimationTree_property_
- void **rename_parameter** **(** :ref:`String<class_String>` old_name, :ref:`String<class_String>` new_name **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

28
classes/class_arraymesh.rst
View File

@@ -44,10 +44,12 @@ The most basic example is the creation of a single triangle:
.. code-tab:: csharp
var vertices = new Godot.Collections.Array<Vector3>();
vertices.Add(new Vector3(0, 1, 0));
vertices.Add(new Vector3(1, 0, 0));
vertices.Add(new Vector3(0, 0, 1));
var vertices = new Vector3[]
{
new Vector3(0, 1, 0),
new Vector3(1, 0, 0),
new Vector3(0, 0, 1),
};
// Initialize the ArrayMesh.
var arrMesh = new ArrayMesh();
@@ -57,7 +59,7 @@ The most basic example is the creation of a single triangle:
// Create the Mesh.
arrMesh.AddSurfaceFromArrays(Mesh.PrimitiveType.Triangles, arrays);
var m = new MeshInstance();
var m = new MeshInstance3D();
m.Mesh = arrMesh;
@@ -172,6 +174,10 @@ Overrides the :ref:`AABB<class_AABB>` with one defined by user for use with frus
| *Getter* | get_shadow_mesh() |
+----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Method Descriptions
-------------------
@@ -311,18 +317,30 @@ Sets a name for a given surface.
- void **surface_update_attribute_region** **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_ArrayMesh_method_surface_update_skin_region:
- void **surface_update_skin_region** **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_ArrayMesh_method_surface_update_vertex_region:
- void **surface_update_vertex_region** **(** :ref:`int<class_int>` surf_idx, :ref:`int<class_int>` offset, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

12
classes/class_arrayoccluder3d.rst
View File

@@ -52,6 +52,10 @@ Property Descriptions
| *Getter* | get_indices() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_ArrayOccluder3D_property_vertices:
@@ -66,6 +70,10 @@ Property Descriptions
| *Getter* | get_vertices() |
+-----------+--------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Method Descriptions
-------------------
@@ -73,6 +81,10 @@ Method Descriptions
- void **set_arrays** **(** :ref:`PackedVector3Array<class_PackedVector3Array>` vertices, :ref:`PackedInt32Array<class_PackedInt32Array>` indices **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

20
classes/class_atlastexture.rst
View File

@@ -26,15 +26,17 @@ Multiple ``AtlasTexture`` resources can be cropped from the same :ref:`atlas<cla
Properties
----------
+-----------------------------------+-------------------------------------------------------------+-----------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`atlas<class_AtlasTexture_property_atlas>` | |
+-----------------------------------+-------------------------------------------------------------+-----------------------+
| :ref:`bool<class_bool>` | :ref:`filter_clip<class_AtlasTexture_property_filter_clip>` | ``false`` |
+-----------------------------------+-------------------------------------------------------------+-----------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`margin<class_AtlasTexture_property_margin>` | ``Rect2(0, 0, 0, 0)`` |
+-----------------------------------+-------------------------------------------------------------+-----------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`region<class_AtlasTexture_property_region>` | ``Rect2(0, 0, 0, 0)`` |
+-----------------------------------+-------------------------------------------------------------+-----------------------+
+-----------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`atlas<class_AtlasTexture_property_atlas>` | |
+-----------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`filter_clip<class_AtlasTexture_property_filter_clip>` | ``false`` |
+-----------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`margin<class_AtlasTexture_property_margin>` | ``Rect2(0, 0, 0, 0)`` |
+-----------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Rect2<class_Rect2>` | :ref:`region<class_AtlasTexture_property_region>` | ``Rect2(0, 0, 0, 0)`` |
+-----------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | resource_local_to_scene | ``false`` (overrides :ref:`Resource<class_Resource_property_resource_local_to_scene>`) |
+-----------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+
Property Descriptions
---------------------

4
classes/class_audioeffect.rst
View File

@@ -40,6 +40,10 @@ Method Descriptions
- :ref:`AudioEffectInstance<class_AudioEffectInstance>` **_instantiate** **(** **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

48
classes/class_audioeffectchorus.rst
View File

@@ -528,72 +528,120 @@ Method Descriptions
- :ref:`float<class_float>` **get_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioEffectChorus_method_get_voice_delay_ms:
- :ref:`float<class_float>` **get_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioEffectChorus_method_get_voice_depth_ms:
- :ref:`float<class_float>` **get_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioEffectChorus_method_get_voice_level_db:
- :ref:`float<class_float>` **get_voice_level_db** **(** :ref:`int<class_int>` voice_idx **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioEffectChorus_method_get_voice_pan:
- :ref:`float<class_float>` **get_voice_pan** **(** :ref:`int<class_int>` voice_idx **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioEffectChorus_method_get_voice_rate_hz:
- :ref:`float<class_float>` **get_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioEffectChorus_method_set_voice_cutoff_hz:
- void **set_voice_cutoff_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` cutoff_hz **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioEffectChorus_method_set_voice_delay_ms:
- void **set_voice_delay_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` delay_ms **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioEffectChorus_method_set_voice_depth_ms:
- void **set_voice_depth_ms** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` depth_ms **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioEffectChorus_method_set_voice_level_db:
- void **set_voice_level_db** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` level_db **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioEffectChorus_method_set_voice_pan:
- void **set_voice_pan** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` pan **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioEffectChorus_method_set_voice_rate_hz:
- void **set_voice_rate_hz** **(** :ref:`int<class_int>` voice_idx, :ref:`float<class_float>` rate_hz **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

4
classes/class_audioeffectfilter.rst
View File

@@ -93,6 +93,10 @@ Threshold frequency for the filter, in Hz.
| *Getter* | get_db() |
+-----------+---------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioEffectFilter_property_gain:

10
classes/class_audioeffectinstance.rst
View File

@@ -14,7 +14,9 @@ AudioEffectInstance
**Inherited By:** :ref:`AudioEffectSpectrumAnalyzerInstance<class_AudioEffectSpectrumAnalyzerInstance>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Methods
-------
@@ -32,12 +34,20 @@ Method Descriptions
- void **_process** **(** const void* src_buffer, AudioFrame* dst_buffer, :ref:`int<class_int>` frame_count **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioEffectInstance_method__process_silence:
- :ref:`bool<class_bool>` **_process_silence** **(** **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

4
classes/class_audioeffectlimiter.rst
View File

@@ -86,6 +86,10 @@ Applies a gain to the limited waves, in decibels. Value can range from 0 to 6.
| *Getter* | get_soft_clip_ratio() |
+-----------+----------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioEffectLimiter_property_threshold_db:

4
classes/class_audioeffectspectrumanalyzer.rst
View File

@@ -117,6 +117,10 @@ The size of the `Fast Fourier transform <https://en.wikipedia.org/wiki/Fast_Four
| *Getter* | get_tap_back_pos() |
+-----------+-------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

6
classes/class_audioeffectspectrumanalyzerinstance.rst
View File

@@ -12,7 +12,9 @@ AudioEffectSpectrumAnalyzerInstance
**Inherits:** :ref:`AudioEffectInstance<class_AudioEffectInstance>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Methods
-------
@@ -43,6 +45,10 @@ Method Descriptions
- :ref:`Vector2<class_Vector2>` **get_magnitude_for_frequency_range** **(** :ref:`float<class_float>` from_hz, :ref:`float<class_float>` to_hz, :ref:`MagnitudeMode<enum_AudioEffectSpectrumAnalyzerInstance_MagnitudeMode>` mode=1 **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

8
classes/class_audioeffectstereoenhance.rst
View File

@@ -66,6 +66,10 @@ Values greater than 1.0 increase intensity of any panning on audio passing throu
| *Getter* | get_surround() |
+-----------+---------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioEffectStereoEnhance_property_time_pullout_ms:
@@ -80,6 +84,10 @@ Values greater than 1.0 increase intensity of any panning on audio passing throu
| *Getter* | get_time_pullout() |
+-----------+-------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

4
classes/class_audioserver.rst
View File

@@ -524,6 +524,10 @@ Sets the volume of the bus at index ``bus_idx`` to ``volume_db``.
- void **set_enable_tagging_used_audio_streams** **(** :ref:`bool<class_bool>` enable **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioServer_method_swap_bus_effects:

24
classes/class_audiostream.rst
View File

@@ -62,36 +62,60 @@ Method Descriptions
- :ref:`int<class_int>` **_get_beat_count** **(** **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStream_method__get_bpm:
- :ref:`float<class_float>` **_get_bpm** **(** **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStream_method__get_length:
- :ref:`float<class_float>` **_get_length** **(** **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStream_method__get_stream_name:
- :ref:`String<class_String>` **_get_stream_name** **(** **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStream_method__instantiate_playback:
- :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` **_instantiate_playback** **(** **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStream_method__is_monophonic:
- :ref:`bool<class_bool>` **_is_monophonic** **(** **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStream_method_get_length:

4
classes/class_audiostreamgeneratorplayback.rst
View File

@@ -74,6 +74,10 @@ Returns the number of frames that can be pushed to the audio sample data buffer
- :ref:`int<class_int>` **get_skips** **(** **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamGeneratorPlayback_method_push_buffer:

12
classes/class_audiostreammp3.rst
View File

@@ -51,6 +51,10 @@ Property Descriptions
| *Getter* | get_bar_beats() |
+-----------+----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamMP3_property_beat_count:
@@ -65,6 +69,10 @@ Property Descriptions
| *Getter* | get_beat_count() |
+-----------+-----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamMP3_property_bpm:
@@ -79,6 +87,10 @@ Property Descriptions
| *Getter* | get_bpm() |
+-----------+----------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamMP3_property_data:

14
classes/class_audiostreamoggvorbis.rst
View File

@@ -12,7 +12,9 @@ AudioStreamOggVorbis
**Inherits:** :ref:`AudioStream<class_AudioStream>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
@@ -46,6 +48,10 @@ Property Descriptions
| *Getter* | get_bar_beats() |
+-----------+----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamOggVorbis_property_beat_count:
@@ -60,6 +66,10 @@ Property Descriptions
| *Getter* | get_beat_count() |
+-----------+-----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamOggVorbis_property_bpm:
@@ -74,6 +84,10 @@ Property Descriptions
| *Getter* | get_bpm() |
+-----------+----------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamOggVorbis_property_loop:

32
classes/class_audiostreamplayback.rst
View File

@@ -54,48 +54,80 @@ Method Descriptions
- :ref:`int<class_int>` **_get_loop_count** **(** **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamPlayback_method__get_playback_position:
- :ref:`float<class_float>` **_get_playback_position** **(** **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamPlayback_method__is_playing:
- :ref:`bool<class_bool>` **_is_playing** **(** **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamPlayback_method__mix:
- :ref:`int<class_int>` **_mix** **(** AudioFrame* buffer, :ref:`float<class_float>` rate_scale, :ref:`int<class_int>` frames **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamPlayback_method__seek:
- void **_seek** **(** :ref:`float<class_float>` position **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamPlayback_method__start:
- void **_start** **(** :ref:`float<class_float>` from_pos **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamPlayback_method__stop:
- void **_stop** **(** **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamPlayback_method__tag_used_streams:
- void **_tag_used_streams** **(** **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

2
classes/class_audiostreamplaybackoggvorbis.rst
View File

@@ -12,7 +12,9 @@ AudioStreamPlaybackOggVorbis
**Inherits:** :ref:`AudioStreamPlaybackResampled<class_AudioStreamPlaybackResampled>` **<** :ref:`AudioStreamPlayback<class_AudioStreamPlayback>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`

14
classes/class_audiostreamplaybackresampled.rst
View File

@@ -14,7 +14,9 @@ AudioStreamPlaybackResampled
**Inherited By:** :ref:`AudioStreamGeneratorPlayback<class_AudioStreamGeneratorPlayback>`, :ref:`AudioStreamPlaybackOggVorbis<class_AudioStreamPlaybackOggVorbis>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Methods
-------
@@ -34,18 +36,30 @@ Method Descriptions
- :ref:`float<class_float>` **_get_stream_sampling_rate** **(** **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamPlaybackResampled_method__mix_resampled:
- :ref:`int<class_int>` **_mix_resampled** **(** AudioFrame* dst_buffer, :ref:`int<class_int>` frame_count **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_AudioStreamPlaybackResampled_method_begin_resample:
- void **begin_resample** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

14
classes/class_basematerial3d.rst
View File

@@ -433,11 +433,11 @@ enum **Transparency**:
- **TRANSPARENCY_ALPHA** = **1** --- The material will use the texture's alpha values for transparency.
- **TRANSPARENCY_ALPHA_SCISSOR** = **2** --- The material will cut off all values below a threshold, the rest will remain opaque.
- **TRANSPARENCY_ALPHA_SCISSOR** = **2** --- The material will cut off all values below a threshold, the rest will remain opaque. The opaque portions will be rendering in the depth prepass.
- **TRANSPARENCY_ALPHA_HASH** = **3** --- The material will cut off all values below a spatially-deterministic threshold, the rest will remain opaque.
- **TRANSPARENCY_ALPHA_DEPTH_PRE_PASS** = **4** --- The material will use the texture's alpha value for transparency, but will still be rendered in the pre-pass.
- **TRANSPARENCY_ALPHA_DEPTH_PRE_PASS** = **4** --- The material will use the texture's alpha value for transparency, but will still be rendered in the depth prepass.
- **TRANSPARENCY_MAX** = **5** --- Represents the size of the :ref:`Transparency<enum_BaseMaterial3D_Transparency>` enum.
@@ -573,11 +573,13 @@ enum **AlphaAntiAliasing**:
enum **DepthDrawMode**:
- **DEPTH_DRAW_OPAQUE_ONLY** = **0** --- Default depth draw mode. Depth is drawn only for opaque objects.
- **DEPTH_DRAW_OPAQUE_ONLY** = **0** --- Default depth draw mode. Depth is drawn only for opaque objects during the opaque prepass (if any) and during the opaque pass.
- **DEPTH_DRAW_ALWAYS** = **1** --- Depth draw is calculated for both opaque and transparent objects.
- **DEPTH_DRAW_ALWAYS** = **1** --- Objects will write to depth during the opaque and the transparent passes. Transparent objects that are close to the camera may obscure other transparent objects behind them.
- **DEPTH_DRAW_DISABLED** = **2** --- No depth draw.
\ **Note:** This does not influence whether transparent objects are included in the depth prepass or not. For that, see :ref:`Transparency<enum_BaseMaterial3D_Transparency>`.
- **DEPTH_DRAW_DISABLED** = **2** --- Objects will not write their depth to the depth buffer, even during the depth prepass (if enabled).
----
@@ -647,7 +649,7 @@ enum **CullMode**:
enum **Flags**:
- **FLAG_DISABLE_DEPTH_TEST** = **0** --- Disables the depth test, so this object is drawn on top of all others. However, objects drawn after it in the draw order may cover it.
- **FLAG_DISABLE_DEPTH_TEST** = **0** --- Disables the depth test, so this object is drawn on top of all others drawn before it. This puts the object in the transparent draw pass where it is sorted based on distance to camera. Objects drawn after it in the draw order may cover it. This also disables writing to depth.
- **FLAG_ALBEDO_FROM_VERTEX_COLOR** = **1** --- Set ``ALBEDO`` to the per-vertex color specified in the mesh.

16
classes/class_cameratexture.rst
View File

@@ -24,13 +24,15 @@ This texture gives access to the camera texture provided by a :ref:`CameraFeed<c
Properties
----------
+-----------------------------------------------+------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`camera_feed_id<class_CameraTexture_property_camera_feed_id>` | ``0`` |
+-----------------------------------------------+------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`camera_is_active<class_CameraTexture_property_camera_is_active>` | ``false`` |
+-----------------------------------------------+------------------------------------------------------------------------+-----------+
| :ref:`FeedImage<enum_CameraServer_FeedImage>` | :ref:`which_feed<class_CameraTexture_property_which_feed>` | ``0`` |
+-----------------------------------------------+------------------------------------------------------------------------+-----------+
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`camera_feed_id<class_CameraTexture_property_camera_feed_id>` | ``0`` |
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`camera_is_active<class_CameraTexture_property_camera_is_active>` | ``false`` |
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | resource_local_to_scene | ``false`` (overrides :ref:`Resource<class_Resource_property_resource_local_to_scene>`) |
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`FeedImage<enum_CameraServer_FeedImage>` | :ref:`which_feed<class_CameraTexture_property_which_feed>` | ``0`` |
+-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
Property Descriptions
---------------------

14
classes/class_canvasgroup.rst
View File

@@ -12,7 +12,9 @@ CanvasGroup
**Inherits:** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
@@ -40,6 +42,10 @@ Property Descriptions
| *Getter* | get_clear_margin() |
+-----------+-------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_CanvasGroup_property_fit_margin:
@@ -54,6 +60,10 @@ Property Descriptions
| *Getter* | get_fit_margin() |
+-----------+-----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_CanvasGroup_property_use_mipmaps:
@@ -68,6 +78,10 @@ Property Descriptions
| *Getter* | is_using_mipmaps() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

32
classes/class_canvastexture.rst
View File

@@ -24,21 +24,23 @@ Description
Properties
----------
+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`diffuse_texture<class_CanvasTexture_property_diffuse_texture>` | |
+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`normal_texture<class_CanvasTexture_property_normal_texture>` | |
+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`Color<class_Color>` | :ref:`specular_color<class_CanvasTexture_property_specular_color>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`float<class_float>` | :ref:`specular_shininess<class_CanvasTexture_property_specular_shininess>` | ``1.0`` |
+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`specular_texture<class_CanvasTexture_property_specular_texture>` | |
+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` | :ref:`texture_filter<class_CanvasTexture_property_texture_filter>` | ``0`` |
+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
| :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` | :ref:`texture_repeat<class_CanvasTexture_property_texture_repeat>` | ``0`` |
+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`diffuse_texture<class_CanvasTexture_property_diffuse_texture>` | |
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`normal_texture<class_CanvasTexture_property_normal_texture>` | |
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | resource_local_to_scene | ``false`` (overrides :ref:`Resource<class_Resource_property_resource_local_to_scene>`) |
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`specular_color<class_CanvasTexture_property_specular_color>` | ``Color(1, 1, 1, 1)`` |
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`specular_shininess<class_CanvasTexture_property_specular_shininess>` | ``1.0`` |
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`specular_texture<class_CanvasTexture_property_specular_texture>` | |
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` | :ref:`texture_filter<class_CanvasTexture_property_texture_filter>` | ``0`` |
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` | :ref:`texture_repeat<class_CanvasTexture_property_texture_repeat>` | ``0`` |
+-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+
Property Descriptions
---------------------

2
classes/class_characterbody2d.rst
View File

@@ -28,7 +28,7 @@ Tutorials
- :doc:`Kinematic character (2D) <../tutorials/physics/kinematic_character_2d>`
- :doc:`Using KinematicBody2D <../tutorials/physics/using_kinematic_body_2d>`
- :doc:`Using CharacterBody2D <../tutorials/physics/using_character_body_2d>`
- `2D Kinematic Character Demo <https://godotengine.org/asset-library/asset/113>`__

19
classes/class_compressedcubemap.rst
View File

@@ -12,7 +12,26 @@ CompressedCubemap
**Inherits:** :ref:`CompressedTextureLayered<class_CompressedTextureLayered>` **<** :ref:`TextureLayered<class_TextureLayered>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
6-sided texture typically used in 3D rendering, optionally compressed.
Description
-----------
A cubemap that is loaded from a ``.ccube`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. ``CompressedCubemap`` can use one of 4 compresson methods:
- Uncompressed (uncompressed on the GPU)
- Lossless (WebP or PNG, uncompressed on the GPU)
- Lossy (WebP, uncompressed on the GPU)
- VRAM Compressed (compressed on the GPU)
Only **VRAM Compressed** actually reduces the memory usage on the GPU. The **Lossless** and **Lossy** compression methods will reduce the required storage on disk, but they will not reduce memory usage on the GPU as the texture is sent to the GPU uncompressed.
Using **VRAM Compressed** also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless or lossy compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D.
See :ref:`Cubemap<class_Cubemap>` for a general description of cubemaps.
.. |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.)`

19
classes/class_compressedcubemaparray.rst
View File

@@ -12,7 +12,26 @@ CompressedCubemapArray
**Inherits:** :ref:`CompressedTextureLayered<class_CompressedTextureLayered>` **<** :ref:`TextureLayered<class_TextureLayered>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Array of 6-sided textures typically used in 3D rendering, optionally compressed.
Description
-----------
A cubemap array that is loaded from a ``.ccubearray`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. ``CompressedCubemapArray`` can use one of 4 compresson methods:
- Uncompressed (uncompressed on the GPU)
- Lossless (WebP or PNG, uncompressed on the GPU)
- Lossy (WebP, uncompressed on the GPU)
- VRAM Compressed (compressed on the GPU)
Only **VRAM Compressed** actually reduces the memory usage on the GPU. The **Lossless** and **Lossy** compression methods will reduce the required storage on disk, but they will not reduce memory usage on the GPU as the texture is sent to the GPU uncompressed.
Using **VRAM Compressed** also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless or lossy compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D.
See :ref:`CubemapArray<class_CubemapArray>` for a general description of cubemap arrays.
.. |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.)`

28
classes/class_compressedtexture2d.rst
View File

@@ -12,19 +12,33 @@ CompressedTexture2D
**Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
A ``.ctex`` texture.
Texture with 2 dimensions, optionally compressed.
Description
-----------
A texture that is loaded from a ``.ctex`` file.
A texture that is loaded from a ``.ctex`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. ``CompressedTexture2D`` can use one of 4 compression methods (including a lack of any compression):
- Uncompressed (uncompressed on the GPU)
- Lossless (WebP or PNG, uncompressed on the GPU)
- Lossy (WebP, uncompressed on the GPU)
- VRAM Compressed (compressed on the GPU)
Only **VRAM Compressed** actually reduces the memory usage on the GPU. The **Lossless** and **Lossy** compression methods will reduce the required storage on disk, but they will not reduce memory usage on the GPU as the texture is sent to the GPU uncompressed.
Using **VRAM Compressed** also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless or lossy compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D.
Properties
----------
+-----------------------------+----------------------------------------------------------------+--------+
| :ref:`String<class_String>` | :ref:`load_path<class_CompressedTexture2D_property_load_path>` | ``""`` |
+-----------------------------+----------------------------------------------------------------+--------+
+-----------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`load_path<class_CompressedTexture2D_property_load_path>` | ``""`` |
+-----------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | resource_local_to_scene | ``false`` (overrides :ref:`Resource<class_Resource_property_resource_local_to_scene>`) |
+-----------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+
Methods
-------
@@ -48,7 +62,7 @@ Property Descriptions
| *Getter* | get_load_path() |
+-----------+-----------------+
The CompressedTexture's file path to a ``.ctex`` file.
The ``CompressedTexture2D``'s file path to a ``.ctex`` file.
Method Descriptions
-------------------
@@ -57,7 +71,7 @@ Method Descriptions
- :ref:`Error<enum_@GlobalScope_Error>` **load** **(** :ref:`String<class_String>` path **)**
Loads the texture from the given path.
Loads the texture from the specified ``path``.
.. |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.)`

19
classes/class_compressedtexture2darray.rst
View File

@@ -12,7 +12,26 @@ CompressedTexture2DArray
**Inherits:** :ref:`CompressedTextureLayered<class_CompressedTextureLayered>` **<** :ref:`TextureLayered<class_TextureLayered>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Array of 2-dimensional textures, optionally compressed.
Description
-----------
A texture array that is loaded from a ``.ctexarray`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. ``CompressedTexture2DArray`` can use one of 4 compresson methods:
- Uncompressed (uncompressed on the GPU)
- Lossless (WebP or PNG, uncompressed on the GPU)
- Lossy (WebP, uncompressed on the GPU)
- VRAM Compressed (compressed on the GPU)
Only **VRAM Compressed** actually reduces the memory usage on the GPU. The **Lossless** and **Lossy** compression methods will reduce the required storage on disk, but they will not reduce memory usage on the GPU as the texture is sent to the GPU uncompressed.
Using **VRAM Compressed** also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless or lossy compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D.
See :ref:`Texture2DArray<class_Texture2DArray>` for a general description of texture arrays.
.. |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.)`

13
classes/class_compressedtexture3d.rst
View File

@@ -12,7 +12,16 @@ CompressedTexture3D
**Inherits:** :ref:`Texture3D<class_Texture3D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Texture with 3 dimensions, optionally compressed.
Description
-----------
``CompressedTexture3D`` is the VRAM-compressed counterpart of :ref:`ImageTexture3D<class_ImageTexture3D>`. The file extension for ``CompressedTexture3D`` files is ``.ctex3d``. This file format is internal to Godot; it is created by importing other image formats with the import system.
\ ``CompressedTexture3D`` uses VRAM compression, which allows to reduce memory usage on the GPU when rendering the texture. This also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D.
See :ref:`Texture3D<class_Texture3D>` for a general description of 3D textures.
Properties
----------
@@ -43,6 +52,8 @@ Property Descriptions
| *Getter* | get_load_path() |
+-----------+-----------------+
The ``CompressedTexture3D``'s file path to a ``.ctex3d`` file.
Method Descriptions
-------------------
@@ -50,6 +61,8 @@ Method Descriptions
- :ref:`Error<enum_@GlobalScope_Error>` **load** **(** :ref:`String<class_String>` path **)**
Loads the texture from the specified ``path``.
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

21
classes/class_compressedtexturelayered.rst
View File

@@ -14,7 +14,24 @@ CompressedTextureLayered
**Inherited By:** :ref:`CompressedCubemap<class_CompressedCubemap>`, :ref:`CompressedCubemapArray<class_CompressedCubemapArray>`, :ref:`CompressedTexture2DArray<class_CompressedTexture2DArray>`
Base class for texture arrays that can optionally be compressed.
Description
-----------
A texture array that is loaded from a ``.ctexarray`` file. This file format is internal to Godot; it is created by importing other image formats with the import system. :ref:`CompressedTexture2D<class_CompressedTexture2D>` can use one of 4 compresson methods:
- Uncompressed (uncompressed on the GPU)
- Lossless (WebP or PNG, uncompressed on the GPU)
- Lossy (WebP, uncompressed on the GPU)
- VRAM Compressed (compressed on the GPU)
Only **VRAM Compressed** actually reduces the memory usage on the GPU. The **Lossless** and **Lossy** compression methods will reduce the required storage on disk, but they will not reduce memory usage on the GPU as the texture is sent to the GPU uncompressed.
Using **VRAM Compressed** also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless or lossy compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D.
Properties
----------
@@ -45,6 +62,8 @@ Property Descriptions
| *Getter* | get_load_path() |
+-----------+-----------------+
The path the texture should be loaded from.
Method Descriptions
-------------------
@@ -52,6 +71,8 @@ Method Descriptions
- :ref:`Error<enum_@GlobalScope_Error>` **load** **(** :ref:`String<class_String>` path **)**
Loads the texture at ``path``.
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

8
classes/class_conetwistjoint3d.rst
View File

@@ -186,12 +186,20 @@ Method Descriptions
- :ref:`float<class_float>` **get_param** **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_ConeTwistJoint3D_method_set_param:
- void **set_param** **(** :ref:`Param<enum_ConeTwistJoint3D_Param>` param, :ref:`float<class_float>` value **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

24
classes/class_control.rst
View File

@@ -12,7 +12,7 @@ Control
**Inherits:** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`BaseButton<class_BaseButton>`, :ref:`ColorRect<class_ColorRect>`, :ref:`Container<class_Container>`, :ref:`EditorDebuggerPlugin<class_EditorDebuggerPlugin>`, :ref:`GraphEdit<class_GraphEdit>`, :ref:`ItemList<class_ItemList>`, :ref:`Label<class_Label>`, :ref:`LineEdit<class_LineEdit>`, :ref:`MenuBar<class_MenuBar>`, :ref:`NinePatchRect<class_NinePatchRect>`, :ref:`Panel<class_Panel>`, :ref:`Range<class_Range>`, :ref:`ReferenceRect<class_ReferenceRect>`, :ref:`RichTextLabel<class_RichTextLabel>`, :ref:`Separator<class_Separator>`, :ref:`TabBar<class_TabBar>`, :ref:`TextEdit<class_TextEdit>`, :ref:`TextureRect<class_TextureRect>`, :ref:`Tree<class_Tree>`, :ref:`VideoStreamPlayer<class_VideoStreamPlayer>`
**Inherited By:** :ref:`BaseButton<class_BaseButton>`, :ref:`ColorRect<class_ColorRect>`, :ref:`Container<class_Container>`, :ref:`GraphEdit<class_GraphEdit>`, :ref:`ItemList<class_ItemList>`, :ref:`Label<class_Label>`, :ref:`LineEdit<class_LineEdit>`, :ref:`MenuBar<class_MenuBar>`, :ref:`NinePatchRect<class_NinePatchRect>`, :ref:`Panel<class_Panel>`, :ref:`Range<class_Range>`, :ref:`ReferenceRect<class_ReferenceRect>`, :ref:`RichTextLabel<class_RichTextLabel>`, :ref:`Separator<class_Separator>`, :ref:`TabBar<class_TabBar>`, :ref:`TextEdit<class_TextEdit>`, :ref:`TextureRect<class_TextureRect>`, :ref:`Tree<class_Tree>`, :ref:`VideoStreamPlayer<class_VideoStreamPlayer>`
All user interface nodes inherit from Control. A control's anchors and offsets adapt its position and size relative to its parent.
@@ -90,6 +90,8 @@ Properties
+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+
| :ref:`LayoutDirection<enum_Control_LayoutDirection>` | :ref:`layout_direction<class_Control_property_layout_direction>` | ``0`` |
+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+
| :ref:`bool<class_bool>` | :ref:`localize_numeral_system<class_Control_property_localize_numeral_system>` | ``true`` |
+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+
| :ref:`CursorShape<enum_Control_CursorShape>` | :ref:`mouse_default_cursor_shape<class_Control_property_mouse_default_cursor_shape>` | ``0`` |
+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+
| :ref:`MouseFilter<enum_Control_MouseFilter>` | :ref:`mouse_filter<class_Control_property_mouse_filter>` | ``0`` |
@@ -1032,6 +1034,24 @@ Controls layout direction and text writing direction. Right-to-left layouts are
----
.. _class_Control_property_localize_numeral_system:
- :ref:`bool<class_bool>` **localize_numeral_system**
+-----------+------------------------------------+
| *Default* | ``true`` |
+-----------+------------------------------------+
| *Setter* | set_localize_numeral_system(value) |
+-----------+------------------------------------+
| *Getter* | is_localizing_numeral_system() |
+-----------+------------------------------------+
If ``true``, automatically converts code line numbers, list indices, :ref:`SpinBox<class_SpinBox>` and :ref:`ProgressBar<class_ProgressBar>` values from the Western Arabic (0..9) to the numeral systems used in current locale.
\ **Note:** Numbers within the text are not automatically converted, it can be done manually, using :ref:`TextServer.format_number<class_TextServer_method_format_number>`.
----
.. _class_Control_property_mouse_default_cursor_shape:
- :ref:`CursorShape<enum_Control_CursorShape>` **mouse_default_cursor_shape**
@@ -1216,7 +1236,7 @@ The node's rotation around its pivot, in radians. See :ref:`pivot_offset<class_C
The node's scale, relative to its :ref:`size<class_Control_property_size>`. Change this property to scale the node around its :ref:`pivot_offset<class_Control_property_pivot_offset>`. The Control's :ref:`tooltip_text<class_Control_property_tooltip_text>` will also scale according to this value.
\ **Note:** This property is mainly intended to be used for animation purposes. Text inside the Control will look pixelated or blurry when the Control is scaled. To support multiple resolutions in your project, use an appropriate viewport stretch mode as described in the :doc:`documentation <../tutorials/viewports/multiple_resolutions>` instead of scaling Controls individually.
\ **Note:** This property is mainly intended to be used for animation purposes. Text inside the Control will look pixelated or blurry when the Control is scaled. To support multiple resolutions in your project, use an appropriate viewport stretch mode as described in the :doc:`documentation <../tutorials/rendering/multiple_resolutions>` instead of scaling Controls individually.
\ **Note:** If the Control node is a child of a :ref:`Container<class_Container>` node, the scale will be reset to ``Vector2(1, 1)`` when the scene is instantiated. To set the Control's scale when it's instantiated, wait for one frame using ``await get_tree().process_frame`` then set its :ref:`scale<class_Control_property_scale>` property.

6
classes/class_cubemap.rst
View File

@@ -17,9 +17,11 @@ Cubemap
Description
-----------
A cubemap is made of 6 textures organized in layers. They are typically used for faking reflections (see :ref:`ReflectionProbe<class_ReflectionProbe>`) in 3D rendering. It can be used to make an object look as if it's reflecting its surroundings. This usually delivers much better performance than other reflection methods.
A cubemap is made of 6 textures organized in layers. They are typically used for faking reflections in 3D rendering (see :ref:`ReflectionProbe<class_ReflectionProbe>`). It can be used to make an object look as if it's reflecting its surroundings. This usually delivers much better performance than other reflection methods.
This resource is typically used as a uniform in custom shaders. Few core Godot methods make use of Cubemap resources.
This resource is typically used as a uniform in custom shaders. Few core Godot methods make use of ``Cubemap`` resources.
To create such a texture file yourself, reimport your image files using the Godot Editor import presets.
\ **Note:** Godot doesn't support using cubemaps in a :ref:`PanoramaSkyMaterial<class_PanoramaSkyMaterial>`. You can use `this tool <https://danilw.github.io/GLSL-howto/cubemap_to_panorama_js/cubemap_to_panorama.html>`__ to convert a cubemap to an equirectangular sky map.

6
classes/class_cubemaparray.rst
View File

@@ -19,9 +19,11 @@ Description
``CubemapArray``\ s are made of an array of :ref:`Cubemap<class_Cubemap>`\ s. Accordingly, like :ref:`Cubemap<class_Cubemap>`\ s they are made of multiple textures the amount of which must be divisible by 6 (one image for each face of the cube). The primary benefit of ``CubemapArray``\ s is that they can be accessed in shader code using a single texture reference. In other words, you can pass multiple :ref:`Cubemap<class_Cubemap>`\ s into a shader using a single ``CubemapArray``.
Generally, ``CubemapArray``\ s provide a more efficient way for storing multiple :ref:`Cubemap<class_Cubemap>`\ s, than storing multiple :ref:`Cubemap<class_Cubemap>`\ s themselves in an array.
Generally, ``CubemapArray``\ s provide a more efficient way for storing multiple :ref:`Cubemap<class_Cubemap>`\ s compared to storing multiple :ref:`Cubemap<class_Cubemap>`\ s themselves in an array.
Internally Godot, uses ``CubemapArray``\ s for many effects including the :ref:`Sky<class_Sky>`, if you set :ref:`ProjectSettings.rendering/reflections/sky_reflections/texture_array_reflections<class_ProjectSettings_property_rendering/reflections/sky_reflections/texture_array_reflections>` to ``true``.
Internally, Godot uses ``CubemapArray``\ s for many effects including the :ref:`Sky<class_Sky>`, if you set :ref:`ProjectSettings.rendering/reflections/sky_reflections/texture_array_reflections<class_ProjectSettings_property_rendering/reflections/sky_reflections/texture_array_reflections>` to ``true``.
To create such a texture file yourself, reimport your image files using the Godot Editor import presets.
\ **Note:** ``CubemapArray`` is not supported in the OpenGL 3 rendering backend.

16
classes/class_curvetexture.rst
View File

@@ -24,13 +24,15 @@ If you need to store up to 3 curves within a single texture, use :ref:`CurveXYZT
Properties
----------
+---------------------------------------------------+---------------------------------------------------------------+---------+
| :ref:`Curve<class_Curve>` | :ref:`curve<class_CurveTexture_property_curve>` | |
+---------------------------------------------------+---------------------------------------------------------------+---------+
| :ref:`TextureMode<enum_CurveTexture_TextureMode>` | :ref:`texture_mode<class_CurveTexture_property_texture_mode>` | ``0`` |
+---------------------------------------------------+---------------------------------------------------------------+---------+
| :ref:`int<class_int>` | :ref:`width<class_CurveTexture_property_width>` | ``256`` |
+---------------------------------------------------+---------------------------------------------------------------+---------+
+---------------------------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`curve<class_CurveTexture_property_curve>` | |
+---------------------------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | resource_local_to_scene | ``false`` (overrides :ref:`Resource<class_Resource_property_resource_local_to_scene>`) |
+---------------------------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`TextureMode<enum_CurveTexture_TextureMode>` | :ref:`texture_mode<class_CurveTexture_property_texture_mode>` | ``0`` |
+---------------------------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`width<class_CurveTexture_property_width>` | ``256`` |
+---------------------------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------+
Enumerations
------------

20
classes/class_curvexyztexture.rst
View File

@@ -24,15 +24,17 @@ If you only need to store one curve within a single texture, use :ref:`CurveText
Properties
----------
+---------------------------+--------------------------------------------------------+---------+
| :ref:`Curve<class_Curve>` | :ref:`curve_x<class_CurveXYZTexture_property_curve_x>` | |
+---------------------------+--------------------------------------------------------+---------+
| :ref:`Curve<class_Curve>` | :ref:`curve_y<class_CurveXYZTexture_property_curve_y>` | |
+---------------------------+--------------------------------------------------------+---------+
| :ref:`Curve<class_Curve>` | :ref:`curve_z<class_CurveXYZTexture_property_curve_z>` | |
+---------------------------+--------------------------------------------------------+---------+
| :ref:`int<class_int>` | :ref:`width<class_CurveXYZTexture_property_width>` | ``256`` |
+---------------------------+--------------------------------------------------------+---------+
+---------------------------+--------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`curve_x<class_CurveXYZTexture_property_curve_x>` | |
+---------------------------+--------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`curve_y<class_CurveXYZTexture_property_curve_y>` | |
+---------------------------+--------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Curve<class_Curve>` | :ref:`curve_z<class_CurveXYZTexture_property_curve_z>` | |
+---------------------------+--------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | resource_local_to_scene | ``false`` (overrides :ref:`Resource<class_Resource_property_resource_local_to_scene>`) |
+---------------------------+--------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`width<class_CurveXYZTexture_property_width>` | ``256`` |
+---------------------------+--------------------------------------------------------+----------------------------------------------------------------------------------------+
Property Descriptions
---------------------

7
classes/class_directionallight2d.rst
View File

@@ -12,7 +12,12 @@ DirectionalLight2D
**Inherits:** :ref:`Light2D<class_Light2D>` **<** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Directional light from a distance.
Description
-----------
A directional light is a type of :ref:`Light2D<class_Light2D>` node that models an infinite number of parallel rays covering the entire scene. It is used for lights with strong intensity that are located far away from the scene (for example: to model sunlight or moonlight).
Properties
----------
@@ -54,6 +59,8 @@ The height of the light. Used with 2D normal mapping. Ranges from 0 (parallel to
| *Getter* | get_max_distance() |
+-----------+-------------------------+
Maximum distance this light covers. Increasing this value will make directional shadows visible from further away, at the cost of lower overall shadow detail and performance (due to more objects being included in shadow rendering).
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

20
classes/class_displayserver.rst
View File

@@ -623,9 +623,11 @@ enum **WindowMode**:
Regardless of the platform, enabling full screen will change the window size to match the monitor's size. Therefore, make sure your project supports :doc:`multiple resolutions <../tutorials/rendering/multiple_resolutions>` when enabling full screen mode.
- **WINDOW_MODE_EXCLUSIVE_FULLSCREEN** = **4** --- Exclusive full screen window mode. This mode is implemented on Windows only. On other platforms, it is equivalent to :ref:`WINDOW_MODE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN>`.
- **WINDOW_MODE_EXCLUSIVE_FULLSCREEN** = **4** --- Exclusive full screen window mode. This mode is implemented on Windows and macOS only. On other platforms, it is equivalent to :ref:`WINDOW_MODE_FULLSCREEN<class_DisplayServer_constant_WINDOW_MODE_FULLSCREEN>`.
Only one window in exclusive full screen mode can be visible on a given screen at a time. If multiple windows are in exclusive full screen mode for the same screen, the last one being set to this mode takes precedence.
\ **On Windows:** Only one window in exclusive full screen mode can be visible on a given screen at a time. If multiple windows are in exclusive full screen mode for the same screen, the last one being set to this mode takes precedence.
\ **On macOS:** Exclusive full-screen mode prevents Dock and Menu from showing up when the mouse pointer is hovering the edge of the screen.
Regardless of the platform, enabling full screen will change the window size to match the monitor's size. Therefore, make sure your project supports :doc:`multiple resolutions <../tutorials/rendering/multiple_resolutions>` when enabling full screen mode.
@@ -755,6 +757,8 @@ Although not guaranteed, the images can be rendered as fast as possible, which m
.. _class_DisplayServer_constant_WINDOW_VIEW:
.. _class_DisplayServer_constant_OPENGL_CONTEXT:
enum **HandleType**:
- **DISPLAY_HANDLE** = **0** --- Display handle:
@@ -775,10 +779,22 @@ enum **HandleType**:
- **WINDOW_VIEW** = **2** --- Window view:
- Windows: ``HDC`` for the window (only with the GL Compatibility renderer).
- macOS: ``NSView*`` for the window main view.
- iOS: ``UIView*`` for the window main view.
- **OPENGL_CONTEXT** = **3** --- OpenGL context (only with the GL Compatibility renderer):
- Windows: ``HGLRC`` for the window.
- Linux: ``GLXContext*`` for the window.
- MacOS: ``NSOpenGLContext*`` for the window.
- Android: ``EGLContext`` for the window.
----
.. _enum_DisplayServer_TTSUtteranceEvent:

154
classes/class_editordebuggerplugin.rst
View File

@@ -10,7 +10,7 @@
EditorDebuggerPlugin
====================
**Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
A base class to implement debugger plugins.
@@ -19,122 +19,108 @@ Description
``EditorDebuggerPlugin`` provides functions related to the editor side of the debugger.
You don't need to instantiate this class; that is automatically handled by the debugger. :ref:`Control<class_Control>` nodes can be added as child nodes to provide a GUI for the plugin.
To interact with the debugger, an instance of this class must be added to the editor via :ref:`EditorPlugin.add_debugger_plugin<class_EditorPlugin_method_add_debugger_plugin>`.
Once added, the :ref:`_setup_session<class_EditorDebuggerPlugin_method__setup_session>` callback will be called for every :ref:`EditorDebuggerSession<class_EditorDebuggerSession>` available to the plugin, and when new ones are created (the sessions may be inactive during this stage).
You can retrieve the available :ref:`EditorDebuggerSession<class_EditorDebuggerSession>`\ s via :ref:`get_sessions<class_EditorDebuggerPlugin_method_get_sessions>` or get a specific one via :ref:`get_session<class_EditorDebuggerPlugin_method_get_session>`.
.. tabs::
.. code-tab:: gdscript
@tool
extends EditorPlugin
class ExampleEditorDebugger extends EditorDebuggerPlugin:
func _has_capture(prefix):
# Return true if you wish to handle message with this prefix.
return prefix == "my_plugin"
func _capture(message, data, session_id):
if message == "my_plugin:ping":
get_session(session_id).send_message("my_plugin:echo", data)
func _setup_session(session_id):
# Add a new tab in the debugger session UI containing a label.
var label = Label.new()
label.name = "Example plugin"
label.text = "Example plugin"
var session = get_session(session_id)
# Listens to the session started and stopped signals.
session.started.connect(func (): print("Session started"))
session.stopped.connect(func (): print("Session stopped"))
session.add_session_tab(label)
var debugger = ExampleEditorDebugger.new()
func _enter_tree():
add_debugger_plugin(debugger)
func _exit_tree():
remove_debugger_plugin(debugger)
Do not free or reparent this node, otherwise it becomes unusable.
To use ``EditorDebuggerPlugin``, register it using the :ref:`EditorPlugin.add_debugger_plugin<class_EditorPlugin_method_add_debugger_plugin>` method first.
Methods
-------
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_capture<class_EditorDebuggerPlugin_method_has_capture>` **(** :ref:`StringName<class_StringName>` name **)** |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_breaked<class_EditorDebuggerPlugin_method_is_breaked>` **(** **)** |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_debuggable<class_EditorDebuggerPlugin_method_is_debuggable>` **(** **)** |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_session_active<class_EditorDebuggerPlugin_method_is_session_active>` **(** **)** |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`register_message_capture<class_EditorDebuggerPlugin_method_register_message_capture>` **(** :ref:`StringName<class_StringName>` name, :ref:`Callable<class_Callable>` callable **)** |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`send_message<class_EditorDebuggerPlugin_method_send_message>` **(** :ref:`String<class_String>` message, :ref:`Array<class_Array>` data **)** |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unregister_message_capture<class_EditorDebuggerPlugin_method_unregister_message_capture>` **(** :ref:`StringName<class_StringName>` name **)** |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
.. _class_EditorDebuggerPlugin_signal_breaked:
- **breaked** **(** :ref:`bool<class_bool>` can_debug **)**
Emitted when the game enters a break state.
----
.. _class_EditorDebuggerPlugin_signal_continued:
- **continued** **(** **)**
Emitted when the game exists a break state.
----
.. _class_EditorDebuggerPlugin_signal_started:
- **started** **(** **)**
Emitted when the debugging starts.
----
.. _class_EditorDebuggerPlugin_signal_stopped:
- **stopped** **(** **)**
Emitted when the debugging stops.
+-----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_capture<class_EditorDebuggerPlugin_method__capture>` **(** :ref:`String<class_String>` message, :ref:`Array<class_Array>` data, :ref:`int<class_int>` session_id **)** |virtual| |
+-----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_has_capture<class_EditorDebuggerPlugin_method__has_capture>` **(** :ref:`String<class_String>` capture **)** |virtual| |const| |
+-----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_setup_session<class_EditorDebuggerPlugin_method__setup_session>` **(** :ref:`int<class_int>` session_id **)** |virtual| |
+-----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorDebuggerSession<class_EditorDebuggerSession>` | :ref:`get_session<class_EditorDebuggerPlugin_method_get_session>` **(** :ref:`int<class_int>` id **)** |
+-----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_sessions<class_EditorDebuggerPlugin_method_get_sessions>` **(** **)** |
+-----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Method Descriptions
-------------------
.. _class_EditorDebuggerPlugin_method_has_capture:
.. _class_EditorDebuggerPlugin_method__capture:
- :ref:`bool<class_bool>` **has_capture** **(** :ref:`StringName<class_StringName>` name **)**
- :ref:`bool<class_bool>` **_capture** **(** :ref:`String<class_String>` message, :ref:`Array<class_Array>` data, :ref:`int<class_int>` session_id **)** |virtual|
Returns ``true`` if a message capture with given name is present otherwise ``false``.
Override this method to process incoming messages. The ``session_id`` is the ID of the :ref:`EditorDebuggerSession<class_EditorDebuggerSession>` that received the message (which you can retrieve via :ref:`get_session<class_EditorDebuggerPlugin_method_get_session>`).
----
.. _class_EditorDebuggerPlugin_method_is_breaked:
.. _class_EditorDebuggerPlugin_method__has_capture:
- :ref:`bool<class_bool>` **is_breaked** **(** **)**
- :ref:`bool<class_bool>` **_has_capture** **(** :ref:`String<class_String>` capture **)** |virtual| |const|
Returns ``true`` if the game is in break state otherwise ``false``.
Override this method to enable receiving messages from the debugger. If ``capture`` is "my_message" then messages starting with "my_message:" will be passes to the :ref:`_capture<class_EditorDebuggerPlugin_method__capture>` method.
----
.. _class_EditorDebuggerPlugin_method_is_debuggable:
.. _class_EditorDebuggerPlugin_method__setup_session:
- :ref:`bool<class_bool>` **is_debuggable** **(** **)**
- void **_setup_session** **(** :ref:`int<class_int>` session_id **)** |virtual|
Returns ``true`` if the game can be debugged otherwise ``false``.
Override this method to be notified whenever a new :ref:`EditorDebuggerSession<class_EditorDebuggerSession>` is created (the session may be inactive during this stage).
----
.. _class_EditorDebuggerPlugin_method_is_session_active:
.. _class_EditorDebuggerPlugin_method_get_session:
- :ref:`bool<class_bool>` **is_session_active** **(** **)**
- :ref:`EditorDebuggerSession<class_EditorDebuggerSession>` **get_session** **(** :ref:`int<class_int>` id **)**
Returns ``true`` if there is an instance of the game running with the attached debugger otherwise ``false``.
Returns the :ref:`EditorDebuggerSession<class_EditorDebuggerSession>` with the given ``id``.
----
.. _class_EditorDebuggerPlugin_method_register_message_capture:
.. _class_EditorDebuggerPlugin_method_get_sessions:
- void **register_message_capture** **(** :ref:`StringName<class_StringName>` name, :ref:`Callable<class_Callable>` callable **)**
- :ref:`Array<class_Array>` **get_sessions** **(** **)**
Registers a message capture with given ``name``. If ``name`` is "my_message" then messages starting with "my_message:" will be called with the given callable.
Returns an array of :ref:`EditorDebuggerSession<class_EditorDebuggerSession>` currently available to this debugger plugin.
Callable must accept a message string and a data array as argument. If the message and data are valid then callable must return ``true`` otherwise ``false``.
----
.. _class_EditorDebuggerPlugin_method_send_message:
- void **send_message** **(** :ref:`String<class_String>` message, :ref:`Array<class_Array>` data **)**
Sends a message with given ``message`` and ``data`` array.
----
.. _class_EditorDebuggerPlugin_method_unregister_message_capture:
- void **unregister_message_capture** **(** :ref:`StringName<class_StringName>` name **)**
Unregisters the message capture with given name.
Note: Not sessions in the array may be inactive, check their state via :ref:`EditorDebuggerSession.is_active<class_EditorDebuggerSession_method_is_active>`
.. |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.)`

138
classes/class_editordebuggersession.rst Normal file
View File

@@ -0,0 +1,138 @@
:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorDebuggerSession.xml.
.. _class_EditorDebuggerSession:
EditorDebuggerSession
=====================
**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
A class to interact with the editor debugger.
Description
-----------
This class cannot be directly instantiated and must be retrieved via a :ref:`EditorDebuggerPlugin<class_EditorDebuggerPlugin>`.
You can add tabs to the session UI via :ref:`add_session_tab<class_EditorDebuggerSession_method_add_session_tab>`, send messages via :ref:`send_message<class_EditorDebuggerSession_method_send_message>`, and toggle :ref:`EngineProfiler<class_EngineProfiler>`\ s via :ref:`toggle_profiler<class_EditorDebuggerSession_method_toggle_profiler>`.
Methods
-------
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_session_tab<class_EditorDebuggerSession_method_add_session_tab>` **(** :ref:`Control<class_Control>` control **)** |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_active<class_EditorDebuggerSession_method_is_active>` **(** **)** |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_breaked<class_EditorDebuggerSession_method_is_breaked>` **(** **)** |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_debuggable<class_EditorDebuggerSession_method_is_debuggable>` **(** **)** |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_session_tab<class_EditorDebuggerSession_method_remove_session_tab>` **(** :ref:`Control<class_Control>` control **)** |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`send_message<class_EditorDebuggerSession_method_send_message>` **(** :ref:`String<class_String>` message, :ref:`Array<class_Array>` data=[] **)** |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`toggle_profiler<class_EditorDebuggerSession_method_toggle_profiler>` **(** :ref:`String<class_String>` profiler, :ref:`bool<class_bool>` enable, :ref:`Array<class_Array>` data=[] **)** |
+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
.. _class_EditorDebuggerSession_signal_breaked:
- **breaked** **(** :ref:`bool<class_bool>` can_debug **)**
Emitted when the attached remote instance enters a break state. If ``can_debug`` is ``true``, the remote instance will enter the debug loop.
----
.. _class_EditorDebuggerSession_signal_continued:
- **continued** **(** **)**
Emitted when the attached remote instance exits a break state.
----
.. _class_EditorDebuggerSession_signal_started:
- **started** **(** **)**
Emitted when a remote instance is attached to this session (i.e. the session becomes active).
----
.. _class_EditorDebuggerSession_signal_stopped:
- **stopped** **(** **)**
Emitted when a remote instance is detached from this session (i.e. the session becomes inactive).
Method Descriptions
-------------------
.. _class_EditorDebuggerSession_method_add_session_tab:
- void **add_session_tab** **(** :ref:`Control<class_Control>` control **)**
Adds the given ``control`` to the debug session UI in the debugger bottom panel.
----
.. _class_EditorDebuggerSession_method_is_active:
- :ref:`bool<class_bool>` **is_active** **(** **)**
Returns ``true`` if the debug session is currently attached to a remote instance.
----
.. _class_EditorDebuggerSession_method_is_breaked:
- :ref:`bool<class_bool>` **is_breaked** **(** **)**
Returns ``true`` if the attached remote instance is currently in the debug loop.
----
.. _class_EditorDebuggerSession_method_is_debuggable:
- :ref:`bool<class_bool>` **is_debuggable** **(** **)**
Returns ``true`` if the attached remote instance can be debugged.
----
.. _class_EditorDebuggerSession_method_remove_session_tab:
- void **remove_session_tab** **(** :ref:`Control<class_Control>` control **)**
Removes the given ``control`` from the debug session UI in the debugger bottom panel.
----
.. _class_EditorDebuggerSession_method_send_message:
- void **send_message** **(** :ref:`String<class_String>` message, :ref:`Array<class_Array>` data=[] **)**
Sends the given ``message`` to the attached remote instance, optionally passing additionally ``data``. See :ref:`EngineDebugger<class_EngineDebugger>` for how to retrieve those messages.
----
.. _class_EditorDebuggerSession_method_toggle_profiler:
- void **toggle_profiler** **(** :ref:`String<class_String>` profiler, :ref:`bool<class_bool>` enable, :ref:`Array<class_Array>` data=[] **)**
Toggle the given ``profiler`` on the attached remote instance, optionally passing additionally ``data``. See :ref:`EngineProfiler<class_EngineProfiler>` for more details.
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`

2
classes/class_editorexportplatform.rst
View File

@@ -12,7 +12,9 @@ EditorExportPlatform
**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`

18
classes/class_editorinterface.rst
View File

@@ -42,6 +42,8 @@ Methods
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorCommandPalette<class_EditorCommandPalette>` | :ref:`get_command_palette<class_EditorInterface_method_get_command_palette>` **(** **)** |const| |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_current_directory<class_EditorInterface_method_get_current_directory>` **(** **)** |const| |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_current_path<class_EditorInterface_method_get_current_path>` **(** **)** |const| |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Node<class_Node>` | :ref:`get_edited_scene_root<class_EditorInterface_method_get_edited_scene_root>` **(** **)** |
@@ -68,7 +70,7 @@ Methods
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ScriptEditor<class_ScriptEditor>` | :ref:`get_script_editor<class_EditorInterface_method_get_script_editor>` **(** **)** |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_selected_path<class_EditorInterface_method_get_selected_path>` **(** **)** |const| |
| :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_selected_paths<class_EditorInterface_method_get_selected_paths>` **(** **)** |const| |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorSelection<class_EditorSelection>` | :ref:`get_selection<class_EditorInterface_method_get_selection>` **(** **)** |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -171,6 +173,14 @@ Returns the editor's :ref:`EditorCommandPalette<class_EditorCommandPalette>` ins
----
.. _class_EditorInterface_method_get_current_directory:
- :ref:`String<class_String>` **get_current_directory** **(** **)** |const|
Returns the current directory being viewed in the :ref:`FileSystemDock<class_FileSystemDock>`. If a file is selected, its base directory will be returned using :ref:`String.get_base_dir<class_String_method_get_base_dir>` instead.
----
.. _class_EditorInterface_method_get_current_path:
- :ref:`String<class_String>` **get_current_path** **(** **)** |const|
@@ -285,11 +295,11 @@ Returns the editor's :ref:`ScriptEditor<class_ScriptEditor>` instance.
----
.. _class_EditorInterface_method_get_selected_path:
.. _class_EditorInterface_method_get_selected_paths:
- :ref:`String<class_String>` **get_selected_path** **(** **)** |const|
- :ref:`PackedStringArray<class_PackedStringArray>` **get_selected_paths** **(** **)** |const|
Returns the path of the directory currently selected in the :ref:`FileSystemDock<class_FileSystemDock>`. If a file is selected, its base directory will be returned using :ref:`String.get_base_dir<class_String_method_get_base_dir>` instead.
Returns an array containing the paths of the currently selected files (and directories) in the :ref:`FileSystemDock<class_FileSystemDock>`.
----

2
classes/class_editornode3dgizmoplugin.rst
View File

@@ -24,7 +24,7 @@ To use ``EditorNode3DGizmoPlugin``, register it using the :ref:`EditorPlugin.add
Tutorials
---------
- :doc:`Node3D gizmo plugins <../tutorials/plugins/editor/spatial_gizmos>`
- :doc:`Node3D gizmo plugins <../tutorials/plugins/editor/3d_gizmos>`
Methods
-------

8
classes/class_editorplugin.rst
View File

@@ -84,7 +84,7 @@ Methods
+-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_custom_type<class_EditorPlugin_method_add_custom_type>` **(** :ref:`String<class_String>` type, :ref:`String<class_String>` base, :ref:`Script<class_Script>` script, :ref:`Texture2D<class_Texture2D>` icon **)** |
+-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_debugger_plugin<class_EditorPlugin_method_add_debugger_plugin>` **(** :ref:`Script<class_Script>` script **)** |
| void | :ref:`add_debugger_plugin<class_EditorPlugin_method_add_debugger_plugin>` **(** :ref:`EditorDebuggerPlugin<class_EditorDebuggerPlugin>` script **)** |
+-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_export_plugin<class_EditorPlugin_method_add_export_plugin>` **(** :ref:`EditorExportPlugin<class_EditorExportPlugin>` plugin **)** |
+-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -130,7 +130,7 @@ Methods
+-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_custom_type<class_EditorPlugin_method_remove_custom_type>` **(** :ref:`String<class_String>` type **)** |
+-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_debugger_plugin<class_EditorPlugin_method_remove_debugger_plugin>` **(** :ref:`Script<class_Script>` script **)** |
| void | :ref:`remove_debugger_plugin<class_EditorPlugin_method_remove_debugger_plugin>` **(** :ref:`EditorDebuggerPlugin<class_EditorDebuggerPlugin>` script **)** |
+-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_export_plugin<class_EditorPlugin_method_remove_export_plugin>` **(** :ref:`EditorExportPlugin<class_EditorExportPlugin>` plugin **)** |
+-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -821,7 +821,7 @@ During run-time, this will be a simple object with a script so this function doe
.. _class_EditorPlugin_method_add_debugger_plugin:
- void **add_debugger_plugin** **(** :ref:`Script<class_Script>` script **)**
- void **add_debugger_plugin** **(** :ref:`EditorDebuggerPlugin<class_EditorDebuggerPlugin>` script **)**
Adds a :ref:`Script<class_Script>` as debugger plugin to the Debugger. The script must extend :ref:`EditorDebuggerPlugin<class_EditorDebuggerPlugin>`.
@@ -1043,7 +1043,7 @@ Removes a custom type added by :ref:`add_custom_type<class_EditorPlugin_method_a
.. _class_EditorPlugin_method_remove_debugger_plugin:
- void **remove_debugger_plugin** **(** :ref:`Script<class_Script>` script **)**
- void **remove_debugger_plugin** **(** :ref:`EditorDebuggerPlugin<class_EditorDebuggerPlugin>` script **)**
Removes the debugger plugin with given script from the Debugger.

2
classes/class_editorproperty.rst
View File

@@ -132,7 +132,7 @@ Emit it if you want to key a property with a single value.
Emit it if you want to mark (or unmark) the value of a property for being saved regardless of being equal to the default value.
The default value is the one the property will get when the node is just instantiated and can come from an ancestor scene in the inheritance/instancing chain, a script or a builtin class.
The default value is the one the property will get when the node is just instantiated and can come from an ancestor scene in the inheritance/instantiation chain, a script or a builtin class.
----

14
classes/class_editorresourceconversionplugin.rst
View File

@@ -12,7 +12,9 @@ EditorResourceConversionPlugin
**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Methods
-------
@@ -32,18 +34,30 @@ Method Descriptions
- :ref:`Resource<class_Resource>` **_convert** **(** :ref:`Resource<class_Resource>` resource **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_EditorResourceConversionPlugin_method__converts_to:
- :ref:`String<class_String>` **_converts_to** **(** **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_EditorResourceConversionPlugin_method__handles:
- :ref:`bool<class_bool>` **_handles** **(** :ref:`Resource<class_Resource>` resource **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

20
classes/class_editorsceneformatimporter.rst
View File

@@ -72,30 +72,50 @@ Method Descriptions
- :ref:`PackedStringArray<class_PackedStringArray>` **_get_extensions** **(** **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_EditorSceneFormatImporter_method__get_import_flags:
- :ref:`int<class_int>` **_get_import_flags** **(** **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_EditorSceneFormatImporter_method__get_import_options:
- void **_get_import_options** **(** :ref:`String<class_String>` path **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_EditorSceneFormatImporter_method__get_option_visibility:
- :ref:`Variant<class_Variant>` **_get_option_visibility** **(** :ref:`String<class_String>` path, :ref:`bool<class_bool>` for_animation, :ref:`String<class_String>` option **)** |virtual| |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_EditorSceneFormatImporter_method__import_scene:
- :ref:`Object<class_Object>` **_import_scene** **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags, :ref:`Dictionary<class_Dictionary>` options, :ref:`int<class_int>` bake_fps **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

2
classes/class_editorsceneformatimportergltf.rst
View File

@@ -12,7 +12,9 @@ EditorSceneFormatImporterGLTF
**Inherits:** :ref:`EditorSceneFormatImporter<class_EditorSceneFormatImporter>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`

30
classes/class_editorspinslider.rst
View File

@@ -22,19 +22,23 @@ This :ref:`Control<class_Control>` node is used in the editor's Inspector dock t
Properties
----------
+------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`flat<class_EditorSpinSlider_property_flat>` | ``false`` |
+------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+
| :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``2`` (overrides :ref:`Control<class_Control_property_focus_mode>`) |
+------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`hide_slider<class_EditorSpinSlider_property_hide_slider>` | ``false`` |
+------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`label<class_EditorSpinSlider_property_label>` | ``""`` |
+------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`read_only<class_EditorSpinSlider_property_read_only>` | ``false`` |
+------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`suffix<class_EditorSpinSlider_property_suffix>` | ``""`` |
+------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+
+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`flat<class_EditorSpinSlider_property_flat>` | ``false`` |
+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``2`` (overrides :ref:`Control<class_Control_property_focus_mode>`) |
+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`hide_slider<class_EditorSpinSlider_property_hide_slider>` | ``false`` |
+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`label<class_EditorSpinSlider_property_label>` | ``""`` |
+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`read_only<class_EditorSpinSlider_property_read_only>` | ``false`` |
+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`int<class_int>` | size_flags_vertical | ``1`` (overrides :ref:`Control<class_Control_property_size_flags_vertical>`) |
+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | step | ``1.0`` (overrides :ref:`Range<class_Range_property_step>`) |
+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`suffix<class_EditorSpinSlider_property_suffix>` | ``""`` |
+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+
Property Descriptions
---------------------

2
classes/class_editorundoredomanager.rst
View File

@@ -63,7 +63,7 @@ Signals
- **history_changed** **(** **)**
Emitted when the list of actions in any history has changed, either when an action is commited or a history is cleared.
Emitted when the list of actions in any history has changed, either when an action is committed or a history is cleared.
----

42
classes/class_engine.rst
View File

@@ -22,17 +22,19 @@ The ``Engine`` singleton allows you to query and modify the project's run-time p
Properties
----------
+---------------------------+---------------------------------------------------------------------------------+----------+
| :ref:`int<class_int>` | :ref:`max_fps<class_Engine_property_max_fps>` | ``0`` |
+---------------------------+---------------------------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`physics_jitter_fix<class_Engine_property_physics_jitter_fix>` | ``0.5`` |
+---------------------------+---------------------------------------------------------------------------------+----------+
| :ref:`int<class_int>` | :ref:`physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>` | ``60`` |
+---------------------------+---------------------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>` | :ref:`print_error_messages<class_Engine_property_print_error_messages>` | ``true`` |
+---------------------------+---------------------------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`time_scale<class_Engine_property_time_scale>` | ``1.0`` |
+---------------------------+---------------------------------------------------------------------------------+----------+
+---------------------------+---------------------------------------------------------------------------------------+----------+
| :ref:`int<class_int>` | :ref:`max_fps<class_Engine_property_max_fps>` | ``0`` |
+---------------------------+---------------------------------------------------------------------------------------+----------+
| :ref:`int<class_int>` | :ref:`max_physics_steps_per_frame<class_Engine_property_max_physics_steps_per_frame>` | ``8`` |
+---------------------------+---------------------------------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`physics_jitter_fix<class_Engine_property_physics_jitter_fix>` | ``0.5`` |
+---------------------------+---------------------------------------------------------------------------------------+----------+
| :ref:`int<class_int>` | :ref:`physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>` | ``60`` |
+---------------------------+---------------------------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>` | :ref:`print_error_messages<class_Engine_property_print_error_messages>` | ``true`` |
+---------------------------+---------------------------------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`time_scale<class_Engine_property_time_scale>` | ``1.0`` |
+---------------------------+---------------------------------------------------------------------------------------+----------+
Methods
-------
@@ -116,6 +118,22 @@ See also :ref:`physics_ticks_per_second<class_Engine_property_physics_ticks_per_
----
.. _class_Engine_property_max_physics_steps_per_frame:
- :ref:`int<class_int>` **max_physics_steps_per_frame**
+-----------+----------------------------------------+
| *Default* | ``8`` |
+-----------+----------------------------------------+
| *Setter* | set_max_physics_steps_per_frame(value) |
+-----------+----------------------------------------+
| *Getter* | get_max_physics_steps_per_frame() |
+-----------+----------------------------------------+
Controls the maximum number of physics steps that can be simulated each rendered frame. The default value is tuned to avoid "spiral of death" situations where expensive physics simulations trigger more expensive simulations indefinitely. However, the game will appear to slow down if the rendering FPS is less than ``1 / max_physics_steps_per_frame`` of :ref:`physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>`. This occurs even if ``delta`` is consistently used in physics calculations. To avoid this, increase :ref:`max_physics_steps_per_frame<class_Engine_property_max_physics_steps_per_frame>` if you have increased :ref:`physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>` significantly above its default value.
----
.. _class_Engine_property_physics_jitter_fix:
- :ref:`float<class_float>` **physics_jitter_fix**
@@ -148,7 +166,7 @@ Controls how much physics ticks are synchronized with real time. For 0 or less,
The number of fixed iterations per second. This controls how often physics simulation and :ref:`Node._physics_process<class_Node_method__physics_process>` methods are run. This value should generally always be set to ``60`` or above, as Godot doesn't interpolate the physics step. As a result, values lower than ``60`` will look stuttery. This value can be increased to make input more reactive or work around collision tunneling issues, but keep in mind doing so will increase CPU usage. See also :ref:`max_fps<class_Engine_property_max_fps>` and :ref:`ProjectSettings.physics/common/physics_ticks_per_second<class_ProjectSettings_property_physics/common/physics_ticks_per_second>`.
\ **Note:** Only 8 physics ticks may be simulated per rendered frame at most. If more than 8 physics ticks have to be simulated per rendered frame to keep up with rendering, the game will appear to slow down (even if ``delta`` is used consistently in physics calculations). Therefore, it is recommended not to increase :ref:`physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>` above 240. Otherwise, the game will slow down when the rendering framerate goes below 30 FPS.
\ **Note:** Only :ref:`max_physics_steps_per_frame<class_Engine_property_max_physics_steps_per_frame>` physics ticks may be simulated per rendered frame at most. If more physics ticks have to be simulated per rendered frame to keep up with rendering, the project will appear to slow down (even if ``delta`` is used consistently in physics calculations). Therefore, it is recommended to also increase :ref:`max_physics_steps_per_frame<class_Engine_property_max_physics_steps_per_frame>` if increasing :ref:`physics_ticks_per_second<class_Engine_property_physics_ticks_per_second>` significantly above its default value.
----

10
classes/class_filesystemdock.rst
View File

@@ -12,7 +12,9 @@ FileSystemDock
**Inherits:** :ref:`VBoxContainer<class_VBoxContainer>` **<** :ref:`BoxContainer<class_BoxContainer>` **<** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Methods
-------
@@ -60,9 +62,9 @@ Signals
----
.. _class_FileSystemDock_signal_instance:
.. _class_FileSystemDock_signal_instantiate:
- **instance** **(** :ref:`PackedStringArray<class_PackedStringArray>` files **)**
- **instantiate** **(** :ref:`PackedStringArray<class_PackedStringArray>` files **)**
Method Descriptions
-------------------
@@ -71,6 +73,10 @@ Method Descriptions
- void **navigate_to_path** **(** :ref:`String<class_String>` path **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

26
classes/class_float.rst
View File

@@ -31,15 +31,17 @@ Tutorials
Constructors
------------
+---------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>` **(** **)** |
+---------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>` **(** :ref:`float<class_float>` from **)** |
+---------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>` **(** :ref:`bool<class_bool>` from **)** |
+---------------------------+----------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>` **(** :ref:`int<class_int>` from **)** |
+---------------------------+----------------------------------------------------------------------------------------+
+---------------------------+------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>` **(** **)** |
+---------------------------+------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>` **(** :ref:`float<class_float>` from **)** |
+---------------------------+------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>` **(** :ref:`String<class_String>` from **)** |
+---------------------------+------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>` **(** :ref:`bool<class_bool>` from **)** |
+---------------------------+------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>` **(** :ref:`int<class_int>` from **)** |
+---------------------------+------------------------------------------------------------------------------------------+
Operators
---------
@@ -127,6 +129,12 @@ Constructs a ``float`` as a copy of the given ``float``.
----
- :ref:`float<class_float>` **float** **(** :ref:`String<class_String>` from **)**
Converts a :ref:`String<class_String>` to a ``float``, following the same rules as :ref:`String.to_float<class_String_method_to_float>`.
----
- :ref:`float<class_float>` **float** **(** :ref:`bool<class_bool>` from **)**
Cast a :ref:`bool<class_bool>` value to a floating-point value, ``float(true)`` will be equal to 1.0 and ``float(false)`` will be equal to 0.0.

36
classes/class_fontfile.rst
View File

@@ -544,24 +544,40 @@ Returns number of the font cache entries.
- :ref:`float<class_float>` **get_cache_descent** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_FontFile_method_get_cache_scale:
- :ref:`float<class_float>` **get_cache_scale** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_FontFile_method_get_cache_underline_position:
- :ref:`float<class_float>` **get_cache_underline_position** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_FontFile_method_get_cache_underline_thickness:
- :ref:`float<class_float>` **get_cache_underline_thickness** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_FontFile_method_get_embolden:
@@ -834,30 +850,50 @@ Renders the range of characters to the font cache texture.
- void **set_cache_ascent** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`float<class_float>` ascent **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_FontFile_method_set_cache_descent:
- void **set_cache_descent** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`float<class_float>` descent **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_FontFile_method_set_cache_scale:
- void **set_cache_scale** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`float<class_float>` scale **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_FontFile_method_set_cache_underline_position:
- void **set_cache_underline_position** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_position **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_FontFile_method_set_cache_underline_thickness:
- void **set_cache_underline_thickness** **(** :ref:`int<class_int>` cache_index, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_thickness **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_FontFile_method_set_embolden:

144
classes/class_generic6dofjoint3d.rst
View File

@@ -899,6 +899,10 @@ Target speed for the motor at the Z axis.
| *Getter* | get_param_x() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_angular_spring_x/enabled:
@@ -913,6 +917,10 @@ Target speed for the motor at the Z axis.
| *Getter* | get_flag_x() |
+-----------+-------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_angular_spring_x/equilibrium_point:
@@ -927,6 +935,10 @@ Target speed for the motor at the Z axis.
| *Getter* | get_param_x() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_angular_spring_x/stiffness:
@@ -941,6 +953,10 @@ Target speed for the motor at the Z axis.
| *Getter* | get_param_x() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_angular_spring_y/damping:
@@ -955,6 +971,10 @@ Target speed for the motor at the Z axis.
| *Getter* | get_param_y() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_angular_spring_y/enabled:
@@ -969,6 +989,10 @@ Target speed for the motor at the Z axis.
| *Getter* | get_flag_y() |
+-----------+-------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_angular_spring_y/equilibrium_point:
@@ -983,6 +1007,10 @@ Target speed for the motor at the Z axis.
| *Getter* | get_param_y() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_angular_spring_y/stiffness:
@@ -997,6 +1025,10 @@ Target speed for the motor at the Z axis.
| *Getter* | get_param_y() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_angular_spring_z/damping:
@@ -1011,6 +1043,10 @@ Target speed for the motor at the Z axis.
| *Getter* | get_param_z() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_angular_spring_z/enabled:
@@ -1025,6 +1061,10 @@ Target speed for the motor at the Z axis.
| *Getter* | get_flag_z() |
+-----------+-------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_angular_spring_z/equilibrium_point:
@@ -1039,6 +1079,10 @@ Target speed for the motor at the Z axis.
| *Getter* | get_param_z() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_angular_spring_z/stiffness:
@@ -1053,6 +1097,10 @@ Target speed for the motor at the Z axis.
| *Getter* | get_param_z() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_linear_limit_x/damping:
@@ -1499,6 +1547,10 @@ The speed that the linear motor will attempt to reach on the Z axis.
| *Getter* | get_param_x() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_linear_spring_x/enabled:
@@ -1513,6 +1565,10 @@ The speed that the linear motor will attempt to reach on the Z axis.
| *Getter* | get_flag_x() |
+-----------+-------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_linear_spring_x/equilibrium_point:
@@ -1527,6 +1583,10 @@ The speed that the linear motor will attempt to reach on the Z axis.
| *Getter* | get_param_x() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_linear_spring_x/stiffness:
@@ -1541,6 +1601,10 @@ The speed that the linear motor will attempt to reach on the Z axis.
| *Getter* | get_param_x() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_linear_spring_y/damping:
@@ -1555,6 +1619,10 @@ The speed that the linear motor will attempt to reach on the Z axis.
| *Getter* | get_param_y() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_linear_spring_y/enabled:
@@ -1569,6 +1637,10 @@ The speed that the linear motor will attempt to reach on the Z axis.
| *Getter* | get_flag_y() |
+-----------+-------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_linear_spring_y/equilibrium_point:
@@ -1583,6 +1655,10 @@ The speed that the linear motor will attempt to reach on the Z axis.
| *Getter* | get_param_y() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_linear_spring_y/stiffness:
@@ -1597,6 +1673,10 @@ The speed that the linear motor will attempt to reach on the Z axis.
| *Getter* | get_param_y() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_linear_spring_z/damping:
@@ -1611,6 +1691,10 @@ The speed that the linear motor will attempt to reach on the Z axis.
| *Getter* | get_param_z() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_linear_spring_z/enabled:
@@ -1625,6 +1709,10 @@ The speed that the linear motor will attempt to reach on the Z axis.
| *Getter* | get_flag_z() |
+-----------+-------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_linear_spring_z/equilibrium_point:
@@ -1639,6 +1727,10 @@ The speed that the linear motor will attempt to reach on the Z axis.
| *Getter* | get_param_z() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_property_linear_spring_z/stiffness:
@@ -1653,6 +1745,10 @@ The speed that the linear motor will attempt to reach on the Z axis.
| *Getter* | get_param_z() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Method Descriptions
-------------------
@@ -1660,72 +1756,120 @@ Method Descriptions
- :ref:`bool<class_bool>` **get_flag_x** **(** :ref:`Flag<enum_Generic6DOFJoint3D_Flag>` flag **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_method_get_flag_y:
- :ref:`bool<class_bool>` **get_flag_y** **(** :ref:`Flag<enum_Generic6DOFJoint3D_Flag>` flag **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_method_get_flag_z:
- :ref:`bool<class_bool>` **get_flag_z** **(** :ref:`Flag<enum_Generic6DOFJoint3D_Flag>` flag **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_method_get_param_x:
- :ref:`float<class_float>` **get_param_x** **(** :ref:`Param<enum_Generic6DOFJoint3D_Param>` param **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_method_get_param_y:
- :ref:`float<class_float>` **get_param_y** **(** :ref:`Param<enum_Generic6DOFJoint3D_Param>` param **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_method_get_param_z:
- :ref:`float<class_float>` **get_param_z** **(** :ref:`Param<enum_Generic6DOFJoint3D_Param>` param **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_method_set_flag_x:
- void **set_flag_x** **(** :ref:`Flag<enum_Generic6DOFJoint3D_Flag>` flag, :ref:`bool<class_bool>` value **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_method_set_flag_y:
- void **set_flag_y** **(** :ref:`Flag<enum_Generic6DOFJoint3D_Flag>` flag, :ref:`bool<class_bool>` value **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_method_set_flag_z:
- void **set_flag_z** **(** :ref:`Flag<enum_Generic6DOFJoint3D_Flag>` flag, :ref:`bool<class_bool>` value **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_method_set_param_x:
- void **set_param_x** **(** :ref:`Param<enum_Generic6DOFJoint3D_Param>` param, :ref:`float<class_float>` value **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_method_set_param_y:
- void **set_param_y** **(** :ref:`Param<enum_Generic6DOFJoint3D_Param>` param, :ref:`float<class_float>` value **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Generic6DOFJoint3D_method_set_param_z:
- void **set_param_z** **(** :ref:`Param<enum_Generic6DOFJoint3D_Param>` param, :ref:`float<class_float>` value **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

10
classes/class_geometryinstance3d.rst
View File

@@ -237,6 +237,8 @@ The global illumination mode to use for the whole geometry. To avoid inconsisten
| *Getter* | is_ignoring_occlusion_culling() |
+-----------+-------------------------------------+
If ``true``, disables occlusion culling for this instance. Useful for gizmos that must be rendered even when occlusion culling is in use.
----
.. _class_GeometryInstance3D_property_lod_bias:
@@ -251,6 +253,10 @@ The global illumination mode to use for the whole geometry. To avoid inconsisten
| *Getter* | get_lod_bias() |
+-----------+---------------------+
Changes how quickly the mesh transitions to a lower level of detail. A value of 0 will force the mesh to its lowest level of detail, a value of 1 will use the default settings, and larger values will keep the mesh in a higher level of detail at farther distances.
Useful for testing level of detail transitions in the editor.
----
.. _class_GeometryInstance3D_property_material_overlay:
@@ -394,6 +400,8 @@ Method Descriptions
- :ref:`Variant<class_Variant>` **get_instance_shader_parameter** **(** :ref:`StringName<class_StringName>` name **)** |const|
Get the value of a shader parameter as set on this instance.
----
.. _class_GeometryInstance3D_method_set_custom_aabb:
@@ -408,6 +416,8 @@ Overrides the bounding box of this node with a custom one. To remove it, set an
- void **set_instance_shader_parameter** **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)**
Set the value of a shader parameter for this instance only.
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

58
classes/class_gltfaccessor.rst
View File

@@ -12,7 +12,9 @@ GLTFAccessor
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
@@ -62,6 +64,10 @@ Property Descriptions
| *Getter* | get_buffer_view() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFAccessor_property_byte_offset:
@@ -76,6 +82,10 @@ Property Descriptions
| *Getter* | get_byte_offset() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFAccessor_property_component_type:
@@ -90,6 +100,10 @@ Property Descriptions
| *Getter* | get_component_type() |
+-----------+---------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFAccessor_property_count:
@@ -104,6 +118,10 @@ Property Descriptions
| *Getter* | get_count() |
+-----------+------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFAccessor_property_max:
@@ -118,6 +136,10 @@ Property Descriptions
| *Getter* | get_max() |
+-----------+--------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFAccessor_property_min:
@@ -132,6 +154,10 @@ Property Descriptions
| *Getter* | get_min() |
+-----------+--------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFAccessor_property_normalized:
@@ -146,6 +172,10 @@ Property Descriptions
| *Getter* | get_normalized() |
+-----------+-----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFAccessor_property_sparse_count:
@@ -160,6 +190,10 @@ Property Descriptions
| *Getter* | get_sparse_count() |
+-----------+-------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFAccessor_property_sparse_indices_buffer_view:
@@ -174,6 +208,10 @@ Property Descriptions
| *Getter* | get_sparse_indices_buffer_view() |
+-----------+---------------------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFAccessor_property_sparse_indices_byte_offset:
@@ -188,6 +226,10 @@ Property Descriptions
| *Getter* | get_sparse_indices_byte_offset() |
+-----------+---------------------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFAccessor_property_sparse_indices_component_type:
@@ -202,6 +244,10 @@ Property Descriptions
| *Getter* | get_sparse_indices_component_type() |
+-----------+------------------------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFAccessor_property_sparse_values_buffer_view:
@@ -216,6 +262,10 @@ Property Descriptions
| *Getter* | get_sparse_values_buffer_view() |
+-----------+--------------------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFAccessor_property_sparse_values_byte_offset:
@@ -230,6 +280,10 @@ Property Descriptions
| *Getter* | get_sparse_values_byte_offset() |
+-----------+--------------------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFAccessor_property_type:
@@ -244,6 +298,10 @@ Property Descriptions
| *Getter* | get_type() |
+-----------+-----------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

6
classes/class_gltfanimation.rst
View File

@@ -12,7 +12,9 @@ GLTFAnimation
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
@@ -36,6 +38,10 @@ Property Descriptions
| *Getter* | get_loop() |
+-----------+-----------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

22
classes/class_gltfbufferview.rst
View File

@@ -12,7 +12,9 @@ GLTFBufferView
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
@@ -44,6 +46,10 @@ Property Descriptions
| *Getter* | get_buffer() |
+-----------+-------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFBufferView_property_byte_length:
@@ -58,6 +64,10 @@ Property Descriptions
| *Getter* | get_byte_length() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFBufferView_property_byte_offset:
@@ -72,6 +82,10 @@ Property Descriptions
| *Getter* | get_byte_offset() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFBufferView_property_byte_stride:
@@ -86,6 +100,10 @@ Property Descriptions
| *Getter* | get_byte_stride() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFBufferView_property_indices:
@@ -100,6 +118,10 @@ Property Descriptions
| *Getter* | get_indices() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

30
classes/class_gltfdocument.rst
View File

@@ -12,8 +12,6 @@ GLTFDocument
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Description
-----------
@@ -58,6 +56,10 @@ Property Descriptions
| *Getter* | get_extensions() |
+-----------+-----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Method Descriptions
-------------------
@@ -65,36 +67,60 @@ Method Descriptions
- :ref:`Error<enum_@GlobalScope_Error>` **append_from_buffer** **(** :ref:`PackedByteArray<class_PackedByteArray>` bytes, :ref:`String<class_String>` base_path, :ref:`GLTFState<class_GLTFState>` state, :ref:`int<class_int>` flags=0, :ref:`int<class_int>` bake_fps=30 **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFDocument_method_append_from_file:
- :ref:`Error<enum_@GlobalScope_Error>` **append_from_file** **(** :ref:`String<class_String>` path, :ref:`GLTFState<class_GLTFState>` state, :ref:`int<class_int>` flags=0, :ref:`int<class_int>` bake_fps=30, :ref:`String<class_String>` base_path="" **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFDocument_method_append_from_scene:
- :ref:`Error<enum_@GlobalScope_Error>` **append_from_scene** **(** :ref:`Node<class_Node>` node, :ref:`GLTFState<class_GLTFState>` state, :ref:`int<class_int>` flags=0, :ref:`int<class_int>` bake_fps=30 **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFDocument_method_generate_buffer:
- :ref:`PackedByteArray<class_PackedByteArray>` **generate_buffer** **(** :ref:`GLTFState<class_GLTFState>` state **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFDocument_method_generate_scene:
- :ref:`Node<class_Node>` **generate_scene** **(** :ref:`GLTFState<class_GLTFState>` state, :ref:`int<class_int>` bake_fps=30 **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFDocument_method_write_to_filesystem:
- :ref:`Error<enum_@GlobalScope_Error>` **write_to_filesystem** **(** :ref:`GLTFState<class_GLTFState>` state, :ref:`String<class_String>` path **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

28
classes/class_gltfdocumentextension.rst
View File

@@ -49,18 +49,30 @@ Method Descriptions
- :ref:`int<class_int>` **_export_node** **(** :ref:`GLTFState<class_GLTFState>` state, :ref:`GLTFNode<class_GLTFNode>` gltf_node, :ref:`Dictionary<class_Dictionary>` json, :ref:`Node<class_Node>` node **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFDocumentExtension_method__export_post:
- :ref:`int<class_int>` **_export_post** **(** :ref:`GLTFState<class_GLTFState>` state **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFDocumentExtension_method__export_preflight:
- :ref:`int<class_int>` **_export_preflight** **(** :ref:`Node<class_Node>` root **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFDocumentExtension_method__get_supported_extensions:
@@ -75,24 +87,40 @@ Returns an array of the GLTF extensions supported by this GLTFDocumentExtension
- :ref:`int<class_int>` **_import_node** **(** :ref:`GLTFState<class_GLTFState>` state, :ref:`GLTFNode<class_GLTFNode>` gltf_node, :ref:`Dictionary<class_Dictionary>` json, :ref:`Node<class_Node>` node **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFDocumentExtension_method__import_post:
- :ref:`int<class_int>` **_import_post** **(** :ref:`GLTFState<class_GLTFState>` state, :ref:`Node<class_Node>` root **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFDocumentExtension_method__import_post_parse:
- :ref:`int<class_int>` **_import_post_parse** **(** :ref:`GLTFState<class_GLTFState>` state **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFDocumentExtension_method__import_preflight:
- :ref:`int<class_int>` **_import_preflight** **(** :ref:`GLTFState<class_GLTFState>` state **)** |virtual|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

2
classes/class_gltfdocumentextensionconvertimportermesh.rst
View File

@@ -12,7 +12,9 @@ GLTFDocumentExtensionConvertImporterMesh
**Inherits:** :ref:`GLTFDocumentExtension<class_GLTFDocumentExtension>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`

14
classes/class_gltfmesh.rst
View File

@@ -12,7 +12,9 @@ GLTFMesh
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
@@ -40,6 +42,10 @@ Property Descriptions
| *Getter* | get_blend_weights() |
+-----------+--------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFMesh_property_instance_materials:
@@ -54,6 +60,10 @@ Property Descriptions
| *Getter* | get_instance_materials() |
+-----------+-------------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFMesh_property_mesh:
@@ -66,6 +76,10 @@ Property Descriptions
| *Getter* | get_mesh() |
+----------+-----------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

52
classes/class_gltfnode.rst
View File

@@ -79,6 +79,10 @@ Property Descriptions
| *Getter* | get_camera() |
+-----------+-------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFNode_property_children:
@@ -93,6 +97,10 @@ Property Descriptions
| *Getter* | get_children() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFNode_property_height:
@@ -107,6 +115,10 @@ Property Descriptions
| *Getter* | get_height() |
+-----------+-------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFNode_property_joint:
@@ -121,6 +133,10 @@ Property Descriptions
| *Getter* | get_joint() |
+-----------+------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFNode_property_light:
@@ -135,6 +151,10 @@ Property Descriptions
| *Getter* | get_light() |
+-----------+------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFNode_property_mesh:
@@ -149,6 +169,10 @@ Property Descriptions
| *Getter* | get_mesh() |
+-----------+-----------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFNode_property_parent:
@@ -163,6 +187,10 @@ Property Descriptions
| *Getter* | get_parent() |
+-----------+-------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFNode_property_position:
@@ -177,6 +205,10 @@ Property Descriptions
| *Getter* | get_position() |
+-----------+----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFNode_property_rotation:
@@ -191,6 +223,10 @@ Property Descriptions
| *Getter* | get_rotation() |
+-----------+----------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFNode_property_scale:
@@ -205,6 +241,10 @@ Property Descriptions
| *Getter* | get_scale() |
+-----------+----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFNode_property_skeleton:
@@ -219,6 +259,10 @@ Property Descriptions
| *Getter* | get_skeleton() |
+-----------+---------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFNode_property_skin:
@@ -233,6 +277,10 @@ Property Descriptions
| *Getter* | get_skin() |
+-----------+-----------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFNode_property_xform:
@@ -247,6 +295,10 @@ Property Descriptions
| *Getter* | get_xform() |
+-----------+-----------------------------------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Method Descriptions
-------------------

38
classes/class_gltfskeleton.rst
View File

@@ -12,7 +12,9 @@ GLTFSkeleton
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
@@ -57,6 +59,10 @@ Property Descriptions
| *Getter* | get_joints() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkeleton_property_roots:
@@ -71,6 +77,10 @@ Property Descriptions
| *Getter* | get_roots() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Method Descriptions
-------------------
@@ -78,42 +88,70 @@ Method Descriptions
- :ref:`BoneAttachment3D<class_BoneAttachment3D>` **get_bone_attachment** **(** :ref:`int<class_int>` idx **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkeleton_method_get_bone_attachment_count:
- :ref:`int<class_int>` **get_bone_attachment_count** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkeleton_method_get_godot_bone_node:
- :ref:`Dictionary<class_Dictionary>` **get_godot_bone_node** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkeleton_method_get_godot_skeleton:
- :ref:`Skeleton3D<class_Skeleton3D>` **get_godot_skeleton** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkeleton_method_get_unique_names:
- :ref:`String[]<class_String>` **get_unique_names** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkeleton_method_set_godot_bone_node:
- void **set_godot_bone_node** **(** :ref:`Dictionary<class_Dictionary>` godot_bone_node **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkeleton_method_set_unique_names:
- void **set_unique_names** **(** :ref:`String[]<class_String>` unique_names **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

54
classes/class_gltfskin.rst
View File

@@ -12,7 +12,9 @@ GLTFSkin
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
@@ -63,6 +65,10 @@ Property Descriptions
| *Getter* | get_godot_skin() |
+----------+-----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkin_property_joints:
@@ -77,6 +83,10 @@ Property Descriptions
| *Getter* | get_joints() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkin_property_joints_original:
@@ -91,6 +101,10 @@ Property Descriptions
| *Getter* | get_joints_original() |
+-----------+----------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkin_property_non_joints:
@@ -105,6 +119,10 @@ Property Descriptions
| *Getter* | get_non_joints() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkin_property_roots:
@@ -119,6 +137,10 @@ Property Descriptions
| *Getter* | get_roots() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkin_property_skeleton:
@@ -133,6 +155,10 @@ Property Descriptions
| *Getter* | get_skeleton() |
+-----------+---------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkin_property_skin_root:
@@ -147,6 +173,10 @@ Property Descriptions
| *Getter* | get_skin_root() |
+-----------+----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Method Descriptions
-------------------
@@ -154,36 +184,60 @@ Method Descriptions
- :ref:`Transform3D[]<class_Transform3D>` **get_inverse_binds** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkin_method_get_joint_i_to_bone_i:
- :ref:`Dictionary<class_Dictionary>` **get_joint_i_to_bone_i** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkin_method_get_joint_i_to_name:
- :ref:`Dictionary<class_Dictionary>` **get_joint_i_to_name** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkin_method_set_inverse_binds:
- void **set_inverse_binds** **(** :ref:`Transform3D[]<class_Transform3D>` inverse_binds **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkin_method_set_joint_i_to_bone_i:
- void **set_joint_i_to_bone_i** **(** :ref:`Dictionary<class_Dictionary>` joint_i_to_bone_i **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFSkin_method_set_joint_i_to_name:
- void **set_joint_i_to_name** **(** :ref:`Dictionary<class_Dictionary>` joint_i_to_name **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

174
classes/class_gltfstate.rst
View File

@@ -12,7 +12,9 @@ GLTFState
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
@@ -135,6 +137,10 @@ Property Descriptions
| *Getter* | get_base_path() |
+-----------+----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_property_buffers:
@@ -149,6 +155,10 @@ Property Descriptions
| *Getter* | get_buffers() |
+-----------+--------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_property_create_animations:
@@ -163,6 +173,10 @@ Property Descriptions
| *Getter* | get_create_animations() |
+-----------+------------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_property_glb_data:
@@ -177,6 +191,10 @@ Property Descriptions
| *Getter* | get_glb_data() |
+-----------+-----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_property_json:
@@ -191,6 +209,10 @@ Property Descriptions
| *Getter* | get_json() |
+-----------+-----------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_property_major_version:
@@ -205,6 +227,10 @@ Property Descriptions
| *Getter* | get_major_version() |
+-----------+--------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_property_minor_version:
@@ -219,6 +245,10 @@ Property Descriptions
| *Getter* | get_minor_version() |
+-----------+--------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_property_root_nodes:
@@ -233,6 +263,10 @@ Property Descriptions
| *Getter* | get_root_nodes() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_property_scene_name:
@@ -247,6 +281,10 @@ Property Descriptions
| *Getter* | get_scene_name() |
+-----------+-----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_property_use_named_skin_binds:
@@ -261,6 +299,10 @@ Property Descriptions
| *Getter* | get_use_named_skin_binds() |
+-----------+---------------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Method Descriptions
-------------------
@@ -276,6 +318,10 @@ Appends an extension to the list of extensions used by this GLTF file during ser
- :ref:`GLTFAccessor[]<class_GLTFAccessor>` **get_accessors** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_additional_data:
@@ -292,84 +338,140 @@ The argument should be the :ref:`GLTFDocumentExtension<class_GLTFDocumentExtensi
- :ref:`AnimationPlayer<class_AnimationPlayer>` **get_animation_player** **(** :ref:`int<class_int>` idx **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_animation_players_count:
- :ref:`int<class_int>` **get_animation_players_count** **(** :ref:`int<class_int>` idx **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_animations:
- :ref:`GLTFAnimation[]<class_GLTFAnimation>` **get_animations** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_buffer_views:
- :ref:`GLTFBufferView[]<class_GLTFBufferView>` **get_buffer_views** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_cameras:
- :ref:`GLTFCamera[]<class_GLTFCamera>` **get_cameras** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_images:
- :ref:`Texture2D[]<class_Texture2D>` **get_images** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_lights:
- :ref:`GLTFLight[]<class_GLTFLight>` **get_lights** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_materials:
- :ref:`BaseMaterial3D[]<class_BaseMaterial3D>` **get_materials** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_meshes:
- :ref:`GLTFMesh[]<class_GLTFMesh>` **get_meshes** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_nodes:
- :ref:`GLTFNode[]<class_GLTFNode>` **get_nodes** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_scene_node:
- :ref:`Node<class_Node>` **get_scene_node** **(** :ref:`int<class_int>` idx **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_skeleton_to_node:
- :ref:`Dictionary<class_Dictionary>` **get_skeleton_to_node** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_skeletons:
- :ref:`GLTFSkeleton[]<class_GLTFSkeleton>` **get_skeletons** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_skins:
- :ref:`GLTFSkin[]<class_GLTFSkin>` **get_skins** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_texture_samplers:
@@ -384,24 +486,40 @@ Retrieves the array of texture samplers that are used by the textures contained
- :ref:`GLTFTexture[]<class_GLTFTexture>` **get_textures** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_unique_animation_names:
- :ref:`String[]<class_String>` **get_unique_animation_names** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_get_unique_names:
- :ref:`String[]<class_String>` **get_unique_names** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_set_accessors:
- void **set_accessors** **(** :ref:`GLTFAccessor[]<class_GLTFAccessor>` accessors **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_set_additional_data:
@@ -418,66 +536,110 @@ The first argument should be the :ref:`GLTFDocumentExtension<class_GLTFDocumentE
- void **set_animations** **(** :ref:`GLTFAnimation[]<class_GLTFAnimation>` animations **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_set_buffer_views:
- void **set_buffer_views** **(** :ref:`GLTFBufferView[]<class_GLTFBufferView>` buffer_views **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_set_cameras:
- void **set_cameras** **(** :ref:`GLTFCamera[]<class_GLTFCamera>` cameras **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_set_images:
- void **set_images** **(** :ref:`Texture2D[]<class_Texture2D>` images **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_set_lights:
- void **set_lights** **(** :ref:`GLTFLight[]<class_GLTFLight>` lights **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_set_materials:
- void **set_materials** **(** :ref:`BaseMaterial3D[]<class_BaseMaterial3D>` materials **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_set_meshes:
- void **set_meshes** **(** :ref:`GLTFMesh[]<class_GLTFMesh>` meshes **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_set_nodes:
- void **set_nodes** **(** :ref:`GLTFNode[]<class_GLTFNode>` nodes **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_set_skeleton_to_node:
- void **set_skeleton_to_node** **(** :ref:`Dictionary<class_Dictionary>` skeleton_to_node **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_set_skeletons:
- void **set_skeletons** **(** :ref:`GLTFSkeleton[]<class_GLTFSkeleton>` skeletons **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_set_skins:
- void **set_skins** **(** :ref:`GLTFSkin[]<class_GLTFSkin>` skins **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_set_texture_samplers:
@@ -492,18 +654,30 @@ Sets the array of texture samplers that are used by the textures contained in th
- void **set_textures** **(** :ref:`GLTFTexture[]<class_GLTFTexture>` textures **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_set_unique_animation_names:
- void **set_unique_animation_names** **(** :ref:`String[]<class_String>` unique_animation_names **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GLTFState_method_set_unique_names:
- void **set_unique_names** **(** :ref:`String[]<class_String>` unique_names **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

6
classes/class_gltftexture.rst
View File

@@ -12,7 +12,9 @@ GLTFTexture
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
@@ -54,6 +56,10 @@ ID of the texture sampler to use when sampling the image. If -1, then the defaul
| *Getter* | get_src_image() |
+-----------+----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

34
classes/class_gpuparticles2d.rst
View File

@@ -70,7 +70,7 @@ Properties
+-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+
| :ref:`bool<class_bool>` | :ref:`trail_enabled<class_GPUParticles2D_property_trail_enabled>` | ``false`` |
+-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+
| :ref:`float<class_float>` | :ref:`trail_length_secs<class_GPUParticles2D_property_trail_length_secs>` | ``0.3`` |
| :ref:`float<class_float>` | :ref:`trail_lifetime<class_GPUParticles2D_property_trail_lifetime>` | ``0.3`` |
+-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+
| :ref:`int<class_int>` | :ref:`trail_section_subdivisions<class_GPUParticles2D_property_trail_section_subdivisions>` | ``4`` |
+-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+
@@ -166,6 +166,10 @@ Number of particles emitted in one emission cycle.
| *Getter* | get_collision_base_size() |
+-----------+--------------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GPUParticles2D_property_draw_order:
@@ -416,19 +420,25 @@ Particle texture. If ``null``, particles will be squares.
| *Getter* | is_trail_enabled() |
+-----------+--------------------------+
If ``true``, enables particle trails using a mesh skinning system.
\ **Note:** Unlike :ref:`GPUParticles3D<class_GPUParticles3D>`, the number of trail sections and subdivisions is set with the :ref:`trail_sections<class_GPUParticles2D_property_trail_sections>` and :ref:`trail_section_subdivisions<class_GPUParticles2D_property_trail_section_subdivisions>` properties.
----
.. _class_GPUParticles2D_property_trail_length_secs:
.. _class_GPUParticles2D_property_trail_lifetime:
- :ref:`float<class_float>` **trail_length_secs**
- :ref:`float<class_float>` **trail_lifetime**
+-----------+-------------------------+
| *Default* | ``0.3`` |
+-----------+-------------------------+
| *Setter* | set_trail_length(value) |
+-----------+-------------------------+
| *Getter* | get_trail_length() |
+-----------+-------------------------+
+-----------+---------------------------+
| *Default* | ``0.3`` |
+-----------+---------------------------+
| *Setter* | set_trail_lifetime(value) |
+-----------+---------------------------+
| *Getter* | get_trail_lifetime() |
+-----------+---------------------------+
The amount of time the particle's trail should represent (in seconds). Only effective if :ref:`trail_enabled<class_GPUParticles2D_property_trail_enabled>` is ``true``.
----
@@ -444,6 +454,8 @@ Particle texture. If ``null``, particles will be squares.
| *Getter* | get_trail_section_subdivisions() |
+-----------+---------------------------------------+
The number of subdivisions to use for the particle trail rendering. Higher values can result in smoother trail curves, at the cost of performance due to increased mesh complexity. See also :ref:`trail_sections<class_GPUParticles2D_property_trail_sections>`. Only effective if :ref:`trail_enabled<class_GPUParticles2D_property_trail_enabled>` is ``true``.
----
.. _class_GPUParticles2D_property_trail_sections:
@@ -458,6 +470,8 @@ Particle texture. If ``null``, particles will be squares.
| *Getter* | get_trail_sections() |
+-----------+---------------------------+
The number of sections to use for the particle trail rendering. Higher values can result in smoother trail curves, at the cost of performance due to increased mesh complexity. See also :ref:`trail_section_subdivisions<class_GPUParticles2D_property_trail_section_subdivisions>`. Only effective if :ref:`trail_enabled<class_GPUParticles2D_property_trail_enabled>` is ``true``.
----
.. _class_GPUParticles2D_property_visibility_rect:

44
classes/class_gpuparticles3d.rst
View File

@@ -78,7 +78,7 @@ Properties
+-----------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------+
| :ref:`bool<class_bool>` | :ref:`trail_enabled<class_GPUParticles3D_property_trail_enabled>` | ``false`` |
+-----------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------+
| :ref:`float<class_float>` | :ref:`trail_length_secs<class_GPUParticles3D_property_trail_length_secs>` | ``0.3`` |
| :ref:`float<class_float>` | :ref:`trail_lifetime<class_GPUParticles3D_property_trail_lifetime>` | ``0.3`` |
+-----------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------+
| :ref:`TransformAlign<enum_GPUParticles3D_TransformAlign>` | :ref:`transform_align<class_GPUParticles3D_property_transform_align>` | ``0`` |
+-----------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------+
@@ -209,6 +209,10 @@ Number of particles to emit.
| *Getter* | get_collision_base_size() |
+-----------+--------------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GPUParticles3D_property_draw_order:
@@ -309,6 +313,10 @@ The number of draw passes when rendering particles.
| *Getter* | get_skin() |
+----------+-----------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GPUParticles3D_property_emitting:
@@ -513,6 +521,10 @@ Speed scaling ratio. A value of ``0`` can be used to pause the particles.
| *Getter* | get_sub_emitter() |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GPUParticles3D_property_trail_enabled:
@@ -527,19 +539,27 @@ Speed scaling ratio. A value of ``0`` can be used to pause the particles.
| *Getter* | is_trail_enabled() |
+-----------+--------------------------+
If ``true``, enables particle trails using a mesh skinning system. Designed to work with :ref:`RibbonTrailMesh<class_RibbonTrailMesh>` and :ref:`TubeTrailMesh<class_TubeTrailMesh>`.
\ **Note:** :ref:`BaseMaterial3D.use_particle_trails<class_BaseMaterial3D_property_use_particle_trails>` must also be enabled on the particle mesh's material. Otherwise, setting :ref:`trail_enabled<class_GPUParticles3D_property_trail_enabled>` to ``true`` will have no effect.
\ **Note:** Unlike :ref:`GPUParticles2D<class_GPUParticles2D>`, the number of trail sections and subdivisions is set in the :ref:`RibbonTrailMesh<class_RibbonTrailMesh>` or the :ref:`TubeTrailMesh<class_TubeTrailMesh>`'s properties.
----
.. _class_GPUParticles3D_property_trail_length_secs:
.. _class_GPUParticles3D_property_trail_lifetime:
- :ref:`float<class_float>` **trail_length_secs**
- :ref:`float<class_float>` **trail_lifetime**
+-----------+-------------------------+
| *Default* | ``0.3`` |
+-----------+-------------------------+
| *Setter* | set_trail_length(value) |
+-----------+-------------------------+
| *Getter* | get_trail_length() |
+-----------+-------------------------+
+-----------+---------------------------+
| *Default* | ``0.3`` |
+-----------+---------------------------+
| *Setter* | set_trail_lifetime(value) |
+-----------+---------------------------+
| *Getter* | get_trail_lifetime() |
+-----------+---------------------------+
The amount of time the particle's trail should represent (in seconds). Only effective if :ref:`trail_enabled<class_GPUParticles3D_property_trail_enabled>` is ``true``.
----
@@ -555,6 +575,10 @@ Speed scaling ratio. A value of ``0`` can be used to pause the particles.
| *Getter* | get_transform_align() |
+-----------+----------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GPUParticles3D_property_visibility_aabb:

16
classes/class_gradienttexture1d.rst
View File

@@ -22,13 +22,15 @@ GradientTexture1D uses a :ref:`Gradient<class_Gradient>` to fill the texture dat
Properties
----------
+---------------------------------+------------------------------------------------------------+-----------+
| :ref:`Gradient<class_Gradient>` | :ref:`gradient<class_GradientTexture1D_property_gradient>` | |
+---------------------------------+------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>` | :ref:`use_hdr<class_GradientTexture1D_property_use_hdr>` | ``false`` |
+---------------------------------+------------------------------------------------------------+-----------+
| :ref:`int<class_int>` | :ref:`width<class_GradientTexture1D_property_width>` | ``256`` |
+---------------------------------+------------------------------------------------------------+-----------+
+---------------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Gradient<class_Gradient>` | :ref:`gradient<class_GradientTexture1D_property_gradient>` | |
+---------------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | resource_local_to_scene | ``false`` (overrides :ref:`Resource<class_Resource_property_resource_local_to_scene>`) |
+---------------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`use_hdr<class_GradientTexture1D_property_use_hdr>` | ``false`` |
+---------------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`width<class_GradientTexture1D_property_width>` | ``256`` |
+---------------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+
Property Descriptions
---------------------

36
classes/class_gradienttexture2d.rst
View File

@@ -22,23 +22,25 @@ The texture uses a :ref:`Gradient<class_Gradient>` to fill the texture data in 2
Properties
----------
+----------------------------------------------+--------------------------------------------------------------+-------------------+
| :ref:`Fill<enum_GradientTexture2D_Fill>` | :ref:`fill<class_GradientTexture2D_property_fill>` | ``0`` |
+----------------------------------------------+--------------------------------------------------------------+-------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`fill_from<class_GradientTexture2D_property_fill_from>` | ``Vector2(0, 0)`` |
+----------------------------------------------+--------------------------------------------------------------+-------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`fill_to<class_GradientTexture2D_property_fill_to>` | ``Vector2(1, 0)`` |
+----------------------------------------------+--------------------------------------------------------------+-------------------+
| :ref:`Gradient<class_Gradient>` | :ref:`gradient<class_GradientTexture2D_property_gradient>` | |
+----------------------------------------------+--------------------------------------------------------------+-------------------+
| :ref:`int<class_int>` | :ref:`height<class_GradientTexture2D_property_height>` | ``64`` |
+----------------------------------------------+--------------------------------------------------------------+-------------------+
| :ref:`Repeat<enum_GradientTexture2D_Repeat>` | :ref:`repeat<class_GradientTexture2D_property_repeat>` | ``0`` |
+----------------------------------------------+--------------------------------------------------------------+-------------------+
| :ref:`bool<class_bool>` | :ref:`use_hdr<class_GradientTexture2D_property_use_hdr>` | ``false`` |
+----------------------------------------------+--------------------------------------------------------------+-------------------+
| :ref:`int<class_int>` | :ref:`width<class_GradientTexture2D_property_width>` | ``64`` |
+----------------------------------------------+--------------------------------------------------------------+-------------------+
+----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Fill<enum_GradientTexture2D_Fill>` | :ref:`fill<class_GradientTexture2D_property_fill>` | ``0`` |
+----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`fill_from<class_GradientTexture2D_property_fill_from>` | ``Vector2(0, 0)`` |
+----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`fill_to<class_GradientTexture2D_property_fill_to>` | ``Vector2(1, 0)`` |
+----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Gradient<class_Gradient>` | :ref:`gradient<class_GradientTexture2D_property_gradient>` | |
+----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`height<class_GradientTexture2D_property_height>` | ``64`` |
+----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`Repeat<enum_GradientTexture2D_Repeat>` | :ref:`repeat<class_GradientTexture2D_property_repeat>` | ``0`` |
+----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | resource_local_to_scene | ``false`` (overrides :ref:`Resource<class_Resource_property_resource_local_to_scene>`) |
+----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`use_hdr<class_GradientTexture2D_property_use_hdr>` | ``false`` |
+----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`width<class_GradientTexture2D_property_width>` | ``64`` |
+----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+
Enumerations
------------

12
classes/class_graphedit.rst
View File

@@ -807,6 +807,10 @@ Theme Property Descriptions
| *Default* | ``Color(1, 1, 1, 1)`` |
+-----------+-----------------------+
.. container:: contribute
There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GraphEdit_theme_color_grid_major:
@@ -885,12 +889,20 @@ The horizontal range within which a port can be grabbed (outer side).
- :ref:`Texture2D<class_Texture2D>` **layout**
.. container:: contribute
There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GraphEdit_theme_icon_minimap:
- :ref:`Texture2D<class_Texture2D>` **minimap**
.. container:: contribute
There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GraphEdit_theme_icon_minus:

4
classes/class_graphnode.rst
View File

@@ -721,6 +721,10 @@ Color of the title text.
| *Default* | ``22`` |
+-----------+--------+
.. container:: contribute
There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GraphNode_theme_constant_close_offset:

16
classes/class_gridmap.rst
View File

@@ -346,12 +346,20 @@ Clear all cells.
- void **clear_baked_meshes** **(** **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GridMap_method_get_bake_mesh_instance:
- :ref:`RID<class_RID>` **get_bake_mesh_instance** **(** :ref:`int<class_int>` idx **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GridMap_method_get_bake_meshes:
@@ -472,6 +480,10 @@ Returns the map coordinates of the cell containing the given ``local_position``.
- void **make_baked_meshes** **(** :ref:`bool<class_bool>` gen_lightmap_uv=false, :ref:`float<class_float>` lightmap_uv_texel_size=0.1 **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GridMap_method_map_to_local:
@@ -486,6 +498,10 @@ Returns the position of a grid cell in the GridMap's local coordinate space. To
- void **resource_changed** **(** :ref:`Resource<class_Resource>` resource **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_GridMap_method_set_cell_item:

4
classes/class_hingejoint3d.rst
View File

@@ -197,6 +197,10 @@ The lower this value, the more the rotation gets slowed down.
| *Getter* | get_param() |
+-----------+------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_HingeJoint3D_property_angular_limit/upper:

4
classes/class_hslider.rst
View File

@@ -101,6 +101,10 @@ The background of the area to the left of the grabber.
- :ref:`StyleBox<class_StyleBox>` **grabber_area_highlight**
.. container:: contribute
There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_HSlider_theme_style_slider:

14
classes/class_image.rst
View File

@@ -492,6 +492,10 @@ Method Descriptions
- void **adjust_bcs** **(** :ref:`float<class_float>` brightness, :ref:`float<class_float>` contrast, :ref:`float<class_float>` saturation **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Image_method_blend_rect:
@@ -554,6 +558,10 @@ Compresses the image to use less memory. Can not directly access pixel data whil
- :ref:`Error<enum_@GlobalScope_Error>` **compress_from_channels** **(** :ref:`CompressMode<enum_Image_CompressMode>` mode, :ref:`UsedChannels<enum_Image_UsedChannels>` channels, :ref:`float<class_float>` lossy_quality=0.7 **)**
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Image_method_compute_image_metrics:
@@ -586,7 +594,7 @@ Copies ``src`` image to this image.
- :ref:`Image<class_Image>` **create** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` use_mipmaps, :ref:`Format<enum_Image_Format>` format **)** |static|
Creates an empty image of given size and format. See :ref:`Format<enum_Image_Format>` constants. If ``use_mipmaps`` is ``true`` then generate mipmaps for this image. See the :ref:`generate_mipmaps<class_Image_method_generate_mipmaps>`.
Creates an empty image of given size and format. See :ref:`Format<enum_Image_Format>` constants. If ``use_mipmaps`` is ``true``, then generate mipmaps for this image. See the :ref:`generate_mipmaps<class_Image_method_generate_mipmaps>`.
----
@@ -628,6 +636,10 @@ Returns :ref:`ALPHA_BLEND<class_Image_constant_ALPHA_BLEND>` if the image has da
- :ref:`UsedChannels<enum_Image_UsedChannels>` **detect_used_channels** **(** :ref:`CompressSource<enum_Image_CompressSource>` source=0 **)** |const|
.. container:: contribute
There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_Image_method_fill:

7
classes/class_imagetexture.rst
View File

@@ -52,6 +52,13 @@ Tutorials
- :doc:`Importing images <../tutorials/assets_pipeline/importing_images>`
Properties
----------
+-------------------------+-------------------------+----------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | resource_local_to_scene | ``false`` (overrides :ref:`Resource<class_Resource_property_resource_local_to_scene>`) |
+-------------------------+-------------------------+----------------------------------------------------------------------------------------+
Methods
-------

11
classes/class_imagetexture3d.rst
View File

@@ -12,7 +12,14 @@ ImageTexture3D
**Inherits:** :ref:`Texture3D<class_Texture3D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
Texture with 3 dimensions.
Description
-----------
``ImageTexture3D`` is a 3-dimensional :ref:`ImageTexture<class_ImageTexture>` that has a width, height, and depth. See also :ref:`ImageTextureLayered<class_ImageTextureLayered>`.
3D textures are typically used to store density maps for :ref:`FogMaterial<class_FogMaterial>`, color correction LUTs for :ref:`Environment<class_Environment>`, vector fields for :ref:`GPUParticlesAttractorVectorField3D<class_GPUParticlesAttractorVectorField3D>` and collision maps for :ref:`GPUParticlesCollisionSDF3D<class_GPUParticlesCollisionSDF3D>`. 3D textures can also be used in custom shaders.
Methods
-------
@@ -30,12 +37,16 @@ Method Descriptions
- :ref:`Error<enum_@GlobalScope_Error>` **create** **(** :ref:`Format<enum_Image_Format>` format, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth, :ref:`bool<class_bool>` use_mipmaps, :ref:`Image[]<class_Image>` data **)**
Creates the ``ImageTexture3D`` with specified ``width``, ``height``, and ``depth``. See :ref:`Format<enum_Image_Format>` for ``format`` options. If ``use_mipmaps`` is ``true``, then generate mipmaps for the ``ImageTexture3D``.
----
.. _class_ImageTexture3D_method_update:
- void **update** **(** :ref:`Image[]<class_Image>` data **)**
Replaces the texture's existing data with the layers specified in ``data``. The size of ``data`` must match the parameters that were used for :ref:`create<class_ImageTexture3D_method_create>`. In other words, the texture cannot be resized or have its format changed by calling :ref:`update<class_ImageTexture3D_method_update>`.
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

9
classes/class_imagetexturelayered.rst
View File

@@ -14,7 +14,12 @@ ImageTextureLayered
**Inherited By:** :ref:`Cubemap<class_Cubemap>`, :ref:`CubemapArray<class_CubemapArray>`, :ref:`Texture2DArray<class_Texture2DArray>`
Base class for texture types which contain the data of multiple :ref:`ImageTexture<class_ImageTexture>`\ s. Each image is of the same size and format.
Description
-----------
Base class for :ref:`Texture2DArray<class_Texture2DArray>`, :ref:`Cubemap<class_Cubemap>` and :ref:`CubemapArray<class_CubemapArray>`. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. See also :ref:`Texture3D<class_Texture3D>`.
Methods
-------
@@ -32,7 +37,7 @@ Method Descriptions
- :ref:`Error<enum_@GlobalScope_Error>` **create_from_images** **(** :ref:`Image[]<class_Image>` images **)**
Creates an ``ImageTextureLayered`` from an array of :ref:`Image<class_Image>`\ s. The first image decides the width, height, image format and mipmapping setting. The other images must have the same width, height, image format and mipmapping setting.
Creates an ``ImageTextureLayered`` from an array of :ref:`Image<class_Image>`\ s. See :ref:`Image.create<class_Image_method_create>` for the expected data format. The first image decides the width, height, image format and mipmapping setting. The other images *must* have the same width, height, image format and mipmapping setting.
Each :ref:`Image<class_Image>` represents one ``layer``.
@@ -48,7 +53,7 @@ The given :ref:`Image<class_Image>` must have the same width, height, image form
If the image format is unsupported, it will be decompressed and converted to a similar and supported :ref:`Format<enum_Image_Format>`.
The update is immediate: synced with the draw.
The update is immediate: it's synchronized with drawing.
.. |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.)`

4
classes/class_importermesh.rst
View File

@@ -90,6 +90,10 @@ Property Descriptions
| *Default* | ``{ "surfaces": [] }`` |
+-----------+------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Method Descriptions
-------------------

14
classes/class_importermeshinstance3d.rst
View File

@@ -12,7 +12,9 @@ ImporterMeshInstance3D
**Inherits:** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
@@ -38,6 +40,10 @@ Property Descriptions
| *Getter* | get_mesh() |
+----------+-----------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_ImporterMeshInstance3D_property_skeleton_path:
@@ -52,6 +58,10 @@ Property Descriptions
| *Getter* | get_skeleton_path() |
+-----------+--------------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
----
.. _class_ImporterMeshInstance3D_property_skin:
@@ -64,6 +74,10 @@ Property Descriptions
| *Getter* | get_skin() |
+----------+-----------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

6
classes/class_inputeventfromwindow.rst
View File

@@ -14,7 +14,9 @@ InputEventFromWindow
**Inherited By:** :ref:`InputEventScreenDrag<class_InputEventScreenDrag>`, :ref:`InputEventScreenTouch<class_InputEventScreenTouch>`, :ref:`InputEventWithModifiers<class_InputEventWithModifiers>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
@@ -38,6 +40,10 @@ Property Descriptions
| *Getter* | get_window_id() |
+-----------+----------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

6
classes/class_inputeventmagnifygesture.rst
View File

@@ -12,7 +12,9 @@ InputEventMagnifyGesture
**Inherits:** :ref:`InputEventGesture<class_InputEventGesture>` **<** :ref:`InputEventWithModifiers<class_InputEventWithModifiers>` **<** :ref:`InputEventFromWindow<class_InputEventFromWindow>` **<** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
@@ -36,6 +38,10 @@ Property Descriptions
| *Getter* | get_factor() |
+-----------+-------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

6
classes/class_inputeventpangesture.rst
View File

@@ -12,7 +12,9 @@ InputEventPanGesture
**Inherits:** :ref:`InputEventGesture<class_InputEventGesture>` **<** :ref:`InputEventWithModifiers<class_InputEventWithModifiers>` **<** :ref:`InputEventFromWindow<class_InputEventFromWindow>` **<** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
@@ -36,6 +38,10 @@ Property Descriptions
| *Getter* | get_delta() |
+-----------+-------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

6
classes/class_inputeventshortcut.rst
View File

@@ -12,7 +12,9 @@ InputEventShortcut
**Inherits:** :ref:`InputEvent<class_InputEvent>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
.. container:: contribute
There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
Properties
----------
@@ -34,6 +36,10 @@ Property Descriptions
| *Getter* | get_shortcut() |
+----------+---------------------+
.. container:: contribute
There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
.. |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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`

26
classes/class_int.rst
View File

@@ -57,15 +57,17 @@ It can take values in the interval ``[-2^63, 2^63 - 1]``, i.e. ``[-9223372036854
Constructors
------------
+-----------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`int<class_int_constructor_int>` **(** **)** |
+-----------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`int<class_int_constructor_int>` **(** :ref:`int<class_int>` from **)** |
+-----------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`int<class_int_constructor_int>` **(** :ref:`bool<class_bool>` from **)** |
+-----------------------+----------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`int<class_int_constructor_int>` **(** :ref:`float<class_float>` from **)** |
+-----------------------+----------------------------------------------------------------------------------+
+-----------------------+------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`int<class_int_constructor_int>` **(** **)** |
+-----------------------+------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`int<class_int_constructor_int>` **(** :ref:`int<class_int>` from **)** |
+-----------------------+------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`int<class_int_constructor_int>` **(** :ref:`String<class_String>` from **)** |
+-----------------------+------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`int<class_int_constructor_int>` **(** :ref:`bool<class_bool>` from **)** |
+-----------------------+------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`int<class_int_constructor_int>` **(** :ref:`float<class_float>` from **)** |
+-----------------------+------------------------------------------------------------------------------------+
Operators
---------
@@ -167,6 +169,12 @@ Constructs an ``int`` as a copy of the given ``int``.
----
- :ref:`int<class_int>` **int** **(** :ref:`String<class_String>` from **)**
Converts a :ref:`String<class_String>` to an ``int``, following the same rules as :ref:`String.to_int<class_String_method_to_int>`.
----
- :ref:`int<class_int>` **int** **(** :ref:`bool<class_bool>` from **)**
Cast a :ref:`bool<class_bool>` value to an integer value, ``int(true)`` will be equals to 1 and ``int(false)`` will be equals to 0.

Some files were not shown because too many files have changed in this diff Show More