diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 9a1dbdc9f..3bc97e6d3 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -2181,10 +2181,6 @@ Since :ref:`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` - **PROPERTY_HINT_COLOR_NO_ALPHA** = **21** --- Hints that a :ref:`Color` property should be edited without affecting its transparency (:ref:`Color.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`, allows to set a type from the create dialog. If you need to create an :ref:`Array` to contain elements of a specific type, the ``hint_string`` must encode nested types using ``":"`` and ``"/"`` for specifying :ref:`Resource` types. - -\ **Example:**\ +- **PROPERTY_HINT_TYPE_STRING** = **23** --- Hint that a property represents a particular type. If a property is :ref:`TYPE_STRING`, allows to set a type from the create dialog. If you need to create an :ref:`Array` to contain elements of a specific type, the ``hint_string`` must encode nested types using ``":"`` and ``"/"`` for specifying :ref:`Resource` types. For instance: :: @@ -2306,51 +2296,49 @@ Unlike :ref:`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` 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` 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` 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` 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`. - -- **PROPERTY_HINT_MAX** = **47** --- Represents the size of the :ref:`PropertyHint` enum. +- **PROPERTY_HINT_MAX** = **45** ---- diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index ce7c08c76..546ef8efc 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -28,17 +28,19 @@ The playback of the animation is controlled by the :ref:`speed_scale` | :ref:`current_frame` | | -+---------------------------+--------------------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`frames` | ``1`` | -+---------------------------+--------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`one_shot` | ``false`` | -+---------------------------+--------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`pause` | ``false`` | -+---------------------------+--------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`speed_scale` | ``1.0`` | -+---------------------------+--------------------------------------------------------------------+-----------+ ++---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`current_frame` | | ++---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`frames` | ``1`` | ++---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`one_shot` | ``false`` | ++---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`pause` | ``false`` | ++---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | ++---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`speed_scale` | ``1.0`` | ++---------------------------+--------------------------------------------------------------------+----------------------------------------------------------------------------------------+ Methods ------- diff --git a/classes/class_animationlibrary.rst b/classes/class_animationlibrary.rst index 54e247d57..be3663b25 100644 --- a/classes/class_animationlibrary.rst +++ b/classes/class_animationlibrary.rst @@ -84,6 +84,10 @@ Property Descriptions | *Default* | ``{}`` | +-----------+--------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + Method Descriptions ------------------- diff --git a/classes/class_animationnodeoneshot.rst b/classes/class_animationnodeoneshot.rst index 6b0de5be7..015ec8227 100644 --- a/classes/class_animationnodeoneshot.rst +++ b/classes/class_animationnodeoneshot.rst @@ -121,6 +121,10 @@ If :ref:`autorestart` is ``true | *Getter* | get_fadein_time() | +-----------+------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_AnimationNodeOneShot_property_fadeout_time: @@ -135,6 +139,10 @@ If :ref:`autorestart` is ``true | *Getter* | get_fadeout_time() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_AnimationNodeOneShot_property_mix_mode: @@ -149,6 +157,10 @@ If :ref:`autorestart` is ``true | *Getter* | get_mix_mode() | +-----------+---------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index a5ed910eb..a89d9ad70 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -219,6 +219,10 @@ Renames the given node. - void **replace_node** **(** :ref:`StringName` name, :ref:`AnimationNode` node **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AnimationNodeStateMachine_method_set_graph_offset: diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index 2726073b5..8e89135a0 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -76,6 +76,10 @@ Method Descriptions - :ref:`float` **get_current_length** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AnimationNodeStateMachinePlayback_method_get_current_node: diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index a97b6f7fd..160bede54 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -12,7 +12,9 @@ AnimationNodeStateMachineTransition **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Tutorials --------- diff --git a/classes/class_animationnodesync.rst b/classes/class_animationnodesync.rst index 18ef5d8e9..7e22fbbb2 100644 --- a/classes/class_animationnodesync.rst +++ b/classes/class_animationnodesync.rst @@ -14,7 +14,9 @@ AnimationNodeSync **Inherited By:** :ref:`AnimationNodeAdd2`, :ref:`AnimationNodeAdd3`, :ref:`AnimationNodeBlend2`, :ref:`AnimationNodeBlend3`, :ref:`AnimationNodeOneShot`, :ref:`AnimationNodeTransition` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- diff --git a/classes/class_animationnodetransition.rst b/classes/class_animationnodetransition.rst index c0700bbef..a94eac241 100644 --- a/classes/class_animationnodetransition.rst +++ b/classes/class_animationnodetransition.rst @@ -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 `! + ---- .. _class_AnimationNodeTransition_property_xfade_time: @@ -122,24 +126,40 @@ Method Descriptions - :ref:`String` **get_input_caption** **(** :ref:`int` input **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AnimationNodeTransition_method_is_input_set_as_auto_advance: - :ref:`bool` **is_input_set_as_auto_advance** **(** :ref:`int` input **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AnimationNodeTransition_method_set_input_as_auto_advance: - void **set_input_as_auto_advance** **(** :ref:`int` input, :ref:`bool` enable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AnimationNodeTransition_method_set_input_caption: - void **set_input_caption** **(** :ref:`int` input, :ref:`String` caption **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_animationrootnode.rst b/classes/class_animationrootnode.rst index a347daaf4..c85d0ec19 100644 --- a/classes/class_animationrootnode.rst +++ b/classes/class_animationrootnode.rst @@ -14,7 +14,9 @@ AnimationRootNode **Inherited By:** :ref:`AnimationNodeAnimation`, :ref:`AnimationNodeBlendSpace1D`, :ref:`AnimationNodeBlendSpace2D`, :ref:`AnimationNodeBlendTree`, :ref:`AnimationNodeStateMachine` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_animationtrackeditplugin.rst b/classes/class_animationtrackeditplugin.rst index 96ca6b585..591ceec66 100644 --- a/classes/class_animationtrackeditplugin.rst +++ b/classes/class_animationtrackeditplugin.rst @@ -12,7 +12,9 @@ AnimationTrackEditPlugin **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index d7d1ffa7b..21574c469 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -204,6 +204,10 @@ Retrieve the motion of the :ref:`root_motion_track` old_name, :ref:`String` new_name **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 33b92bcdb..0d21539c8 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -44,10 +44,12 @@ The most basic example is the creation of a single triangle: .. code-tab:: csharp - var vertices = new Godot.Collections.Array(); - 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` 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 `! + Method Descriptions ------------------- @@ -311,18 +317,30 @@ Sets a name for a given surface. - void **surface_update_attribute_region** **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ArrayMesh_method_surface_update_skin_region: - void **surface_update_skin_region** **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ArrayMesh_method_surface_update_vertex_region: - void **surface_update_vertex_region** **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_arrayoccluder3d.rst b/classes/class_arrayoccluder3d.rst index 9b08cc465..4f1e3df26 100644 --- a/classes/class_arrayoccluder3d.rst +++ b/classes/class_arrayoccluder3d.rst @@ -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 `! + ---- .. _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 `! + Method Descriptions ------------------- @@ -73,6 +81,10 @@ Method Descriptions - void **set_arrays** **(** :ref:`PackedVector3Array` vertices, :ref:`PackedInt32Array` indices **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index e73d410a9..e13362d23 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -26,15 +26,17 @@ Multiple ``AtlasTexture`` resources can be cropped from the same :ref:`atlas` | :ref:`atlas` | | -+-----------------------------------+-------------------------------------------------------------+-----------------------+ -| :ref:`bool` | :ref:`filter_clip` | ``false`` | -+-----------------------------------+-------------------------------------------------------------+-----------------------+ -| :ref:`Rect2` | :ref:`margin` | ``Rect2(0, 0, 0, 0)`` | -+-----------------------------------+-------------------------------------------------------------+-----------------------+ -| :ref:`Rect2` | :ref:`region` | ``Rect2(0, 0, 0, 0)`` | -+-----------------------------------+-------------------------------------------------------------+-----------------------+ ++-----------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`atlas` | | ++-----------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`filter_clip` | ``false`` | ++-----------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`margin` | ``Rect2(0, 0, 0, 0)`` | ++-----------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`region` | ``Rect2(0, 0, 0, 0)`` | ++-----------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | ++-----------------------------------+-------------------------------------------------------------+----------------------------------------------------------------------------------------+ Property Descriptions --------------------- diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index cc85cf607..b184d5b48 100644 --- a/classes/class_audioeffect.rst +++ b/classes/class_audioeffect.rst @@ -40,6 +40,10 @@ Method Descriptions - :ref:`AudioEffectInstance` **_instantiate** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_audioeffectchorus.rst b/classes/class_audioeffectchorus.rst index 638ee8b42..49f1b6b5c 100644 --- a/classes/class_audioeffectchorus.rst +++ b/classes/class_audioeffectchorus.rst @@ -528,72 +528,120 @@ Method Descriptions - :ref:`float` **get_voice_cutoff_hz** **(** :ref:`int` voice_idx **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioEffectChorus_method_get_voice_delay_ms: - :ref:`float` **get_voice_delay_ms** **(** :ref:`int` voice_idx **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioEffectChorus_method_get_voice_depth_ms: - :ref:`float` **get_voice_depth_ms** **(** :ref:`int` voice_idx **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioEffectChorus_method_get_voice_level_db: - :ref:`float` **get_voice_level_db** **(** :ref:`int` voice_idx **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioEffectChorus_method_get_voice_pan: - :ref:`float` **get_voice_pan** **(** :ref:`int` voice_idx **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioEffectChorus_method_get_voice_rate_hz: - :ref:`float` **get_voice_rate_hz** **(** :ref:`int` voice_idx **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioEffectChorus_method_set_voice_cutoff_hz: - void **set_voice_cutoff_hz** **(** :ref:`int` voice_idx, :ref:`float` cutoff_hz **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioEffectChorus_method_set_voice_delay_ms: - void **set_voice_delay_ms** **(** :ref:`int` voice_idx, :ref:`float` delay_ms **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioEffectChorus_method_set_voice_depth_ms: - void **set_voice_depth_ms** **(** :ref:`int` voice_idx, :ref:`float` depth_ms **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioEffectChorus_method_set_voice_level_db: - void **set_voice_level_db** **(** :ref:`int` voice_idx, :ref:`float` level_db **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioEffectChorus_method_set_voice_pan: - void **set_voice_pan** **(** :ref:`int` voice_idx, :ref:`float` pan **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioEffectChorus_method_set_voice_rate_hz: - void **set_voice_rate_hz** **(** :ref:`int` voice_idx, :ref:`float` rate_hz **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_audioeffectfilter.rst b/classes/class_audioeffectfilter.rst index 564e232c5..96bb0d925 100644 --- a/classes/class_audioeffectfilter.rst +++ b/classes/class_audioeffectfilter.rst @@ -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 `! + ---- .. _class_AudioEffectFilter_property_gain: diff --git a/classes/class_audioeffectinstance.rst b/classes/class_audioeffectinstance.rst index aae5123c7..1039ab004 100644 --- a/classes/class_audioeffectinstance.rst +++ b/classes/class_audioeffectinstance.rst @@ -14,7 +14,9 @@ AudioEffectInstance **Inherited By:** :ref:`AudioEffectSpectrumAnalyzerInstance` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -32,12 +34,20 @@ Method Descriptions - void **_process** **(** const void* src_buffer, AudioFrame* dst_buffer, :ref:`int` frame_count **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioEffectInstance_method__process_silence: - :ref:`bool` **_process_silence** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index adb861731..fb7234177 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -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 `! + ---- .. _class_AudioEffectLimiter_property_threshold_db: diff --git a/classes/class_audioeffectspectrumanalyzer.rst b/classes/class_audioeffectspectrumanalyzer.rst index 43434e90b..7ee49c95d 100644 --- a/classes/class_audioeffectspectrumanalyzer.rst +++ b/classes/class_audioeffectspectrumanalyzer.rst @@ -117,6 +117,10 @@ The size of the `Fast Fourier transform `! + .. |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.)` diff --git a/classes/class_audioeffectspectrumanalyzerinstance.rst b/classes/class_audioeffectspectrumanalyzerinstance.rst index 9b37f894f..9d7edeb30 100644 --- a/classes/class_audioeffectspectrumanalyzerinstance.rst +++ b/classes/class_audioeffectspectrumanalyzerinstance.rst @@ -12,7 +12,9 @@ AudioEffectSpectrumAnalyzerInstance **Inherits:** :ref:`AudioEffectInstance` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -43,6 +45,10 @@ Method Descriptions - :ref:`Vector2` **get_magnitude_for_frequency_range** **(** :ref:`float` from_hz, :ref:`float` to_hz, :ref:`MagnitudeMode` mode=1 **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_audioeffectstereoenhance.rst b/classes/class_audioeffectstereoenhance.rst index 5cddeab8e..3fec073af 100644 --- a/classes/class_audioeffectstereoenhance.rst +++ b/classes/class_audioeffectstereoenhance.rst @@ -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 `! + ---- .. _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 `! + .. |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.)` diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index f2f6c684b..34f5e47b7 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -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` enable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioServer_method_swap_bus_effects: diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index 123429600..f6835f0d7 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -62,36 +62,60 @@ Method Descriptions - :ref:`int` **_get_beat_count** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioStream_method__get_bpm: - :ref:`float` **_get_bpm** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioStream_method__get_length: - :ref:`float` **_get_length** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioStream_method__get_stream_name: - :ref:`String` **_get_stream_name** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioStream_method__instantiate_playback: - :ref:`AudioStreamPlayback` **_instantiate_playback** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioStream_method__is_monophonic: - :ref:`bool` **_is_monophonic** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioStream_method_get_length: diff --git a/classes/class_audiostreamgeneratorplayback.rst b/classes/class_audiostreamgeneratorplayback.rst index 8c83d70c3..0e4e2f835 100644 --- a/classes/class_audiostreamgeneratorplayback.rst +++ b/classes/class_audiostreamgeneratorplayback.rst @@ -74,6 +74,10 @@ Returns the number of frames that can be pushed to the audio sample data buffer - :ref:`int` **get_skips** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioStreamGeneratorPlayback_method_push_buffer: diff --git a/classes/class_audiostreammp3.rst b/classes/class_audiostreammp3.rst index 9173d2b20..24684ca83 100644 --- a/classes/class_audiostreammp3.rst +++ b/classes/class_audiostreammp3.rst @@ -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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _class_AudioStreamMP3_property_data: diff --git a/classes/class_audiostreamoggvorbis.rst b/classes/class_audiostreamoggvorbis.rst index c4664b6fd..5ff1e2109 100644 --- a/classes/class_audiostreamoggvorbis.rst +++ b/classes/class_audiostreamoggvorbis.rst @@ -12,7 +12,9 @@ AudioStreamOggVorbis **Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _class_AudioStreamOggVorbis_property_loop: diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index fd2be8cac..a795f0bff 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -54,48 +54,80 @@ Method Descriptions - :ref:`int` **_get_loop_count** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioStreamPlayback_method__get_playback_position: - :ref:`float` **_get_playback_position** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioStreamPlayback_method__is_playing: - :ref:`bool` **_is_playing** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioStreamPlayback_method__mix: - :ref:`int` **_mix** **(** AudioFrame* buffer, :ref:`float` rate_scale, :ref:`int` frames **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioStreamPlayback_method__seek: - void **_seek** **(** :ref:`float` position **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioStreamPlayback_method__start: - void **_start** **(** :ref:`float` from_pos **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioStreamPlayback_method__stop: - void **_stop** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _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 `! + .. |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.)` diff --git a/classes/class_audiostreamplaybackoggvorbis.rst b/classes/class_audiostreamplaybackoggvorbis.rst index 181eff4ff..62806a3f1 100644 --- a/classes/class_audiostreamplaybackoggvorbis.rst +++ b/classes/class_audiostreamplaybackoggvorbis.rst @@ -12,7 +12,9 @@ AudioStreamPlaybackOggVorbis **Inherits:** :ref:`AudioStreamPlaybackResampled` **<** :ref:`AudioStreamPlayback` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_audiostreamplaybackresampled.rst b/classes/class_audiostreamplaybackresampled.rst index 2f974d75f..4e13d5201 100644 --- a/classes/class_audiostreamplaybackresampled.rst +++ b/classes/class_audiostreamplaybackresampled.rst @@ -14,7 +14,9 @@ AudioStreamPlaybackResampled **Inherited By:** :ref:`AudioStreamGeneratorPlayback`, :ref:`AudioStreamPlaybackOggVorbis` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -34,18 +36,30 @@ Method Descriptions - :ref:`float` **_get_stream_sampling_rate** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_AudioStreamPlaybackResampled_method__mix_resampled: - :ref:`int` **_mix_resampled** **(** AudioFrame* dst_buffer, :ref:`int` frame_count **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _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 `! + .. |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.)` diff --git a/classes/class_basematerial3d.rst b/classes/class_basematerial3d.rst index 20e71bf83..21d8581a3 100644 --- a/classes/class_basematerial3d.rst +++ b/classes/class_basematerial3d.rst @@ -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. @@ -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`. + +- **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. diff --git a/classes/class_cameratexture.rst b/classes/class_cameratexture.rst index 1c2b92bf0..7d081bce0 100644 --- a/classes/class_cameratexture.rst +++ b/classes/class_cameratexture.rst @@ -24,13 +24,15 @@ This texture gives access to the camera texture provided by a :ref:`CameraFeed` | :ref:`camera_feed_id` | ``0`` | -+-----------------------------------------------+------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`camera_is_active` | ``false`` | -+-----------------------------------------------+------------------------------------------------------------------------+-----------+ -| :ref:`FeedImage` | :ref:`which_feed` | ``0`` | -+-----------------------------------------------+------------------------------------------------------------------------+-----------+ ++-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`camera_feed_id` | ``0`` | ++-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`camera_is_active` | ``false`` | ++-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | ++-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`FeedImage` | :ref:`which_feed` | ``0`` | ++-----------------------------------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ Property Descriptions --------------------- diff --git a/classes/class_canvasgroup.rst b/classes/class_canvasgroup.rst index 52019064d..3221568a1 100644 --- a/classes/class_canvasgroup.rst +++ b/classes/class_canvasgroup.rst @@ -12,7 +12,9 @@ CanvasGroup **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + ---- .. _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 `! + ---- .. _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 `! + .. |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.)` diff --git a/classes/class_canvastexture.rst b/classes/class_canvastexture.rst index c7b0cc26c..becd2bc4f 100644 --- a/classes/class_canvastexture.rst +++ b/classes/class_canvastexture.rst @@ -24,21 +24,23 @@ Description Properties ---------- -+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ -| :ref:`Texture2D` | :ref:`diffuse_texture` | | -+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ -| :ref:`Texture2D` | :ref:`normal_texture` | | -+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ -| :ref:`Color` | :ref:`specular_color` | ``Color(1, 1, 1, 1)`` | -+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ -| :ref:`float` | :ref:`specular_shininess` | ``1.0`` | -+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ -| :ref:`Texture2D` | :ref:`specular_texture` | | -+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ -| :ref:`TextureFilter` | :ref:`texture_filter` | ``0`` | -+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ -| :ref:`TextureRepeat` | :ref:`texture_repeat` | ``0`` | -+-----------------------------------------------------+----------------------------------------------------------------------------+-----------------------+ ++-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`diffuse_texture` | | ++-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`normal_texture` | | ++-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | ++-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`specular_color` | ``Color(1, 1, 1, 1)`` | ++-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`specular_shininess` | ``1.0`` | ++-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`specular_texture` | | ++-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`TextureFilter` | :ref:`texture_filter` | ``0`` | ++-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`TextureRepeat` | :ref:`texture_repeat` | ``0`` | ++-----------------------------------------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ Property Descriptions --------------------- diff --git a/classes/class_characterbody2d.rst b/classes/class_characterbody2d.rst index 1a3f89199..c262ef54a 100644 --- a/classes/class_characterbody2d.rst +++ b/classes/class_characterbody2d.rst @@ -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 `__ diff --git a/classes/class_compressedcubemap.rst b/classes/class_compressedcubemap.rst index eb595d35a..f4a3f6066 100644 --- a/classes/class_compressedcubemap.rst +++ b/classes/class_compressedcubemap.rst @@ -12,7 +12,26 @@ CompressedCubemap **Inherits:** :ref:`CompressedTextureLayered` **<** :ref:`TextureLayered` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`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` 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.)` diff --git a/classes/class_compressedcubemaparray.rst b/classes/class_compressedcubemaparray.rst index 25da547c6..bd315daab 100644 --- a/classes/class_compressedcubemaparray.rst +++ b/classes/class_compressedcubemaparray.rst @@ -12,7 +12,26 @@ CompressedCubemapArray **Inherits:** :ref:`CompressedTextureLayered` **<** :ref:`TextureLayered` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`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` 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.)` diff --git a/classes/class_compressedtexture2d.rst b/classes/class_compressedtexture2d.rst index a1ca33241..ecf15b082 100644 --- a/classes/class_compressedtexture2d.rst +++ b/classes/class_compressedtexture2d.rst @@ -12,19 +12,33 @@ CompressedTexture2D **Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`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` | :ref:`load_path` | ``""`` | -+-----------------------------+----------------------------------------------------------------+--------+ ++-----------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`load_path` | ``""`` | ++-----------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | ++-----------------------------+----------------------------------------------------------------+----------------------------------------------------------------------------------------+ 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` **load** **(** :ref:`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.)` diff --git a/classes/class_compressedtexture2darray.rst b/classes/class_compressedtexture2darray.rst index 89af0bd63..e3b203e17 100644 --- a/classes/class_compressedtexture2darray.rst +++ b/classes/class_compressedtexture2darray.rst @@ -12,7 +12,26 @@ CompressedTexture2DArray **Inherits:** :ref:`CompressedTextureLayered` **<** :ref:`TextureLayered` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`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` 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.)` diff --git a/classes/class_compressedtexture3d.rst b/classes/class_compressedtexture3d.rst index a1c4fe868..1cba04160 100644 --- a/classes/class_compressedtexture3d.rst +++ b/classes/class_compressedtexture3d.rst @@ -12,7 +12,16 @@ CompressedTexture3D **Inherits:** :ref:`Texture3D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +Texture with 3 dimensions, optionally compressed. +Description +----------- + +``CompressedTexture3D`` is the VRAM-compressed counterpart of :ref:`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` 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` **load** **(** :ref:`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.)` diff --git a/classes/class_compressedtexturelayered.rst b/classes/class_compressedtexturelayered.rst index f2fbb1d4f..1a880aebd 100644 --- a/classes/class_compressedtexturelayered.rst +++ b/classes/class_compressedtexturelayered.rst @@ -14,7 +14,24 @@ CompressedTextureLayered **Inherited By:** :ref:`CompressedCubemap`, :ref:`CompressedCubemapArray`, :ref:`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` 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` **load** **(** :ref:`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.)` diff --git a/classes/class_conetwistjoint3d.rst b/classes/class_conetwistjoint3d.rst index 926c49aef..890227d5f 100644 --- a/classes/class_conetwistjoint3d.rst +++ b/classes/class_conetwistjoint3d.rst @@ -186,12 +186,20 @@ Method Descriptions - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ConeTwistJoint3D_method_set_param: - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_control.rst b/classes/class_control.rst index 8ca9ae999..cc95bece9 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -12,7 +12,7 @@ Control **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`BaseButton`, :ref:`ColorRect`, :ref:`Container`, :ref:`EditorDebuggerPlugin`, :ref:`GraphEdit`, :ref:`ItemList`, :ref:`Label`, :ref:`LineEdit`, :ref:`MenuBar`, :ref:`NinePatchRect`, :ref:`Panel`, :ref:`Range`, :ref:`ReferenceRect`, :ref:`RichTextLabel`, :ref:`Separator`, :ref:`TabBar`, :ref:`TextEdit`, :ref:`TextureRect`, :ref:`Tree`, :ref:`VideoStreamPlayer` +**Inherited By:** :ref:`BaseButton`, :ref:`ColorRect`, :ref:`Container`, :ref:`GraphEdit`, :ref:`ItemList`, :ref:`Label`, :ref:`LineEdit`, :ref:`MenuBar`, :ref:`NinePatchRect`, :ref:`Panel`, :ref:`Range`, :ref:`ReferenceRect`, :ref:`RichTextLabel`, :ref:`Separator`, :ref:`TabBar`, :ref:`TextEdit`, :ref:`TextureRect`, :ref:`Tree`, :ref:`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` | :ref:`layout_direction` | ``0`` | +------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ +| :ref:`bool` | :ref:`localize_numeral_system` | ``true`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ | :ref:`CursorShape` | :ref:`mouse_default_cursor_shape` | ``0`` | +------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ | :ref:`MouseFilter` | :ref:`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` **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` and :ref:`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_Control_property_mouse_default_cursor_shape: - :ref:`CursorShape` **mouse_default_cursor_shape** @@ -1216,7 +1236,7 @@ The node's rotation around its pivot, in radians. See :ref:`pivot_offset`. Change this property to scale the node around its :ref:`pivot_offset`. The Control's :ref:`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` 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` property. diff --git a/classes/class_cubemap.rst b/classes/class_cubemap.rst index bb43ddf40..cc77c2414 100644 --- a/classes/class_cubemap.rst +++ b/classes/class_cubemap.rst @@ -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`) 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`). 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`. You can use `this tool `__ to convert a cubemap to an equirectangular sky map. diff --git a/classes/class_cubemaparray.rst b/classes/class_cubemaparray.rst index f8463accd..d5156d187 100644 --- a/classes/class_cubemaparray.rst +++ b/classes/class_cubemaparray.rst @@ -19,9 +19,11 @@ Description ``CubemapArray``\ s are made of an array of :ref:`Cubemap`\ s. Accordingly, like :ref:`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`\ s into a shader using a single ``CubemapArray``. -Generally, ``CubemapArray``\ s provide a more efficient way for storing multiple :ref:`Cubemap`\ s, than storing multiple :ref:`Cubemap`\ s themselves in an array. +Generally, ``CubemapArray``\ s provide a more efficient way for storing multiple :ref:`Cubemap`\ s compared to storing multiple :ref:`Cubemap`\ s themselves in an array. -Internally Godot, uses ``CubemapArray``\ s for many effects including the :ref:`Sky`, if you set :ref:`ProjectSettings.rendering/reflections/sky_reflections/texture_array_reflections` to ``true``. +Internally, Godot uses ``CubemapArray``\ s for many effects including the :ref:`Sky`, if you set :ref:`ProjectSettings.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. diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 7798b8f52..3adf2379e 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -24,13 +24,15 @@ If you need to store up to 3 curves within a single texture, use :ref:`CurveXYZT Properties ---------- -+---------------------------------------------------+---------------------------------------------------------------+---------+ -| :ref:`Curve` | :ref:`curve` | | -+---------------------------------------------------+---------------------------------------------------------------+---------+ -| :ref:`TextureMode` | :ref:`texture_mode` | ``0`` | -+---------------------------------------------------+---------------------------------------------------------------+---------+ -| :ref:`int` | :ref:`width` | ``256`` | -+---------------------------------------------------+---------------------------------------------------------------+---------+ ++---------------------------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`curve` | | ++---------------------------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | ++---------------------------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`TextureMode` | :ref:`texture_mode` | ``0`` | ++---------------------------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`width` | ``256`` | ++---------------------------------------------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------+ Enumerations ------------ diff --git a/classes/class_curvexyztexture.rst b/classes/class_curvexyztexture.rst index 06596794f..d62624a86 100644 --- a/classes/class_curvexyztexture.rst +++ b/classes/class_curvexyztexture.rst @@ -24,15 +24,17 @@ If you only need to store one curve within a single texture, use :ref:`CurveText Properties ---------- -+---------------------------+--------------------------------------------------------+---------+ -| :ref:`Curve` | :ref:`curve_x` | | -+---------------------------+--------------------------------------------------------+---------+ -| :ref:`Curve` | :ref:`curve_y` | | -+---------------------------+--------------------------------------------------------+---------+ -| :ref:`Curve` | :ref:`curve_z` | | -+---------------------------+--------------------------------------------------------+---------+ -| :ref:`int` | :ref:`width` | ``256`` | -+---------------------------+--------------------------------------------------------+---------+ ++---------------------------+--------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`curve_x` | | ++---------------------------+--------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`curve_y` | | ++---------------------------+--------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`curve_z` | | ++---------------------------+--------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | ++---------------------------+--------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`width` | ``256`` | ++---------------------------+--------------------------------------------------------+----------------------------------------------------------------------------------------+ Property Descriptions --------------------- diff --git a/classes/class_directionallight2d.rst b/classes/class_directionallight2d.rst index ce668e8b2..2b730cdd8 100644 --- a/classes/class_directionallight2d.rst +++ b/classes/class_directionallight2d.rst @@ -12,7 +12,12 @@ DirectionalLight2D **Inherits:** :ref:`Light2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +Directional light from a distance. +Description +----------- + +A directional light is a type of :ref:`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.)` diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index 2ad3fb32c..39c56a8aa 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -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`. +- **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`. -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: diff --git a/classes/class_editordebuggerplugin.rst b/classes/class_editordebuggerplugin.rst index 17a3e11d2..ff0735b80 100644 --- a/classes/class_editordebuggerplugin.rst +++ b/classes/class_editordebuggerplugin.rst @@ -10,7 +10,7 @@ EditorDebuggerPlugin ==================== -**Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`RefCounted` **<** :ref:`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` 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`. + +Once added, the :ref:`_setup_session` callback will be called for every :ref:`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`\ s via :ref:`get_sessions` or get a specific one via :ref:`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` method first. Methods ------- -+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_capture` **(** :ref:`StringName` name **)** | -+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_breaked` **(** **)** | -+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_debuggable` **(** **)** | -+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_session_active` **(** **)** | -+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`register_message_capture` **(** :ref:`StringName` name, :ref:`Callable` callable **)** | -+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`send_message` **(** :ref:`String` message, :ref:`Array` data **)** | -+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unregister_message_capture` **(** :ref:`StringName` name **)** | -+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Signals -------- - -.. _class_EditorDebuggerPlugin_signal_breaked: - -- **breaked** **(** :ref:`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` | :ref:`_capture` **(** :ref:`String` message, :ref:`Array` data, :ref:`int` session_id **)** |virtual| | ++-----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_has_capture` **(** :ref:`String` capture **)** |virtual| |const| | ++-----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_setup_session` **(** :ref:`int` session_id **)** |virtual| | ++-----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorDebuggerSession` | :ref:`get_session` **(** :ref:`int` id **)** | ++-----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_sessions` **(** **)** | ++-----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- -.. _class_EditorDebuggerPlugin_method_has_capture: +.. _class_EditorDebuggerPlugin_method__capture: -- :ref:`bool` **has_capture** **(** :ref:`StringName` name **)** +- :ref:`bool` **_capture** **(** :ref:`String` message, :ref:`Array` data, :ref:`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` that received the message (which you can retrieve via :ref:`get_session`). ---- -.. _class_EditorDebuggerPlugin_method_is_breaked: +.. _class_EditorDebuggerPlugin_method__has_capture: -- :ref:`bool` **is_breaked** **(** **)** +- :ref:`bool` **_has_capture** **(** :ref:`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` method. ---- -.. _class_EditorDebuggerPlugin_method_is_debuggable: +.. _class_EditorDebuggerPlugin_method__setup_session: -- :ref:`bool` **is_debuggable** **(** **)** +- void **_setup_session** **(** :ref:`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` is created (the session may be inactive during this stage). ---- -.. _class_EditorDebuggerPlugin_method_is_session_active: +.. _class_EditorDebuggerPlugin_method_get_session: -- :ref:`bool` **is_session_active** **(** **)** +- :ref:`EditorDebuggerSession` **get_session** **(** :ref:`int` id **)** -Returns ``true`` if there is an instance of the game running with the attached debugger otherwise ``false``. +Returns the :ref:`EditorDebuggerSession` with the given ``id``. ---- -.. _class_EditorDebuggerPlugin_method_register_message_capture: +.. _class_EditorDebuggerPlugin_method_get_sessions: -- void **register_message_capture** **(** :ref:`StringName` name, :ref:`Callable` callable **)** +- :ref:`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` 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` message, :ref:`Array` data **)** - -Sends a message with given ``message`` and ``data`` array. - ----- - -.. _class_EditorDebuggerPlugin_method_unregister_message_capture: - -- void **unregister_message_capture** **(** :ref:`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` .. |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.)` diff --git a/classes/class_editordebuggersession.rst b/classes/class_editordebuggersession.rst new file mode 100644 index 000000000..8d83bae56 --- /dev/null +++ b/classes/class_editordebuggersession.rst @@ -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` **<** :ref:`Object` + +A class to interact with the editor debugger. + +Description +----------- + +This class cannot be directly instantiated and must be retrieved via a :ref:`EditorDebuggerPlugin`. + +You can add tabs to the session UI via :ref:`add_session_tab`, send messages via :ref:`send_message`, and toggle :ref:`EngineProfiler`\ s via :ref:`toggle_profiler`. + +Methods +------- + ++-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_session_tab` **(** :ref:`Control` control **)** | ++-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** | ++-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_breaked` **(** **)** | ++-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_debuggable` **(** **)** | ++-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_session_tab` **(** :ref:`Control` control **)** | ++-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`send_message` **(** :ref:`String` message, :ref:`Array` data=[] **)** | ++-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`toggle_profiler` **(** :ref:`String` profiler, :ref:`bool` enable, :ref:`Array` data=[] **)** | ++-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_EditorDebuggerSession_signal_breaked: + +- **breaked** **(** :ref:`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` control **)** + +Adds the given ``control`` to the debug session UI in the debugger bottom panel. + +---- + +.. _class_EditorDebuggerSession_method_is_active: + +- :ref:`bool` **is_active** **(** **)** + +Returns ``true`` if the debug session is currently attached to a remote instance. + +---- + +.. _class_EditorDebuggerSession_method_is_breaked: + +- :ref:`bool` **is_breaked** **(** **)** + +Returns ``true`` if the attached remote instance is currently in the debug loop. + +---- + +.. _class_EditorDebuggerSession_method_is_debuggable: + +- :ref:`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` 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` message, :ref:`Array` data=[] **)** + +Sends the given ``message`` to the attached remote instance, optionally passing additionally ``data``. See :ref:`EngineDebugger` for how to retrieve those messages. + +---- + +.. _class_EditorDebuggerSession_method_toggle_profiler: + +- void **toggle_profiler** **(** :ref:`String` profiler, :ref:`bool` enable, :ref:`Array` data=[] **)** + +Toggle the given ``profiler`` on the attached remote instance, optionally passing additionally ``data``. See :ref:`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.)` diff --git a/classes/class_editorexportplatform.rst b/classes/class_editorexportplatform.rst index 7b1de8df4..0a71f3869 100644 --- a/classes/class_editorexportplatform.rst +++ b/classes/class_editorexportplatform.rst @@ -12,7 +12,9 @@ EditorExportPlatform **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index 6f2f7557f..fb7fcf4c4 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -42,6 +42,8 @@ Methods +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorCommandPalette` | :ref:`get_command_palette` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_current_directory` **(** **)** |const| | ++-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_current_path` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | @@ -68,7 +70,7 @@ Methods +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_selected_path` **(** **)** |const| | +| :ref:`PackedStringArray` | :ref:`get_selected_paths` **(** **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorSelection` | :ref:`get_selection` **(** **)** | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -171,6 +173,14 @@ Returns the editor's :ref:`EditorCommandPalette` ins ---- +.. _class_EditorInterface_method_get_current_directory: + +- :ref:`String` **get_current_directory** **(** **)** |const| + +Returns the current directory being viewed in the :ref:`FileSystemDock`. If a file is selected, its base directory will be returned using :ref:`String.get_base_dir` instead. + +---- + .. _class_EditorInterface_method_get_current_path: - :ref:`String` **get_current_path** **(** **)** |const| @@ -285,11 +295,11 @@ Returns the editor's :ref:`ScriptEditor` instance. ---- -.. _class_EditorInterface_method_get_selected_path: +.. _class_EditorInterface_method_get_selected_paths: -- :ref:`String` **get_selected_path** **(** **)** |const| +- :ref:`PackedStringArray` **get_selected_paths** **(** **)** |const| -Returns the path of the directory currently selected in the :ref:`FileSystemDock`. If a file is selected, its base directory will be returned using :ref:`String.get_base_dir` instead. +Returns an array containing the paths of the currently selected files (and directories) in the :ref:`FileSystemDock`. ---- diff --git a/classes/class_editornode3dgizmoplugin.rst b/classes/class_editornode3dgizmoplugin.rst index 4288199fc..46fc9688f 100644 --- a/classes/class_editornode3dgizmoplugin.rst +++ b/classes/class_editornode3dgizmoplugin.rst @@ -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 ------- diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index c6d4a518f..405a0578e 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -84,7 +84,7 @@ Methods +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_custom_type` **(** :ref:`String` type, :ref:`String` base, :ref:`Script` script, :ref:`Texture2D` icon **)** | +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_debugger_plugin` **(** :ref:`Script` script **)** | +| void | :ref:`add_debugger_plugin` **(** :ref:`EditorDebuggerPlugin` script **)** | +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_export_plugin` **(** :ref:`EditorExportPlugin` plugin **)** | +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -130,7 +130,7 @@ Methods +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_custom_type` **(** :ref:`String` type **)** | +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_debugger_plugin` **(** :ref:`Script` script **)** | +| void | :ref:`remove_debugger_plugin` **(** :ref:`EditorDebuggerPlugin` script **)** | +-----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_export_plugin` **(** :ref:`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` script **)** +- void **add_debugger_plugin** **(** :ref:`EditorDebuggerPlugin` script **)** Adds a :ref:`Script` as debugger plugin to the Debugger. The script must extend :ref:`EditorDebuggerPlugin`. @@ -1043,7 +1043,7 @@ Removes a custom type added by :ref:`add_custom_type` script **)** +- void **remove_debugger_plugin** **(** :ref:`EditorDebuggerPlugin` script **)** Removes the debugger plugin with given script from the Debugger. diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index 770c72cbf..625dfabf8 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -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. ---- diff --git a/classes/class_editorresourceconversionplugin.rst b/classes/class_editorresourceconversionplugin.rst index f5b998672..c6e1583cf 100644 --- a/classes/class_editorresourceconversionplugin.rst +++ b/classes/class_editorresourceconversionplugin.rst @@ -12,7 +12,9 @@ EditorResourceConversionPlugin **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -32,18 +34,30 @@ Method Descriptions - :ref:`Resource` **_convert** **(** :ref:`Resource` resource **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_EditorResourceConversionPlugin_method__converts_to: - :ref:`String` **_converts_to** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_EditorResourceConversionPlugin_method__handles: - :ref:`bool` **_handles** **(** :ref:`Resource` resource **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_editorsceneformatimporter.rst b/classes/class_editorsceneformatimporter.rst index 89164e147..e964e30b2 100644 --- a/classes/class_editorsceneformatimporter.rst +++ b/classes/class_editorsceneformatimporter.rst @@ -72,30 +72,50 @@ Method Descriptions - :ref:`PackedStringArray` **_get_extensions** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_EditorSceneFormatImporter_method__get_import_flags: - :ref:`int` **_get_import_flags** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_EditorSceneFormatImporter_method__get_import_options: - void **_get_import_options** **(** :ref:`String` path **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_EditorSceneFormatImporter_method__get_option_visibility: - :ref:`Variant` **_get_option_visibility** **(** :ref:`String` path, :ref:`bool` for_animation, :ref:`String` option **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_EditorSceneFormatImporter_method__import_scene: - :ref:`Object` **_import_scene** **(** :ref:`String` path, :ref:`int` flags, :ref:`Dictionary` options, :ref:`int` bake_fps **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_editorsceneformatimportergltf.rst b/classes/class_editorsceneformatimportergltf.rst index b73d8ae79..d31b6f742 100644 --- a/classes/class_editorsceneformatimportergltf.rst +++ b/classes/class_editorsceneformatimportergltf.rst @@ -12,7 +12,9 @@ EditorSceneFormatImporterGLTF **Inherits:** :ref:`EditorSceneFormatImporter` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_editorspinslider.rst b/classes/class_editorspinslider.rst index 9cb448b1d..9205e7dc3 100644 --- a/classes/class_editorspinslider.rst +++ b/classes/class_editorspinslider.rst @@ -22,19 +22,23 @@ This :ref:`Control` node is used in the editor's Inspector dock t Properties ---------- -+------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`bool` | :ref:`flat` | ``false`` | -+------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | -+------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`bool` | :ref:`hide_slider` | ``false`` | -+------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`String` | :ref:`label` | ``""`` | -+------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`bool` | :ref:`read_only` | ``false`` | -+------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ -| :ref:`String` | :ref:`suffix` | ``""`` | -+------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ ++------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`flat` | ``false`` | ++------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | ++------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`hide_slider` | ``false`` | ++------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`label` | ``""`` | ++------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`read_only` | ``false`` | ++------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | size_flags_vertical | ``1`` (overrides :ref:`Control`) | ++------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | step | ``1.0`` (overrides :ref:`Range`) | ++------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`suffix` | ``""`` | ++------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ Property Descriptions --------------------- diff --git a/classes/class_editorundoredomanager.rst b/classes/class_editorundoredomanager.rst index 10d4574aa..d6d2e4bfb 100644 --- a/classes/class_editorundoredomanager.rst +++ b/classes/class_editorundoredomanager.rst @@ -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. ---- diff --git a/classes/class_engine.rst b/classes/class_engine.rst index 5dece51f7..18998ec59 100644 --- a/classes/class_engine.rst +++ b/classes/class_engine.rst @@ -22,17 +22,19 @@ The ``Engine`` singleton allows you to query and modify the project's run-time p Properties ---------- -+---------------------------+---------------------------------------------------------------------------------+----------+ -| :ref:`int` | :ref:`max_fps` | ``0`` | -+---------------------------+---------------------------------------------------------------------------------+----------+ -| :ref:`float` | :ref:`physics_jitter_fix` | ``0.5`` | -+---------------------------+---------------------------------------------------------------------------------+----------+ -| :ref:`int` | :ref:`physics_ticks_per_second` | ``60`` | -+---------------------------+---------------------------------------------------------------------------------+----------+ -| :ref:`bool` | :ref:`print_error_messages` | ``true`` | -+---------------------------+---------------------------------------------------------------------------------+----------+ -| :ref:`float` | :ref:`time_scale` | ``1.0`` | -+---------------------------+---------------------------------------------------------------------------------+----------+ ++---------------------------+---------------------------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`max_fps` | ``0`` | ++---------------------------+---------------------------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`max_physics_steps_per_frame` | ``8`` | ++---------------------------+---------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`physics_jitter_fix` | ``0.5`` | ++---------------------------+---------------------------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`physics_ticks_per_second` | ``60`` | ++---------------------------+---------------------------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`print_error_messages` | ``true`` | ++---------------------------+---------------------------------------------------------------------------------------+----------+ +| :ref:`float` | :ref:`time_scale` | ``1.0`` | ++---------------------------+---------------------------------------------------------------------------------------+----------+ Methods ------- @@ -116,6 +118,22 @@ See also :ref:`physics_ticks_per_second` **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`. This occurs even if ``delta`` is consistently used in physics calculations. To avoid this, increase :ref:`max_physics_steps_per_frame` if you have increased :ref:`physics_ticks_per_second` significantly above its default value. + +---- + .. _class_Engine_property_physics_jitter_fix: - :ref:`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` 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` and :ref:`ProjectSettings.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` above 240. Otherwise, the game will slow down when the rendering framerate goes below 30 FPS. +\ **Note:** Only :ref:`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` if increasing :ref:`physics_ticks_per_second` significantly above its default value. ---- diff --git a/classes/class_filesystemdock.rst b/classes/class_filesystemdock.rst index fc21b0c71..a6edc581e 100644 --- a/classes/class_filesystemdock.rst +++ b/classes/class_filesystemdock.rst @@ -12,7 +12,9 @@ FileSystemDock **Inherits:** :ref:`VBoxContainer` **<** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -60,9 +62,9 @@ Signals ---- -.. _class_FileSystemDock_signal_instance: +.. _class_FileSystemDock_signal_instantiate: -- **instance** **(** :ref:`PackedStringArray` files **)** +- **instantiate** **(** :ref:`PackedStringArray` files **)** Method Descriptions ------------------- @@ -71,6 +73,10 @@ Method Descriptions - void **navigate_to_path** **(** :ref:`String` path **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_float.rst b/classes/class_float.rst index 7c32700d9..d6a2581c0 100644 --- a/classes/class_float.rst +++ b/classes/class_float.rst @@ -31,15 +31,17 @@ Tutorials Constructors ------------ -+---------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`float` **(** **)** | -+---------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`float` **(** :ref:`float` from **)** | -+---------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`float` **(** :ref:`bool` from **)** | -+---------------------------+----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`float` **(** :ref:`int` from **)** | -+---------------------------+----------------------------------------------------------------------------------------+ ++---------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`float` **(** **)** | ++---------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`float` **(** :ref:`float` from **)** | ++---------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`float` **(** :ref:`String` from **)** | ++---------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`float` **(** :ref:`bool` from **)** | ++---------------------------+------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`float` **(** :ref:`int` from **)** | ++---------------------------+------------------------------------------------------------------------------------------+ Operators --------- @@ -127,6 +129,12 @@ Constructs a ``float`` as a copy of the given ``float``. ---- +- :ref:`float` **float** **(** :ref:`String` from **)** + +Converts a :ref:`String` to a ``float``, following the same rules as :ref:`String.to_float`. + +---- + - :ref:`float` **float** **(** :ref:`bool` from **)** Cast a :ref:`bool` value to a floating-point value, ``float(true)`` will be equal to 1.0 and ``float(false)`` will be equal to 0.0. diff --git a/classes/class_fontfile.rst b/classes/class_fontfile.rst index 6cf80ac27..8efa88e49 100644 --- a/classes/class_fontfile.rst +++ b/classes/class_fontfile.rst @@ -544,24 +544,40 @@ Returns number of the font cache entries. - :ref:`float` **get_cache_descent** **(** :ref:`int` cache_index, :ref:`int` size **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_FontFile_method_get_cache_scale: - :ref:`float` **get_cache_scale** **(** :ref:`int` cache_index, :ref:`int` size **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_FontFile_method_get_cache_underline_position: - :ref:`float` **get_cache_underline_position** **(** :ref:`int` cache_index, :ref:`int` size **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_FontFile_method_get_cache_underline_thickness: - :ref:`float` **get_cache_underline_thickness** **(** :ref:`int` cache_index, :ref:`int` size **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _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` cache_index, :ref:`int` size, :ref:`float` ascent **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_FontFile_method_set_cache_descent: - void **set_cache_descent** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`float` descent **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_FontFile_method_set_cache_scale: - void **set_cache_scale** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`float` scale **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_FontFile_method_set_cache_underline_position: - void **set_cache_underline_position** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`float` underline_position **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_FontFile_method_set_cache_underline_thickness: - void **set_cache_underline_thickness** **(** :ref:`int` cache_index, :ref:`int` size, :ref:`float` underline_thickness **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_FontFile_method_set_embolden: diff --git a/classes/class_generic6dofjoint3d.rst b/classes/class_generic6dofjoint3d.rst index f4d1a70da..98c565bc9 100644 --- a/classes/class_generic6dofjoint3d.rst +++ b/classes/class_generic6dofjoint3d.rst @@ -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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + Method Descriptions ------------------- @@ -1660,72 +1756,120 @@ Method Descriptions - :ref:`bool` **get_flag_x** **(** :ref:`Flag` flag **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Generic6DOFJoint3D_method_get_flag_y: - :ref:`bool` **get_flag_y** **(** :ref:`Flag` flag **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Generic6DOFJoint3D_method_get_flag_z: - :ref:`bool` **get_flag_z** **(** :ref:`Flag` flag **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Generic6DOFJoint3D_method_get_param_x: - :ref:`float` **get_param_x** **(** :ref:`Param` param **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Generic6DOFJoint3D_method_get_param_y: - :ref:`float` **get_param_y** **(** :ref:`Param` param **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Generic6DOFJoint3D_method_get_param_z: - :ref:`float` **get_param_z** **(** :ref:`Param` param **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Generic6DOFJoint3D_method_set_flag_x: - void **set_flag_x** **(** :ref:`Flag` flag, :ref:`bool` value **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Generic6DOFJoint3D_method_set_flag_y: - void **set_flag_y** **(** :ref:`Flag` flag, :ref:`bool` value **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Generic6DOFJoint3D_method_set_flag_z: - void **set_flag_z** **(** :ref:`Flag` flag, :ref:`bool` value **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Generic6DOFJoint3D_method_set_param_x: - void **set_param_x** **(** :ref:`Param` param, :ref:`float` value **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Generic6DOFJoint3D_method_set_param_y: - void **set_param_y** **(** :ref:`Param` param, :ref:`float` value **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Generic6DOFJoint3D_method_set_param_z: - void **set_param_z** **(** :ref:`Param` param, :ref:`float` value **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_geometryinstance3d.rst b/classes/class_geometryinstance3d.rst index 9bea58ecf..f6cef7f1c 100644 --- a/classes/class_geometryinstance3d.rst +++ b/classes/class_geometryinstance3d.rst @@ -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` **get_instance_shader_parameter** **(** :ref:`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` name, :ref:`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.)` diff --git a/classes/class_gltfaccessor.rst b/classes/class_gltfaccessor.rst index 8b36213cb..b4fcb769a 100644 --- a/classes/class_gltfaccessor.rst +++ b/classes/class_gltfaccessor.rst @@ -12,7 +12,9 @@ GLTFAccessor **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + .. |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.)` diff --git a/classes/class_gltfanimation.rst b/classes/class_gltfanimation.rst index 8d6bd2e16..aadd38125 100644 --- a/classes/class_gltfanimation.rst +++ b/classes/class_gltfanimation.rst @@ -12,7 +12,9 @@ GLTFAnimation **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + .. |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.)` diff --git a/classes/class_gltfbufferview.rst b/classes/class_gltfbufferview.rst index a86b7d162..3cc5d246f 100644 --- a/classes/class_gltfbufferview.rst +++ b/classes/class_gltfbufferview.rst @@ -12,7 +12,9 @@ GLTFBufferView **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + .. |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.)` diff --git a/classes/class_gltfdocument.rst b/classes/class_gltfdocument.rst index ca3f9a760..22df1c771 100644 --- a/classes/class_gltfdocument.rst +++ b/classes/class_gltfdocument.rst @@ -12,8 +12,6 @@ GLTFDocument **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`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 `! + Method Descriptions ------------------- @@ -65,36 +67,60 @@ Method Descriptions - :ref:`Error` **append_from_buffer** **(** :ref:`PackedByteArray` bytes, :ref:`String` base_path, :ref:`GLTFState` state, :ref:`int` flags=0, :ref:`int` bake_fps=30 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFDocument_method_append_from_file: - :ref:`Error` **append_from_file** **(** :ref:`String` path, :ref:`GLTFState` state, :ref:`int` flags=0, :ref:`int` bake_fps=30, :ref:`String` base_path="" **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFDocument_method_append_from_scene: - :ref:`Error` **append_from_scene** **(** :ref:`Node` node, :ref:`GLTFState` state, :ref:`int` flags=0, :ref:`int` bake_fps=30 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFDocument_method_generate_buffer: - :ref:`PackedByteArray` **generate_buffer** **(** :ref:`GLTFState` state **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFDocument_method_generate_scene: - :ref:`Node` **generate_scene** **(** :ref:`GLTFState` state, :ref:`int` bake_fps=30 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFDocument_method_write_to_filesystem: - :ref:`Error` **write_to_filesystem** **(** :ref:`GLTFState` state, :ref:`String` path **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_gltfdocumentextension.rst b/classes/class_gltfdocumentextension.rst index 2525e2b2f..80c2c3596 100644 --- a/classes/class_gltfdocumentextension.rst +++ b/classes/class_gltfdocumentextension.rst @@ -49,18 +49,30 @@ Method Descriptions - :ref:`int` **_export_node** **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Dictionary` json, :ref:`Node` node **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFDocumentExtension_method__export_post: - :ref:`int` **_export_post** **(** :ref:`GLTFState` state **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFDocumentExtension_method__export_preflight: - :ref:`int` **_export_preflight** **(** :ref:`Node` root **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFDocumentExtension_method__get_supported_extensions: @@ -75,24 +87,40 @@ Returns an array of the GLTF extensions supported by this GLTFDocumentExtension - :ref:`int` **_import_node** **(** :ref:`GLTFState` state, :ref:`GLTFNode` gltf_node, :ref:`Dictionary` json, :ref:`Node` node **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFDocumentExtension_method__import_post: - :ref:`int` **_import_post** **(** :ref:`GLTFState` state, :ref:`Node` root **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFDocumentExtension_method__import_post_parse: - :ref:`int` **_import_post_parse** **(** :ref:`GLTFState` state **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFDocumentExtension_method__import_preflight: - :ref:`int` **_import_preflight** **(** :ref:`GLTFState` state **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_gltfdocumentextensionconvertimportermesh.rst b/classes/class_gltfdocumentextensionconvertimportermesh.rst index 290b2d9a6..b47918b6f 100644 --- a/classes/class_gltfdocumentextensionconvertimportermesh.rst +++ b/classes/class_gltfdocumentextensionconvertimportermesh.rst @@ -12,7 +12,9 @@ GLTFDocumentExtensionConvertImporterMesh **Inherits:** :ref:`GLTFDocumentExtension` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_gltfmesh.rst b/classes/class_gltfmesh.rst index 660b093dc..f09a545e1 100644 --- a/classes/class_gltfmesh.rst +++ b/classes/class_gltfmesh.rst @@ -12,7 +12,9 @@ GLTFMesh **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + ---- .. _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 `! + ---- .. _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 `! + .. |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.)` diff --git a/classes/class_gltfnode.rst b/classes/class_gltfnode.rst index c04187969..54a1e29ec 100644 --- a/classes/class_gltfnode.rst +++ b/classes/class_gltfnode.rst @@ -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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + Method Descriptions ------------------- diff --git a/classes/class_gltfskeleton.rst b/classes/class_gltfskeleton.rst index 74eb8d2bb..55c714c6c 100644 --- a/classes/class_gltfskeleton.rst +++ b/classes/class_gltfskeleton.rst @@ -12,7 +12,9 @@ GLTFSkeleton **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + ---- .. _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 `! + Method Descriptions ------------------- @@ -78,42 +88,70 @@ Method Descriptions - :ref:`BoneAttachment3D` **get_bone_attachment** **(** :ref:`int` idx **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFSkeleton_method_get_bone_attachment_count: - :ref:`int` **get_bone_attachment_count** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFSkeleton_method_get_godot_bone_node: - :ref:`Dictionary` **get_godot_bone_node** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFSkeleton_method_get_godot_skeleton: - :ref:`Skeleton3D` **get_godot_skeleton** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFSkeleton_method_get_unique_names: - :ref:`String[]` **get_unique_names** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFSkeleton_method_set_godot_bone_node: - void **set_godot_bone_node** **(** :ref:`Dictionary` godot_bone_node **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFSkeleton_method_set_unique_names: - void **set_unique_names** **(** :ref:`String[]` unique_names **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_gltfskin.rst b/classes/class_gltfskin.rst index 39cd7543c..b91d2dbc3 100644 --- a/classes/class_gltfskin.rst +++ b/classes/class_gltfskin.rst @@ -12,7 +12,9 @@ GLTFSkin **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + Method Descriptions ------------------- @@ -154,36 +184,60 @@ Method Descriptions - :ref:`Transform3D[]` **get_inverse_binds** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFSkin_method_get_joint_i_to_bone_i: - :ref:`Dictionary` **get_joint_i_to_bone_i** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFSkin_method_get_joint_i_to_name: - :ref:`Dictionary` **get_joint_i_to_name** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFSkin_method_set_inverse_binds: - void **set_inverse_binds** **(** :ref:`Transform3D[]` inverse_binds **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFSkin_method_set_joint_i_to_bone_i: - void **set_joint_i_to_bone_i** **(** :ref:`Dictionary` joint_i_to_bone_i **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFSkin_method_set_joint_i_to_name: - void **set_joint_i_to_name** **(** :ref:`Dictionary` joint_i_to_name **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_gltfstate.rst b/classes/class_gltfstate.rst index df139e163..28abca523 100644 --- a/classes/class_gltfstate.rst +++ b/classes/class_gltfstate.rst @@ -12,7 +12,9 @@ GLTFState **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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 `! + Method Descriptions ------------------- @@ -276,6 +318,10 @@ Appends an extension to the list of extensions used by this GLTF file during ser - :ref:`GLTFAccessor[]` **get_accessors** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_additional_data: @@ -292,84 +338,140 @@ The argument should be the :ref:`GLTFDocumentExtension` **get_animation_player** **(** :ref:`int` idx **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_animation_players_count: - :ref:`int` **get_animation_players_count** **(** :ref:`int` idx **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_animations: - :ref:`GLTFAnimation[]` **get_animations** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_buffer_views: - :ref:`GLTFBufferView[]` **get_buffer_views** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_cameras: - :ref:`GLTFCamera[]` **get_cameras** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_images: - :ref:`Texture2D[]` **get_images** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_lights: - :ref:`GLTFLight[]` **get_lights** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_materials: - :ref:`BaseMaterial3D[]` **get_materials** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_meshes: - :ref:`GLTFMesh[]` **get_meshes** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_nodes: - :ref:`GLTFNode[]` **get_nodes** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_scene_node: - :ref:`Node` **get_scene_node** **(** :ref:`int` idx **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_skeleton_to_node: - :ref:`Dictionary` **get_skeleton_to_node** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_skeletons: - :ref:`GLTFSkeleton[]` **get_skeletons** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_skins: - :ref:`GLTFSkin[]` **get_skins** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _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[]` **get_textures** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_unique_animation_names: - :ref:`String[]` **get_unique_animation_names** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_get_unique_names: - :ref:`String[]` **get_unique_names** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_set_accessors: - void **set_accessors** **(** :ref:`GLTFAccessor[]` accessors **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_set_additional_data: @@ -418,66 +536,110 @@ The first argument should be the :ref:`GLTFDocumentExtension` animations **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_set_buffer_views: - void **set_buffer_views** **(** :ref:`GLTFBufferView[]` buffer_views **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_set_cameras: - void **set_cameras** **(** :ref:`GLTFCamera[]` cameras **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_set_images: - void **set_images** **(** :ref:`Texture2D[]` images **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_set_lights: - void **set_lights** **(** :ref:`GLTFLight[]` lights **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_set_materials: - void **set_materials** **(** :ref:`BaseMaterial3D[]` materials **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_set_meshes: - void **set_meshes** **(** :ref:`GLTFMesh[]` meshes **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_set_nodes: - void **set_nodes** **(** :ref:`GLTFNode[]` nodes **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_set_skeleton_to_node: - void **set_skeleton_to_node** **(** :ref:`Dictionary` skeleton_to_node **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_set_skeletons: - void **set_skeletons** **(** :ref:`GLTFSkeleton[]` skeletons **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_set_skins: - void **set_skins** **(** :ref:`GLTFSkin[]` skins **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _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[]` textures **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_set_unique_animation_names: - void **set_unique_animation_names** **(** :ref:`String[]` unique_animation_names **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GLTFState_method_set_unique_names: - void **set_unique_names** **(** :ref:`String[]` unique_names **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_gltftexture.rst b/classes/class_gltftexture.rst index 1f4515c66..42ba658c7 100644 --- a/classes/class_gltftexture.rst +++ b/classes/class_gltftexture.rst @@ -12,7 +12,9 @@ GLTFTexture **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + .. |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.)` diff --git a/classes/class_gpuparticles2d.rst b/classes/class_gpuparticles2d.rst index ff93c319d..2a91dec3a 100644 --- a/classes/class_gpuparticles2d.rst +++ b/classes/class_gpuparticles2d.rst @@ -70,7 +70,7 @@ Properties +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`bool` | :ref:`trail_enabled` | ``false`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ -| :ref:`float` | :ref:`trail_length_secs` | ``0.3`` | +| :ref:`float` | :ref:`trail_lifetime` | ``0.3`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`int` | :ref:`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 `! + ---- .. _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`, the number of trail sections and subdivisions is set with the :ref:`trail_sections` and :ref:`trail_section_subdivisions` properties. + ---- -.. _class_GPUParticles2D_property_trail_length_secs: +.. _class_GPUParticles2D_property_trail_lifetime: -- :ref:`float` **trail_length_secs** +- :ref:`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` 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`. Only effective if :ref:`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`. Only effective if :ref:`trail_enabled` is ``true``. + ---- .. _class_GPUParticles2D_property_visibility_rect: diff --git a/classes/class_gpuparticles3d.rst b/classes/class_gpuparticles3d.rst index 0a3c92a94..e36e8d1ed 100644 --- a/classes/class_gpuparticles3d.rst +++ b/classes/class_gpuparticles3d.rst @@ -78,7 +78,7 @@ Properties +-----------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------+ | :ref:`bool` | :ref:`trail_enabled` | ``false`` | +-----------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------+ -| :ref:`float` | :ref:`trail_length_secs` | ``0.3`` | +| :ref:`float` | :ref:`trail_lifetime` | ``0.3`` | +-----------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------+ | :ref:`TransformAlign` | :ref:`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 `! + ---- .. _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 `! + ---- .. _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 `! + ---- .. _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` and :ref:`TubeTrailMesh`. + +\ **Note:** :ref:`BaseMaterial3D.use_particle_trails` must also be enabled on the particle mesh's material. Otherwise, setting :ref:`trail_enabled` to ``true`` will have no effect. + +\ **Note:** Unlike :ref:`GPUParticles2D`, the number of trail sections and subdivisions is set in the :ref:`RibbonTrailMesh` or the :ref:`TubeTrailMesh`'s properties. + ---- -.. _class_GPUParticles3D_property_trail_length_secs: +.. _class_GPUParticles3D_property_trail_lifetime: -- :ref:`float` **trail_length_secs** +- :ref:`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` 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 `! + ---- .. _class_GPUParticles3D_property_visibility_aabb: diff --git a/classes/class_gradienttexture1d.rst b/classes/class_gradienttexture1d.rst index 796269b6e..5d397f1c0 100644 --- a/classes/class_gradienttexture1d.rst +++ b/classes/class_gradienttexture1d.rst @@ -22,13 +22,15 @@ GradientTexture1D uses a :ref:`Gradient` to fill the texture dat Properties ---------- -+---------------------------------+------------------------------------------------------------+-----------+ -| :ref:`Gradient` | :ref:`gradient` | | -+---------------------------------+------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`use_hdr` | ``false`` | -+---------------------------------+------------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`width` | ``256`` | -+---------------------------------+------------------------------------------------------------+-----------+ ++---------------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Gradient` | :ref:`gradient` | | ++---------------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | ++---------------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_hdr` | ``false`` | ++---------------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`width` | ``256`` | ++---------------------------------+------------------------------------------------------------+----------------------------------------------------------------------------------------+ Property Descriptions --------------------- diff --git a/classes/class_gradienttexture2d.rst b/classes/class_gradienttexture2d.rst index 0e9492d7a..4410e29a9 100644 --- a/classes/class_gradienttexture2d.rst +++ b/classes/class_gradienttexture2d.rst @@ -22,23 +22,25 @@ The texture uses a :ref:`Gradient` to fill the texture data in 2 Properties ---------- -+----------------------------------------------+--------------------------------------------------------------+-------------------+ -| :ref:`Fill` | :ref:`fill` | ``0`` | -+----------------------------------------------+--------------------------------------------------------------+-------------------+ -| :ref:`Vector2` | :ref:`fill_from` | ``Vector2(0, 0)`` | -+----------------------------------------------+--------------------------------------------------------------+-------------------+ -| :ref:`Vector2` | :ref:`fill_to` | ``Vector2(1, 0)`` | -+----------------------------------------------+--------------------------------------------------------------+-------------------+ -| :ref:`Gradient` | :ref:`gradient` | | -+----------------------------------------------+--------------------------------------------------------------+-------------------+ -| :ref:`int` | :ref:`height` | ``64`` | -+----------------------------------------------+--------------------------------------------------------------+-------------------+ -| :ref:`Repeat` | :ref:`repeat` | ``0`` | -+----------------------------------------------+--------------------------------------------------------------+-------------------+ -| :ref:`bool` | :ref:`use_hdr` | ``false`` | -+----------------------------------------------+--------------------------------------------------------------+-------------------+ -| :ref:`int` | :ref:`width` | ``64`` | -+----------------------------------------------+--------------------------------------------------------------+-------------------+ ++----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Fill` | :ref:`fill` | ``0`` | ++----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`fill_from` | ``Vector2(0, 0)`` | ++----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`fill_to` | ``Vector2(1, 0)`` | ++----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Gradient` | :ref:`gradient` | | ++----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`height` | ``64`` | ++----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Repeat` | :ref:`repeat` | ``0`` | ++----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | ++----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`use_hdr` | ``false`` | ++----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`width` | ``64`` | ++----------------------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ Enumerations ------------ diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 565fc547c..baebdddd3 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -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 `! + ---- .. _class_GraphEdit_theme_color_grid_major: @@ -885,12 +889,20 @@ The horizontal range within which a port can be grabbed (outer side). - :ref:`Texture2D` **layout** +.. container:: contribute + + There is currently no description for this theme property. Please help us by :ref:`contributing one `! + ---- .. _class_GraphEdit_theme_icon_minimap: - :ref:`Texture2D` **minimap** +.. container:: contribute + + There is currently no description for this theme property. Please help us by :ref:`contributing one `! + ---- .. _class_GraphEdit_theme_icon_minus: diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 55780ec20..b076d0f10 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -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 `! + ---- .. _class_GraphNode_theme_constant_close_offset: diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 14c62d2dc..177632af3 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -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 `! + ---- .. _class_GridMap_method_get_bake_mesh_instance: - :ref:`RID` **get_bake_mesh_instance** **(** :ref:`int` idx **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _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` gen_lightmap_uv=false, :ref:`float` lightmap_uv_texel_size=0.1 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _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` resource **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_GridMap_method_set_cell_item: diff --git a/classes/class_hingejoint3d.rst b/classes/class_hingejoint3d.rst index dd066de93..09b8fe1b8 100644 --- a/classes/class_hingejoint3d.rst +++ b/classes/class_hingejoint3d.rst @@ -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 `! + ---- .. _class_HingeJoint3D_property_angular_limit/upper: diff --git a/classes/class_hslider.rst b/classes/class_hslider.rst index 9a9e837c7..ef5096e0a 100644 --- a/classes/class_hslider.rst +++ b/classes/class_hslider.rst @@ -101,6 +101,10 @@ The background of the area to the left of the grabber. - :ref:`StyleBox` **grabber_area_highlight** +.. container:: contribute + + There is currently no description for this theme property. Please help us by :ref:`contributing one `! + ---- .. _class_HSlider_theme_style_slider: diff --git a/classes/class_image.rst b/classes/class_image.rst index c12214c0b..584dd9dcd 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -492,6 +492,10 @@ Method Descriptions - void **adjust_bcs** **(** :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _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` **compress_from_channels** **(** :ref:`CompressMode` mode, :ref:`UsedChannels` channels, :ref:`float` lossy_quality=0.7 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Image_method_compute_image_metrics: @@ -586,7 +594,7 @@ Copies ``src`` image to this image. - :ref:`Image` **create** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format **)** |static| -Creates an empty image of given size and format. See :ref:`Format` constants. If ``use_mipmaps`` is ``true`` then generate mipmaps for this image. See the :ref:`generate_mipmaps`. +Creates an empty image of given size and format. See :ref:`Format` constants. If ``use_mipmaps`` is ``true``, then generate mipmaps for this image. See the :ref:`generate_mipmaps`. ---- @@ -628,6 +636,10 @@ Returns :ref:`ALPHA_BLEND` if the image has da - :ref:`UsedChannels` **detect_used_channels** **(** :ref:`CompressSource` source=0 **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Image_method_fill: diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index 1c376702f..1620384ae 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -52,6 +52,13 @@ Tutorials - :doc:`Importing images <../tutorials/assets_pipeline/importing_images>` +Properties +---------- + ++-------------------------+-------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | ++-------------------------+-------------------------+----------------------------------------------------------------------------------------+ + Methods ------- diff --git a/classes/class_imagetexture3d.rst b/classes/class_imagetexture3d.rst index 2b8af1813..514eba9d2 100644 --- a/classes/class_imagetexture3d.rst +++ b/classes/class_imagetexture3d.rst @@ -12,7 +12,14 @@ ImageTexture3D **Inherits:** :ref:`Texture3D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +Texture with 3 dimensions. +Description +----------- + +``ImageTexture3D`` is a 3-dimensional :ref:`ImageTexture` that has a width, height, and depth. See also :ref:`ImageTextureLayered`. + +3D textures are typically used to store density maps for :ref:`FogMaterial`, color correction LUTs for :ref:`Environment`, vector fields for :ref:`GPUParticlesAttractorVectorField3D` and collision maps for :ref:`GPUParticlesCollisionSDF3D`. 3D textures can also be used in custom shaders. Methods ------- @@ -30,12 +37,16 @@ Method Descriptions - :ref:`Error` **create** **(** :ref:`Format` format, :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` use_mipmaps, :ref:`Image[]` data **)** +Creates the ``ImageTexture3D`` with specified ``width``, ``height``, and ``depth``. See :ref:`Format` for ``format`` options. If ``use_mipmaps`` is ``true``, then generate mipmaps for the ``ImageTexture3D``. + ---- .. _class_ImageTexture3D_method_update: - void **update** **(** :ref:`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`. In other words, the texture cannot be resized or have its format changed by calling :ref:`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.)` diff --git a/classes/class_imagetexturelayered.rst b/classes/class_imagetexturelayered.rst index f2715f926..6056d65a3 100644 --- a/classes/class_imagetexturelayered.rst +++ b/classes/class_imagetexturelayered.rst @@ -14,7 +14,12 @@ ImageTextureLayered **Inherited By:** :ref:`Cubemap`, :ref:`CubemapArray`, :ref:`Texture2DArray` +Base class for texture types which contain the data of multiple :ref:`ImageTexture`\ s. Each image is of the same size and format. +Description +----------- + +Base class for :ref:`Texture2DArray`, :ref:`Cubemap` and :ref:`CubemapArray`. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. See also :ref:`Texture3D`. Methods ------- @@ -32,7 +37,7 @@ Method Descriptions - :ref:`Error` **create_from_images** **(** :ref:`Image[]` images **)** -Creates an ``ImageTextureLayered`` from an array of :ref:`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`\ s. See :ref:`Image.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` represents one ``layer``. @@ -48,7 +53,7 @@ The given :ref:`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`. -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.)` diff --git a/classes/class_importermesh.rst b/classes/class_importermesh.rst index 26118556f..5e6fd0ef0 100644 --- a/classes/class_importermesh.rst +++ b/classes/class_importermesh.rst @@ -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 `! + Method Descriptions ------------------- diff --git a/classes/class_importermeshinstance3d.rst b/classes/class_importermeshinstance3d.rst index 30d4f9f7b..b286992a1 100644 --- a/classes/class_importermeshinstance3d.rst +++ b/classes/class_importermeshinstance3d.rst @@ -12,7 +12,9 @@ ImporterMeshInstance3D **Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + ---- .. _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 `! + ---- .. _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 `! + .. |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.)` diff --git a/classes/class_inputeventfromwindow.rst b/classes/class_inputeventfromwindow.rst index 49ee22f4b..0ff3b62c8 100644 --- a/classes/class_inputeventfromwindow.rst +++ b/classes/class_inputeventfromwindow.rst @@ -14,7 +14,9 @@ InputEventFromWindow **Inherited By:** :ref:`InputEventScreenDrag`, :ref:`InputEventScreenTouch`, :ref:`InputEventWithModifiers` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + .. |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.)` diff --git a/classes/class_inputeventmagnifygesture.rst b/classes/class_inputeventmagnifygesture.rst index 8ef4191e4..689ab17c4 100644 --- a/classes/class_inputeventmagnifygesture.rst +++ b/classes/class_inputeventmagnifygesture.rst @@ -12,7 +12,9 @@ InputEventMagnifyGesture **Inherits:** :ref:`InputEventGesture` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEventFromWindow` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + .. |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.)` diff --git a/classes/class_inputeventpangesture.rst b/classes/class_inputeventpangesture.rst index 0cab6522c..b1eaa26a4 100644 --- a/classes/class_inputeventpangesture.rst +++ b/classes/class_inputeventpangesture.rst @@ -12,7 +12,9 @@ InputEventPanGesture **Inherits:** :ref:`InputEventGesture` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEventFromWindow` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + .. |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.)` diff --git a/classes/class_inputeventshortcut.rst b/classes/class_inputeventshortcut.rst index 1c74cdb23..e17dc7967 100644 --- a/classes/class_inputeventshortcut.rst +++ b/classes/class_inputeventshortcut.rst @@ -12,7 +12,9 @@ InputEventShortcut **Inherits:** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + .. |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.)` diff --git a/classes/class_int.rst b/classes/class_int.rst index c26c599e6..616bcf49f 100644 --- a/classes/class_int.rst +++ b/classes/class_int.rst @@ -57,15 +57,17 @@ It can take values in the interval ``[-2^63, 2^63 - 1]``, i.e. ``[-9223372036854 Constructors ------------ -+-----------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`int` **(** **)** | -+-----------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`int` **(** :ref:`int` from **)** | -+-----------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`int` **(** :ref:`bool` from **)** | -+-----------------------+----------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`int` **(** :ref:`float` from **)** | -+-----------------------+----------------------------------------------------------------------------------+ ++-----------------------+------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`int` **(** **)** | ++-----------------------+------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`int` **(** :ref:`int` from **)** | ++-----------------------+------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`int` **(** :ref:`String` from **)** | ++-----------------------+------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`int` **(** :ref:`bool` from **)** | ++-----------------------+------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`int` **(** :ref:`float` from **)** | ++-----------------------+------------------------------------------------------------------------------------+ Operators --------- @@ -167,6 +169,12 @@ Constructs an ``int`` as a copy of the given ``int``. ---- +- :ref:`int` **int** **(** :ref:`String` from **)** + +Converts a :ref:`String` to an ``int``, following the same rules as :ref:`String.to_int`. + +---- + - :ref:`int` **int** **(** :ref:`bool` from **)** Cast a :ref:`bool` value to an integer value, ``int(true)`` will be equals to 1 and ``int(false)`` will be equals to 0. diff --git a/classes/class_javaclass.rst b/classes/class_javaclass.rst index 2f24ba72a..24fe4d576 100644 --- a/classes/class_javaclass.rst +++ b/classes/class_javaclass.rst @@ -12,7 +12,9 @@ JavaClass **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_javaclasswrapper.rst b/classes/class_javaclasswrapper.rst index a547401ca..111df451c 100644 --- a/classes/class_javaclasswrapper.rst +++ b/classes/class_javaclasswrapper.rst @@ -12,7 +12,9 @@ JavaClassWrapper **Inherits:** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -28,6 +30,10 @@ Method Descriptions - :ref:`JavaClass` **wrap** **(** :ref:`String` name **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_jsonrpc.rst b/classes/class_jsonrpc.rst index e2c37550b..04042b37f 100644 --- a/classes/class_jsonrpc.rst +++ b/classes/class_jsonrpc.rst @@ -136,12 +136,20 @@ To add new supported methods extend the JSONRPC class and call :ref:`process_act - :ref:`String` **process_string** **(** :ref:`String` action **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_JSONRPC_method_set_scope: - void **set_scope** **(** :ref:`String` scope, :ref:`Object` target **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_label.rst b/classes/class_label.rst index 8026adaa6..55353aca6 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -170,6 +170,10 @@ Controls the text's horizontal alignment. Supports left, center, right, and fill | *Getter* | get_label_settings() | +----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_Label_property_language: diff --git a/classes/class_labelsettings.rst b/classes/class_labelsettings.rst index baf6e2c13..965744753 100644 --- a/classes/class_labelsettings.rst +++ b/classes/class_labelsettings.rst @@ -12,7 +12,9 @@ LabelSettings **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -50,6 +52,10 @@ Property Descriptions | *Getter* | get_font() | +----------+-----------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_LabelSettings_property_font_color: @@ -64,6 +70,10 @@ Property Descriptions | *Getter* | get_font_color() | +-----------+-----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_LabelSettings_property_font_size: @@ -78,6 +88,10 @@ Property Descriptions | *Getter* | get_font_size() | +-----------+----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_LabelSettings_property_line_spacing: @@ -92,6 +106,10 @@ Property Descriptions | *Getter* | get_line_spacing() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_LabelSettings_property_outline_color: @@ -106,6 +124,10 @@ Property Descriptions | *Getter* | get_outline_color() | +-----------+--------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_LabelSettings_property_outline_size: @@ -120,6 +142,10 @@ Property Descriptions | *Getter* | get_outline_size() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_LabelSettings_property_shadow_color: @@ -134,6 +160,10 @@ Property Descriptions | *Getter* | get_shadow_color() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_LabelSettings_property_shadow_offset: @@ -148,6 +178,10 @@ Property Descriptions | *Getter* | get_shadow_offset() | +-----------+--------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_LabelSettings_property_shadow_size: @@ -162,6 +196,10 @@ Property Descriptions | *Getter* | get_shadow_size() | +-----------+------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 4c8f83ec4..89cfcf838 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -357,12 +357,20 @@ Method Descriptions - :ref:`float` **get_height** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Light2D_method_set_height: - void **set_height** **(** :ref:`float` height **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_light3d.rst b/classes/class_light3d.rst index 0f3628257..e9aa685a7 100644 --- a/classes/class_light3d.rst +++ b/classes/class_light3d.rst @@ -646,6 +646,10 @@ If ``true``, reverses the backface culling of the mesh. This can be useful when | *Getter* | get_param() | +-----------+------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + Method Descriptions ------------------- diff --git a/classes/class_lightoccluder2d.rst b/classes/class_lightoccluder2d.rst index e9b0355c3..d9d512b4d 100644 --- a/classes/class_lightoccluder2d.rst +++ b/classes/class_lightoccluder2d.rst @@ -80,6 +80,10 @@ The LightOccluder2D's occluder light mask. The LightOccluder2D will cast shadows | *Getter* | is_set_as_sdf_collision() | +-----------+-----------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_material.rst b/classes/class_material.rst index 5dcafb204..2dbbe07fb 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -105,30 +105,50 @@ Method Descriptions - :ref:`bool` **_can_do_next_pass** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Material_method__can_use_render_priority: - :ref:`bool` **_can_use_render_priority** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Material_method__get_shader_mode: - :ref:`Mode` **_get_shader_mode** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Material_method__get_shader_rid: - :ref:`RID` **_get_shader_rid** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Material_method_inspect_native_shader_code: - void **inspect_native_shader_code** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index 8bcde5031..5a3eb1434 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -371,84 +371,140 @@ Method Descriptions - :ref:`AABB` **_get_aabb** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Mesh_method__get_blend_shape_count: - :ref:`int` **_get_blend_shape_count** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Mesh_method__get_blend_shape_name: - :ref:`StringName` **_get_blend_shape_name** **(** :ref:`int` index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Mesh_method__get_surface_count: - :ref:`int` **_get_surface_count** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Mesh_method__set_blend_shape_name: - void **_set_blend_shape_name** **(** :ref:`int` index, :ref:`StringName` name **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Mesh_method__surface_get_array_index_len: - :ref:`int` **_surface_get_array_index_len** **(** :ref:`int` index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Mesh_method__surface_get_array_len: - :ref:`int` **_surface_get_array_len** **(** :ref:`int` index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Mesh_method__surface_get_arrays: - :ref:`Array` **_surface_get_arrays** **(** :ref:`int` index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Mesh_method__surface_get_blend_shape_arrays: - :ref:`Array[]` **_surface_get_blend_shape_arrays** **(** :ref:`int` index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Mesh_method__surface_get_format: - :ref:`int` **_surface_get_format** **(** :ref:`int` index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Mesh_method__surface_get_lods: - :ref:`Dictionary` **_surface_get_lods** **(** :ref:`int` index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Mesh_method__surface_get_material: - :ref:`Material` **_surface_get_material** **(** :ref:`int` index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Mesh_method__surface_get_primitive_type: - :ref:`int` **_surface_get_primitive_type** **(** :ref:`int` index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Mesh_method__surface_set_material: - void **_surface_set_material** **(** :ref:`int` index, :ref:`Material` material **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Mesh_method_create_convex_shape: diff --git a/classes/class_meshinstance3d.rst b/classes/class_meshinstance3d.rst index 54e12efb7..5f56313bf 100644 --- a/classes/class_meshinstance3d.rst +++ b/classes/class_meshinstance3d.rst @@ -160,6 +160,10 @@ This helper creates a :ref:`StaticBody3D` child node with a - :ref:`int` **find_blend_shape_by_name** **(** :ref:`StringName` name **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_MeshInstance3D_method_get_active_material: @@ -174,12 +178,20 @@ Returns the :ref:`Material` that will be used by the :ref:`Mesh< - :ref:`int` **get_blend_shape_count** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_MeshInstance3D_method_get_blend_shape_value: - :ref:`float` **get_blend_shape_value** **(** :ref:`int` blend_shape_idx **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_MeshInstance3D_method_get_surface_override_material: @@ -202,6 +214,10 @@ Returns the number of surface override materials. This is equivalent to :ref:`Me - void **set_blend_shape_value** **(** :ref:`int` blend_shape_idx, :ref:`float` value **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_MeshInstance3D_method_set_surface_override_material: diff --git a/classes/class_meshtexture.rst b/classes/class_meshtexture.rst index 9fa7893b9..1979b0f83 100644 --- a/classes/class_meshtexture.rst +++ b/classes/class_meshtexture.rst @@ -22,13 +22,15 @@ Simple texture that uses a mesh to draw itself. It's limited because flags can't Properties ---------- -+-----------------------------------+--------------------------------------------------------------+-------------------+ -| :ref:`Texture2D` | :ref:`base_texture` | | -+-----------------------------------+--------------------------------------------------------------+-------------------+ -| :ref:`Vector2` | :ref:`image_size` | ``Vector2(0, 0)`` | -+-----------------------------------+--------------------------------------------------------------+-------------------+ -| :ref:`Mesh` | :ref:`mesh` | | -+-----------------------------------+--------------------------------------------------------------+-------------------+ ++-----------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`base_texture` | | ++-----------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`image_size` | ``Vector2(0, 0)`` | ++-----------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`mesh` | | ++-----------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | ++-----------------------------------+--------------------------------------------------------------+----------------------------------------------------------------------------------------+ Property Descriptions --------------------- diff --git a/classes/class_missingnode.rst b/classes/class_missingnode.rst index b59b513e5..b89fcece5 100644 --- a/classes/class_missingnode.rst +++ b/classes/class_missingnode.rst @@ -17,7 +17,7 @@ This is an internal editor class intended for keeping data of nodes of unknown t Description ----------- -This is an internal editor class intended for keeping data of nodes of unknown type (most likely this type was supplied by an extension that is no longer loaded). It can´t be manually instantiated or placed in the scene. Ignore it if you don't know what it is. +This is an internal editor class intended for keeping data of nodes of unknown type (most likely this type was supplied by an extension that is no longer loaded). It can't be manually instantiated or placed in the scene. Ignore it if you don't know what it is. Properties ---------- @@ -41,6 +41,10 @@ Property Descriptions | *Getter* | get_original_class() | +----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_MissingNode_property_recording_properties: @@ -53,6 +57,10 @@ Property Descriptions | *Getter* | is_recording_properties() | +----------+---------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_missingresource.rst b/classes/class_missingresource.rst index 555fcc14b..3cb00b5cd 100644 --- a/classes/class_missingresource.rst +++ b/classes/class_missingresource.rst @@ -17,7 +17,7 @@ This is an internal editor class intended for keeping data of resources of unkno Description ----------- -This is an internal editor class intended for keeping data of resources of unknown type (most likely this type was supplied by an extension that is no longer loaded). It can´t be manually instantiated or placed in the scene. Ignore it if you don't know what it is. +This is an internal editor class intended for keeping data of resources of unknown type (most likely this type was supplied by an extension that is no longer loaded). It can't be manually instantiated or placed in the scene. Ignore it if you don't know what it is. Properties ---------- @@ -41,6 +41,10 @@ Property Descriptions | *Getter* | get_original_class() | +----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_MissingResource_property_recording_properties: @@ -53,6 +57,10 @@ Property Descriptions | *Getter* | is_recording_properties() | +----------+---------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 7458be10a..b011c09e6 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -116,6 +116,10 @@ Property Descriptions | *Getter* | get_buffer() | +-----------+--------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_MultiMesh_property_color_array: diff --git a/classes/class_nativeextension.rst b/classes/class_nativeextension.rst index a371298b1..e9131639a 100644 --- a/classes/class_nativeextension.rst +++ b/classes/class_nativeextension.rst @@ -12,7 +12,9 @@ NativeExtension **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -59,30 +61,50 @@ Method Descriptions - void **close_library** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_NativeExtension_method_get_minimum_library_initialization_level: - :ref:`InitializationLevel` **get_minimum_library_initialization_level** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_NativeExtension_method_initialize_library: - void **initialize_library** **(** :ref:`InitializationLevel` level **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_NativeExtension_method_is_library_open: - :ref:`bool` **is_library_open** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_NativeExtension_method_open_library: - :ref:`Error` **open_library** **(** :ref:`String` path, :ref:`String` entry_symbol **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_nativeextensionmanager.rst b/classes/class_nativeextensionmanager.rst index e7de8e8b6..9f74ab453 100644 --- a/classes/class_nativeextensionmanager.rst +++ b/classes/class_nativeextensionmanager.rst @@ -12,7 +12,9 @@ NativeExtensionManager **Inherits:** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -65,36 +67,60 @@ Method Descriptions - :ref:`NativeExtension` **get_extension** **(** :ref:`String` path **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_NativeExtensionManager_method_get_loaded_extensions: - :ref:`PackedStringArray` **get_loaded_extensions** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_NativeExtensionManager_method_is_extension_loaded: - :ref:`bool` **is_extension_loaded** **(** :ref:`String` path **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_NativeExtensionManager_method_load_extension: - :ref:`LoadStatus` **load_extension** **(** :ref:`String` path **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_NativeExtensionManager_method_reload_extension: - :ref:`LoadStatus` **reload_extension** **(** :ref:`String` path **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_NativeExtensionManager_method_unload_extension: - :ref:`LoadStatus` **unload_extension** **(** :ref:`String` path **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_node.rst b/classes/class_node.rst index 4458d4fc5..b470b636e 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -338,7 +338,7 @@ enum **ProcessMode**: .. _class_Node_constant_DUPLICATE_SCRIPTS: -.. _class_Node_constant_DUPLICATE_USE_INSTANCING: +.. _class_Node_constant_DUPLICATE_USE_INSTANTIATION: enum **DuplicateFlags**: @@ -348,7 +348,7 @@ enum **DuplicateFlags**: - **DUPLICATE_SCRIPTS** = **4** --- Duplicate the node's scripts. -- **DUPLICATE_USE_INSTANCING** = **8** --- Duplicate using instancing. +- **DUPLICATE_USE_INSTANTIATION** = **8** --- Duplicate using instancing. An instance stays linked to the original so when the original changes, the instance changes too. @@ -1467,7 +1467,7 @@ Removes a child node. The node is NOT deleted and must be deleted manually. - void **remove_from_group** **(** :ref:`StringName` group **)** -Removes a node from a group. See notes in the description, and the group methods in :ref:`SceneTree`. +Removes a node from the ``group``. Does nothing if the node is not in the ``group``. See notes in the description, and the group methods in :ref:`SceneTree`. ---- diff --git a/classes/class_node3dgizmo.rst b/classes/class_node3dgizmo.rst index 07343cb9f..63480e950 100644 --- a/classes/class_node3dgizmo.rst +++ b/classes/class_node3dgizmo.rst @@ -14,7 +14,9 @@ Node3DGizmo **Inherited By:** :ref:`EditorNode3DGizmo` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index cdfd659a7..5e370b0d1 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -294,12 +294,20 @@ Operator Descriptions - :ref:`bool` **operator !=** **(** :ref:`NodePath` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_NodePath_operator_eq_bool: - :ref:`bool` **operator ==** **(** :ref:`NodePath` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_noisetexture2d.rst b/classes/class_noisetexture2d.rst index 57c1c6ebc..a46faf057 100644 --- a/classes/class_noisetexture2d.rst +++ b/classes/class_noisetexture2d.rst @@ -34,29 +34,31 @@ The class uses :ref:`Thread`\ s to generate the texture data inter Properties ---------- -+---------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`as_normal_map` | ``false`` | -+---------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`bump_strength` | ``8.0`` | -+---------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`Gradient` | :ref:`color_ramp` | | -+---------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`generate_mipmaps` | ``true`` | -+---------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`height` | ``512`` | -+---------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`in_3d_space` | ``false`` | -+---------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`invert` | ``false`` | -+---------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`Noise` | :ref:`noise` | | -+---------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`seamless` | ``false`` | -+---------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`seamless_blend_skirt` | ``0.1`` | -+---------------------------------+---------------------------------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`width` | ``512`` | -+---------------------------------+---------------------------------------------------------------------------------+-----------+ ++---------------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`as_normal_map` | ``false`` | ++---------------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`bump_strength` | ``8.0`` | ++---------------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Gradient` | :ref:`color_ramp` | | ++---------------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`generate_mipmaps` | ``true`` | ++---------------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`height` | ``512`` | ++---------------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`in_3d_space` | ``false`` | ++---------------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`invert` | ``false`` | ++---------------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Noise` | :ref:`noise` | | ++---------------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | ++---------------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`seamless` | ``false`` | ++---------------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`seamless_blend_skirt` | ``0.1`` | ++---------------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`width` | ``512`` | ++---------------------------------+---------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ Property Descriptions --------------------- diff --git a/classes/class_oggpacketsequenceplayback.rst b/classes/class_oggpacketsequenceplayback.rst index dedb1681c..47d7e8887 100644 --- a/classes/class_oggpacketsequenceplayback.rst +++ b/classes/class_oggpacketsequenceplayback.rst @@ -12,7 +12,9 @@ OggPacketSequencePlayback **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index 9a55ea39d..57ea2b818 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -311,6 +311,10 @@ Returns the :ref:`PopupMenu` contained in this button. - :ref:`int` **get_selectable_item** **(** :ref:`bool` from_last=false **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_OptionButton_method_get_selected_id: @@ -333,6 +337,10 @@ Gets the metadata of the selected item. Metadata for items can be set using :ref - :ref:`bool` **has_selectable_items** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_OptionButton_method_is_item_disabled: @@ -347,6 +355,10 @@ Returns ``true`` if the item at index ``idx`` is disabled. - :ref:`bool` **is_item_separator** **(** :ref:`int` idx **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_OptionButton_method_remove_item: diff --git a/classes/class_os.rst b/classes/class_os.rst index 35f9a8f84..d4ae84ddb 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -955,7 +955,7 @@ Returns ``true`` if the environment variable with the name ``variable`` exists. - :ref:`bool` **has_feature** **(** :ref:`String` tag_name **)** |const| -Returns ``true`` if the feature for the given feature tag is supported in the currently running instance, depending on the platform, build, etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. Refer to the :doc:`Feature Tags <../getting_started/workflow/export/feature_tags>` documentation for more details. +Returns ``true`` if the feature for the given feature tag is supported in the currently running instance, depending on the platform, build, etc. Can be used to check whether you're currently running a debug build, on a certain platform or arch, etc. Refer to the :doc:`Feature Tags <../tutorials/export/feature_tags>` documentation for more details. \ **Note:** Tag names are case-sensitive. diff --git a/classes/class_packeddatacontainer.rst b/classes/class_packeddatacontainer.rst index 39aedb004..af237f81d 100644 --- a/classes/class_packeddatacontainer.rst +++ b/classes/class_packeddatacontainer.rst @@ -12,7 +12,9 @@ PackedDataContainer **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -41,6 +43,10 @@ Property Descriptions | *Default* | ``PackedByteArray()`` | +-----------+-----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + Method Descriptions ------------------- @@ -48,12 +54,20 @@ Method Descriptions - :ref:`Error` **pack** **(** :ref:`Variant` value **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PackedDataContainer_method_size: - :ref:`int` **size** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_packeddatacontainerref.rst b/classes/class_packeddatacontainerref.rst index 6ea26385b..f7811ff46 100644 --- a/classes/class_packeddatacontainerref.rst +++ b/classes/class_packeddatacontainerref.rst @@ -28,6 +28,10 @@ Method Descriptions - :ref:`int` **size** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_packetpeerextension.rst b/classes/class_packetpeerextension.rst index 48009987d..b05f7806f 100644 --- a/classes/class_packetpeerextension.rst +++ b/classes/class_packetpeerextension.rst @@ -12,7 +12,9 @@ PacketPeerExtension **Inherits:** :ref:`PacketPeer` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -34,24 +36,40 @@ Method Descriptions - :ref:`int` **_get_available_packet_count** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PacketPeerExtension_method__get_max_packet_size: - :ref:`int` **_get_max_packet_size** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PacketPeerExtension_method__get_packet: - :ref:`Error` **_get_packet** **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PacketPeerExtension_method__put_packet: - :ref:`Error` **_put_packet** **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_packetpeerstream.rst b/classes/class_packetpeerstream.rst index 0eb73f76a..81498e30a 100644 --- a/classes/class_packetpeerstream.rst +++ b/classes/class_packetpeerstream.rst @@ -47,6 +47,10 @@ Property Descriptions | *Getter* | get_input_buffer_max_size() | +-----------+----------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_PacketPeerStream_property_output_buffer_max_size: @@ -61,6 +65,10 @@ Property Descriptions | *Getter* | get_output_buffer_max_size() | +-----------+-----------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_PacketPeerStream_property_stream_peer: diff --git a/classes/class_particleprocessmaterial.rst b/classes/class_particleprocessmaterial.rst index 10eda696a..bfe4ba57a 100644 --- a/classes/class_particleprocessmaterial.rst +++ b/classes/class_particleprocessmaterial.rst @@ -1321,6 +1321,10 @@ Maximum amount set in the sub particles emitter. | *Getter* | get_sub_emitter_amount_at_end() | +----------+--------------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ParticleProcessMaterial_property_sub_emitter_frequency: @@ -1333,6 +1337,10 @@ Maximum amount set in the sub particles emitter. | *Getter* | get_sub_emitter_frequency() | +----------+----------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ParticleProcessMaterial_property_sub_emitter_keep_velocity: @@ -1347,6 +1355,10 @@ Maximum amount set in the sub particles emitter. | *Getter* | get_sub_emitter_keep_velocity() | +-----------+--------------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ParticleProcessMaterial_property_sub_emitter_mode: @@ -1361,6 +1373,10 @@ Maximum amount set in the sub particles emitter. | *Getter* | get_sub_emitter_mode() | +-----------+-----------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ParticleProcessMaterial_property_tangential_accel_curve: diff --git a/classes/class_physicalbone3d.rst b/classes/class_physicalbone3d.rst index ea076528d..ebf6f8aa2 100644 --- a/classes/class_physicalbone3d.rst +++ b/classes/class_physicalbone3d.rst @@ -12,7 +12,9 @@ PhysicalBone3D **Inherits:** :ref:`PhysicsBody3D` **<** :ref:`CollisionObject3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -389,30 +391,50 @@ Called during physics processing, allowing you to read and safely modify the sim - void **apply_central_impulse** **(** :ref:`Vector3` impulse **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicalBone3D_method_apply_impulse: - void **apply_impulse** **(** :ref:`Vector3` impulse, :ref:`Vector3` position=Vector3(0, 0, 0) **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicalBone3D_method_get_bone_id: - :ref:`int` **get_bone_id** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicalBone3D_method_get_simulate_physics: - :ref:`bool` **get_simulate_physics** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicalBone3D_method_is_simulating_physics: - :ref:`bool` **is_simulating_physics** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_physicalskymaterial.rst b/classes/class_physicalskymaterial.rst index 5d12add66..f6a3bd60e 100644 --- a/classes/class_physicalskymaterial.rst +++ b/classes/class_physicalskymaterial.rst @@ -65,6 +65,10 @@ Property Descriptions | *Getter* | get_energy_multiplier() | +-----------+------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicalSkyMaterial_property_ground_color: diff --git a/classes/class_physicsdirectbodystate2d.rst b/classes/class_physicsdirectbodystate2d.rst index 0e69c6031..462445802 100644 --- a/classes/class_physicsdirectbodystate2d.rst +++ b/classes/class_physicsdirectbodystate2d.rst @@ -31,31 +31,31 @@ Tutorials Properties ---------- -+---------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`float` | :ref:`angular_velocity` | ``0.0`` | -+---------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`Vector2` | :ref:`center_of_mass` | ``Vector2(0, 0)`` | -+---------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`Vector2` | :ref:`center_of_mass_local` | ``Vector2(0, 0)`` | -+---------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`float` | :ref:`inverse_inertia` | ``0.0`` | -+---------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`float` | :ref:`inverse_mass` | ``0.0`` | -+---------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`Vector2` | :ref:`linear_velocity` | ``Vector2(0, 0)`` | -+---------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`bool` | :ref:`sleeping` | ``false`` | -+---------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`float` | :ref:`step` | ``0.0`` | -+---------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`float` | :ref:`total_angular_damp` | ``0.0`` | -+---------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`Vector2` | :ref:`total_gravity` | ``Vector2(0, 0)`` | -+---------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`float` | :ref:`total_linear_damp` | ``0.0`` | -+---------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`Transform2D` | :ref:`transform` | ``Transform2D(1, 0, 0, 1, 0, 0)`` | -+---------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------+ ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`angular_velocity` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`center_of_mass` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`center_of_mass_local` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`inverse_inertia` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`inverse_mass` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`linear_velocity` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`sleeping` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`step` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`total_angular_damp` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`total_gravity` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`total_linear_damp` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`transform` | ++---------------------------------------+-------------------------------------------------------------------------------------------+ Methods ------- @@ -121,13 +121,11 @@ Property Descriptions - :ref:`float` **angular_velocity** -+-----------+-----------------------------+ -| *Default* | ``0.0`` | -+-----------+-----------------------------+ -| *Setter* | set_angular_velocity(value) | -+-----------+-----------------------------+ -| *Getter* | get_angular_velocity() | -+-----------+-----------------------------+ ++----------+-----------------------------+ +| *Setter* | set_angular_velocity(value) | ++----------+-----------------------------+ +| *Getter* | get_angular_velocity() | ++----------+-----------------------------+ The body's rotational velocity in *radians* per second. @@ -137,11 +135,9 @@ The body's rotational velocity in *radians* per second. - :ref:`Vector2` **center_of_mass** -+-----------+----------------------+ -| *Default* | ``Vector2(0, 0)`` | -+-----------+----------------------+ -| *Getter* | get_center_of_mass() | -+-----------+----------------------+ ++----------+----------------------+ +| *Getter* | get_center_of_mass() | ++----------+----------------------+ The body's center of mass position relative to the body's center in the global coordinate system. @@ -151,11 +147,9 @@ The body's center of mass position relative to the body's center in the global c - :ref:`Vector2` **center_of_mass_local** -+-----------+----------------------------+ -| *Default* | ``Vector2(0, 0)`` | -+-----------+----------------------------+ -| *Getter* | get_center_of_mass_local() | -+-----------+----------------------------+ ++----------+----------------------------+ +| *Getter* | get_center_of_mass_local() | ++----------+----------------------------+ The body's center of mass position in the body's local coordinate system. @@ -165,11 +159,9 @@ The body's center of mass position in the body's local coordinate system. - :ref:`float` **inverse_inertia** -+-----------+-----------------------+ -| *Default* | ``0.0`` | -+-----------+-----------------------+ -| *Getter* | get_inverse_inertia() | -+-----------+-----------------------+ ++----------+-----------------------+ +| *Getter* | get_inverse_inertia() | ++----------+-----------------------+ The inverse of the inertia of the body. @@ -179,11 +171,9 @@ The inverse of the inertia of the body. - :ref:`float` **inverse_mass** -+-----------+--------------------+ -| *Default* | ``0.0`` | -+-----------+--------------------+ -| *Getter* | get_inverse_mass() | -+-----------+--------------------+ ++----------+--------------------+ +| *Getter* | get_inverse_mass() | ++----------+--------------------+ The inverse of the mass of the body. @@ -193,13 +183,11 @@ The inverse of the mass of the body. - :ref:`Vector2` **linear_velocity** -+-----------+----------------------------+ -| *Default* | ``Vector2(0, 0)`` | -+-----------+----------------------------+ -| *Setter* | set_linear_velocity(value) | -+-----------+----------------------------+ -| *Getter* | get_linear_velocity() | -+-----------+----------------------------+ ++----------+----------------------------+ +| *Setter* | set_linear_velocity(value) | ++----------+----------------------------+ +| *Getter* | get_linear_velocity() | ++----------+----------------------------+ The body's linear velocity in pixels per second. @@ -209,13 +197,11 @@ The body's linear velocity in pixels per second. - :ref:`bool` **sleeping** -+-----------+------------------------+ -| *Default* | ``false`` | -+-----------+------------------------+ -| *Setter* | set_sleep_state(value) | -+-----------+------------------------+ -| *Getter* | is_sleeping() | -+-----------+------------------------+ ++----------+------------------------+ +| *Setter* | set_sleep_state(value) | ++----------+------------------------+ +| *Getter* | is_sleeping() | ++----------+------------------------+ If ``true``, this body is currently sleeping (not active). @@ -225,11 +211,9 @@ If ``true``, this body is currently sleeping (not active). - :ref:`float` **step** -+-----------+------------+ -| *Default* | ``0.0`` | -+-----------+------------+ -| *Getter* | get_step() | -+-----------+------------+ ++----------+------------+ +| *Getter* | get_step() | ++----------+------------+ The timestep (delta) used for the simulation. @@ -239,11 +223,9 @@ The timestep (delta) used for the simulation. - :ref:`float` **total_angular_damp** -+-----------+--------------------------+ -| *Default* | ``0.0`` | -+-----------+--------------------------+ -| *Getter* | get_total_angular_damp() | -+-----------+--------------------------+ ++----------+--------------------------+ +| *Getter* | get_total_angular_damp() | ++----------+--------------------------+ The rate at which the body stops rotating, if there are not any other forces moving it. @@ -253,11 +235,9 @@ The rate at which the body stops rotating, if there are not any other forces mov - :ref:`Vector2` **total_gravity** -+-----------+---------------------+ -| *Default* | ``Vector2(0, 0)`` | -+-----------+---------------------+ -| *Getter* | get_total_gravity() | -+-----------+---------------------+ ++----------+---------------------+ +| *Getter* | get_total_gravity() | ++----------+---------------------+ The total gravity vector being currently applied to this body. @@ -267,11 +247,9 @@ The total gravity vector being currently applied to this body. - :ref:`float` **total_linear_damp** -+-----------+-------------------------+ -| *Default* | ``0.0`` | -+-----------+-------------------------+ -| *Getter* | get_total_linear_damp() | -+-----------+-------------------------+ ++----------+-------------------------+ +| *Getter* | get_total_linear_damp() | ++----------+-------------------------+ The rate at which the body stops moving, if there are not any other forces moving it. @@ -281,13 +259,11 @@ The rate at which the body stops moving, if there are not any other forces movin - :ref:`Transform2D` **transform** -+-----------+-----------------------------------+ -| *Default* | ``Transform2D(1, 0, 0, 1, 0, 0)`` | -+-----------+-----------------------------------+ -| *Setter* | set_transform(value) | -+-----------+-----------------------------------+ -| *Getter* | get_transform() | -+-----------+-----------------------------------+ ++----------+----------------------+ +| *Setter* | set_transform(value) | ++----------+----------------------+ +| *Getter* | get_transform() | ++----------+----------------------+ The body's transformation matrix. @@ -372,6 +348,8 @@ An impulse is time-independent! Applying an impulse every frame would result in Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. +\ **Note:** :ref:`inverse_inertia` is required for this to work. To have :ref:`inverse_inertia`, an active :ref:`CollisionShape2D` must be a child of the node, or you can manually set :ref:`inverse_inertia`. + ---- .. _class_PhysicsDirectBodyState2D_method_apply_torque_impulse: @@ -382,6 +360,8 @@ Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). +\ **Note:** :ref:`inverse_inertia` is required for this to work. To have :ref:`inverse_inertia`, an active :ref:`CollisionShape2D` must be a child of the node, or you can manually set :ref:`inverse_inertia`. + ---- .. _class_PhysicsDirectBodyState2D_method_get_constant_force: diff --git a/classes/class_physicsdirectbodystate2dextension.rst b/classes/class_physicsdirectbodystate2dextension.rst index a983246c3..f9ddd23ef 100644 --- a/classes/class_physicsdirectbodystate2dextension.rst +++ b/classes/class_physicsdirectbodystate2dextension.rst @@ -12,7 +12,9 @@ PhysicsDirectBodyState2DExtension **Inherits:** :ref:`PhysicsDirectBodyState2D` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -110,252 +112,420 @@ Method Descriptions - void **_add_constant_central_force** **(** :ref:`Vector2` force **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__add_constant_force: - void **_add_constant_force** **(** :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__add_constant_torque: - void **_add_constant_torque** **(** :ref:`float` torque **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__apply_central_force: - void **_apply_central_force** **(** :ref:`Vector2` force **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__apply_central_impulse: - void **_apply_central_impulse** **(** :ref:`Vector2` impulse **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__apply_force: - void **_apply_force** **(** :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__apply_impulse: - void **_apply_impulse** **(** :ref:`Vector2` impulse, :ref:`Vector2` position **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__apply_torque: - void **_apply_torque** **(** :ref:`float` torque **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__apply_torque_impulse: - void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_angular_velocity: - :ref:`float` **_get_angular_velocity** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_center_of_mass: - :ref:`Vector2` **_get_center_of_mass** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_center_of_mass_local: - :ref:`Vector2` **_get_center_of_mass_local** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_constant_force: - :ref:`Vector2` **_get_constant_force** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_constant_torque: - :ref:`float` **_get_constant_torque** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_contact_collider: - :ref:`RID` **_get_contact_collider** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_contact_collider_id: - :ref:`int` **_get_contact_collider_id** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_contact_collider_object: - :ref:`Object` **_get_contact_collider_object** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_contact_collider_position: - :ref:`Vector2` **_get_contact_collider_position** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_contact_collider_shape: - :ref:`int` **_get_contact_collider_shape** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_contact_collider_velocity_at_position: - :ref:`Vector2` **_get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_contact_count: - :ref:`int` **_get_contact_count** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_contact_local_normal: - :ref:`Vector2` **_get_contact_local_normal** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_contact_local_position: - :ref:`Vector2` **_get_contact_local_position** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_contact_local_shape: - :ref:`int` **_get_contact_local_shape** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_inverse_inertia: - :ref:`float` **_get_inverse_inertia** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_inverse_mass: - :ref:`float` **_get_inverse_mass** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_linear_velocity: - :ref:`Vector2` **_get_linear_velocity** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_space_state: - :ref:`PhysicsDirectSpaceState2D` **_get_space_state** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_step: - :ref:`float` **_get_step** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_total_angular_damp: - :ref:`float` **_get_total_angular_damp** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_total_gravity: - :ref:`Vector2` **_get_total_gravity** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_total_linear_damp: - :ref:`float` **_get_total_linear_damp** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_transform: - :ref:`Transform2D` **_get_transform** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__get_velocity_at_local_position: - :ref:`Vector2` **_get_velocity_at_local_position** **(** :ref:`Vector2` local_position **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__integrate_forces: - void **_integrate_forces** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__is_sleeping: - :ref:`bool` **_is_sleeping** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__set_angular_velocity: - void **_set_angular_velocity** **(** :ref:`float` velocity **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__set_constant_force: - void **_set_constant_force** **(** :ref:`Vector2` force **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__set_constant_torque: - void **_set_constant_torque** **(** :ref:`float` torque **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__set_linear_velocity: - void **_set_linear_velocity** **(** :ref:`Vector2` velocity **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__set_sleep_state: - void **_set_sleep_state** **(** :ref:`bool` enabled **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState2DExtension_method__set_transform: - void **_set_transform** **(** :ref:`Transform2D` transform **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_physicsdirectbodystate3d.rst b/classes/class_physicsdirectbodystate3d.rst index d73b6fb58..54ef2e316 100644 --- a/classes/class_physicsdirectbodystate3d.rst +++ b/classes/class_physicsdirectbodystate3d.rst @@ -31,35 +31,35 @@ Tutorials Properties ---------- -+---------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Vector3` | :ref:`angular_velocity` | ``Vector3(0, 0, 0)`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Vector3` | :ref:`center_of_mass` | ``Vector3(0, 0, 0)`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Vector3` | :ref:`center_of_mass_local` | ``Vector3(0, 0, 0)`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Vector3` | :ref:`inverse_inertia` | ``Vector3(0, 0, 0)`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Basis` | :ref:`inverse_inertia_tensor` | ``Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`inverse_mass` | ``0.0`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Vector3` | :ref:`linear_velocity` | ``Vector3(0, 0, 0)`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Basis` | :ref:`principal_inertia_axes` | ``Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`sleeping` | ``false`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`step` | ``0.0`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`total_angular_damp` | ``0.0`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Vector3` | :ref:`total_gravity` | ``Vector3(0, 0, 0)`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`float` | :ref:`total_linear_damp` | ``0.0`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Transform3D` | :ref:`transform` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------+-----------------------------------------------------+ ++---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`angular_velocity` | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`center_of_mass` | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`center_of_mass_local` | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`inverse_inertia` | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`inverse_inertia_tensor` | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`inverse_mass` | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`linear_velocity` | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`principal_inertia_axes` | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`sleeping` | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`step` | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`total_angular_damp` | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`total_gravity` | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`total_linear_damp` | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`Transform3D` | :ref:`transform` | ++---------------------------------------+-----------------------------------------------------------------------------------------------+ Methods ------- @@ -127,13 +127,11 @@ Property Descriptions - :ref:`Vector3` **angular_velocity** -+-----------+-----------------------------+ -| *Default* | ``Vector3(0, 0, 0)`` | -+-----------+-----------------------------+ -| *Setter* | set_angular_velocity(value) | -+-----------+-----------------------------+ -| *Getter* | get_angular_velocity() | -+-----------+-----------------------------+ ++----------+-----------------------------+ +| *Setter* | set_angular_velocity(value) | ++----------+-----------------------------+ +| *Getter* | get_angular_velocity() | ++----------+-----------------------------+ The body's rotational velocity in *radians* per second. @@ -143,11 +141,9 @@ The body's rotational velocity in *radians* per second. - :ref:`Vector3` **center_of_mass** -+-----------+----------------------+ -| *Default* | ``Vector3(0, 0, 0)`` | -+-----------+----------------------+ -| *Getter* | get_center_of_mass() | -+-----------+----------------------+ ++----------+----------------------+ +| *Getter* | get_center_of_mass() | ++----------+----------------------+ The body's center of mass position relative to the body's center in the global coordinate system. @@ -157,11 +153,9 @@ The body's center of mass position relative to the body's center in the global c - :ref:`Vector3` **center_of_mass_local** -+-----------+----------------------------+ -| *Default* | ``Vector3(0, 0, 0)`` | -+-----------+----------------------------+ -| *Getter* | get_center_of_mass_local() | -+-----------+----------------------------+ ++----------+----------------------------+ +| *Getter* | get_center_of_mass_local() | ++----------+----------------------------+ The body's center of mass position in the body's local coordinate system. @@ -171,11 +165,9 @@ The body's center of mass position in the body's local coordinate system. - :ref:`Vector3` **inverse_inertia** -+-----------+-----------------------+ -| *Default* | ``Vector3(0, 0, 0)`` | -+-----------+-----------------------+ -| *Getter* | get_inverse_inertia() | -+-----------+-----------------------+ ++----------+-----------------------+ +| *Getter* | get_inverse_inertia() | ++----------+-----------------------+ The inverse of the inertia of the body. @@ -185,11 +177,9 @@ The inverse of the inertia of the body. - :ref:`Basis` **inverse_inertia_tensor** -+-----------+--------------------------------------+ -| *Default* | ``Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)`` | -+-----------+--------------------------------------+ -| *Getter* | get_inverse_inertia_tensor() | -+-----------+--------------------------------------+ ++----------+------------------------------+ +| *Getter* | get_inverse_inertia_tensor() | ++----------+------------------------------+ The inverse of the inertia tensor of the body. @@ -199,11 +189,9 @@ The inverse of the inertia tensor of the body. - :ref:`float` **inverse_mass** -+-----------+--------------------+ -| *Default* | ``0.0`` | -+-----------+--------------------+ -| *Getter* | get_inverse_mass() | -+-----------+--------------------+ ++----------+--------------------+ +| *Getter* | get_inverse_mass() | ++----------+--------------------+ The inverse of the mass of the body. @@ -213,13 +201,11 @@ The inverse of the mass of the body. - :ref:`Vector3` **linear_velocity** -+-----------+----------------------------+ -| *Default* | ``Vector3(0, 0, 0)`` | -+-----------+----------------------------+ -| *Setter* | set_linear_velocity(value) | -+-----------+----------------------------+ -| *Getter* | get_linear_velocity() | -+-----------+----------------------------+ ++----------+----------------------------+ +| *Setter* | set_linear_velocity(value) | ++----------+----------------------------+ +| *Getter* | get_linear_velocity() | ++----------+----------------------------+ The body's linear velocity in units per second. @@ -229,11 +215,13 @@ The body's linear velocity in units per second. - :ref:`Basis` **principal_inertia_axes** -+-----------+--------------------------------------+ -| *Default* | ``Basis(1, 0, 0, 0, 1, 0, 0, 0, 1)`` | -+-----------+--------------------------------------+ -| *Getter* | get_principal_inertia_axes() | -+-----------+--------------------------------------+ ++----------+------------------------------+ +| *Getter* | get_principal_inertia_axes() | ++----------+------------------------------+ + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! ---- @@ -241,13 +229,11 @@ The body's linear velocity in units per second. - :ref:`bool` **sleeping** -+-----------+------------------------+ -| *Default* | ``false`` | -+-----------+------------------------+ -| *Setter* | set_sleep_state(value) | -+-----------+------------------------+ -| *Getter* | is_sleeping() | -+-----------+------------------------+ ++----------+------------------------+ +| *Setter* | set_sleep_state(value) | ++----------+------------------------+ +| *Getter* | is_sleeping() | ++----------+------------------------+ If ``true``, this body is currently sleeping (not active). @@ -257,11 +243,9 @@ If ``true``, this body is currently sleeping (not active). - :ref:`float` **step** -+-----------+------------+ -| *Default* | ``0.0`` | -+-----------+------------+ -| *Getter* | get_step() | -+-----------+------------+ ++----------+------------+ +| *Getter* | get_step() | ++----------+------------+ The timestep (delta) used for the simulation. @@ -271,11 +255,9 @@ The timestep (delta) used for the simulation. - :ref:`float` **total_angular_damp** -+-----------+--------------------------+ -| *Default* | ``0.0`` | -+-----------+--------------------------+ -| *Getter* | get_total_angular_damp() | -+-----------+--------------------------+ ++----------+--------------------------+ +| *Getter* | get_total_angular_damp() | ++----------+--------------------------+ The rate at which the body stops rotating, if there are not any other forces moving it. @@ -285,11 +267,9 @@ The rate at which the body stops rotating, if there are not any other forces mov - :ref:`Vector3` **total_gravity** -+-----------+----------------------+ -| *Default* | ``Vector3(0, 0, 0)`` | -+-----------+----------------------+ -| *Getter* | get_total_gravity() | -+-----------+----------------------+ ++----------+---------------------+ +| *Getter* | get_total_gravity() | ++----------+---------------------+ The total gravity vector being currently applied to this body. @@ -299,11 +279,9 @@ The total gravity vector being currently applied to this body. - :ref:`float` **total_linear_damp** -+-----------+-------------------------+ -| *Default* | ``0.0`` | -+-----------+-------------------------+ -| *Getter* | get_total_linear_damp() | -+-----------+-------------------------+ ++----------+-------------------------+ +| *Getter* | get_total_linear_damp() | ++----------+-------------------------+ The rate at which the body stops moving, if there are not any other forces moving it. @@ -313,13 +291,11 @@ The rate at which the body stops moving, if there are not any other forces movin - :ref:`Transform3D` **transform** -+-----------+-----------------------------------------------------+ -| *Default* | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | -+-----------+-----------------------------------------------------+ -| *Setter* | set_transform(value) | -+-----------+-----------------------------------------------------+ -| *Getter* | get_transform() | -+-----------+-----------------------------------------------------+ ++----------+----------------------+ +| *Setter* | set_transform(value) | ++----------+----------------------+ +| *Getter* | get_transform() | ++----------+----------------------+ The body's transformation matrix. @@ -404,6 +380,8 @@ An impulse is time-independent! Applying an impulse every frame would result in Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. +\ **Note:** :ref:`inverse_inertia` is required for this to work. To have :ref:`inverse_inertia`, an active :ref:`CollisionShape3D` must be a child of the node, or you can manually set :ref:`inverse_inertia`. + ---- .. _class_PhysicsDirectBodyState3D_method_apply_torque_impulse: @@ -414,6 +392,8 @@ Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). +\ **Note:** :ref:`inverse_inertia` is required for this to work. To have :ref:`inverse_inertia`, an active :ref:`CollisionShape3D` must be a child of the node, or you can manually set :ref:`inverse_inertia`. + ---- .. _class_PhysicsDirectBodyState3D_method_get_constant_force: diff --git a/classes/class_physicsdirectbodystate3dextension.rst b/classes/class_physicsdirectbodystate3dextension.rst index 8c7cbfba8..f63d9e46f 100644 --- a/classes/class_physicsdirectbodystate3dextension.rst +++ b/classes/class_physicsdirectbodystate3dextension.rst @@ -12,7 +12,9 @@ PhysicsDirectBodyState3DExtension **Inherits:** :ref:`PhysicsDirectBodyState3D` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -116,270 +118,450 @@ Method Descriptions - void **_add_constant_central_force** **(** :ref:`Vector3` force **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__add_constant_force: - void **_add_constant_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__add_constant_torque: - void **_add_constant_torque** **(** :ref:`Vector3` torque **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__apply_central_force: - void **_apply_central_force** **(** :ref:`Vector3` force **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__apply_central_impulse: - void **_apply_central_impulse** **(** :ref:`Vector3` impulse **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__apply_force: - void **_apply_force** **(** :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__apply_impulse: - void **_apply_impulse** **(** :ref:`Vector3` impulse, :ref:`Vector3` position **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__apply_torque: - void **_apply_torque** **(** :ref:`Vector3` torque **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__apply_torque_impulse: - void **_apply_torque_impulse** **(** :ref:`Vector3` impulse **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_angular_velocity: - :ref:`Vector3` **_get_angular_velocity** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_center_of_mass: - :ref:`Vector3` **_get_center_of_mass** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_center_of_mass_local: - :ref:`Vector3` **_get_center_of_mass_local** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_constant_force: - :ref:`Vector3` **_get_constant_force** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_constant_torque: - :ref:`Vector3` **_get_constant_torque** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_contact_collider: - :ref:`RID` **_get_contact_collider** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_contact_collider_id: - :ref:`int` **_get_contact_collider_id** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_contact_collider_object: - :ref:`Object` **_get_contact_collider_object** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_contact_collider_position: - :ref:`Vector3` **_get_contact_collider_position** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_contact_collider_shape: - :ref:`int` **_get_contact_collider_shape** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_contact_collider_velocity_at_position: - :ref:`Vector3` **_get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_contact_count: - :ref:`int` **_get_contact_count** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_contact_impulse: - :ref:`float` **_get_contact_impulse** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_contact_local_normal: - :ref:`Vector3` **_get_contact_local_normal** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_contact_local_position: - :ref:`Vector3` **_get_contact_local_position** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_contact_local_shape: - :ref:`int` **_get_contact_local_shape** **(** :ref:`int` contact_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_inverse_inertia: - :ref:`Vector3` **_get_inverse_inertia** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_inverse_inertia_tensor: - :ref:`Basis` **_get_inverse_inertia_tensor** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_inverse_mass: - :ref:`float` **_get_inverse_mass** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_linear_velocity: - :ref:`Vector3` **_get_linear_velocity** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_principal_inertia_axes: - :ref:`Basis` **_get_principal_inertia_axes** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_space_state: - :ref:`PhysicsDirectSpaceState3D` **_get_space_state** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_step: - :ref:`float` **_get_step** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_total_angular_damp: - :ref:`float` **_get_total_angular_damp** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_total_gravity: - :ref:`Vector3` **_get_total_gravity** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_total_linear_damp: - :ref:`float` **_get_total_linear_damp** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_transform: - :ref:`Transform3D` **_get_transform** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__get_velocity_at_local_position: - :ref:`Vector3` **_get_velocity_at_local_position** **(** :ref:`Vector3` local_position **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__integrate_forces: - void **_integrate_forces** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__is_sleeping: - :ref:`bool` **_is_sleeping** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__set_angular_velocity: - void **_set_angular_velocity** **(** :ref:`Vector3` velocity **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__set_constant_force: - void **_set_constant_force** **(** :ref:`Vector3` force **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__set_constant_torque: - void **_set_constant_torque** **(** :ref:`Vector3` torque **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__set_linear_velocity: - void **_set_linear_velocity** **(** :ref:`Vector3` velocity **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__set_sleep_state: - void **_set_sleep_state** **(** :ref:`bool` enabled **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectBodyState3DExtension_method__set_transform: - void **_set_transform** **(** :ref:`Transform3D` transform **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_physicsdirectspacestate2dextension.rst b/classes/class_physicsdirectspacestate2dextension.rst index 17024292a..546091f94 100644 --- a/classes/class_physicsdirectspacestate2dextension.rst +++ b/classes/class_physicsdirectspacestate2dextension.rst @@ -12,7 +12,9 @@ PhysicsDirectSpaceState2DExtension **Inherits:** :ref:`PhysicsDirectSpaceState2D` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -38,36 +40,60 @@ Method Descriptions - :ref:`bool` **_cast_motion** **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, float* closest_safe, float* closest_unsafe **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectSpaceState2DExtension_method__collide_shape: - :ref:`bool` **_collide_shape** **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, void* results, :ref:`int` max_results, int32_t* result_count **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectSpaceState2DExtension_method__intersect_point: - :ref:`int` **_intersect_point** **(** :ref:`Vector2` position, :ref:`int` canvas_instance_id, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer2DExtensionShapeResult* results, :ref:`int` max_results **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectSpaceState2DExtension_method__intersect_ray: - :ref:`bool` **_intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, :ref:`bool` hit_from_inside, PhysicsServer2DExtensionRayResult* result **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectSpaceState2DExtension_method__intersect_shape: - :ref:`int` **_intersect_shape** **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer2DExtensionShapeResult* result, :ref:`int` max_results **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectSpaceState2DExtension_method__rest_info: - :ref:`bool` **_rest_info** **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer2DExtensionShapeRestInfo* rest_info **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_physicsdirectspacestate3dextension.rst b/classes/class_physicsdirectspacestate3dextension.rst index e7ccef2c4..fe72bb9e4 100644 --- a/classes/class_physicsdirectspacestate3dextension.rst +++ b/classes/class_physicsdirectspacestate3dextension.rst @@ -12,7 +12,9 @@ PhysicsDirectSpaceState3DExtension **Inherits:** :ref:`PhysicsDirectSpaceState3D` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -40,42 +42,70 @@ Method Descriptions - :ref:`bool` **_cast_motion** **(** :ref:`RID` shape_rid, :ref:`Transform3D` transform, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, float* closest_safe, float* closest_unsafe, PhysicsServer3DExtensionShapeRestInfo* info **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectSpaceState3DExtension_method__collide_shape: - :ref:`bool` **_collide_shape** **(** :ref:`RID` shape_rid, :ref:`Transform3D` transform, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, void* results, :ref:`int` max_results, int32_t* result_count **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectSpaceState3DExtension_method__get_closest_point_to_object_volume: - :ref:`Vector3` **_get_closest_point_to_object_volume** **(** :ref:`RID` object, :ref:`Vector3` point **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectSpaceState3DExtension_method__intersect_point: - :ref:`int` **_intersect_point** **(** :ref:`Vector3` position, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer3DExtensionShapeResult* results, :ref:`int` max_results **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectSpaceState3DExtension_method__intersect_ray: - :ref:`bool` **_intersect_ray** **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, :ref:`bool` hit_from_inside, :ref:`bool` hit_back_faces, PhysicsServer3DExtensionRayResult* result **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectSpaceState3DExtension_method__intersect_shape: - :ref:`int` **_intersect_shape** **(** :ref:`RID` shape_rid, :ref:`Transform3D` transform, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer3DExtensionShapeResult* result_count, :ref:`int` max_results **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsDirectSpaceState3DExtension_method__rest_info: - :ref:`bool` **_rest_info** **(** :ref:`RID` shape_rid, :ref:`Transform3D` transform, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer3DExtensionShapeRestInfo* rest_info **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_physicsserver2d.rst b/classes/class_physicsserver2d.rst index e3b68816d..0d8d8a122 100644 --- a/classes/class_physicsserver2d.rst +++ b/classes/class_physicsserver2d.rst @@ -656,6 +656,10 @@ Adds a shape to the area, along with a transform matrix. Shapes are usually refe - void **area_attach_canvas_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_area_attach_object_instance_id: @@ -686,6 +690,10 @@ Creates an :ref:`Area2D`. After creating an :ref:`Area2D` **area_get_canvas_instance_id** **(** :ref:`RID` area **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_area_get_collision_layer: @@ -772,6 +780,10 @@ Removes a shape from an area. It does not delete the shape, so it can be reassig - void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_area_set_collision_layer: @@ -812,6 +824,10 @@ Sets the function to call when any body/area enters or exits the area. This call - void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_area_set_param: @@ -972,6 +988,10 @@ An impulse is time-independent! Applying an impulse every frame would result in - void **body_attach_canvas_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_body_attach_object_instance_id: @@ -1002,6 +1022,10 @@ Creates a physics body. - :ref:`int` **body_get_canvas_instance_id** **(** :ref:`RID` body **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_body_get_collision_layer: @@ -1338,24 +1362,40 @@ Returns ``true`` if a collision would result from moving along a motion vector f - :ref:`RID` **capsule_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_circle_shape_create: - :ref:`RID` **circle_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_concave_polygon_shape_create: - :ref:`RID` **concave_polygon_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_convex_polygon_shape_create: - :ref:`RID` **convex_polygon_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_damped_spring_joint_get_param: @@ -1394,12 +1434,20 @@ Returns information about the current state of the 2D physics engine. See :ref:` - void **joint_clear** **(** :ref:`RID` joint **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_joint_create: - :ref:`RID` **joint_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_joint_get_param: @@ -1422,18 +1470,30 @@ Returns a joint's type (see :ref:`JointType`). - void **joint_make_damped_spring** **(** :ref:`RID` joint, :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_joint_make_groove: - void **joint_make_groove** **(** :ref:`RID` joint, :ref:`Vector2` groove1_a, :ref:`Vector2` groove2_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_joint_make_pin: - void **joint_make_pin** **(** :ref:`RID` joint, :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_joint_set_param: @@ -1448,18 +1508,30 @@ Sets a joint parameter. See :ref:`JointParam` f - :ref:`RID` **rectangle_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_segment_shape_create: - :ref:`RID` **segment_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_separation_ray_shape_create: - :ref:`RID` **separation_ray_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2D_method_set_active: @@ -1546,6 +1618,10 @@ Sets the value for a space parameter. See :ref:`SpaceParameter` **world_boundary_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_physicsserver2dextension.rst b/classes/class_physicsserver2dextension.rst index e3cd088a5..4b619b790 100644 --- a/classes/class_physicsserver2dextension.rst +++ b/classes/class_physicsserver2dextension.rst @@ -12,7 +12,9 @@ PhysicsServer2DExtension **Inherits:** :ref:`PhysicsServer2D` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -298,816 +300,1360 @@ Method Descriptions - void **_area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform, :ref:`bool` disabled **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_attach_canvas_instance_id: - void **_area_attach_canvas_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_attach_object_instance_id: - void **_area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_clear_shapes: - void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_create: - :ref:`RID` **_area_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_get_canvas_instance_id: - :ref:`int` **_area_get_canvas_instance_id** **(** :ref:`RID` area **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_get_collision_layer: - :ref:`int` **_area_get_collision_layer** **(** :ref:`RID` area **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_get_collision_mask: - :ref:`int` **_area_get_collision_mask** **(** :ref:`RID` area **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_get_object_instance_id: - :ref:`int` **_area_get_object_instance_id** **(** :ref:`RID` area **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_get_param: - :ref:`Variant` **_area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_get_shape: - :ref:`RID` **_area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_get_shape_count: - :ref:`int` **_area_get_shape_count** **(** :ref:`RID` area **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_get_shape_transform: - :ref:`Transform2D` **_area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_get_space: - :ref:`RID` **_area_get_space** **(** :ref:`RID` area **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_get_transform: - :ref:`Transform2D` **_area_get_transform** **(** :ref:`RID` area **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_remove_shape: - void **_area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_set_area_monitor_callback: - void **_area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_set_collision_layer: - void **_area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_set_collision_mask: - void **_area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_set_monitor_callback: - void **_area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_set_monitorable: - void **_area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_set_param: - void **_area_set_param** **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_set_pickable: - void **_area_set_pickable** **(** :ref:`RID` area, :ref:`bool` pickable **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_set_shape: - void **_area_set_shape** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_set_shape_disabled: - void **_area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_set_shape_transform: - void **_area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_set_space: - void **_area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__area_set_transform: - void **_area_set_transform** **(** :ref:`RID` area, :ref:`Transform2D` transform **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_add_collision_exception: - void **_body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_add_constant_central_force: - void **_body_add_constant_central_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_add_constant_force: - void **_body_add_constant_force** **(** :ref:`RID` body, :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_add_constant_torque: - void **_body_add_constant_torque** **(** :ref:`RID` body, :ref:`float` torque **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_add_shape: - void **_body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform, :ref:`bool` disabled **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_apply_central_force: - void **_body_apply_central_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_apply_central_impulse: - void **_body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector2` impulse **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_apply_force: - void **_body_apply_force** **(** :ref:`RID` body, :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_apply_impulse: - void **_body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector2` impulse, :ref:`Vector2` position **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_apply_torque: - void **_body_apply_torque** **(** :ref:`RID` body, :ref:`float` torque **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_apply_torque_impulse: - void **_body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`float` impulse **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_attach_canvas_instance_id: - void **_body_attach_canvas_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_attach_object_instance_id: - void **_body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_clear_shapes: - void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_collide_shape: - :ref:`bool` **_body_collide_shape** **(** :ref:`RID` body, :ref:`int` body_shape, :ref:`RID` shape, :ref:`Transform2D` shape_xform, :ref:`Vector2` motion, void* results, :ref:`int` result_max, int32_t* result_count **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_create: - :ref:`RID` **_body_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_canvas_instance_id: - :ref:`int` **_body_get_canvas_instance_id** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_collision_exceptions: - :ref:`RID[]` **_body_get_collision_exceptions** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_collision_layer: - :ref:`int` **_body_get_collision_layer** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_collision_mask: - :ref:`int` **_body_get_collision_mask** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_collision_priority: - :ref:`float` **_body_get_collision_priority** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_constant_force: - :ref:`Vector2` **_body_get_constant_force** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_constant_torque: - :ref:`float` **_body_get_constant_torque** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_contacts_reported_depth_threshold: - :ref:`float` **_body_get_contacts_reported_depth_threshold** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_continuous_collision_detection_mode: - :ref:`CCDMode` **_body_get_continuous_collision_detection_mode** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_direct_state: - :ref:`PhysicsDirectBodyState2D` **_body_get_direct_state** **(** :ref:`RID` body **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_max_contacts_reported: - :ref:`int` **_body_get_max_contacts_reported** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_mode: - :ref:`BodyMode` **_body_get_mode** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_object_instance_id: - :ref:`int` **_body_get_object_instance_id** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_param: - :ref:`Variant` **_body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_shape: - :ref:`RID` **_body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_shape_count: - :ref:`int` **_body_get_shape_count** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_shape_transform: - :ref:`Transform2D` **_body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_space: - :ref:`RID` **_body_get_space** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_get_state: - :ref:`Variant` **_body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_is_omitting_force_integration: - :ref:`bool` **_body_is_omitting_force_integration** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_remove_collision_exception: - void **_body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_remove_shape: - void **_body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_reset_mass_properties: - void **_body_reset_mass_properties** **(** :ref:`RID` body **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_axis_velocity: - void **_body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_collision_layer: - void **_body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_collision_mask: - void **_body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_collision_priority: - void **_body_set_collision_priority** **(** :ref:`RID` body, :ref:`float` priority **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_constant_force: - void **_body_set_constant_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_constant_torque: - void **_body_set_constant_torque** **(** :ref:`RID` body, :ref:`float` torque **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_contacts_reported_depth_threshold: - void **_body_set_contacts_reported_depth_threshold** **(** :ref:`RID` body, :ref:`float` threshold **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_continuous_collision_detection_mode: - void **_body_set_continuous_collision_detection_mode** **(** :ref:`RID` body, :ref:`CCDMode` mode **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_force_integration_callback: - void **_body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Callable` callable, :ref:`Variant` userdata **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_max_contacts_reported: - void **_body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_mode: - void **_body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` mode **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_omit_force_integration: - void **_body_set_omit_force_integration** **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_param: - void **_body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`Variant` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_pickable: - void **_body_set_pickable** **(** :ref:`RID` body, :ref:`bool` pickable **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_shape: - void **_body_set_shape** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_shape_as_one_way_collision: - void **_body_set_shape_as_one_way_collision** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable, :ref:`float` margin **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_shape_disabled: - void **_body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_shape_transform: - void **_body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_space: - void **_body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_state: - void **_body_set_state** **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_set_state_sync_callback: - void **_body_set_state_sync_callback** **(** :ref:`RID` body, :ref:`Callable` callable **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__body_test_motion: - :ref:`bool` **_body_test_motion** **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin, :ref:`bool` collide_separation_ray, :ref:`bool` recovery_as_collision, PhysicsServer2DExtensionMotionResult* result **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__capsule_shape_create: - :ref:`RID` **_capsule_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__circle_shape_create: - :ref:`RID` **_circle_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__concave_polygon_shape_create: - :ref:`RID` **_concave_polygon_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__convex_polygon_shape_create: - :ref:`RID` **_convex_polygon_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__damped_spring_joint_get_param: - :ref:`float` **_damped_spring_joint_get_param** **(** :ref:`RID` joint, :ref:`DampedSpringParam` param **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__damped_spring_joint_set_param: - void **_damped_spring_joint_set_param** **(** :ref:`RID` joint, :ref:`DampedSpringParam` param, :ref:`float` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__end_sync: - void **_end_sync** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__finish: - void **_finish** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__flush_queries: - void **_flush_queries** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__free_rid: - void **_free_rid** **(** :ref:`RID` rid **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__get_process_info: - :ref:`int` **_get_process_info** **(** :ref:`ProcessInfo` process_info **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__init: - void **_init** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__is_flushing_queries: - :ref:`bool` **_is_flushing_queries** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__joint_clear: - void **_joint_clear** **(** :ref:`RID` joint **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__joint_create: - :ref:`RID` **_joint_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__joint_disable_collisions_between_bodies: - void **_joint_disable_collisions_between_bodies** **(** :ref:`RID` joint, :ref:`bool` disable **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__joint_get_param: - :ref:`float` **_joint_get_param** **(** :ref:`RID` joint, :ref:`JointParam` param **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__joint_get_type: - :ref:`JointType` **_joint_get_type** **(** :ref:`RID` joint **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__joint_is_disabled_collisions_between_bodies: - :ref:`bool` **_joint_is_disabled_collisions_between_bodies** **(** :ref:`RID` joint **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__joint_make_damped_spring: - void **_joint_make_damped_spring** **(** :ref:`RID` joint, :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__joint_make_groove: - void **_joint_make_groove** **(** :ref:`RID` joint, :ref:`Vector2` a_groove1, :ref:`Vector2` a_groove2, :ref:`Vector2` b_anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__joint_make_pin: - void **_joint_make_pin** **(** :ref:`RID` joint, :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__joint_set_param: - void **_joint_set_param** **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__pin_joint_get_param: - :ref:`float` **_pin_joint_get_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__pin_joint_set_param: - void **_pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__rectangle_shape_create: - :ref:`RID` **_rectangle_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__segment_shape_create: - :ref:`RID` **_segment_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__separation_ray_shape_create: - :ref:`RID` **_separation_ray_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__set_active: - void **_set_active** **(** :ref:`bool` active **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__shape_collide: - :ref:`bool` **_shape_collide** **(** :ref:`RID` shape_A, :ref:`Transform2D` xform_A, :ref:`Vector2` motion_A, :ref:`RID` shape_B, :ref:`Transform2D` xform_B, :ref:`Vector2` motion_B, void* results, :ref:`int` result_max, int32_t* result_count **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__shape_get_custom_solver_bias: - :ref:`float` **_shape_get_custom_solver_bias** **(** :ref:`RID` shape **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__shape_get_data: - :ref:`Variant` **_shape_get_data** **(** :ref:`RID` shape **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__shape_get_type: - :ref:`ShapeType` **_shape_get_type** **(** :ref:`RID` shape **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__shape_set_custom_solver_bias: - void **_shape_set_custom_solver_bias** **(** :ref:`RID` shape, :ref:`float` bias **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__shape_set_data: - void **_shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__space_create: - :ref:`RID` **_space_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__space_get_contact_count: - :ref:`int` **_space_get_contact_count** **(** :ref:`RID` space **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__space_get_contacts: - :ref:`PackedVector2Array` **_space_get_contacts** **(** :ref:`RID` space **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__space_get_direct_state: - :ref:`PhysicsDirectSpaceState2D` **_space_get_direct_state** **(** :ref:`RID` space **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__space_get_param: - :ref:`float` **_space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__space_is_active: - :ref:`bool` **_space_is_active** **(** :ref:`RID` space **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__space_set_active: - void **_space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__space_set_debug_contacts: - void **_space_set_debug_contacts** **(** :ref:`RID` space, :ref:`int` max_contacts **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__space_set_param: - void **_space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__step: - void **_step** **(** :ref:`float` step **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__sync: - void **_sync** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer2DExtension_method__world_boundary_shape_create: - :ref:`RID` **_world_boundary_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_physicsserver3d.rst b/classes/class_physicsserver3d.rst index 27f003e6e..f07df96c9 100644 --- a/classes/class_physicsserver3d.rst +++ b/classes/class_physicsserver3d.rst @@ -1094,6 +1094,10 @@ Removes a shape from an area. It does not delete the shape, so it can be reassig - void **area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_area_set_collision_layer: @@ -1134,6 +1138,10 @@ Sets the function to call when any body/area enters or exits the area. This call - void **area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_area_set_param: @@ -1164,6 +1172,10 @@ Substitutes a given area shape by another. The old shape is selected by its inde - void **area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_area_set_shape_transform: @@ -1316,6 +1328,10 @@ Removes all shapes from a body. - :ref:`RID` **body_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_body_get_collision_layer: @@ -1446,6 +1462,10 @@ Returns a body state. - :ref:`bool` **body_is_axis_locked** **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_body_is_continuous_collision_detection_enabled: @@ -1494,6 +1514,10 @@ Restores the default inertia and center of mass based on shapes to cancel any cu - void **body_set_axis_lock** **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_body_set_axis_velocity: @@ -1624,6 +1648,10 @@ Substitutes a given body shape by another. The old shape is selected by its inde - void **body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_body_set_shape_transform: @@ -1662,18 +1690,30 @@ Returns ``true`` if a collision would result from moving along a motion vector f - :ref:`RID` **box_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_capsule_shape_create: - :ref:`RID` **capsule_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_concave_polygon_shape_create: - :ref:`RID` **concave_polygon_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_cone_twist_joint_get_param: @@ -1696,18 +1736,30 @@ Sets a cone_twist_joint parameter (see :ref:`ConeTwistJointParam` **convex_polygon_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_custom_shape_create: - :ref:`RID` **custom_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_cylinder_shape_create: - :ref:`RID` **cylinder_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_free_rid: @@ -1762,6 +1814,10 @@ Returns information about the current state of the 3D physics engine. See :ref:` - :ref:`RID` **heightmap_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_hinge_joint_get_flag: @@ -1800,12 +1856,20 @@ Sets a hinge_joint parameter (see :ref:`HingeJointParam` joint **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_joint_create: - :ref:`RID` **joint_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_joint_get_solver_priority: @@ -1828,30 +1892,50 @@ Returns the type of the Joint3D. - void **joint_make_cone_twist** **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_joint_make_generic_6dof: - void **joint_make_generic_6dof** **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_joint_make_hinge: - void **joint_make_hinge** **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` hinge_A, :ref:`RID` body_B, :ref:`Transform3D` hinge_B **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_joint_make_pin: - void **joint_make_pin** **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_joint_make_slider: - void **joint_make_slider** **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_joint_set_solver_priority: @@ -1914,6 +1998,10 @@ Sets a pin_joint parameter (see :ref:`PinJointParam` **separation_ray_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_set_active: @@ -1968,6 +2056,10 @@ Gets a slider_joint parameter (see :ref:`SliderJointParam` **soft_body_get_bounds** **(** :ref:`RID` body **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_space_create: @@ -2022,12 +2114,20 @@ Sets the value for a space parameter. A list of available parameters is on the : - :ref:`RID` **sphere_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3D_method_world_boundary_shape_create: - :ref:`RID` **world_boundary_shape_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_physicsserver3dextension.rst b/classes/class_physicsserver3dextension.rst index c05383fe2..13ad17c0b 100644 --- a/classes/class_physicsserver3dextension.rst +++ b/classes/class_physicsserver3dextension.rst @@ -12,7 +12,9 @@ PhysicsServer3DExtension **Inherits:** :ref:`PhysicsServer3D` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -398,1116 +400,1860 @@ Method Descriptions - void **_area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform3D` transform, :ref:`bool` disabled **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_attach_object_instance_id: - void **_area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_clear_shapes: - void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_create: - :ref:`RID` **_area_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_get_collision_layer: - :ref:`int` **_area_get_collision_layer** **(** :ref:`RID` area **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_get_collision_mask: - :ref:`int` **_area_get_collision_mask** **(** :ref:`RID` area **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_get_object_instance_id: - :ref:`int` **_area_get_object_instance_id** **(** :ref:`RID` area **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_get_param: - :ref:`Variant` **_area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_get_shape: - :ref:`RID` **_area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_get_shape_count: - :ref:`int` **_area_get_shape_count** **(** :ref:`RID` area **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_get_shape_transform: - :ref:`Transform3D` **_area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_get_space: - :ref:`RID` **_area_get_space** **(** :ref:`RID` area **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_get_transform: - :ref:`Transform3D` **_area_get_transform** **(** :ref:`RID` area **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_remove_shape: - void **_area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_set_area_monitor_callback: - void **_area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_set_collision_layer: - void **_area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_set_collision_mask: - void **_area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_set_monitor_callback: - void **_area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_set_monitorable: - void **_area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_set_param: - void **_area_set_param** **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_set_ray_pickable: - void **_area_set_ray_pickable** **(** :ref:`RID` area, :ref:`bool` enable **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_set_shape: - void **_area_set_shape** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_set_shape_disabled: - void **_area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_set_shape_transform: - void **_area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform3D` transform **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_set_space: - void **_area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__area_set_transform: - void **_area_set_transform** **(** :ref:`RID` area, :ref:`Transform3D` transform **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_add_collision_exception: - void **_body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_add_constant_central_force: - void **_body_add_constant_central_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_add_constant_force: - void **_body_add_constant_force** **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_add_constant_torque: - void **_body_add_constant_torque** **(** :ref:`RID` body, :ref:`Vector3` torque **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_add_shape: - void **_body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform3D` transform, :ref:`bool` disabled **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_apply_central_force: - void **_body_apply_central_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_apply_central_impulse: - void **_body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_apply_force: - void **_body_apply_force** **(** :ref:`RID` body, :ref:`Vector3` force, :ref:`Vector3` position **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_apply_impulse: - void **_body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse, :ref:`Vector3` position **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_apply_torque: - void **_body_apply_torque** **(** :ref:`RID` body, :ref:`Vector3` torque **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_apply_torque_impulse: - void **_body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`Vector3` impulse **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_attach_object_instance_id: - void **_body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_clear_shapes: - void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_create: - :ref:`RID` **_body_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_collision_exceptions: - :ref:`RID[]` **_body_get_collision_exceptions** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_collision_layer: - :ref:`int` **_body_get_collision_layer** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_collision_mask: - :ref:`int` **_body_get_collision_mask** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_collision_priority: - :ref:`float` **_body_get_collision_priority** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_constant_force: - :ref:`Vector3` **_body_get_constant_force** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_constant_torque: - :ref:`Vector3` **_body_get_constant_torque** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_contacts_reported_depth_threshold: - :ref:`float` **_body_get_contacts_reported_depth_threshold** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_direct_state: - :ref:`PhysicsDirectBodyState3D` **_body_get_direct_state** **(** :ref:`RID` body **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_max_contacts_reported: - :ref:`int` **_body_get_max_contacts_reported** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_mode: - :ref:`BodyMode` **_body_get_mode** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_object_instance_id: - :ref:`int` **_body_get_object_instance_id** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_param: - :ref:`Variant` **_body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_shape: - :ref:`RID` **_body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_shape_count: - :ref:`int` **_body_get_shape_count** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_shape_transform: - :ref:`Transform3D` **_body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_space: - :ref:`RID` **_body_get_space** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_state: - :ref:`Variant` **_body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_get_user_flags: - :ref:`int` **_body_get_user_flags** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_is_axis_locked: - :ref:`bool` **_body_is_axis_locked** **(** :ref:`RID` body, :ref:`BodyAxis` axis **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_is_continuous_collision_detection_enabled: - :ref:`bool` **_body_is_continuous_collision_detection_enabled** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_is_omitting_force_integration: - :ref:`bool` **_body_is_omitting_force_integration** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_remove_collision_exception: - void **_body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_remove_shape: - void **_body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_reset_mass_properties: - void **_body_reset_mass_properties** **(** :ref:`RID` body **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_axis_lock: - void **_body_set_axis_lock** **(** :ref:`RID` body, :ref:`BodyAxis` axis, :ref:`bool` lock **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_axis_velocity: - void **_body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector3` axis_velocity **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_collision_layer: - void **_body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_collision_mask: - void **_body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_collision_priority: - void **_body_set_collision_priority** **(** :ref:`RID` body, :ref:`float` priority **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_constant_force: - void **_body_set_constant_force** **(** :ref:`RID` body, :ref:`Vector3` force **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_constant_torque: - void **_body_set_constant_torque** **(** :ref:`RID` body, :ref:`Vector3` torque **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_contacts_reported_depth_threshold: - void **_body_set_contacts_reported_depth_threshold** **(** :ref:`RID` body, :ref:`float` threshold **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_enable_continuous_collision_detection: - void **_body_set_enable_continuous_collision_detection** **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_force_integration_callback: - void **_body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Callable` callable, :ref:`Variant` userdata **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_max_contacts_reported: - void **_body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_mode: - void **_body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` mode **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_omit_force_integration: - void **_body_set_omit_force_integration** **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_param: - void **_body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`Variant` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_ray_pickable: - void **_body_set_ray_pickable** **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_shape: - void **_body_set_shape** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_shape_disabled: - void **_body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_shape_transform: - void **_body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform3D` transform **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_space: - void **_body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_state: - void **_body_set_state** **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_state_sync_callback: - void **_body_set_state_sync_callback** **(** :ref:`RID` body, :ref:`Callable` callable **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_set_user_flags: - void **_body_set_user_flags** **(** :ref:`RID` body, :ref:`int` flags **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__body_test_motion: - :ref:`bool` **_body_test_motion** **(** :ref:`RID` body, :ref:`Transform3D` from, :ref:`Vector3` motion, :ref:`float` margin, :ref:`int` max_collisions, :ref:`bool` collide_separation_ray, PhysicsServer3DExtensionMotionResult* result **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__box_shape_create: - :ref:`RID` **_box_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__capsule_shape_create: - :ref:`RID` **_capsule_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__concave_polygon_shape_create: - :ref:`RID` **_concave_polygon_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__cone_twist_joint_get_param: - :ref:`float` **_cone_twist_joint_get_param** **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__cone_twist_joint_set_param: - void **_cone_twist_joint_set_param** **(** :ref:`RID` joint, :ref:`ConeTwistJointParam` param, :ref:`float` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__convex_polygon_shape_create: - :ref:`RID` **_convex_polygon_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__custom_shape_create: - :ref:`RID` **_custom_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__cylinder_shape_create: - :ref:`RID` **_cylinder_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__end_sync: - void **_end_sync** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__finish: - void **_finish** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__flush_queries: - void **_flush_queries** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__free_rid: - void **_free_rid** **(** :ref:`RID` rid **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__generic_6dof_joint_get_flag: - :ref:`bool` **_generic_6dof_joint_get_flag** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__generic_6dof_joint_get_param: - :ref:`float` **_generic_6dof_joint_get_param** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__generic_6dof_joint_set_flag: - void **_generic_6dof_joint_set_flag** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag, :ref:`bool` enable **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__generic_6dof_joint_set_param: - void **_generic_6dof_joint_set_param** **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisParam` param, :ref:`float` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__get_process_info: - :ref:`int` **_get_process_info** **(** :ref:`ProcessInfo` process_info **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__heightmap_shape_create: - :ref:`RID` **_heightmap_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__hinge_joint_get_flag: - :ref:`bool` **_hinge_joint_get_flag** **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__hinge_joint_get_param: - :ref:`float` **_hinge_joint_get_param** **(** :ref:`RID` joint, :ref:`HingeJointParam` param **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__hinge_joint_set_flag: - void **_hinge_joint_set_flag** **(** :ref:`RID` joint, :ref:`HingeJointFlag` flag, :ref:`bool` enabled **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__hinge_joint_set_param: - void **_hinge_joint_set_param** **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__init: - void **_init** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__is_flushing_queries: - :ref:`bool` **_is_flushing_queries** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__joint_clear: - void **_joint_clear** **(** :ref:`RID` joint **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__joint_create: - :ref:`RID` **_joint_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__joint_get_solver_priority: - :ref:`int` **_joint_get_solver_priority** **(** :ref:`RID` joint **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__joint_get_type: - :ref:`JointType` **_joint_get_type** **(** :ref:`RID` joint **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__joint_make_cone_twist: - void **_joint_make_cone_twist** **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__joint_make_generic_6dof: - void **_joint_make_generic_6dof** **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__joint_make_hinge: - void **_joint_make_hinge** **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` hinge_A, :ref:`RID` body_B, :ref:`Transform3D` hinge_B **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__joint_make_hinge_simple: - void **_joint_make_hinge_simple** **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Vector3` pivot_A, :ref:`Vector3` axis_A, :ref:`RID` body_B, :ref:`Vector3` pivot_B, :ref:`Vector3` axis_B **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__joint_make_pin: - void **_joint_make_pin** **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Vector3` local_A, :ref:`RID` body_B, :ref:`Vector3` local_B **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__joint_make_slider: - void **_joint_make_slider** **(** :ref:`RID` joint, :ref:`RID` body_A, :ref:`Transform3D` local_ref_A, :ref:`RID` body_B, :ref:`Transform3D` local_ref_B **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__joint_set_solver_priority: - void **_joint_set_solver_priority** **(** :ref:`RID` joint, :ref:`int` priority **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__pin_joint_get_local_a: - :ref:`Vector3` **_pin_joint_get_local_a** **(** :ref:`RID` joint **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__pin_joint_get_local_b: - :ref:`Vector3` **_pin_joint_get_local_b** **(** :ref:`RID` joint **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__pin_joint_get_param: - :ref:`float` **_pin_joint_get_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__pin_joint_set_local_a: - void **_pin_joint_set_local_a** **(** :ref:`RID` joint, :ref:`Vector3` local_A **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__pin_joint_set_local_b: - void **_pin_joint_set_local_b** **(** :ref:`RID` joint, :ref:`Vector3` local_B **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__pin_joint_set_param: - void **_pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__separation_ray_shape_create: - :ref:`RID` **_separation_ray_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__set_active: - void **_set_active** **(** :ref:`bool` active **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__shape_get_custom_solver_bias: - :ref:`float` **_shape_get_custom_solver_bias** **(** :ref:`RID` shape **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__shape_get_data: - :ref:`Variant` **_shape_get_data** **(** :ref:`RID` shape **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__shape_get_margin: - :ref:`float` **_shape_get_margin** **(** :ref:`RID` shape **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__shape_get_type: - :ref:`ShapeType` **_shape_get_type** **(** :ref:`RID` shape **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__shape_set_custom_solver_bias: - void **_shape_set_custom_solver_bias** **(** :ref:`RID` shape, :ref:`float` bias **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__shape_set_data: - void **_shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__shape_set_margin: - void **_shape_set_margin** **(** :ref:`RID` shape, :ref:`float` margin **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__slider_joint_get_param: - :ref:`float` **_slider_joint_get_param** **(** :ref:`RID` joint, :ref:`SliderJointParam` param **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__slider_joint_set_param: - void **_slider_joint_set_param** **(** :ref:`RID` joint, :ref:`SliderJointParam` param, :ref:`float` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_add_collision_exception: - void **_soft_body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` body_b **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_create: - :ref:`RID` **_soft_body_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_get_bounds: - :ref:`AABB` **_soft_body_get_bounds** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_get_collision_exceptions: - :ref:`RID[]` **_soft_body_get_collision_exceptions** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_get_collision_layer: - :ref:`int` **_soft_body_get_collision_layer** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_get_collision_mask: - :ref:`int` **_soft_body_get_collision_mask** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_get_damping_coefficient: - :ref:`float` **_soft_body_get_damping_coefficient** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_get_drag_coefficient: - :ref:`float` **_soft_body_get_drag_coefficient** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_get_linear_stiffness: - :ref:`float` **_soft_body_get_linear_stiffness** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_get_point_global_position: - :ref:`Vector3` **_soft_body_get_point_global_position** **(** :ref:`RID` body, :ref:`int` point_index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_get_pressure_coefficient: - :ref:`float` **_soft_body_get_pressure_coefficient** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_get_simulation_precision: - :ref:`int` **_soft_body_get_simulation_precision** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_get_space: - :ref:`RID` **_soft_body_get_space** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_get_state: - :ref:`Variant` **_soft_body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_get_total_mass: - :ref:`float` **_soft_body_get_total_mass** **(** :ref:`RID` body **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_is_point_pinned: - :ref:`bool` **_soft_body_is_point_pinned** **(** :ref:`RID` body, :ref:`int` point_index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_move_point: - void **_soft_body_move_point** **(** :ref:`RID` body, :ref:`int` point_index, :ref:`Vector3` global_position **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_pin_point: - void **_soft_body_pin_point** **(** :ref:`RID` body, :ref:`int` point_index, :ref:`bool` pin **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_remove_all_pinned_points: - void **_soft_body_remove_all_pinned_points** **(** :ref:`RID` body **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_remove_collision_exception: - void **_soft_body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` body_b **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_set_collision_layer: - void **_soft_body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_set_collision_mask: - void **_soft_body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_set_damping_coefficient: - void **_soft_body_set_damping_coefficient** **(** :ref:`RID` body, :ref:`float` damping_coefficient **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_set_drag_coefficient: - void **_soft_body_set_drag_coefficient** **(** :ref:`RID` body, :ref:`float` drag_coefficient **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_set_linear_stiffness: - void **_soft_body_set_linear_stiffness** **(** :ref:`RID` body, :ref:`float` linear_stiffness **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_set_mesh: - void **_soft_body_set_mesh** **(** :ref:`RID` body, :ref:`RID` mesh **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_set_pressure_coefficient: - void **_soft_body_set_pressure_coefficient** **(** :ref:`RID` body, :ref:`float` pressure_coefficient **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_set_ray_pickable: - void **_soft_body_set_ray_pickable** **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_set_simulation_precision: - void **_soft_body_set_simulation_precision** **(** :ref:`RID` body, :ref:`int` simulation_precision **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_set_space: - void **_soft_body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_set_state: - void **_soft_body_set_state** **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` variant **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_set_total_mass: - void **_soft_body_set_total_mass** **(** :ref:`RID` body, :ref:`float` total_mass **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_set_transform: - void **_soft_body_set_transform** **(** :ref:`RID` body, :ref:`Transform3D` transform **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__soft_body_update_rendering_server: - void **_soft_body_update_rendering_server** **(** :ref:`RID` body, :ref:`PhysicsServer3DRenderingServerHandler` rendering_server_handler **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__space_create: - :ref:`RID` **_space_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__space_get_contact_count: - :ref:`int` **_space_get_contact_count** **(** :ref:`RID` space **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__space_get_contacts: - :ref:`PackedVector3Array` **_space_get_contacts** **(** :ref:`RID` space **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__space_get_direct_state: - :ref:`PhysicsDirectSpaceState3D` **_space_get_direct_state** **(** :ref:`RID` space **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__space_get_param: - :ref:`float` **_space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__space_is_active: - :ref:`bool` **_space_is_active** **(** :ref:`RID` space **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__space_set_active: - void **_space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__space_set_debug_contacts: - void **_space_set_debug_contacts** **(** :ref:`RID` space, :ref:`int` max_contacts **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__space_set_param: - void **_space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__sphere_shape_create: - :ref:`RID` **_sphere_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__step: - void **_step** **(** :ref:`float` step **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__sync: - void **_sync** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DExtension_method__world_boundary_shape_create: - :ref:`RID` **_world_boundary_shape_create** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_physicsserver3drenderingserverhandler.rst b/classes/class_physicsserver3drenderingserverhandler.rst index 1b04015d0..3bdff493a 100644 --- a/classes/class_physicsserver3drenderingserverhandler.rst +++ b/classes/class_physicsserver3drenderingserverhandler.rst @@ -12,7 +12,9 @@ PhysicsServer3DRenderingServerHandler **Inherits:** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -32,18 +34,30 @@ Method Descriptions - void **_set_aabb** **(** :ref:`AABB` aabb **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DRenderingServerHandler_method__set_normal: - void **_set_normal** **(** :ref:`int` vertex_id, const void* normals **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PhysicsServer3DRenderingServerHandler_method__set_vertex: - void **_set_vertex** **(** :ref:`int` vertex_id, const void* vertices **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_placeholdercubemap.rst b/classes/class_placeholdercubemap.rst index 69802662b..5eaec7a38 100644 --- a/classes/class_placeholdercubemap.rst +++ b/classes/class_placeholdercubemap.rst @@ -12,7 +12,16 @@ PlaceholderCubemap **Inherits:** :ref:`PlaceholderTextureLayered` **<** :ref:`TextureLayered` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +Placeholder class for a cubemap texture. +Description +----------- + +This class is used when loading a project that uses a :ref:`Cubemap` subclass in 2 conditions: + +- When running the project exported in dedicated server mode, only the texture's dimensions are kept (as they may be relied upon for gameplay purposes or positioning of other elements). This allows reducing the exported PCK's size significantly. + +- When this subclass is missing due to using a different engine version or build (e.g. modules disabled). .. |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.)` diff --git a/classes/class_placeholdercubemaparray.rst b/classes/class_placeholdercubemaparray.rst index 6d5619b12..56efe64ac 100644 --- a/classes/class_placeholdercubemaparray.rst +++ b/classes/class_placeholdercubemaparray.rst @@ -12,7 +12,16 @@ PlaceholderCubemapArray **Inherits:** :ref:`PlaceholderTextureLayered` **<** :ref:`TextureLayered` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +Placeholder class for a cubemap texture array. +Description +----------- + +This class is used when loading a project that uses a :ref:`CubemapArray` subclass in 2 conditions: + +- When running the project exported in dedicated server mode, only the texture's dimensions are kept (as they may be relied upon for gameplay purposes or positioning of other elements). This allows reducing the exported PCK's size significantly. + +- When this subclass is missing due to using a different engine version or build (e.g. modules disabled). .. |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.)` diff --git a/classes/class_placeholdermaterial.rst b/classes/class_placeholdermaterial.rst index ea9f67e07..81dc9a7b4 100644 --- a/classes/class_placeholdermaterial.rst +++ b/classes/class_placeholdermaterial.rst @@ -12,7 +12,16 @@ PlaceholderMaterial **Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +Placeholder class for a material. +Description +----------- + +This class is used when loading a project that uses a :ref:`Material` subclass in 2 conditions: + +- When running the project exported in dedicated server mode, only the texture's dimensions are kept (as they may be relied upon for gameplay purposes or positioning of other elements). This allows reducing the exported PCK's size significantly. + +- When this subclass is missing due to using a different engine version or build (e.g. modules disabled). .. |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.)` diff --git a/classes/class_placeholdermesh.rst b/classes/class_placeholdermesh.rst index af6525fba..c6c21d863 100644 --- a/classes/class_placeholdermesh.rst +++ b/classes/class_placeholdermesh.rst @@ -12,7 +12,16 @@ PlaceholderMesh **Inherits:** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +Placeholder class for a mesh. +Description +----------- + +This class is used when loading a project that uses a :ref:`Mesh` subclass in 2 conditions: + +- When running the project exported in dedicated server mode, only the texture's dimensions are kept (as they may be relied upon for gameplay purposes or positioning of other elements). This allows reducing the exported PCK's size significantly. + +- When this subclass is missing due to using a different engine version or build (e.g. modules disabled). Properties ---------- @@ -36,6 +45,8 @@ Property Descriptions | *Getter* | get_aabb() | +-----------+----------------------------+ +The smallest :ref:`AABB` enclosing this mesh in local space. + .. |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.)` diff --git a/classes/class_placeholdertexture2d.rst b/classes/class_placeholdertexture2d.rst index e5e838b28..0057b17ed 100644 --- a/classes/class_placeholdertexture2d.rst +++ b/classes/class_placeholdertexture2d.rst @@ -12,14 +12,25 @@ PlaceholderTexture2D **Inherits:** :ref:`Texture2D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +Placeholder class for a 2-dimensional texture. +Description +----------- + +This class is used when loading a project that uses a :ref:`Texture2D` subclass in 2 conditions: + +- When running the project exported in dedicated server mode, only the texture's dimensions are kept (as they may be relied upon for gameplay purposes or positioning of other elements). This allows reducing the exported PCK's size significantly. + +- When this subclass is missing due to using a different engine version or build (e.g. modules disabled). Properties ---------- -+-------------------------------+-------------------------------------------------------+-------------------+ -| :ref:`Vector2` | :ref:`size` | ``Vector2(1, 1)`` | -+-------------------------------+-------------------------------------------------------+-------------------+ ++-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | ++-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`size` | ``Vector2(1, 1)`` | ++-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -36,6 +47,8 @@ Property Descriptions | *Getter* | get_size() | +-----------+-------------------+ +The texture's size (in pixels). + .. |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.)` diff --git a/classes/class_placeholdertexture2darray.rst b/classes/class_placeholdertexture2darray.rst index cd6bfe163..15ff226e0 100644 --- a/classes/class_placeholdertexture2darray.rst +++ b/classes/class_placeholdertexture2darray.rst @@ -12,7 +12,16 @@ PlaceholderTexture2DArray **Inherits:** :ref:`PlaceholderTextureLayered` **<** :ref:`TextureLayered` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +Placeholder class for a 2-dimensional texture array. +Description +----------- + +This class is used when loading a project that uses a :ref:`Texture2D` subclass in 2 conditions: + +- When running the project exported in dedicated server mode, only the texture's dimensions are kept (as they may be relied upon for gameplay purposes or positioning of other elements). This allows reducing the exported PCK's size significantly. + +- When this subclass is missing due to using a different engine version or build (e.g. modules disabled). .. |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.)` diff --git a/classes/class_placeholdertexture3d.rst b/classes/class_placeholdertexture3d.rst index 375c89952..82705c0c2 100644 --- a/classes/class_placeholdertexture3d.rst +++ b/classes/class_placeholdertexture3d.rst @@ -12,7 +12,16 @@ PlaceholderTexture3D **Inherits:** :ref:`Texture3D` **<** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +Placeholder class for a 3-dimensional texture. +Description +----------- + +This class is used when loading a project that uses a :ref:`Texture3D` subclass in 2 conditions: + +- When running the project exported in dedicated server mode, only the texture's dimensions are kept (as they may be relied upon for gameplay purposes or positioning of other elements). This allows reducing the exported PCK's size significantly. + +- When this subclass is missing due to using a different engine version or build (e.g. modules disabled). Properties ---------- @@ -36,6 +45,8 @@ Property Descriptions | *Getter* | get_size() | +-----------+-----------------------+ +The texture's size (in pixels). + .. |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.)` diff --git a/classes/class_placeholdertexturelayered.rst b/classes/class_placeholdertexturelayered.rst index e957bd69f..b2c898b7f 100644 --- a/classes/class_placeholdertexturelayered.rst +++ b/classes/class_placeholdertexturelayered.rst @@ -14,7 +14,16 @@ PlaceholderTextureLayered **Inherited By:** :ref:`PlaceholderCubemap`, :ref:`PlaceholderCubemapArray`, :ref:`PlaceholderTexture2DArray` +Placeholder class for a 2-dimensional texture array. +Description +----------- + +This class is used when loading a project that uses a :ref:`TextureLayered` subclass in 2 conditions: + +- When running the project exported in dedicated server mode, only the texture's dimensions are kept (as they may be relied upon for gameplay purposes or positioning of other elements). This allows reducing the exported PCK's size significantly. + +- When this subclass is missing due to using a different engine version or build (e.g. modules disabled). Properties ---------- @@ -40,6 +49,8 @@ Property Descriptions | *Getter* | get_layers() | +-----------+-------------------+ +The number of layers in the texture array. + ---- .. _class_PlaceholderTextureLayered_property_size: @@ -54,6 +65,8 @@ Property Descriptions | *Getter* | get_size() | +-----------+--------------------+ +The size of each texture layer (in pixels). + .. |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.)` diff --git a/classes/class_pointlight2d.rst b/classes/class_pointlight2d.rst index d320d8a39..3b66f7a1e 100644 --- a/classes/class_pointlight2d.rst +++ b/classes/class_pointlight2d.rst @@ -12,7 +12,9 @@ PointLight2D **Inherits:** :ref:`Light2D` **<** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index 72e27050e..ef888178a 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -104,6 +104,10 @@ If ``true``, polygon edges will be anti-aliased. | *Default* | ``[]`` | +-----------+--------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_Polygon2D_property_color: @@ -134,6 +138,10 @@ The polygon's fill color. If ``texture`` is defined, it will be multiplied by th | *Getter* | get_internal_vertex_count() | +-----------+----------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_Polygon2D_property_invert_border: @@ -230,6 +238,10 @@ The list of polygons, in case more than one is being represented. Every individu | *Getter* | get_skeleton() | +-----------+---------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_Polygon2D_property_texture: diff --git a/classes/class_polygonpathfinder.rst b/classes/class_polygonpathfinder.rst index 2692ab213..e818327ac 100644 --- a/classes/class_polygonpathfinder.rst +++ b/classes/class_polygonpathfinder.rst @@ -12,7 +12,9 @@ PolygonPathFinder **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -42,48 +44,80 @@ Method Descriptions - :ref:`PackedVector2Array` **find_path** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PolygonPathFinder_method_get_bounds: - :ref:`Rect2` **get_bounds** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PolygonPathFinder_method_get_closest_point: - :ref:`Vector2` **get_closest_point** **(** :ref:`Vector2` point **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PolygonPathFinder_method_get_intersections: - :ref:`PackedVector2Array` **get_intersections** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PolygonPathFinder_method_get_point_penalty: - :ref:`float` **get_point_penalty** **(** :ref:`int` idx **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PolygonPathFinder_method_is_point_inside: - :ref:`bool` **is_point_inside** **(** :ref:`Vector2` point **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PolygonPathFinder_method_set_point_penalty: - void **set_point_penalty** **(** :ref:`int` idx, :ref:`float` penalty **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PolygonPathFinder_method_setup: - void **setup** **(** :ref:`PackedVector2Array` points, :ref:`PackedInt32Array` connections **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index c74a80d42..2ec1f3436 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -1008,6 +1008,10 @@ Width of the single indentation level. | *Default* | ``2`` | +-----------+-------+ +.. container:: contribute + + There is currently no description for this theme property. Please help us by :ref:`contributing one `! + ---- .. _class_PopupMenu_theme_constant_item_start_padding: @@ -1018,6 +1022,10 @@ Width of the single indentation level. | *Default* | ``2`` | +-----------+-------+ +.. container:: contribute + + There is currently no description for this theme property. Please help us by :ref:`contributing one `! + ---- .. _class_PopupMenu_theme_constant_outline_size: diff --git a/classes/class_portablecompressedtexture2d.rst b/classes/class_portablecompressedtexture2d.rst index 5e3eed3a9..a6932cb45 100644 --- a/classes/class_portablecompressedtexture2d.rst +++ b/classes/class_portablecompressedtexture2d.rst @@ -30,13 +30,15 @@ This resource is intended to be created from code. Properties ---------- -+-----------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------+ -| :ref:`PackedByteArray` | :ref:`_data` | ``PackedByteArray()`` | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------+ -| :ref:`bool` | :ref:`keep_compressed_buffer` | ``false`` | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------+ -| :ref:`Vector2` | :ref:`size_override` | ``Vector2(0, 0)`` | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------+-----------------------+ ++-----------------------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`_data` | ``PackedByteArray()`` | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`keep_compressed_buffer` | ``false`` | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`bool` | resource_local_to_scene | ``false`` (overrides :ref:`Resource`) | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`size_override` | ``Vector2(0, 0)`` | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------+ Methods ------- @@ -95,6 +97,10 @@ Property Descriptions | *Default* | ``PackedByteArray()`` | +-----------+-----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_PortableCompressedTexture2D_property_keep_compressed_buffer: @@ -138,7 +144,7 @@ Method Descriptions Initializes the compressed texture from a base image. The compression mode must be provided. -If this image will be used as a normal map, the "normal map" flag is recommended, to ensure optimum quality. +\ ``normal_map`` is recommended to ensure optimum quality if this image will be used as a normal map. If lossy compression is requested, the quality setting can optionally be provided. This maps to Lossy WebP compression quality. diff --git a/classes/class_primitivemesh.rst b/classes/class_primitivemesh.rst index 5de4fd22a..42abc935f 100644 --- a/classes/class_primitivemesh.rst +++ b/classes/class_primitivemesh.rst @@ -24,6 +24,8 @@ Base class for all primitive meshes. Handles applying a :ref:`Material` | :ref:`add_uv2` | ``false`` | +---------------------------------+--------------------------------------------------------------+----------------------------+ | :ref:`AABB` | :ref:`custom_aabb` | ``AABB(0, 0, 0, 0, 0, 0)`` | +---------------------------------+--------------------------------------------------------------+----------------------------+ @@ -31,6 +33,8 @@ Properties +---------------------------------+--------------------------------------------------------------+----------------------------+ | :ref:`Material` | :ref:`material` | | +---------------------------------+--------------------------------------------------------------+----------------------------+ +| :ref:`float` | :ref:`uv2_padding` | ``2.0`` | ++---------------------------------+--------------------------------------------------------------+----------------------------+ Methods ------- @@ -44,6 +48,22 @@ Methods Property Descriptions --------------------- +.. _class_PrimitiveMesh_property_add_uv2: + +- :ref:`bool` **add_uv2** + ++-----------+--------------------+ +| *Default* | ``false`` | ++-----------+--------------------+ +| *Setter* | set_add_uv2(value) | ++-----------+--------------------+ +| *Getter* | get_add_uv2() | ++-----------+--------------------+ + +If set, generates UV2 UV coordinates applying a padding using the :ref:`uv2_padding` setting. UV2 is needed for lightmapping. + +---- + .. _class_PrimitiveMesh_property_custom_aabb: - :ref:`AABB` **custom_aabb** @@ -90,6 +110,22 @@ This gives the same result as using :ref:`BaseMaterial3D.CULL_FRONT` of the primitive mesh. +---- + +.. _class_PrimitiveMesh_property_uv2_padding: + +- :ref:`float` **uv2_padding** + ++-----------+------------------------+ +| *Default* | ``2.0`` | ++-----------+------------------------+ +| *Setter* | set_uv2_padding(value) | ++-----------+------------------------+ +| *Getter* | get_uv2_padding() | ++-----------+------------------------+ + +If :ref:`add_uv2` is set, specifies the padding in pixels applied along seams of the mesh. If at generation the size of the lightmap texture can't be determined, the UVs are calculated assuming a texture size of 1024x1024. + Method Descriptions ------------------- @@ -97,6 +133,10 @@ Method Descriptions - :ref:`Array` **_create_mesh_array** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_PrimitiveMesh_method_get_mesh_arrays: diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index c29a4d851..4b6cbd296 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -22,15 +22,11 @@ General-purpose progress bar. Shows fill percentage from right to left. Properties ---------- -+---------------------------+--------------------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`fill_mode` | ``0`` | -+---------------------------+--------------------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`show_percentage` | ``true`` | -+---------------------------+--------------------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | size_flags_vertical | ``0`` (overrides :ref:`Control`) | -+---------------------------+--------------------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | step | ``0.01`` (overrides :ref:`Range`) | -+---------------------------+--------------------------------------------------------------------+------------------------------------------------------------------------------+ ++-------------------------+--------------------------------------------------------------------+----------+ +| :ref:`int` | :ref:`fill_mode` | ``0`` | ++-------------------------+--------------------------------------------------------------------+----------+ +| :ref:`bool` | :ref:`show_percentage` | ``true`` | ++-------------------------+--------------------------------------------------------------------+----------+ Theme Properties ---------------- diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index a14919f9d..21d8e4602 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -108,9 +108,9 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`audio/driver/output_latency.web` | ``50`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio/general/2d_panning_strength` | ``1.0`` | +| :ref:`float` | :ref:`audio/general/2d_panning_strength` | ``0.5`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio/general/3d_panning_strength` | ``1.0`` | +| :ref:`float` | :ref:`audio/general/3d_panning_strength` | ``0.5`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`audio/video/video_delay_compensation_ms` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -124,6 +124,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`compression/formats/zstd/window_log_size` | ``27`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/disable_touch` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/file_logging/enable_file_logging` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/file_logging/enable_file_logging.pc` | ``true`` | @@ -996,6 +998,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`physics/common/enable_object_picking` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/common/max_physics_steps_per_frame` | ``8`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`physics/common/physics_jitter_fix` | ``0.5`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`physics/common/physics_ticks_per_second` | ``60`` | @@ -1134,6 +1138,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/lightmapping/bake_quality/ultra_quality_ray_count` | ``1024`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/lightmapping/primitive_meshes/texel_size` | ``0.2`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`rendering/lightmapping/probe_capture/update_speed` | ``15`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/lights_and_shadows/directional_shadow/16_bits` | ``true`` | @@ -1272,8 +1278,6 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/textures/lossless_compression/force_png` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/textures/lossless_compression/webp_compression_level` | ``2`` | -+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/textures/vram_compression/import_bptc` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/textures/vram_compression/import_etc` | ``false`` | @@ -1282,6 +1286,10 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/textures/vram_compression/import_s3tc` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/textures/webp_compression/compression_method` | ``2`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/textures/webp_compression/lossless_compression_factor` | ``25`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`rendering/transparent_background` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/vrs/mode` | ``0`` | @@ -1425,7 +1433,7 @@ If ``true``, applies linear filtering when scaling the image (recommended for hi | *Default* | ``""`` | +-----------+--------+ -This user directory is used for storing persistent data (``user://`` filesystem). If left empty, ``user://`` resolves to a project-specific folder in Godot's own configuration folder (see :ref:`OS.get_user_data_dir`). If a custom directory name is defined, this name will be used instead and appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in :ref:`OS.get_user_data_dir`). +This user directory is used for storing persistent data (``user://`` filesystem). If a custom directory name is defined, this name will be appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in :ref:`OS.get_user_data_dir`). The :ref:`application/config/use_custom_user_dir` setting must be enabled for this to take effect. @@ -1523,7 +1531,9 @@ Specifies a file to override project settings. For example: ``user://custom_sett | *Default* | ``false`` | +-----------+-----------+ -If ``true``, the project will save user data to its own user directory (see :ref:`application/config/custom_user_dir_name`). This setting is only effective on desktop platforms. A name must be set in the :ref:`application/config/custom_user_dir_name` setting for this to take effect. If ``false``, the project will save user data to ``(OS user data directory)/Godot/app_userdata/(project name)``. +If ``true``, the project will save user data to its own user directory. If :ref:`application/config/custom_user_dir_name` is empty, ``/`` directory will be used. If ``false``, the project will save user data to ``/Godot/app_userdata/``. + +See also `File paths in Godot projects <../tutorials/io/data_paths.html#accessing-persistent-user-data-user>`__. This setting is only effective on desktop platforms. ---- @@ -1808,10 +1818,12 @@ Safer override for :ref:`audio/driver/output_latency` **audio/general/2d_panning_strength** +-----------+---------+ -| *Default* | ``1.0`` | +| *Default* | ``0.5`` | +-----------+---------+ -The base strength of the panning effect for all AudioStreamPlayer2D nodes. The panning strength can be further scaled on each Node using :ref:`AudioStreamPlayer2D.panning_strength`. +The base strength of the panning effect for all :ref:`AudioStreamPlayer2D` nodes. The panning strength can be further scaled on each Node using :ref:`AudioStreamPlayer2D.panning_strength`. A value of ``0.0`` disables stereo panning entirely, leaving only volume attenuation in place. A value of ``1.0`` completely mutes one of the channels if the sound is located exactly to the left (or right) of the listener. + +The default value of ``0.5`` is tuned for headphones. When using speakers, you may find lower values to sound better as speakers have a lower stereo separation compared to headphones. ---- @@ -1820,10 +1832,12 @@ The base strength of the panning effect for all AudioStreamPlayer2D nodes. The p - :ref:`float` **audio/general/3d_panning_strength** +-----------+---------+ -| *Default* | ``1.0`` | +| *Default* | ``0.5`` | +-----------+---------+ -The base strength of the panning effect for all AudioStreamPlayer3D nodes. The panning strength can be further scaled on each Node using :ref:`AudioStreamPlayer3D.panning_strength`. +The base strength of the panning effect for all :ref:`AudioStreamPlayer3D` nodes. The panning strength can be further scaled on each Node using :ref:`AudioStreamPlayer3D.panning_strength`. A value of ``0.0`` disables stereo panning entirely, leaving only volume attenuation in place. A value of ``1.0`` completely mutes one of the channels if the sound is located exactly to the left (or right) of the listener. + +The default value of ``0.5`` is tuned for headphones. When using speakers, you may find lower values to sound better as speakers have a lower stereo separation compared to headphones. ---- @@ -1899,6 +1913,18 @@ Largest size limit (in power of 2) allowed when compressing using long-distance ---- +.. _class_ProjectSettings_property_debug/disable_touch: + +- :ref:`bool` **debug/disable_touch** + ++-----------+-----------+ +| *Default* | ``false`` | ++-----------+-----------+ + +Disable touch input. Only has effect on iOS. + +---- + .. _class_ProjectSettings_property_debug/file_logging/enable_file_logging: - :ref:`bool` **debug/file_logging/enable_file_logging** @@ -2747,7 +2773,7 @@ Position offset for tooltips, relative to the mouse cursor's hotspot. | *Default* | ``true`` | +-----------+----------+ -If ``true``, allows HiDPI display on Windows, macOS, Android, iOS and Web. If ``false``, the platform's low-DPI fallback will be used on HiDPI displays, which causes the window to be displayed in a blurry or pixelated manner (and can cause various window management bugs). Therefore, it is recommended to make your project scale to :doc:`multiple resolutions <../tutorials/viewports/multiple_resolutions>` instead of disabling this setting. +If ``true``, allows HiDPI display on Windows, macOS, Android, iOS and Web. If ``false``, the platform's low-DPI fallback will be used on HiDPI displays, which causes the window to be displayed in a blurry or pixelated manner (and can cause various window management bugs). Therefore, it is recommended to make your project scale to :doc:`multiple resolutions <../tutorials/rendering/multiple_resolutions>` instead of disabling this setting. \ **Note:** This setting has no effect on Linux as DPI-awareness fallbacks are not supported there. @@ -3661,6 +3687,10 @@ Default :ref:`InputEventAction` to select an item in a : - :ref:`Dictionary` **input/ui_swap_input_direction** +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_input/ui_text_add_selection_for_next_occurrence: @@ -7107,6 +7137,20 @@ Enables :ref:`Viewport.physics_object_picking` **physics/common/max_physics_steps_per_frame** + ++-----------+-------+ +| *Default* | ``8`` | ++-----------+-------+ + +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/common/physics_ticks_per_second`. This occurs even if ``delta`` is consistently used in physics calculations. To avoid this, increase :ref:`physics/common/max_physics_steps_per_frame` if you have increased :ref:`physics/common/physics_ticks_per_second` significantly above its default value. + +\ **Note:** This property is only read when the project starts. To change the maximum number of simulated physics steps per frame at runtime, set :ref:`Engine.max_physics_steps_per_frame` instead. + +---- + .. _class_ProjectSettings_property_physics/common/physics_jitter_fix: - :ref:`float` **physics/common/physics_jitter_fix** @@ -7135,7 +7179,7 @@ The number of fixed iterations per second. This controls how often physics simul \ **Note:** This property is only read when the project starts. To change the physics FPS at runtime, set :ref:`Engine.physics_ticks_per_second` instead. -\ **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/common/physics_ticks_per_second` above 240. Otherwise, the game will slow down when the rendering framerate goes below 30 FPS. +\ **Note:** Only :ref:`physics/common/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:`physics/common/max_physics_steps_per_frame` if increasing :ref:`physics/common/physics_ticks_per_second` significantly above its default value. ---- @@ -7147,6 +7191,10 @@ The number of fixed iterations per second. This controls how often physics simul | *Default* | ``1`` | +-----------+-------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/2d/sdf/scale: @@ -7157,6 +7205,10 @@ The number of fixed iterations per second. This controls how often physics simul | *Default* | ``1`` | +-----------+-------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/2d/shadow_atlas/size: @@ -7167,6 +7219,10 @@ The number of fixed iterations per second. This controls how often physics simul | *Default* | ``2048`` | +-----------+----------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/2d/snap/snap_2d_transforms_to_pixel: @@ -7177,6 +7233,10 @@ The number of fixed iterations per second. This controls how often physics simul | *Default* | ``false`` | +-----------+-----------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/2d/snap/snap_2d_vertices_to_pixel: @@ -7187,6 +7247,10 @@ The number of fixed iterations per second. This controls how often physics simul | *Default* | ``false`` | +-----------+-----------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/anti_aliasing/quality/msaa_2d: @@ -7265,6 +7329,10 @@ Enables Temporal Anti-Aliasing for the default screen :ref:`Viewport`! + ---- .. _class_ProjectSettings_property_rendering/anti_aliasing/screen_space_roughness_limiter/enabled: @@ -7275,6 +7343,10 @@ Enables Temporal Anti-Aliasing for the default screen :ref:`Viewport`! + ---- .. _class_ProjectSettings_property_rendering/anti_aliasing/screen_space_roughness_limiter/limit: @@ -7285,6 +7357,10 @@ Enables Temporal Anti-Aliasing for the default screen :ref:`Viewport`! + ---- .. _class_ProjectSettings_property_rendering/camera/depth_of_field/depth_of_field_bokeh_quality: @@ -7767,6 +7843,10 @@ If ``true``, renders :ref:`VoxelGI` and SDFGI (:ref:`Environment. | *Default* | ``5`` | +-----------+-------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/global_illumination/sdfgi/frames_to_update_lights: @@ -7777,6 +7857,10 @@ If ``true``, renders :ref:`VoxelGI` and SDFGI (:ref:`Environment. | *Default* | ``2`` | +-----------+-------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/global_illumination/sdfgi/probe_ray_count: @@ -7787,6 +7871,10 @@ If ``true``, renders :ref:`VoxelGI` and SDFGI (:ref:`Environment. | *Default* | ``1`` | +-----------+-------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/global_illumination/voxel_gi/quality: @@ -7797,6 +7885,10 @@ If ``true``, renders :ref:`VoxelGI` and SDFGI (:ref:`Environment. | *Default* | ``0`` | +-----------+-------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/lightmapping/bake_performance/max_rays_per_pass: @@ -7931,6 +8023,18 @@ The number of rays to use for baking lightmaps with :ref:`LightmapGI` **rendering/lightmapping/primitive_meshes/texel_size** + ++-----------+---------+ +| *Default* | ``0.2`` | ++-----------+---------+ + +The texel_size that is used to calculate the :ref:`Mesh.lightmap_size_hint` on :ref:`PrimitiveMesh` resources if :ref:`PrimitiveMesh.add_uv2` is enabled. + +---- + .. _class_ProjectSettings_property_rendering/lightmapping/probe_capture/update_speed: - :ref:`float` **rendering/lightmapping/probe_capture/update_speed** @@ -8139,6 +8243,10 @@ Enables the use of physically based units for light sources. Physically based un | *Default* | ``512`` | +-----------+---------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/limits/forward_renderer/threaded_render_minimum_instances: @@ -8149,6 +8257,10 @@ Enables the use of physically based units for light sources. Physically based un | *Default* | ``500`` | +-----------+---------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/limits/global_shader_variables/buffer_size: @@ -8159,6 +8271,10 @@ Enables the use of physically based units for light sources. Physically based un | *Default* | ``65536`` | +-----------+-----------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/limits/opengl/max_lights_per_object: @@ -8205,6 +8321,10 @@ Max number of positional lights renderable in a frame. If more lights than this | *Default* | ``1000`` | +-----------+----------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/limits/spatial_indexer/update_iterations_per_frame: @@ -8215,6 +8335,10 @@ Max number of positional lights renderable in a frame. If more lights than this | *Default* | ``10`` | +-----------+--------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/limits/time/time_rollover_secs: @@ -8225,6 +8349,10 @@ Max number of positional lights renderable in a frame. If more lights than this | *Default* | ``3600`` | +-----------+----------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/mesh_lod/lod_change/threshold_pixels: @@ -8511,6 +8639,10 @@ Windows override for :ref:`rendering/rendering_device/driver`! + ---- .. _class_ProjectSettings_property_rendering/rendering_device/staging_buffer/max_size_mb: @@ -8521,6 +8653,10 @@ Windows override for :ref:`rendering/rendering_device/driver`! + ---- .. _class_ProjectSettings_property_rendering/rendering_device/staging_buffer/texture_upload_region_size_px: @@ -8531,6 +8667,10 @@ Windows override for :ref:`rendering/rendering_device/driver`! + ---- .. _class_ProjectSettings_property_rendering/rendering_device/vulkan/max_descriptors_per_pool: @@ -8541,6 +8681,10 @@ Windows override for :ref:`rendering/rendering_device/driver`! + ---- .. _class_ProjectSettings_property_rendering/scaling_3d/fsr_sharpness: @@ -8587,6 +8731,10 @@ Scales the 3D render buffer based on the viewport size uses an image filter spec | *Default* | ``true`` | +-----------+----------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/shader_compiler/shader_cache/enabled: @@ -8609,6 +8757,10 @@ Enable the shader cache, which stores compiled shaders to disk to prevent stutte | *Default* | ``false`` | +-----------+-----------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/shader_compiler/shader_cache/strip_debug.release: @@ -8619,6 +8771,10 @@ Enable the shader cache, which stores compiled shaders to disk to prevent stutte | *Default* | ``true`` | +-----------+----------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/shader_compiler/shader_cache/use_zstd_compression: @@ -8629,6 +8785,10 @@ Enable the shader cache, which stores compiled shaders to disk to prevent stutte | *Default* | ``true`` | +-----------+----------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_rendering/shading/overrides/force_lambert_over_burley: @@ -8765,18 +8925,6 @@ If ``true``, the texture importer will import lossless textures using the PNG fo ---- -.. _class_ProjectSettings_property_rendering/textures/lossless_compression/webp_compression_level: - -- :ref:`int` **rendering/textures/lossless_compression/webp_compression_level** - -+-----------+-------+ -| *Default* | ``2`` | -+-----------+-------+ - -The default compression level for lossless WebP. Higher levels result in smaller files at the cost of compression speed. Decompression speed is mostly unaffected by the compression level. Supported values are 0 to 9. Note that compression levels above 6 are very slow and offer very little savings. - ----- - .. _class_ProjectSettings_property_rendering/textures/vram_compression/import_bptc: - :ref:`bool` **rendering/textures/vram_compression/import_bptc** @@ -8833,6 +8981,30 @@ If ``true``, the texture importer will import VRAM-compressed textures using the ---- +.. _class_ProjectSettings_property_rendering/textures/webp_compression/compression_method: + +- :ref:`int` **rendering/textures/webp_compression/compression_method** + ++-----------+-------+ +| *Default* | ``2`` | ++-----------+-------+ + +The default compression method for WebP. Affects both lossy and lossless WebP. A higher value results in smaller files at the cost of compression speed. Decompression speed is mostly unaffected by the compression method. Supported values are 0 to 6. Note that compression methods above 4 are very slow and offer very little savings. + +---- + +.. _class_ProjectSettings_property_rendering/textures/webp_compression/lossless_compression_factor: + +- :ref:`float` **rendering/textures/webp_compression/lossless_compression_factor** + ++-----------+--------+ +| *Default* | ``25`` | ++-----------+--------+ + +The default compression factor for lossless WebP. Decompression speed is mostly unaffected by the compression factor. Supported values are 0 to 100. + +---- + .. _class_ProjectSettings_property_rendering/transparent_background: - :ref:`bool` **rendering/transparent_background** @@ -8877,6 +9049,10 @@ If :ref:`rendering/vrs/mode` | *Default* | ``0.3`` | +-----------+---------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_threading/worker_pool/max_threads: @@ -8887,6 +9063,10 @@ If :ref:`rendering/vrs/mode` | *Default* | ``-1`` | +-----------+--------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_threading/worker_pool/use_system_threads_for_low_priority_tasks: @@ -8897,6 +9077,10 @@ If :ref:`rendering/vrs/mode` | *Default* | ``true`` | +-----------+----------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ProjectSettings_property_xr/openxr/default_action_map: diff --git a/classes/class_quaternion.rst b/classes/class_quaternion.rst index 9b3849532..eb52ed5fd 100644 --- a/classes/class_quaternion.rst +++ b/classes/class_quaternion.rst @@ -215,6 +215,10 @@ Constructs a ``Quaternion`` as a copy of the given ``Quaternion``. - :ref:`Quaternion` **Quaternion** **(** :ref:`Vector3` arc_from, :ref:`Vector3` arc_to **)** +.. container:: contribute + + There is currently no description for this constructor. Please help us by :ref:`contributing one `! + ---- - :ref:`Quaternion` **Quaternion** **(** :ref:`Vector3` axis, :ref:`float` angle **)** @@ -258,6 +262,10 @@ Returns the dot product of two quaternions. - :ref:`Quaternion` **exp** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Quaternion_method_from_euler: @@ -272,12 +280,20 @@ Constructs a Quaternion from Euler angles in YXZ rotation order. - :ref:`float` **get_angle** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Quaternion_method_get_axis: - :ref:`Vector3` **get_axis** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Quaternion_method_get_euler: @@ -340,6 +356,10 @@ Returns the length of the quaternion, squared. - :ref:`Quaternion` **log** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Quaternion_method_normalized: diff --git a/classes/class_range.rst b/classes/class_range.rst index f408b3ccc..e2684eb8b 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -24,27 +24,29 @@ Range is a base class for :ref:`Control` nodes that change a floa Properties ---------- -+---------------------------+----------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`allow_greater` | ``false`` | -+---------------------------+----------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`allow_lesser` | ``false`` | -+---------------------------+----------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`exp_edit` | ``false`` | -+---------------------------+----------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`max_value` | ``100.0`` | -+---------------------------+----------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`min_value` | ``0.0`` | -+---------------------------+----------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`page` | ``0.0`` | -+---------------------------+----------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`ratio` | | -+---------------------------+----------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`rounded` | ``false`` | -+---------------------------+----------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`step` | ``1.0`` | -+---------------------------+----------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`value` | ``0.0`` | -+---------------------------+----------------------------------------------------------+-----------+ ++---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`allow_greater` | ``false`` | ++---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`allow_lesser` | ``false`` | ++---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`exp_edit` | ``false`` | ++---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`max_value` | ``100.0`` | ++---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`min_value` | ``0.0`` | ++---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`page` | ``0.0`` | ++---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ratio` | | ++---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rounded` | ``false`` | ++---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | size_flags_vertical | ``0`` (overrides :ref:`Control`) | ++---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`step` | ``0.01`` | ++---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`value` | ``0.0`` | ++---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ Methods ------- @@ -212,7 +214,7 @@ If ``true``, ``value`` will always be rounded to the nearest integer. - :ref:`float` **step** +-----------+-----------------+ -| *Default* | ``1.0`` | +| *Default* | ``0.01`` | +-----------+-----------------+ | *Setter* | set_step(value) | +-----------+-----------------+ diff --git a/classes/class_rdattachmentformat.rst b/classes/class_rdattachmentformat.rst index e4594b6e7..cc8d098ff 100644 --- a/classes/class_rdattachmentformat.rst +++ b/classes/class_rdattachmentformat.rst @@ -12,7 +12,9 @@ RDAttachmentFormat **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -40,6 +42,10 @@ Property Descriptions | *Getter* | get_format() | +-----------+-------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDAttachmentFormat_property_samples: @@ -54,6 +60,10 @@ Property Descriptions | *Getter* | get_samples() | +-----------+--------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDAttachmentFormat_property_usage_flags: @@ -68,6 +78,10 @@ Property Descriptions | *Getter* | get_usage_flags() | +-----------+------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_rdpipelinecolorblendstate.rst b/classes/class_rdpipelinecolorblendstate.rst index daa165831..afd9146c5 100644 --- a/classes/class_rdpipelinecolorblendstate.rst +++ b/classes/class_rdpipelinecolorblendstate.rst @@ -12,7 +12,9 @@ RDPipelineColorBlendState **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -42,6 +44,10 @@ Property Descriptions | *Getter* | get_attachments() | +-----------+------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineColorBlendState_property_blend_constant: @@ -56,6 +62,10 @@ Property Descriptions | *Getter* | get_blend_constant() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineColorBlendState_property_enable_logic_op: @@ -70,6 +80,10 @@ Property Descriptions | *Getter* | get_enable_logic_op() | +-----------+----------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineColorBlendState_property_logic_op: @@ -84,6 +98,10 @@ Property Descriptions | *Getter* | get_logic_op() | +-----------+---------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_rdpipelinecolorblendstateattachment.rst b/classes/class_rdpipelinecolorblendstateattachment.rst index 611376137..37895cf8e 100644 --- a/classes/class_rdpipelinecolorblendstateattachment.rst +++ b/classes/class_rdpipelinecolorblendstateattachment.rst @@ -12,7 +12,9 @@ RDPipelineColorBlendStateAttachment **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -63,6 +65,10 @@ Property Descriptions | *Getter* | get_alpha_blend_op() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineColorBlendStateAttachment_property_color_blend_op: @@ -77,6 +83,10 @@ Property Descriptions | *Getter* | get_color_blend_op() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineColorBlendStateAttachment_property_dst_alpha_blend_factor: @@ -91,6 +101,10 @@ Property Descriptions | *Getter* | get_dst_alpha_blend_factor() | +-----------+-----------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineColorBlendStateAttachment_property_dst_color_blend_factor: @@ -105,6 +119,10 @@ Property Descriptions | *Getter* | get_dst_color_blend_factor() | +-----------+-----------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineColorBlendStateAttachment_property_enable_blend: @@ -119,6 +137,10 @@ Property Descriptions | *Getter* | get_enable_blend() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineColorBlendStateAttachment_property_src_alpha_blend_factor: @@ -133,6 +155,10 @@ Property Descriptions | *Getter* | get_src_alpha_blend_factor() | +-----------+-----------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineColorBlendStateAttachment_property_src_color_blend_factor: @@ -147,6 +173,10 @@ Property Descriptions | *Getter* | get_src_color_blend_factor() | +-----------+-----------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineColorBlendStateAttachment_property_write_a: @@ -161,6 +191,10 @@ Property Descriptions | *Getter* | get_write_a() | +-----------+--------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineColorBlendStateAttachment_property_write_b: @@ -175,6 +209,10 @@ Property Descriptions | *Getter* | get_write_b() | +-----------+--------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineColorBlendStateAttachment_property_write_g: @@ -189,6 +227,10 @@ Property Descriptions | *Getter* | get_write_g() | +-----------+--------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineColorBlendStateAttachment_property_write_r: @@ -203,6 +245,10 @@ Property Descriptions | *Getter* | get_write_r() | +-----------+--------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + Method Descriptions ------------------- @@ -210,6 +256,10 @@ Method Descriptions - void **set_as_mix** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_rdpipelinedepthstencilstate.rst b/classes/class_rdpipelinedepthstencilstate.rst index 213b3c43f..98133464b 100644 --- a/classes/class_rdpipelinedepthstencilstate.rst +++ b/classes/class_rdpipelinedepthstencilstate.rst @@ -12,7 +12,9 @@ RDPipelineDepthStencilState **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -76,6 +78,10 @@ Property Descriptions | *Getter* | get_back_op_compare() | +-----------+----------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_back_op_compare_mask: @@ -90,6 +96,10 @@ Property Descriptions | *Getter* | get_back_op_compare_mask() | +-----------+---------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_back_op_depth_fail: @@ -104,6 +114,10 @@ Property Descriptions | *Getter* | get_back_op_depth_fail() | +-----------+-------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_back_op_fail: @@ -118,6 +132,10 @@ Property Descriptions | *Getter* | get_back_op_fail() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_back_op_pass: @@ -132,6 +150,10 @@ Property Descriptions | *Getter* | get_back_op_pass() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_back_op_reference: @@ -146,6 +168,10 @@ Property Descriptions | *Getter* | get_back_op_reference() | +-----------+------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_back_op_write_mask: @@ -160,6 +186,10 @@ Property Descriptions | *Getter* | get_back_op_write_mask() | +-----------+-------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_depth_compare_operator: @@ -174,6 +204,10 @@ Property Descriptions | *Getter* | get_depth_compare_operator() | +-----------+-----------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_depth_range_max: @@ -188,6 +222,10 @@ Property Descriptions | *Getter* | get_depth_range_max() | +-----------+----------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_depth_range_min: @@ -202,6 +240,10 @@ Property Descriptions | *Getter* | get_depth_range_min() | +-----------+----------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_enable_depth_range: @@ -216,6 +258,10 @@ Property Descriptions | *Getter* | get_enable_depth_range() | +-----------+-------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_enable_depth_test: @@ -230,6 +276,10 @@ Property Descriptions | *Getter* | get_enable_depth_test() | +-----------+------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_enable_depth_write: @@ -244,6 +294,10 @@ Property Descriptions | *Getter* | get_enable_depth_write() | +-----------+-------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_enable_stencil: @@ -258,6 +312,10 @@ Property Descriptions | *Getter* | get_enable_stencil() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_front_op_compare: @@ -272,6 +330,10 @@ Property Descriptions | *Getter* | get_front_op_compare() | +-----------+-----------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_front_op_compare_mask: @@ -286,6 +348,10 @@ Property Descriptions | *Getter* | get_front_op_compare_mask() | +-----------+----------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_front_op_depth_fail: @@ -300,6 +366,10 @@ Property Descriptions | *Getter* | get_front_op_depth_fail() | +-----------+--------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_front_op_fail: @@ -314,6 +384,10 @@ Property Descriptions | *Getter* | get_front_op_fail() | +-----------+--------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_front_op_pass: @@ -328,6 +402,10 @@ Property Descriptions | *Getter* | get_front_op_pass() | +-----------+--------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_front_op_reference: @@ -342,6 +420,10 @@ Property Descriptions | *Getter* | get_front_op_reference() | +-----------+-------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineDepthStencilState_property_front_op_write_mask: @@ -356,6 +438,10 @@ Property Descriptions | *Getter* | get_front_op_write_mask() | +-----------+--------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_rdpipelinemultisamplestate.rst b/classes/class_rdpipelinemultisamplestate.rst index 090cc3a16..7c47bd8a0 100644 --- a/classes/class_rdpipelinemultisamplestate.rst +++ b/classes/class_rdpipelinemultisamplestate.rst @@ -12,7 +12,9 @@ RDPipelineMultisampleState **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -46,6 +48,10 @@ Property Descriptions | *Getter* | get_enable_alpha_to_coverage() | +-----------+-------------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineMultisampleState_property_enable_alpha_to_one: @@ -60,6 +66,10 @@ Property Descriptions | *Getter* | get_enable_alpha_to_one() | +-----------+--------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineMultisampleState_property_enable_sample_shading: @@ -74,6 +84,10 @@ Property Descriptions | *Getter* | get_enable_sample_shading() | +-----------+----------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineMultisampleState_property_min_sample_shading: @@ -88,6 +102,10 @@ Property Descriptions | *Getter* | get_min_sample_shading() | +-----------+-------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineMultisampleState_property_sample_count: @@ -102,6 +120,10 @@ Property Descriptions | *Getter* | get_sample_count() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineMultisampleState_property_sample_masks: @@ -116,6 +138,10 @@ Property Descriptions | *Getter* | get_sample_masks() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_rdpipelinerasterizationstate.rst b/classes/class_rdpipelinerasterizationstate.rst index 8118a4170..2d1dfec7b 100644 --- a/classes/class_rdpipelinerasterizationstate.rst +++ b/classes/class_rdpipelinerasterizationstate.rst @@ -12,7 +12,9 @@ RDPipelineRasterizationState **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -56,6 +58,10 @@ Property Descriptions | *Getter* | get_cull_mode() | +-----------+----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineRasterizationState_property_depth_bias_clamp: @@ -70,6 +76,10 @@ Property Descriptions | *Getter* | get_depth_bias_clamp() | +-----------+-----------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineRasterizationState_property_depth_bias_constant_factor: @@ -84,6 +94,10 @@ Property Descriptions | *Getter* | get_depth_bias_constant_factor() | +-----------+---------------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineRasterizationState_property_depth_bias_enabled: @@ -98,6 +112,10 @@ Property Descriptions | *Getter* | get_depth_bias_enabled() | +-----------+-------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineRasterizationState_property_depth_bias_slope_factor: @@ -112,6 +130,10 @@ Property Descriptions | *Getter* | get_depth_bias_slope_factor() | +-----------+------------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineRasterizationState_property_discard_primitives: @@ -126,6 +148,10 @@ Property Descriptions | *Getter* | get_discard_primitives() | +-----------+-------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineRasterizationState_property_enable_depth_clamp: @@ -140,6 +166,10 @@ Property Descriptions | *Getter* | get_enable_depth_clamp() | +-----------+-------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineRasterizationState_property_front_face: @@ -154,6 +184,10 @@ Property Descriptions | *Getter* | get_front_face() | +-----------+-----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineRasterizationState_property_line_width: @@ -168,6 +202,10 @@ Property Descriptions | *Getter* | get_line_width() | +-----------+-----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineRasterizationState_property_patch_control_points: @@ -182,6 +220,10 @@ Property Descriptions | *Getter* | get_patch_control_points() | +-----------+---------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineRasterizationState_property_wireframe: @@ -196,6 +238,10 @@ Property Descriptions | *Getter* | get_wireframe() | +-----------+----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_rdpipelinespecializationconstant.rst b/classes/class_rdpipelinespecializationconstant.rst index 506dfd45f..b46665453 100644 --- a/classes/class_rdpipelinespecializationconstant.rst +++ b/classes/class_rdpipelinespecializationconstant.rst @@ -12,7 +12,9 @@ RDPipelineSpecializationConstant **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -38,6 +40,10 @@ Property Descriptions | *Getter* | get_constant_id() | +-----------+------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDPipelineSpecializationConstant_property_value: @@ -50,6 +56,10 @@ Property Descriptions | *Getter* | get_value() | +----------+------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_rdsamplerstate.rst b/classes/class_rdsamplerstate.rst index 04366a09a..8123e9841 100644 --- a/classes/class_rdsamplerstate.rst +++ b/classes/class_rdsamplerstate.rst @@ -12,7 +12,9 @@ RDSamplerState **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -64,6 +66,10 @@ Property Descriptions | *Getter* | get_anisotropy_max() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDSamplerState_property_border_color: @@ -78,6 +84,10 @@ Property Descriptions | *Getter* | get_border_color() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDSamplerState_property_compare_op: @@ -92,6 +102,10 @@ Property Descriptions | *Getter* | get_compare_op() | +-----------+-----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDSamplerState_property_enable_compare: @@ -106,6 +120,10 @@ Property Descriptions | *Getter* | get_enable_compare() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDSamplerState_property_lod_bias: @@ -120,6 +138,10 @@ Property Descriptions | *Getter* | get_lod_bias() | +-----------+---------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDSamplerState_property_mag_filter: @@ -134,6 +156,10 @@ Property Descriptions | *Getter* | get_mag_filter() | +-----------+-----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDSamplerState_property_max_lod: @@ -148,6 +174,10 @@ Property Descriptions | *Getter* | get_max_lod() | +-----------+--------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDSamplerState_property_min_filter: @@ -162,6 +192,10 @@ Property Descriptions | *Getter* | get_min_filter() | +-----------+-----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDSamplerState_property_min_lod: @@ -176,6 +210,10 @@ Property Descriptions | *Getter* | get_min_lod() | +-----------+--------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDSamplerState_property_mip_filter: @@ -190,6 +228,10 @@ Property Descriptions | *Getter* | get_mip_filter() | +-----------+-----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDSamplerState_property_repeat_u: @@ -204,6 +246,10 @@ Property Descriptions | *Getter* | get_repeat_u() | +-----------+---------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDSamplerState_property_repeat_v: @@ -218,6 +264,10 @@ Property Descriptions | *Getter* | get_repeat_v() | +-----------+---------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDSamplerState_property_repeat_w: @@ -232,6 +282,10 @@ Property Descriptions | *Getter* | get_repeat_w() | +-----------+---------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDSamplerState_property_unnormalized_uvw: @@ -246,6 +300,10 @@ Property Descriptions | *Getter* | get_unnormalized_uvw() | +-----------+-----------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDSamplerState_property_use_anisotropy: @@ -260,6 +318,10 @@ Property Descriptions | *Getter* | get_use_anisotropy() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_rdshaderfile.rst b/classes/class_rdshaderfile.rst index 1d223f73a..e53bafaae 100644 --- a/classes/class_rdshaderfile.rst +++ b/classes/class_rdshaderfile.rst @@ -12,7 +12,9 @@ RDShaderFile **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -47,6 +49,10 @@ Property Descriptions | *Getter* | get_base_error() | +-----------+-----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + Method Descriptions ------------------- @@ -54,18 +60,30 @@ Method Descriptions - :ref:`RDShaderSPIRV` **get_spirv** **(** :ref:`StringName` version=&"" **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderFile_method_get_version_list: - :ref:`PackedStringArray` **get_version_list** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderFile_method_set_bytecode: - void **set_bytecode** **(** :ref:`RDShaderSPIRV` bytecode, :ref:`StringName` version=&"" **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_rdshadersource.rst b/classes/class_rdshadersource.rst index 0d2cf2380..d1a090ef9 100644 --- a/classes/class_rdshadersource.rst +++ b/classes/class_rdshadersource.rst @@ -12,7 +12,9 @@ RDShaderSource **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -55,6 +57,10 @@ Property Descriptions | *Getter* | get_language() | +-----------+---------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSource_property_source_compute: @@ -69,6 +75,10 @@ Property Descriptions | *Getter* | get_stage_source() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSource_property_source_fragment: @@ -83,6 +93,10 @@ Property Descriptions | *Getter* | get_stage_source() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSource_property_source_tesselation_control: @@ -97,6 +111,10 @@ Property Descriptions | *Getter* | get_stage_source() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSource_property_source_tesselation_evaluation: @@ -111,6 +129,10 @@ Property Descriptions | *Getter* | get_stage_source() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSource_property_source_vertex: @@ -125,6 +147,10 @@ Property Descriptions | *Getter* | get_stage_source() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + Method Descriptions ------------------- @@ -132,12 +158,20 @@ Method Descriptions - :ref:`String` **get_stage_source** **(** :ref:`ShaderStage` stage **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSource_method_set_stage_source: - void **set_stage_source** **(** :ref:`ShaderStage` stage, :ref:`String` source **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_rdshaderspirv.rst b/classes/class_rdshaderspirv.rst index 86b5b36bb..1453cd9ad 100644 --- a/classes/class_rdshaderspirv.rst +++ b/classes/class_rdshaderspirv.rst @@ -12,7 +12,9 @@ RDShaderSPIRV **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -67,6 +69,10 @@ Property Descriptions | *Getter* | get_stage_bytecode() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSPIRV_property_bytecode_fragment: @@ -81,6 +87,10 @@ Property Descriptions | *Getter* | get_stage_bytecode() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSPIRV_property_bytecode_tesselation_control: @@ -95,6 +105,10 @@ Property Descriptions | *Getter* | get_stage_bytecode() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSPIRV_property_bytecode_tesselation_evaluation: @@ -109,6 +123,10 @@ Property Descriptions | *Getter* | get_stage_bytecode() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSPIRV_property_bytecode_vertex: @@ -123,6 +141,10 @@ Property Descriptions | *Getter* | get_stage_bytecode() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSPIRV_property_compile_error_compute: @@ -137,6 +159,10 @@ Property Descriptions | *Getter* | get_stage_compile_error() | +-----------+--------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSPIRV_property_compile_error_fragment: @@ -151,6 +177,10 @@ Property Descriptions | *Getter* | get_stage_compile_error() | +-----------+--------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSPIRV_property_compile_error_tesselation_control: @@ -165,6 +195,10 @@ Property Descriptions | *Getter* | get_stage_compile_error() | +-----------+--------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSPIRV_property_compile_error_tesselation_evaluation: @@ -179,6 +213,10 @@ Property Descriptions | *Getter* | get_stage_compile_error() | +-----------+--------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSPIRV_property_compile_error_vertex: @@ -193,6 +231,10 @@ Property Descriptions | *Getter* | get_stage_compile_error() | +-----------+--------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + Method Descriptions ------------------- @@ -200,24 +242,40 @@ Method Descriptions - :ref:`PackedByteArray` **get_stage_bytecode** **(** :ref:`ShaderStage` stage **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSPIRV_method_get_stage_compile_error: - :ref:`String` **get_stage_compile_error** **(** :ref:`ShaderStage` stage **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSPIRV_method_set_stage_bytecode: - void **set_stage_bytecode** **(** :ref:`ShaderStage` stage, :ref:`PackedByteArray` bytecode **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RDShaderSPIRV_method_set_stage_compile_error: - void **set_stage_compile_error** **(** :ref:`ShaderStage` stage, :ref:`String` compile_error **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_rdtextureformat.rst b/classes/class_rdtextureformat.rst index ce4845442..4c3528dba 100644 --- a/classes/class_rdtextureformat.rst +++ b/classes/class_rdtextureformat.rst @@ -12,7 +12,9 @@ RDTextureFormat **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -61,6 +63,10 @@ Property Descriptions | *Getter* | get_array_layers() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDTextureFormat_property_depth: @@ -75,6 +81,10 @@ Property Descriptions | *Getter* | get_depth() | +-----------+------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDTextureFormat_property_format: @@ -89,6 +99,10 @@ Property Descriptions | *Getter* | get_format() | +-----------+-------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDTextureFormat_property_height: @@ -103,6 +117,10 @@ Property Descriptions | *Getter* | get_height() | +-----------+-------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDTextureFormat_property_mipmaps: @@ -117,6 +135,10 @@ Property Descriptions | *Getter* | get_mipmaps() | +-----------+--------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDTextureFormat_property_samples: @@ -131,6 +153,10 @@ Property Descriptions | *Getter* | get_samples() | +-----------+--------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDTextureFormat_property_texture_type: @@ -145,6 +171,10 @@ Property Descriptions | *Getter* | get_texture_type() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDTextureFormat_property_usage_bits: @@ -159,6 +189,10 @@ Property Descriptions | *Getter* | get_usage_bits() | +-----------+-----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDTextureFormat_property_width: @@ -173,6 +207,10 @@ Property Descriptions | *Getter* | get_width() | +-----------+------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + Method Descriptions ------------------- @@ -180,12 +218,20 @@ Method Descriptions - void **add_shareable_format** **(** :ref:`DataFormat` format **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RDTextureFormat_method_remove_shareable_format: - void **remove_shareable_format** **(** :ref:`DataFormat` format **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_rdtextureview.rst b/classes/class_rdtextureview.rst index 788ceac51..3e0dd3aae 100644 --- a/classes/class_rdtextureview.rst +++ b/classes/class_rdtextureview.rst @@ -12,7 +12,9 @@ RDTextureView **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -44,6 +46,10 @@ Property Descriptions | *Getter* | get_format_override() | +-----------+----------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDTextureView_property_swizzle_a: @@ -58,6 +64,10 @@ Property Descriptions | *Getter* | get_swizzle_a() | +-----------+----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDTextureView_property_swizzle_b: @@ -72,6 +82,10 @@ Property Descriptions | *Getter* | get_swizzle_b() | +-----------+----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDTextureView_property_swizzle_g: @@ -86,6 +100,10 @@ Property Descriptions | *Getter* | get_swizzle_g() | +-----------+----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDTextureView_property_swizzle_r: @@ -100,6 +118,10 @@ Property Descriptions | *Getter* | get_swizzle_r() | +-----------+----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_rduniform.rst b/classes/class_rduniform.rst index 33f27d596..a66baf7ae 100644 --- a/classes/class_rduniform.rst +++ b/classes/class_rduniform.rst @@ -12,7 +12,9 @@ RDUniform **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -49,6 +51,10 @@ Property Descriptions | *Getter* | get_binding() | +-----------+--------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDUniform_property_uniform_type: @@ -63,6 +69,10 @@ Property Descriptions | *Getter* | get_uniform_type() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + Method Descriptions ------------------- @@ -70,18 +80,30 @@ Method Descriptions - void **add_id** **(** :ref:`RID` id **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RDUniform_method_clear_ids: - void **clear_ids** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RDUniform_method_get_ids: - :ref:`RID[]` **get_ids** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_rdvertexattribute.rst b/classes/class_rdvertexattribute.rst index 34dfc013e..4e0104990 100644 --- a/classes/class_rdvertexattribute.rst +++ b/classes/class_rdvertexattribute.rst @@ -12,7 +12,9 @@ RDVertexAttribute **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -44,6 +46,10 @@ Property Descriptions | *Getter* | get_format() | +-----------+-------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDVertexAttribute_property_frequency: @@ -58,6 +64,10 @@ Property Descriptions | *Getter* | get_frequency() | +-----------+----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDVertexAttribute_property_location: @@ -72,6 +82,10 @@ Property Descriptions | *Getter* | get_location() | +-----------+---------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDVertexAttribute_property_offset: @@ -86,6 +100,10 @@ Property Descriptions | *Getter* | get_offset() | +-----------+-------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RDVertexAttribute_property_stride: @@ -100,6 +118,10 @@ Property Descriptions | *Getter* | get_stride() | +-----------+-------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index 2dc135844..446b5aafb 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -12,7 +12,7 @@ RefCounted **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DTLSServer`, :ref:`DirAccess`, :ref:`ENetConnection`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EditorUndoRedoManager`, :ref:`EncodedObjectAsID`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`HashingContext`, :ref:`ImageFormatLoader`, :ref:`JSON`, :ref:`JavaClass`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRPositionalTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` +**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DTLSServer`, :ref:`DirAccess`, :ref:`ENetConnection`, :ref:`EditorDebuggerPlugin`, :ref:`EditorDebuggerSession`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EditorUndoRedoManager`, :ref:`EncodedObjectAsID`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`FileAccess`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`HashingContext`, :ref:`ImageFormatLoader`, :ref:`JSON`, :ref:`JavaClass`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`NavigationPathQueryParameters2D`, :ref:`NavigationPathQueryParameters3D`, :ref:`NavigationPathQueryResult2D`, :ref:`NavigationPathQueryResult3D`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRPositionalTracker`, :ref:`ZIPPacker`, :ref:`ZIPReader` Base class for reference-counted objects. diff --git a/classes/class_renderingdevice.rst b/classes/class_renderingdevice.rst index 0f01dc4cd..7805e08f4 100644 --- a/classes/class_renderingdevice.rst +++ b/classes/class_renderingdevice.rst @@ -12,7 +12,9 @@ RenderingDevice **Inherits:** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -194,6 +196,8 @@ Methods +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`uniform_set_is_valid` **(** :ref:`RID` uniform_set **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`vertex_array_create` **(** :ref:`int` vertex_count, :ref:`int` vertex_format, :ref:`RID[]` src_buffers **)** | ++------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`vertex_buffer_create` **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray(), :ref:`bool` use_as_storage=false **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`vertex_format_create` **(** :ref:`RDVertexAttribute[]` vertex_descriptions **)** | @@ -2256,174 +2260,290 @@ Method Descriptions - void **barrier** **(** :ref:`int` from=7, :ref:`int` to=7 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_buffer_clear: - :ref:`Error` **buffer_clear** **(** :ref:`RID` buffer, :ref:`int` offset, :ref:`int` size_bytes, :ref:`int` post_barrier=7 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_buffer_get_data: - :ref:`PackedByteArray` **buffer_get_data** **(** :ref:`RID` buffer **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_buffer_update: - :ref:`Error` **buffer_update** **(** :ref:`RID` buffer, :ref:`int` offset, :ref:`int` size_bytes, :ref:`PackedByteArray` data, :ref:`int` post_barrier=7 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_capture_timestamp: - void **capture_timestamp** **(** :ref:`String` name **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_compute_list_add_barrier: - void **compute_list_add_barrier** **(** :ref:`int` compute_list **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_compute_list_begin: - :ref:`int` **compute_list_begin** **(** :ref:`bool` allow_draw_overlap=false **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_compute_list_bind_compute_pipeline: - void **compute_list_bind_compute_pipeline** **(** :ref:`int` compute_list, :ref:`RID` compute_pipeline **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_compute_list_bind_uniform_set: - void **compute_list_bind_uniform_set** **(** :ref:`int` compute_list, :ref:`RID` uniform_set, :ref:`int` set_index **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_compute_list_dispatch: - void **compute_list_dispatch** **(** :ref:`int` compute_list, :ref:`int` x_groups, :ref:`int` y_groups, :ref:`int` z_groups **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_compute_list_end: - void **compute_list_end** **(** :ref:`int` post_barrier=7 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_compute_list_set_push_constant: - void **compute_list_set_push_constant** **(** :ref:`int` compute_list, :ref:`PackedByteArray` buffer, :ref:`int` size_bytes **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_compute_pipeline_create: - :ref:`RID` **compute_pipeline_create** **(** :ref:`RID` shader, :ref:`RDPipelineSpecializationConstant[]` specialization_constants=[] **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_compute_pipeline_is_valid: - :ref:`bool` **compute_pipeline_is_valid** **(** :ref:`RID` compute_pieline **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_create_local_device: - :ref:`RenderingDevice` **create_local_device** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_command_begin_label: - void **draw_command_begin_label** **(** :ref:`String` name, :ref:`Color` color **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_command_end_label: - void **draw_command_end_label** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_command_insert_label: - void **draw_command_insert_label** **(** :ref:`String` name, :ref:`Color` color **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_list_begin: - :ref:`int` **draw_list_begin** **(** :ref:`RID` framebuffer, :ref:`InitialAction` initial_color_action, :ref:`FinalAction` final_color_action, :ref:`InitialAction` initial_depth_action, :ref:`FinalAction` final_depth_action, :ref:`PackedColorArray` clear_color_values=PackedColorArray(), :ref:`float` clear_depth=1.0, :ref:`int` clear_stencil=0, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`Array` storage_textures=[] **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_list_begin_for_screen: - :ref:`int` **draw_list_begin_for_screen** **(** :ref:`int` screen=0, :ref:`Color` clear_color=Color(0, 0, 0, 1) **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_list_begin_split: - :ref:`PackedInt64Array` **draw_list_begin_split** **(** :ref:`RID` framebuffer, :ref:`int` splits, :ref:`InitialAction` initial_color_action, :ref:`FinalAction` final_color_action, :ref:`InitialAction` initial_depth_action, :ref:`FinalAction` final_depth_action, :ref:`PackedColorArray` clear_color_values=PackedColorArray(), :ref:`float` clear_depth=1.0, :ref:`int` clear_stencil=0, :ref:`Rect2` region=Rect2(0, 0, 0, 0), :ref:`RID[]` storage_textures=[] **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_list_bind_index_array: - void **draw_list_bind_index_array** **(** :ref:`int` draw_list, :ref:`RID` index_array **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_list_bind_render_pipeline: - void **draw_list_bind_render_pipeline** **(** :ref:`int` draw_list, :ref:`RID` render_pipeline **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_list_bind_uniform_set: - void **draw_list_bind_uniform_set** **(** :ref:`int` draw_list, :ref:`RID` uniform_set, :ref:`int` set_index **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_list_bind_vertex_array: - void **draw_list_bind_vertex_array** **(** :ref:`int` draw_list, :ref:`RID` vertex_array **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_list_disable_scissor: - void **draw_list_disable_scissor** **(** :ref:`int` draw_list **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_list_draw: - void **draw_list_draw** **(** :ref:`int` draw_list, :ref:`bool` use_indices, :ref:`int` instances, :ref:`int` procedural_vertex_count=0 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_list_enable_scissor: - void **draw_list_enable_scissor** **(** :ref:`int` draw_list, :ref:`Rect2` rect=Rect2(0, 0, 0, 0) **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_list_end: - void **draw_list_end** **(** :ref:`int` post_barrier=7 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_list_set_blend_constants: @@ -2438,360 +2558,608 @@ Sets blend constants for draw list, blend constants are used only if the graphic - void **draw_list_set_push_constant** **(** :ref:`int` draw_list, :ref:`PackedByteArray` buffer, :ref:`int` size_bytes **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_list_switch_to_next_pass: - :ref:`int` **draw_list_switch_to_next_pass** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_draw_list_switch_to_next_pass_split: - :ref:`PackedInt64Array` **draw_list_switch_to_next_pass_split** **(** :ref:`int` splits **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_framebuffer_create: - :ref:`RID` **framebuffer_create** **(** :ref:`RID[]` textures, :ref:`int` validate_with_format=-1, :ref:`int` view_count=1 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_framebuffer_create_empty: - :ref:`RID` **framebuffer_create_empty** **(** :ref:`Vector2i` size, :ref:`TextureSamples` samples=0, :ref:`int` validate_with_format=-1 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_framebuffer_create_multipass: - :ref:`RID` **framebuffer_create_multipass** **(** :ref:`RID[]` textures, :ref:`RDFramebufferPass[]` passes, :ref:`int` validate_with_format=-1, :ref:`int` view_count=1 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_framebuffer_format_create: - :ref:`int` **framebuffer_format_create** **(** :ref:`RDAttachmentFormat[]` attachments, :ref:`int` view_count=1 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_framebuffer_format_create_empty: - :ref:`int` **framebuffer_format_create_empty** **(** :ref:`TextureSamples` samples=0 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_framebuffer_format_create_multipass: - :ref:`int` **framebuffer_format_create_multipass** **(** :ref:`RDAttachmentFormat[]` attachments, :ref:`RDFramebufferPass[]` passes, :ref:`int` view_count=1 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_framebuffer_format_get_texture_samples: - :ref:`TextureSamples` **framebuffer_format_get_texture_samples** **(** :ref:`int` format, :ref:`int` render_pass=0 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_framebuffer_get_format: - :ref:`int` **framebuffer_get_format** **(** :ref:`RID` framebuffer **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_framebuffer_is_valid: - :ref:`bool` **framebuffer_is_valid** **(** :ref:`RID` framebuffer **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_free_rid: - void **free_rid** **(** :ref:`RID` rid **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_full_barrier: - void **full_barrier** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_get_captured_timestamp_cpu_time: - :ref:`int` **get_captured_timestamp_cpu_time** **(** :ref:`int` index **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_get_captured_timestamp_gpu_time: - :ref:`int` **get_captured_timestamp_gpu_time** **(** :ref:`int` index **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_get_captured_timestamp_name: - :ref:`String` **get_captured_timestamp_name** **(** :ref:`int` index **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_get_captured_timestamps_count: - :ref:`int` **get_captured_timestamps_count** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_get_captured_timestamps_frame: - :ref:`int` **get_captured_timestamps_frame** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_get_device_name: - :ref:`String` **get_device_name** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_get_device_pipeline_cache_uuid: - :ref:`String` **get_device_pipeline_cache_uuid** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_get_device_vendor_name: - :ref:`String` **get_device_vendor_name** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_get_driver_resource: - :ref:`int` **get_driver_resource** **(** :ref:`DriverResource` resource, :ref:`RID` rid, :ref:`int` index **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_get_frame_delay: - :ref:`int` **get_frame_delay** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_get_memory_usage: - :ref:`int` **get_memory_usage** **(** :ref:`MemoryType` type **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_index_array_create: - :ref:`RID` **index_array_create** **(** :ref:`RID` index_buffer, :ref:`int` index_offset, :ref:`int` index_count **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_index_buffer_create: - :ref:`RID` **index_buffer_create** **(** :ref:`int` size_indices, :ref:`IndexBufferFormat` format, :ref:`PackedByteArray` data=PackedByteArray(), :ref:`bool` use_restart_indices=false **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_limit_get: - :ref:`int` **limit_get** **(** :ref:`Limit` limit **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_render_pipeline_create: - :ref:`RID` **render_pipeline_create** **(** :ref:`RID` shader, :ref:`int` framebuffer_format, :ref:`int` vertex_format, :ref:`RenderPrimitive` primitive, :ref:`RDPipelineRasterizationState` rasterization_state, :ref:`RDPipelineMultisampleState` multisample_state, :ref:`RDPipelineDepthStencilState` stencil_state, :ref:`RDPipelineColorBlendState` color_blend_state, :ref:`int` dynamic_state_flags=0, :ref:`int` for_render_pass=0, :ref:`RDPipelineSpecializationConstant[]` specialization_constants=[] **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_render_pipeline_is_valid: - :ref:`bool` **render_pipeline_is_valid** **(** :ref:`RID` render_pipeline **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_sampler_create: - :ref:`RID` **sampler_create** **(** :ref:`RDSamplerState` state **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_screen_get_framebuffer_format: - :ref:`int` **screen_get_framebuffer_format** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_screen_get_height: - :ref:`int` **screen_get_height** **(** :ref:`int` screen=0 **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_screen_get_width: - :ref:`int` **screen_get_width** **(** :ref:`int` screen=0 **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_set_resource_name: - void **set_resource_name** **(** :ref:`RID` id, :ref:`String` name **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_shader_compile_binary_from_spirv: - :ref:`PackedByteArray` **shader_compile_binary_from_spirv** **(** :ref:`RDShaderSPIRV` spirv_data, :ref:`String` name="" **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_shader_compile_spirv_from_source: - :ref:`RDShaderSPIRV` **shader_compile_spirv_from_source** **(** :ref:`RDShaderSource` shader_source, :ref:`bool` allow_cache=true **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_shader_create_from_bytecode: - :ref:`RID` **shader_create_from_bytecode** **(** :ref:`PackedByteArray` binary_data **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_shader_create_from_spirv: - :ref:`RID` **shader_create_from_spirv** **(** :ref:`RDShaderSPIRV` spirv_data, :ref:`String` name="" **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_shader_get_vertex_input_attribute_mask: - :ref:`int` **shader_get_vertex_input_attribute_mask** **(** :ref:`RID` shader **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_storage_buffer_create: - :ref:`RID` **storage_buffer_create** **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray(), :ref:`int` usage=0 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_submit: - void **submit** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_sync: - void **sync** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_texture_buffer_create: - :ref:`RID` **texture_buffer_create** **(** :ref:`int` size_bytes, :ref:`DataFormat` format, :ref:`PackedByteArray` data=PackedByteArray() **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_texture_clear: - :ref:`Error` **texture_clear** **(** :ref:`RID` texture, :ref:`Color` color, :ref:`int` base_mipmap, :ref:`int` mipmap_count, :ref:`int` base_layer, :ref:`int` layer_count, :ref:`int` post_barrier=7 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_texture_copy: - :ref:`Error` **texture_copy** **(** :ref:`RID` from_texture, :ref:`RID` to_texture, :ref:`Vector3` from_pos, :ref:`Vector3` to_pos, :ref:`Vector3` size, :ref:`int` src_mipmap, :ref:`int` dst_mipmap, :ref:`int` src_layer, :ref:`int` dst_layer, :ref:`int` post_barrier=7 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_texture_create: - :ref:`RID` **texture_create** **(** :ref:`RDTextureFormat` format, :ref:`RDTextureView` view, :ref:`PackedByteArray[]` data=[] **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_texture_create_shared: - :ref:`RID` **texture_create_shared** **(** :ref:`RDTextureView` view, :ref:`RID` with_texture **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_texture_create_shared_from_slice: - :ref:`RID` **texture_create_shared_from_slice** **(** :ref:`RDTextureView` view, :ref:`RID` with_texture, :ref:`int` layer, :ref:`int` mipmap, :ref:`int` mipmaps=1, :ref:`TextureSliceType` slice_type=0 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_texture_get_data: - :ref:`PackedByteArray` **texture_get_data** **(** :ref:`RID` texture, :ref:`int` layer **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_texture_is_format_supported_for_usage: - :ref:`bool` **texture_is_format_supported_for_usage** **(** :ref:`DataFormat` format, :ref:`int` usage_flags **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_texture_is_shared: - :ref:`bool` **texture_is_shared** **(** :ref:`RID` texture **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_texture_is_valid: - :ref:`bool` **texture_is_valid** **(** :ref:`RID` texture **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_texture_resolve_multisample: - :ref:`Error` **texture_resolve_multisample** **(** :ref:`RID` from_texture, :ref:`RID` to_texture, :ref:`int` post_barrier=7 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_texture_update: - :ref:`Error` **texture_update** **(** :ref:`RID` texture, :ref:`int` layer, :ref:`PackedByteArray` data, :ref:`int` post_barrier=7 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_uniform_buffer_create: - :ref:`RID` **uniform_buffer_create** **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray() **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_uniform_set_create: - :ref:`RID` **uniform_set_create** **(** :ref:`RDUniform[]` uniforms, :ref:`RID` shader, :ref:`int` shader_set **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_uniform_set_is_valid: - :ref:`bool` **uniform_set_is_valid** **(** :ref:`RID` uniform_set **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +---- + +.. _class_RenderingDevice_method_vertex_array_create: + +- :ref:`RID` **vertex_array_create** **(** :ref:`int` vertex_count, :ref:`int` vertex_format, :ref:`RID[]` src_buffers **)** + +Creates a vertex array based on the specified buffers. + ---- .. _class_RenderingDevice_method_vertex_buffer_create: - :ref:`RID` **vertex_buffer_create** **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray(), :ref:`bool` use_as_storage=false **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingDevice_method_vertex_format_create: - :ref:`int` **vertex_format_create** **(** :ref:`RDVertexAttribute[]` vertex_descriptions **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index 1d893bab0..2693b3dee 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -811,6 +811,8 @@ Methods +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** |const| | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_get_rd_texture` **(** :ref:`RID` texture, :ref:`bool` srgb=false **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`texture_proxy_create` **(** :ref:`RID` base **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`texture_proxy_update` **(** :ref:`RID` texture, :ref:`RID` proxy_to **)** | @@ -3173,6 +3175,10 @@ Method Descriptions - :ref:`Image[]` **bake_render_uv2** **(** :ref:`RID` base, :ref:`RID[]` material_overrides, :ref:`Vector2i` image_size **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_camera_attributes_create: @@ -3189,24 +3195,40 @@ Once finished with your RID, you will want to free the RID using the RenderingSe - void **camera_attributes_set_auto_exposure** **(** :ref:`RID` camera_attributes, :ref:`bool` enable, :ref:`float` min_sensitivity, :ref:`float` max_sensitivity, :ref:`float` speed, :ref:`float` scale **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_camera_attributes_set_dof_blur: - void **camera_attributes_set_dof_blur** **(** :ref:`RID` camera_attributes, :ref:`bool` far_enable, :ref:`float` far_distance, :ref:`float` far_transition, :ref:`bool` near_enable, :ref:`float` near_distance, :ref:`float` near_transition, :ref:`float` amount **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape: - void **camera_attributes_set_dof_blur_bokeh_shape** **(** :ref:`DOFBokehShape` shape **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_camera_attributes_set_dof_blur_quality: - void **camera_attributes_set_dof_blur_quality** **(** :ref:`DOFBlurQuality` quality, :ref:`bool` use_jitter **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_camera_attributes_set_exposure: @@ -3245,6 +3267,10 @@ Once finished with your RID, you will want to free the RID using the RenderingSe - void **camera_set_camera_attributes** **(** :ref:`RID` camera, :ref:`RID` effects **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_camera_set_cull_mask: @@ -3325,102 +3351,170 @@ Subsequent drawing commands will be ignored unless they fall within the specifie - void **canvas_item_add_circle** **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_clip_ignore: - void **canvas_item_add_clip_ignore** **(** :ref:`RID` item, :ref:`bool` ignore **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region: - void **canvas_item_add_lcd_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_line: - void **canvas_item_add_line** **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_mesh: - void **canvas_item_add_mesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`Transform2D` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`RID` texture **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region: - void **canvas_item_add_msdf_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`float` px_range=1.0 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_multimesh: - void **canvas_item_add_multimesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_nine_patch: - void **canvas_item_add_nine_patch** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_particles: - void **canvas_item_add_particles** **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_polygon: - void **canvas_item_add_polygon** **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`RID` texture **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_polyline: - void **canvas_item_add_polyline** **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_primitive: - void **canvas_item_add_primitive** **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_rect: - void **canvas_item_add_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_set_transform: - void **canvas_item_add_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_texture_rect: - void **canvas_item_add_texture_rect** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_texture_rect_region: - void **canvas_item_add_texture_rect_region** **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false, :ref:`bool` clip_uv=true **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_add_triangle_array: - void **canvas_item_add_triangle_array** **(** :ref:`RID` item, :ref:`PackedInt32Array` indices, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`PackedInt32Array` bones=PackedInt32Array(), :ref:`PackedFloat32Array` weights=PackedFloat32Array(), :ref:`RID` texture, :ref:`int` count=-1 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_clear: @@ -3435,18 +3529,30 @@ Clears the :ref:`CanvasItem` and removes all commands in it. - :ref:`RID` **canvas_item_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_canvas_group_mode: - void **canvas_item_set_canvas_group_mode** **(** :ref:`RID` item, :ref:`CanvasGroupMode` mode, :ref:`float` clear_margin=5.0, :ref:`bool` fit_empty=false, :ref:`float` fit_margin=0.0, :ref:`bool` blur_mipmaps=false **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_clip: - void **canvas_item_set_clip** **(** :ref:`RID` item, :ref:`bool` clip **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_copy_to_backbuffer: @@ -3461,30 +3567,50 @@ Sets the :ref:`CanvasItem` to copy a rect to the backbuffer. - void **canvas_item_set_custom_rect** **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2(0, 0, 0, 0) **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_default_texture_filter: - void **canvas_item_set_default_texture_filter** **(** :ref:`RID` item, :ref:`CanvasItemTextureFilter` filter **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_default_texture_repeat: - void **canvas_item_set_default_texture_repeat** **(** :ref:`RID` item, :ref:`CanvasItemTextureRepeat` repeat **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_distance_field_mode: - void **canvas_item_set_distance_field_mode** **(** :ref:`RID` item, :ref:`bool` enabled **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_draw_behind_parent: - void **canvas_item_set_draw_behind_parent** **(** :ref:`RID` item, :ref:`bool` enabled **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_draw_index: @@ -3499,6 +3625,10 @@ Sets the index for the :ref:`CanvasItem`. - void **canvas_item_set_light_mask** **(** :ref:`RID` item, :ref:`int` mask **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_material: @@ -3513,30 +3643,50 @@ Sets a new material to the :ref:`CanvasItem`. - void **canvas_item_set_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_parent: - void **canvas_item_set_parent** **(** :ref:`RID` item, :ref:`RID` parent **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_self_modulate: - void **canvas_item_set_self_modulate** **(** :ref:`RID` item, :ref:`Color` color **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_sort_children_by_y: - void **canvas_item_set_sort_children_by_y** **(** :ref:`RID` item, :ref:`bool` enabled **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_transform: - void **canvas_item_set_transform** **(** :ref:`RID` item, :ref:`Transform2D` transform **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_use_parent_material: @@ -3559,12 +3709,20 @@ Sets the rendering visibility layer associated with this :ref:`CanvasItem` item, :ref:`bool` enable, :ref:`Rect2` area, :ref:`Callable` enter_callable, :ref:`Callable` exit_callable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_visible: - void **canvas_item_set_visible** **(** :ref:`RID` item, :ref:`bool` visible **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent: @@ -3623,6 +3781,10 @@ Once finished with your RID, you will want to free the RID using the RenderingSe - void **canvas_light_occluder_set_as_sdf_collision** **(** :ref:`RID` occluder, :ref:`bool` enable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_light_occluder_set_enabled: @@ -3823,6 +3985,10 @@ Sets the shape of the occluder polygon. - void **canvas_set_disable_scale** **(** :ref:`bool` disable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_set_item_mirroring: @@ -3845,108 +4011,180 @@ Modulates all colors in the given canvas. - void **canvas_set_shadow_texture_size** **(** :ref:`int` size **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_texture_create: - :ref:`RID` **canvas_texture_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_texture_set_channel: - void **canvas_texture_set_channel** **(** :ref:`RID` canvas_texture, :ref:`CanvasTextureChannel` channel, :ref:`RID` texture **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_texture_set_shading_parameters: - void **canvas_texture_set_shading_parameters** **(** :ref:`RID` canvas_texture, :ref:`Color` base_color, :ref:`float` shininess **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_texture_set_texture_filter: - void **canvas_texture_set_texture_filter** **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureFilter` filter **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_canvas_texture_set_texture_repeat: - void **canvas_texture_set_texture_repeat** **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureRepeat` repeat **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_create_local_rendering_device: - :ref:`RenderingDevice` **create_local_rendering_device** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_decal_create: - :ref:`RID` **decal_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_decal_set_albedo_mix: - void **decal_set_albedo_mix** **(** :ref:`RID` decal, :ref:`float` albedo_mix **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_decal_set_cull_mask: - void **decal_set_cull_mask** **(** :ref:`RID` decal, :ref:`int` mask **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_decal_set_distance_fade: - void **decal_set_distance_fade** **(** :ref:`RID` decal, :ref:`bool` enabled, :ref:`float` begin, :ref:`float` length **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_decal_set_emission_energy: - void **decal_set_emission_energy** **(** :ref:`RID` decal, :ref:`float` energy **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_decal_set_extents: - void **decal_set_extents** **(** :ref:`RID` decal, :ref:`Vector3` extents **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_decal_set_fade: - void **decal_set_fade** **(** :ref:`RID` decal, :ref:`float` above, :ref:`float` below **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_decal_set_modulate: - void **decal_set_modulate** **(** :ref:`RID` decal, :ref:`Color` color **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_decal_set_normal_fade: - void **decal_set_normal_fade** **(** :ref:`RID` decal, :ref:`float` fade **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_decal_set_texture: - void **decal_set_texture** **(** :ref:`RID` decal, :ref:`DecalTexture` type, :ref:`RID` texture **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_decals_set_filter: - void **decals_set_filter** **(** :ref:`DecalFilter` filter **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_directional_light_create: @@ -3965,18 +4203,30 @@ To place in a scene, attach this directional light to an instance using :ref:`in - void **directional_shadow_atlas_set_size** **(** :ref:`int` size, :ref:`bool` is_16bits **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_directional_soft_shadow_filter_set_quality: - void **directional_soft_shadow_filter_set_quality** **(** :ref:`ShadowQuality` quality **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_environment_bake_panorama: - :ref:`Image` **environment_bake_panorama** **(** :ref:`RID` environment, :ref:`bool` bake_irradiance, :ref:`Vector2i` size **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_environment_create: @@ -3993,12 +4243,20 @@ Once finished with your RID, you will want to free the RID using the RenderingSe - void **environment_glow_set_use_bicubic_upscale** **(** :ref:`bool` enable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_environment_glow_set_use_high_quality: - void **environment_glow_set_use_high_quality** **(** :ref:`bool` enable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_environment_set_adjustment: @@ -4013,6 +4271,10 @@ Sets the values to be used with the "Adjustment" post-process effect. See :ref:` - void **environment_set_ambient_light** **(** :ref:`RID` env, :ref:`Color` color, :ref:`EnvironmentAmbientSource` ambient=0, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0, :ref:`EnvironmentReflectionSource` reflection_source=0 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_environment_set_background: @@ -4051,36 +4313,60 @@ Sets the maximum layer to use if using Canvas background mode. - void **environment_set_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` light_color, :ref:`float` light_energy, :ref:`float` sun_scatter, :ref:`float` density, :ref:`float` height, :ref:`float` height_density, :ref:`float` aerial_perspective, :ref:`float` sky_affect **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_environment_set_glow: - void **environment_set_glow** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`PackedFloat32Array` levels, :ref:`float` intensity, :ref:`float` strength, :ref:`float` mix, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`float` glow_map_strength, :ref:`RID` glow_map **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_environment_set_sdfgi: - void **environment_set_sdfgi** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` cascades, :ref:`float` min_cell_size, :ref:`EnvironmentSDFGIYScale` y_scale, :ref:`bool` use_occlusion, :ref:`float` bounce_feedback, :ref:`bool` read_sky, :ref:`float` energy, :ref:`float` normal_bias, :ref:`float` probe_bias **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_converge: - void **environment_set_sdfgi_frames_to_converge** **(** :ref:`EnvironmentSDFGIFramesToConverge` frames **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light: - void **environment_set_sdfgi_frames_to_update_light** **(** :ref:`EnvironmentSDFGIFramesToUpdateLight` frames **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_environment_set_sdfgi_ray_count: - void **environment_set_sdfgi_ray_count** **(** :ref:`EnvironmentSDFGIRayCount` ray_count **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_environment_set_sky: @@ -4143,6 +4429,10 @@ Sets the variables to be used with the "screen space reflections" post-process e - void **environment_set_ssr_roughness_quality** **(** :ref:`EnvironmentSSRRoughnessQuality` quality **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_environment_set_tonemap: @@ -4157,6 +4447,10 @@ Sets the variables to be used with the "tonemap" post-process effect. See :ref:` - void **environment_set_volumetric_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` density, :ref:`Color` albedo, :ref:`Color` emission, :ref:`float` emission_energy, :ref:`float` anisotropy, :ref:`float` length, :ref:`float` p_detail_spread, :ref:`float` gi_inject, :ref:`bool` temporal_reprojection, :ref:`float` temporal_reprojection_amount, :ref:`float` ambient_inject, :ref:`float` sky_affect **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_environment_set_volumetric_fog_filter_active: @@ -4211,12 +4505,20 @@ Sets the shape of the fog volume to either :ref:`FOG_VOLUME_SHAPE_ELLIPSOID` swap_buffers=true, :ref:`float` frame_step=0.0 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_force_sync: - void **force_sync** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_free_rid: @@ -4231,18 +4533,30 @@ Tries to free an object in the RenderingServer. - :ref:`float` **get_frame_setup_time_cpu** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_get_rendering_device: - :ref:`RenderingDevice` **get_rendering_device** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_get_rendering_info: - :ref:`int` **get_rendering_info** **(** :ref:`RenderingInfo` info **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_get_shader_parameter_list: @@ -4329,42 +4643,70 @@ If ``half_resolution`` is ``true``, renders :ref:`VoxelGI` and SD - void **global_shader_parameter_add** **(** :ref:`StringName` name, :ref:`GlobalShaderParameterType` type, :ref:`Variant` default_value **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_global_shader_parameter_get: - :ref:`Variant` **global_shader_parameter_get** **(** :ref:`StringName` name **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_global_shader_parameter_get_list: - :ref:`PackedStringArray` **global_shader_parameter_get_list** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_global_shader_parameter_get_type: - :ref:`GlobalShaderParameterType` **global_shader_parameter_get_type** **(** :ref:`StringName` name **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_global_shader_parameter_remove: - void **global_shader_parameter_remove** **(** :ref:`StringName` name **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_global_shader_parameter_set: - void **global_shader_parameter_set** **(** :ref:`StringName` name, :ref:`Variant` value **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_global_shader_parameter_set_override: - void **global_shader_parameter_set_override** **(** :ref:`StringName` name, :ref:`Variant` value **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_has_changed: @@ -4433,18 +4775,30 @@ Once finished with your RID, you will want to free the RID using the RenderingSe - :ref:`Variant` **instance_geometry_get_shader_parameter** **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value: - :ref:`Variant` **instance_geometry_get_shader_parameter_default_value** **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_list: - :ref:`Dictionary[]` **instance_geometry_get_shader_parameter_list** **(** :ref:`RID` instance **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_instance_geometry_set_cast_shadows_setting: @@ -4467,12 +4821,20 @@ Sets the flag for a given :ref:`InstanceFlags` instance, :ref:`RID` lightmap, :ref:`Rect2` lightmap_uv_scale, :ref:`int` lightmap_slice **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_instance_geometry_set_lod_bias: - void **instance_geometry_set_lod_bias** **(** :ref:`RID` instance, :ref:`float` lod_bias **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_instance_geometry_set_material_overlay: @@ -4495,6 +4857,10 @@ Sets a material that will override the material for all surfaces on the mesh ass - void **instance_geometry_set_shader_parameter** **(** :ref:`RID` instance, :ref:`StringName` parameter, :ref:`Variant` value **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_instance_geometry_set_transparency: @@ -4555,6 +4921,10 @@ Sets a margin to increase the size of the AABB when culling objects from the vie - void **instance_set_ignore_culling** **(** :ref:`RID` instance, :ref:`bool` enabled **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_instance_set_layer_mask: @@ -4671,12 +5041,20 @@ Sets whether to use a dual paraboloid or a cubemap for the shadow map. Dual para - void **light_projectors_set_filter** **(** :ref:`LightProjectorFilter` filter **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_light_set_bake_mode: - void **light_set_bake_mode** **(** :ref:`RID` light, :ref:`LightBakeMode` bake_mode **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_light_set_color: @@ -4707,6 +5085,10 @@ Sets the distance fade for this Light3D. This acts as a form of level of detail - void **light_set_max_sdfgi_cascade** **(** :ref:`RID` light, :ref:`int` cascade **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_light_set_negative: @@ -4753,30 +5135,50 @@ If ``true``, light will cast shadows. Equivalent to :ref:`Light3D.shadow_enabled - :ref:`RID` **lightmap_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree: - :ref:`PackedInt32Array` **lightmap_get_probe_capture_bsp_tree** **(** :ref:`RID` lightmap **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_lightmap_get_probe_capture_points: - :ref:`PackedVector3Array` **lightmap_get_probe_capture_points** **(** :ref:`RID` lightmap **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_lightmap_get_probe_capture_sh: - :ref:`PackedColorArray` **lightmap_get_probe_capture_sh** **(** :ref:`RID` lightmap **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra: - :ref:`PackedInt32Array` **lightmap_get_probe_capture_tetrahedra** **(** :ref:`RID` lightmap **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_lightmap_set_baked_exposure_normalization: @@ -4791,30 +5193,50 @@ Used to inform the renderer what exposure normalization value was used while bak - void **lightmap_set_probe_bounds** **(** :ref:`RID` lightmap, :ref:`AABB` bounds **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_lightmap_set_probe_capture_data: - void **lightmap_set_probe_capture_data** **(** :ref:`RID` lightmap, :ref:`PackedVector3Array` points, :ref:`PackedColorArray` point_sh, :ref:`PackedInt32Array` tetrahedra, :ref:`PackedInt32Array` bsp_tree **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_lightmap_set_probe_capture_update_speed: - void **lightmap_set_probe_capture_update_speed** **(** :ref:`float` speed **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_lightmap_set_probe_interior: - void **lightmap_set_probe_interior** **(** :ref:`RID` lightmap, :ref:`bool` interior **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_lightmap_set_textures: - void **lightmap_set_textures** **(** :ref:`RID` lightmap, :ref:`RID` light, :ref:`bool` uses_sh **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_make_sphere_mesh: @@ -4879,12 +5301,20 @@ Sets a shader material's shader. - void **mesh_add_surface** **(** :ref:`RID` mesh, :ref:`Dictionary` surface **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_mesh_add_surface_from_arrays: - void **mesh_add_surface_from_arrays** **(** :ref:`RID` mesh, :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[], :ref:`Dictionary` lods={}, :ref:`int` compress_format=0 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_mesh_clear: @@ -4911,6 +5341,10 @@ To place in a scene, attach this mesh to an instance using :ref:`instance_set_ba - :ref:`RID` **mesh_create_from_surfaces** **(** :ref:`Dictionary[]` surfaces, :ref:`int` blend_shape_count=0 **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_mesh_get_blend_shape_count: @@ -4941,6 +5375,10 @@ Returns a mesh's custom aabb. - :ref:`Dictionary` **mesh_get_surface** **(** :ref:`RID` mesh, :ref:`int` surface **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_mesh_get_surface_count: @@ -4971,6 +5409,10 @@ Sets a mesh's custom aabb. - void **mesh_set_shadow_mesh** **(** :ref:`RID` mesh, :ref:`RID` shadow_mesh **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_mesh_surface_get_arrays: @@ -4993,24 +5435,40 @@ Returns a mesh's surface's arrays for blend shapes. - :ref:`int` **mesh_surface_get_format_attribute_stride** **(** :ref:`int` format, :ref:`int` vertex_count **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_mesh_surface_get_format_offset: - :ref:`int` **mesh_surface_get_format_offset** **(** :ref:`int` format, :ref:`int` vertex_count, :ref:`int` array_index **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_mesh_surface_get_format_skin_stride: - :ref:`int` **mesh_surface_get_format_skin_stride** **(** :ref:`int` format, :ref:`int` vertex_count **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_mesh_surface_get_format_vertex_stride: - :ref:`int` **mesh_surface_get_format_vertex_stride** **(** :ref:`int` format, :ref:`int` vertex_count **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_mesh_surface_get_material: @@ -5033,24 +5491,40 @@ Sets a mesh's surface's material. - void **mesh_surface_update_attribute_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_mesh_surface_update_skin_region: - void **mesh_surface_update_skin_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_mesh_surface_update_vertex_region: - void **mesh_surface_update_vertex_region** **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_multimesh_allocate_data: - void **multimesh_allocate_data** **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`bool` color_format=false, :ref:`bool` custom_data_format=false **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_multimesh_create: @@ -5077,6 +5551,10 @@ Calculates and returns the axis-aligned bounding box that encloses all instances - :ref:`PackedFloat32Array` **multimesh_get_buffer** **(** :ref:`RID` multimesh **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_multimesh_get_instance_count: @@ -5171,6 +5649,10 @@ Sets the :ref:`Transform2D` for this instance. For use when m - void **multimesh_set_buffer** **(** :ref:`RID` multimesh, :ref:`PackedFloat32Array` buffer **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_multimesh_set_mesh: @@ -5193,12 +5675,20 @@ Sets the number of instances visible at a given time. If -1, all instances that - :ref:`RID` **occluder_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_occluder_set_mesh: - void **occluder_set_mesh** **(** :ref:`RID` occluder, :ref:`PackedVector3Array` vertices, :ref:`PackedInt32Array` indices **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_omni_light_create: @@ -5217,66 +5707,110 @@ To place in a scene, attach this omni light to an instance using :ref:`instance_ - :ref:`RID` **particles_collision_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_collision_height_field_update: - void **particles_collision_height_field_update** **(** :ref:`RID` particles_collision **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_collision_set_attractor_attenuation: - void **particles_collision_set_attractor_attenuation** **(** :ref:`RID` particles_collision, :ref:`float` curve **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_collision_set_attractor_directionality: - void **particles_collision_set_attractor_directionality** **(** :ref:`RID` particles_collision, :ref:`float` amount **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_collision_set_attractor_strength: - void **particles_collision_set_attractor_strength** **(** :ref:`RID` particles_collision, :ref:`float` setrngth **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_collision_set_box_extents: - void **particles_collision_set_box_extents** **(** :ref:`RID` particles_collision, :ref:`Vector3` extents **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_collision_set_collision_type: - void **particles_collision_set_collision_type** **(** :ref:`RID` particles_collision, :ref:`ParticlesCollisionType` type **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_collision_set_cull_mask: - void **particles_collision_set_cull_mask** **(** :ref:`RID` particles_collision, :ref:`int` mask **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_collision_set_field_texture: - void **particles_collision_set_field_texture** **(** :ref:`RID` particles_collision, :ref:`RID` texture **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_collision_set_height_field_resolution: - void **particles_collision_set_height_field_resolution** **(** :ref:`RID` particles_collision, :ref:`ParticlesCollisionHeightfieldResolution` resolution **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_collision_set_sphere_radius: - void **particles_collision_set_sphere_radius** **(** :ref:`RID` particles_collision, :ref:`float` radius **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_create: @@ -5295,6 +5829,10 @@ To place in a scene, attach these particles to an instance using :ref:`instance_ - void **particles_emit** **(** :ref:`RID` particles, :ref:`Transform3D` transform, :ref:`Vector3` velocity, :ref:`Color` color, :ref:`Color` custom, :ref:`int` emit_flags **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_get_current_aabb: @@ -5349,6 +5887,10 @@ Sets the number of particles to be drawn and allocates the memory for them. Equi - void **particles_set_collision_base_size** **(** :ref:`RID` particles, :ref:`float` size **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_set_custom_aabb: @@ -5427,6 +5969,10 @@ If ``true``, uses fractional delta which smooths the movement of the particles. - void **particles_set_interpolate** **(** :ref:`RID` particles, :ref:`bool` enable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_set_lifetime: @@ -5441,6 +5987,10 @@ Sets the lifetime of each particle in the system. Equivalent to :ref:`GPUParticl - void **particles_set_mode** **(** :ref:`RID` particles, :ref:`ParticlesMode` mode **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_set_one_shot: @@ -5489,24 +6039,40 @@ Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D. - void **particles_set_subemitter** **(** :ref:`RID` particles, :ref:`RID` subemitter_particles **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_set_trail_bind_poses: - void **particles_set_trail_bind_poses** **(** :ref:`RID` particles, :ref:`Transform3D[]` bind_poses **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_set_trails: - void **particles_set_trails** **(** :ref:`RID` particles, :ref:`bool` enable, :ref:`float` length_sec **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_set_transform_align: - void **particles_set_transform_align** **(** :ref:`RID` particles, :ref:`ParticlesTransformAlign` align **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_particles_set_use_local_coordinates: @@ -5521,6 +6087,10 @@ If ``true``, particles use local coordinates. If ``false`` they use global coord - void **positional_soft_shadow_filter_set_quality** **(** :ref:`ShadowQuality` quality **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_reflection_probe_create: @@ -5539,18 +6109,30 @@ To place in a scene, attach this reflection probe to an instance using :ref:`ins - void **reflection_probe_set_ambient_color** **(** :ref:`RID` probe, :ref:`Color` color **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_reflection_probe_set_ambient_energy: - void **reflection_probe_set_ambient_energy** **(** :ref:`RID` probe, :ref:`float` energy **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_reflection_probe_set_ambient_mode: - void **reflection_probe_set_ambient_mode** **(** :ref:`RID` probe, :ref:`ReflectionProbeAmbientMode` mode **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_reflection_probe_set_as_interior: @@ -5613,6 +6195,10 @@ Sets the max distance away from the probe an object can be before it is culled. - void **reflection_probe_set_mesh_lod_threshold** **(** :ref:`RID` probe, :ref:`float` pixels **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_reflection_probe_set_origin_offset: @@ -5627,6 +6213,10 @@ Sets the origin offset to be used when this reflection probe is in box project m - void **reflection_probe_set_resolution** **(** :ref:`RID` probe, :ref:`int` resolution **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_reflection_probe_set_update_mode: @@ -5661,6 +6251,10 @@ The scenario is the 3D world that all the visual instances exist in. - void **scenario_set_camera_attributes** **(** :ref:`RID` scenario, :ref:`RID` effects **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_scenario_set_environment: @@ -5683,6 +6277,10 @@ Sets the fallback environment to be used by this scenario. The fallback environm - void **screen_space_roughness_limiter_set_active** **(** :ref:`bool` enable, :ref:`float` amount, :ref:`float` limit **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_set_boot_image: @@ -5741,12 +6339,20 @@ Returns a default texture from a shader searched by name. - :ref:`Variant` **shader_get_parameter_default** **(** :ref:`RID` shader, :ref:`StringName` name **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_shader_set_code: - void **shader_set_code** **(** :ref:`RID` shader, :ref:`String` code **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_shader_set_default_texture_parameter: @@ -5763,12 +6369,20 @@ Sets a shader's default texture. Overwrites the texture given by name. - void **shader_set_path_hint** **(** :ref:`RID` shader, :ref:`String` path **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_skeleton_allocate_data: - void **skeleton_allocate_data** **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_skeleton_bone_get_transform: @@ -5825,12 +6439,20 @@ Returns the number of bones allocated for this skeleton. - void **skeleton_set_base_transform_2d** **(** :ref:`RID` skeleton, :ref:`Transform2D` base_transform **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_sky_bake_panorama: - :ref:`Image` **sky_bake_panorama** **(** :ref:`RID` sky, :ref:`float` energy, :ref:`bool` bake_irradiance, :ref:`Vector2i` size **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_sky_create: @@ -5855,12 +6477,20 @@ Sets the material that the sky uses to render the background and reflection maps - void **sky_set_mode** **(** :ref:`RID` sky, :ref:`SkyMode` mode **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_sky_set_radiance_size: - void **sky_set_radiance_size** **(** :ref:`RID` sky, :ref:`int` radiance_size **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_spot_light_create: @@ -5879,120 +6509,208 @@ To place in a scene, attach this spot light to an instance using :ref:`instance_ - void **sub_surface_scattering_set_quality** **(** :ref:`SubSurfaceScatteringQuality` quality **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_sub_surface_scattering_set_scale: - void **sub_surface_scattering_set_scale** **(** :ref:`float` scale, :ref:`float` depth_scale **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_2d_create: - :ref:`RID` **texture_2d_create** **(** :ref:`Image` image **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_2d_get: - :ref:`Image` **texture_2d_get** **(** :ref:`RID` texture **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_2d_layer_get: - :ref:`Image` **texture_2d_layer_get** **(** :ref:`RID` texture, :ref:`int` layer **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_2d_layered_create: - :ref:`RID` **texture_2d_layered_create** **(** :ref:`Image[]` layers, :ref:`TextureLayeredType` layered_type **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_2d_layered_placeholder_create: - :ref:`RID` **texture_2d_layered_placeholder_create** **(** :ref:`TextureLayeredType` layered_type **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_2d_placeholder_create: - :ref:`RID` **texture_2d_placeholder_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_2d_update: - void **texture_2d_update** **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_3d_create: - :ref:`RID` **texture_3d_create** **(** :ref:`Format` format, :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` mipmaps, :ref:`Image[]` data **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_3d_get: - :ref:`Image[]` **texture_3d_get** **(** :ref:`RID` texture **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_3d_placeholder_create: - :ref:`RID` **texture_3d_placeholder_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_3d_update: - void **texture_3d_update** **(** :ref:`RID` texture, :ref:`Image[]` data **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_get_path: - :ref:`String` **texture_get_path** **(** :ref:`RID` texture **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +---- + +.. _class_RenderingServer_method_texture_get_rd_texture: + +- :ref:`RID` **texture_get_rd_texture** **(** :ref:`RID` texture, :ref:`bool` srgb=false **)** |const| + +Returns a texture :ref:`RID` that can be used with :ref:`RenderingDevice`. + ---- .. _class_RenderingServer_method_texture_proxy_create: - :ref:`RID` **texture_proxy_create** **(** :ref:`RID` base **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_proxy_update: - void **texture_proxy_update** **(** :ref:`RID` texture, :ref:`RID` proxy_to **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_replace: - void **texture_replace** **(** :ref:`RID` texture, :ref:`RID` by_texture **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_set_force_redraw_if_visible: - void **texture_set_force_redraw_if_visible** **(** :ref:`RID` texture, :ref:`bool` enable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_set_path: - void **texture_set_path** **(** :ref:`RID` texture, :ref:`String` path **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_texture_set_size_override: - void **texture_set_size_override** **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_attach_camera: @@ -6050,18 +6768,30 @@ Once finished with your RID, you will want to free the RID using the RenderingSe - :ref:`float` **viewport_get_measured_render_time_cpu** **(** :ref:`RID` viewport **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_get_measured_render_time_gpu: - :ref:`float` **viewport_get_measured_render_time_gpu** **(** :ref:`RID` viewport **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_get_render_info: - :ref:`int` **viewport_get_render_info** **(** :ref:`RID` viewport, :ref:`ViewportRenderInfoType` type, :ref:`ViewportRenderInfo` info **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_get_texture: @@ -6134,12 +6864,20 @@ Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw` viewport, :ref:`CanvasItemTextureFilter` filter **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat: - void **viewport_set_default_canvas_item_texture_repeat** **(** :ref:`RID` viewport, :ref:`CanvasItemTextureRepeat` repeat **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_set_disable_2d: @@ -6154,6 +6892,10 @@ If ``true``, the viewport's canvas is not rendered. - void **viewport_set_disable_3d** **(** :ref:`RID` viewport, :ref:`bool` disable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_set_disable_environment: @@ -6184,6 +6926,10 @@ Sets the viewport's global transformation matrix. - void **viewport_set_measure_render_time** **(** :ref:`RID` viewport, :ref:`bool` enable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_set_msaa_2d: @@ -6206,12 +6952,20 @@ Sets the multisample anti-aliasing mode for 3D. See :ref:`ViewportMSAA` quality **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_set_occlusion_rays_per_thread: - void **viewport_set_occlusion_rays_per_thread** **(** :ref:`int` rays_per_thread **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_set_parent_viewport: @@ -6280,12 +7034,20 @@ The scenario contains information about environment information, reflection atla - void **viewport_set_screen_space_aa** **(** :ref:`RID` viewport, :ref:`ViewportScreenSpaceAA` mode **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_set_sdf_oversize_and_scale: - void **viewport_set_sdf_oversize_and_scale** **(** :ref:`RID` viewport, :ref:`ViewportSDFOversize` oversize, :ref:`ViewportSDFScale` scale **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_set_size: @@ -6300,12 +7062,20 @@ Sets the viewport's width and height. - void **viewport_set_snap_2d_transforms_to_pixel** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel: - void **viewport_set_snap_2d_vertices_to_pixel** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_set_texture_mipmap_bias: @@ -6338,12 +7108,20 @@ Sets when the viewport should be updated. See :ref:`ViewportUpdateMode` viewport, :ref:`bool` enable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_set_use_occlusion_culling: - void **viewport_set_use_occlusion_culling** **(** :ref:`RID` viewport, :ref:`bool` enable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_viewport_set_use_taa: @@ -6382,66 +7160,110 @@ Texture to use when the VRS mode is set to :ref:`VIEWPORT_VRS_TEXTURE` **visibility_notifier_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_visibility_notifier_set_aabb: - void **visibility_notifier_set_aabb** **(** :ref:`RID` notifier, :ref:`AABB` aabb **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_visibility_notifier_set_callbacks: - void **visibility_notifier_set_callbacks** **(** :ref:`RID` notifier, :ref:`Callable` enter_callable, :ref:`Callable` exit_callable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_allocate_data: - void **voxel_gi_allocate_data** **(** :ref:`RID` voxel_gi, :ref:`Transform3D` to_cell_xform, :ref:`AABB` aabb, :ref:`Vector3i` octree_size, :ref:`PackedByteArray` octree_cells, :ref:`PackedByteArray` data_cells, :ref:`PackedByteArray` distance_field, :ref:`PackedInt32Array` level_counts **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_create: - :ref:`RID` **voxel_gi_create** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_get_data_cells: - :ref:`PackedByteArray` **voxel_gi_get_data_cells** **(** :ref:`RID` voxel_gi **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_get_distance_field: - :ref:`PackedByteArray` **voxel_gi_get_distance_field** **(** :ref:`RID` voxel_gi **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_get_level_counts: - :ref:`PackedInt32Array` **voxel_gi_get_level_counts** **(** :ref:`RID` voxel_gi **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_get_octree_cells: - :ref:`PackedByteArray` **voxel_gi_get_octree_cells** **(** :ref:`RID` voxel_gi **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_get_octree_size: - :ref:`Vector3i` **voxel_gi_get_octree_size** **(** :ref:`RID` voxel_gi **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_get_to_cell_xform: - :ref:`Transform3D` **voxel_gi_get_to_cell_xform** **(** :ref:`RID` voxel_gi **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_set_baked_exposure_normalization: @@ -6456,48 +7278,80 @@ Used to inform the renderer what exposure normalization value was used while bak - void **voxel_gi_set_bias** **(** :ref:`RID` voxel_gi, :ref:`float` bias **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_set_dynamic_range: - void **voxel_gi_set_dynamic_range** **(** :ref:`RID` voxel_gi, :ref:`float` range **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_set_energy: - void **voxel_gi_set_energy** **(** :ref:`RID` voxel_gi, :ref:`float` energy **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_set_interior: - void **voxel_gi_set_interior** **(** :ref:`RID` voxel_gi, :ref:`bool` enable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_set_normal_bias: - void **voxel_gi_set_normal_bias** **(** :ref:`RID` voxel_gi, :ref:`float` bias **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_set_propagation: - void **voxel_gi_set_propagation** **(** :ref:`RID` voxel_gi, :ref:`float` amount **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_set_quality: - void **voxel_gi_set_quality** **(** :ref:`VoxelGIQuality` quality **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RenderingServer_method_voxel_gi_set_use_two_bounces: - void **voxel_gi_set_use_two_bounces** **(** :ref:`RID` voxel_gi, :ref:`bool` enable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_resourceformatloader.rst b/classes/class_resourceformatloader.rst index b16885f9c..299a8211c 100644 --- a/classes/class_resourceformatloader.rst +++ b/classes/class_resourceformatloader.rst @@ -74,12 +74,20 @@ Method Descriptions - :ref:`bool` **_exists** **(** :ref:`String` path **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ResourceFormatLoader_method__get_classes_used: - :ref:`PackedStringArray` **_get_classes_used** **(** :ref:`String` path **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ResourceFormatLoader_method__get_dependencies: @@ -114,6 +122,10 @@ Gets the class name of the resource associated with the given path. If the loade - :ref:`int` **_get_resource_uid** **(** :ref:`String` path **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ResourceFormatLoader_method__handles_type: diff --git a/classes/class_ribbontrailmesh.rst b/classes/class_ribbontrailmesh.rst index e916142d7..2867e1cd1 100644 --- a/classes/class_ribbontrailmesh.rst +++ b/classes/class_ribbontrailmesh.rst @@ -12,7 +12,9 @@ RibbonTrailMesh **Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -59,6 +61,10 @@ Property Descriptions | *Getter* | get_curve() | +----------+------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RibbonTrailMesh_property_section_length: @@ -73,6 +79,10 @@ Property Descriptions | *Getter* | get_section_length() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RibbonTrailMesh_property_section_segments: @@ -87,6 +97,10 @@ Property Descriptions | *Getter* | get_section_segments() | +-----------+-----------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RibbonTrailMesh_property_sections: @@ -101,6 +115,10 @@ Property Descriptions | *Getter* | get_sections() | +-----------+---------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RibbonTrailMesh_property_shape: @@ -115,6 +133,10 @@ Property Descriptions | *Getter* | get_shape() | +-----------+------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_RibbonTrailMesh_property_size: @@ -129,6 +151,10 @@ Property Descriptions | *Getter* | get_size() | +-----------+-----------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 98da6fe2d..3d1670478 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -1159,6 +1159,10 @@ Adds a ``[font]`` tag to the tag stack. Overrides default fonts for its duration - void **push_font_size** **(** :ref:`int` font_size **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_RichTextLabel_method_push_hint: diff --git a/classes/class_rid.rst b/classes/class_rid.rst index e7cc29424..f838b65aa 100644 --- a/classes/class_rid.rst +++ b/classes/class_rid.rst @@ -91,36 +91,60 @@ Operator Descriptions - :ref:`bool` **operator !=** **(** :ref:`RID` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_RID_operator_lt_bool: - :ref:`bool` **operator <** **(** :ref:`RID` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_RID_operator_lte_bool: - :ref:`bool` **operator <=** **(** :ref:`RID` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_RID_operator_eq_bool: - :ref:`bool` **operator ==** **(** :ref:`RID` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_RID_operator_gt_bool: - :ref:`bool` **operator >** **(** :ref:`RID` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_RID_operator_gte_bool: - :ref:`bool` **operator >=** **(** :ref:`RID` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index 8a14fbf21..3051063db 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -724,6 +724,8 @@ An impulse is time-independent! Applying an impulse every frame would result in Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. +\ **Note:** :ref:`inertia` is required for this to work. To have :ref:`inertia`, an active :ref:`CollisionShape2D` must be a child of the node, or you can manually set :ref:`inertia`. + ---- .. _class_RigidBody2D_method_apply_torque_impulse: @@ -734,6 +736,8 @@ Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). +\ **Note:** :ref:`inertia` is required for this to work. To have :ref:`inertia`, an active :ref:`CollisionShape2D` must be a child of the node, or you can manually set :ref:`inertia`. + ---- .. _class_RigidBody2D_method_get_colliding_bodies: diff --git a/classes/class_rigidbody3d.rst b/classes/class_rigidbody3d.rst index e5bb89019..bd615a1d7 100644 --- a/classes/class_rigidbody3d.rst +++ b/classes/class_rigidbody3d.rst @@ -708,6 +708,8 @@ An impulse is time-independent! Applying an impulse every frame would result in Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update. +\ **Note:** :ref:`inertia` is required for this to work. To have :ref:`inertia`, an active :ref:`CollisionShape3D` must be a child of the node, or you can manually set :ref:`inertia`. + ---- .. _class_RigidBody3D_method_apply_torque_impulse: @@ -718,6 +720,8 @@ Applies a rotational impulse to the body without affecting the position. An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise). +\ **Note:** :ref:`inertia` is required for this to work. To have :ref:`inertia`, an active :ref:`CollisionShape3D` must be a child of the node, or you can manually set :ref:`inertia`. + ---- .. _class_RigidBody3D_method_get_colliding_bodies: diff --git a/classes/class_scriptextension.rst b/classes/class_scriptextension.rst index 8647b57d8..fd7bc50a7 100644 --- a/classes/class_scriptextension.rst +++ b/classes/class_scriptextension.rst @@ -12,7 +12,9 @@ ScriptExtension **Inherits:** :ref:`Script` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -88,186 +90,310 @@ Method Descriptions - :ref:`bool` **_can_instantiate** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__editor_can_reload_from_file: - :ref:`bool` **_editor_can_reload_from_file** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__get_base_script: - :ref:`Script` **_get_base_script** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__get_constants: - :ref:`Dictionary` **_get_constants** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__get_documentation: - :ref:`Dictionary[]` **_get_documentation** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__get_instance_base_type: - :ref:`StringName` **_get_instance_base_type** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__get_language: - :ref:`ScriptLanguage` **_get_language** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__get_member_line: - :ref:`int` **_get_member_line** **(** :ref:`StringName` member **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__get_members: - :ref:`StringName[]` **_get_members** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__get_method_info: - :ref:`Dictionary` **_get_method_info** **(** :ref:`StringName` method **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__get_property_default_value: - :ref:`Variant` **_get_property_default_value** **(** :ref:`StringName` property **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__get_rpc_config: - :ref:`Variant` **_get_rpc_config** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__get_script_method_list: - :ref:`Dictionary[]` **_get_script_method_list** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__get_script_property_list: - :ref:`Dictionary[]` **_get_script_property_list** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__get_script_signal_list: - :ref:`Dictionary[]` **_get_script_signal_list** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__get_source_code: - :ref:`String` **_get_source_code** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__has_method: - :ref:`bool` **_has_method** **(** :ref:`StringName` method **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__has_property_default_value: - :ref:`bool` **_has_property_default_value** **(** :ref:`StringName` property **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__has_script_signal: - :ref:`bool` **_has_script_signal** **(** :ref:`StringName` signal **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__has_source_code: - :ref:`bool` **_has_source_code** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__inherits_script: - :ref:`bool` **_inherits_script** **(** :ref:`Script` script **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__instance_create: - void* **_instance_create** **(** :ref:`Object` for_object **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__instance_has: - :ref:`bool` **_instance_has** **(** :ref:`Object` object **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__is_placeholder_fallback_enabled: - :ref:`bool` **_is_placeholder_fallback_enabled** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__is_tool: - :ref:`bool` **_is_tool** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__is_valid: - :ref:`bool` **_is_valid** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__placeholder_erased: - void **_placeholder_erased** **(** void* placeholder **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__placeholder_instance_create: - void* **_placeholder_instance_create** **(** :ref:`Object` for_object **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__reload: - :ref:`Error` **_reload** **(** :ref:`bool` keep_state **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__set_source_code: - void **_set_source_code** **(** :ref:`String` code **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptExtension_method__update_exports: - void **_update_exports** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_scriptlanguage.rst b/classes/class_scriptlanguage.rst index f00187116..77abe70e1 100644 --- a/classes/class_scriptlanguage.rst +++ b/classes/class_scriptlanguage.rst @@ -14,7 +14,9 @@ ScriptLanguage **Inherited By:** :ref:`ScriptLanguageExtension` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_scriptlanguageextension.rst b/classes/class_scriptlanguageextension.rst index 8ee8585cc..d51a451d6 100644 --- a/classes/class_scriptlanguageextension.rst +++ b/classes/class_scriptlanguageextension.rst @@ -12,7 +12,9 @@ ScriptLanguageExtension **Inherits:** :ref:`ScriptLanguage` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -263,354 +265,590 @@ Method Descriptions - void **_add_global_constant** **(** :ref:`StringName` name, :ref:`Variant` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__add_named_global_constant: - void **_add_named_global_constant** **(** :ref:`StringName` name, :ref:`Variant` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__alloc_instance_binding_data: - void* **_alloc_instance_binding_data** **(** :ref:`Object` object **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__auto_indent_code: - :ref:`String` **_auto_indent_code** **(** :ref:`String` code, :ref:`int` from_line, :ref:`int` to_line **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__can_inherit_from_file: - :ref:`bool` **_can_inherit_from_file** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__complete_code: - :ref:`Dictionary` **_complete_code** **(** :ref:`String` code, :ref:`String` path, :ref:`Object` owner **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__create_script: - :ref:`Object` **_create_script** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__debug_get_current_stack_info: - :ref:`Dictionary[]` **_debug_get_current_stack_info** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__debug_get_error: - :ref:`String` **_debug_get_error** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__debug_get_globals: - :ref:`Dictionary` **_debug_get_globals** **(** :ref:`int` max_subitems, :ref:`int` max_depth **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__debug_get_stack_level_count: - :ref:`int` **_debug_get_stack_level_count** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__debug_get_stack_level_function: - :ref:`String` **_debug_get_stack_level_function** **(** :ref:`int` level **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__debug_get_stack_level_instance: - void* **_debug_get_stack_level_instance** **(** :ref:`int` level **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__debug_get_stack_level_line: - :ref:`int` **_debug_get_stack_level_line** **(** :ref:`int` level **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__debug_get_stack_level_locals: - :ref:`Dictionary` **_debug_get_stack_level_locals** **(** :ref:`int` level, :ref:`int` max_subitems, :ref:`int` max_depth **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__debug_get_stack_level_members: - :ref:`Dictionary` **_debug_get_stack_level_members** **(** :ref:`int` level, :ref:`int` max_subitems, :ref:`int` max_depth **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__debug_parse_stack_level_expression: - :ref:`String` **_debug_parse_stack_level_expression** **(** :ref:`int` level, :ref:`String` expression, :ref:`int` max_subitems, :ref:`int` max_depth **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__execute_file: - :ref:`Error` **_execute_file** **(** :ref:`String` path **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__find_function: - :ref:`int` **_find_function** **(** :ref:`String` class_name, :ref:`String` function_name **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__finish: - void **_finish** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__frame: - void **_frame** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__free_instance_binding_data: - void **_free_instance_binding_data** **(** void* data **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__get_built_in_templates: - :ref:`Dictionary[]` **_get_built_in_templates** **(** :ref:`StringName` object **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__get_comment_delimiters: - :ref:`PackedStringArray` **_get_comment_delimiters** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__get_extension: - :ref:`String` **_get_extension** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__get_global_class_name: - :ref:`Dictionary` **_get_global_class_name** **(** :ref:`String` path **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__get_name: - :ref:`String` **_get_name** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__get_public_annotations: - :ref:`Dictionary[]` **_get_public_annotations** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__get_public_constants: - :ref:`Dictionary` **_get_public_constants** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__get_public_functions: - :ref:`Dictionary[]` **_get_public_functions** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__get_recognized_extensions: - :ref:`PackedStringArray` **_get_recognized_extensions** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__get_reserved_words: - :ref:`PackedStringArray` **_get_reserved_words** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__get_string_delimiters: - :ref:`PackedStringArray` **_get_string_delimiters** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__get_type: - :ref:`String` **_get_type** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__handles_global_class_type: - :ref:`bool` **_handles_global_class_type** **(** :ref:`String` type **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__has_named_classes: - :ref:`bool` **_has_named_classes** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__init: - void **_init** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__is_control_flow_keyword: - :ref:`bool` **_is_control_flow_keyword** **(** :ref:`String` keyword **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__is_using_templates: - :ref:`bool` **_is_using_templates** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__lookup_code: - :ref:`Dictionary` **_lookup_code** **(** :ref:`String` code, :ref:`String` symbol, :ref:`String` path, :ref:`Object` owner **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__make_function: - :ref:`String` **_make_function** **(** :ref:`String` class_name, :ref:`String` function_name, :ref:`PackedStringArray` function_args **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__make_template: - :ref:`Script` **_make_template** **(** :ref:`String` template, :ref:`String` class_name, :ref:`String` base_class_name **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__open_in_external_editor: - :ref:`Error` **_open_in_external_editor** **(** :ref:`Script` script, :ref:`int` line, :ref:`int` column **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__overrides_external_editor: - :ref:`bool` **_overrides_external_editor** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__profiling_get_accumulated_data: - :ref:`int` **_profiling_get_accumulated_data** **(** ScriptLanguageExtensionProfilingInfo* info_array, :ref:`int` info_max **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__profiling_get_frame_data: - :ref:`int` **_profiling_get_frame_data** **(** ScriptLanguageExtensionProfilingInfo* info_array, :ref:`int` info_max **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__profiling_start: - void **_profiling_start** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__profiling_stop: - void **_profiling_stop** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__refcount_decremented_instance_binding: - :ref:`bool` **_refcount_decremented_instance_binding** **(** :ref:`Object` object **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__refcount_incremented_instance_binding: - void **_refcount_incremented_instance_binding** **(** :ref:`Object` object **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__reload_all_scripts: - void **_reload_all_scripts** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__reload_tool_script: - void **_reload_tool_script** **(** :ref:`Script` script, :ref:`bool` soft_reload **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__remove_named_global_constant: - void **_remove_named_global_constant** **(** :ref:`StringName` name **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__supports_builtin_mode: - :ref:`bool` **_supports_builtin_mode** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__supports_documentation: - :ref:`bool` **_supports_documentation** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__thread_enter: - void **_thread_enter** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__thread_exit: - void **_thread_exit** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__validate: - :ref:`Dictionary` **_validate** **(** :ref:`String` script, :ref:`String` path, :ref:`bool` validate_functions, :ref:`bool` validate_errors, :ref:`bool` validate_warnings, :ref:`bool` validate_safe_lines **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_ScriptLanguageExtension_method__validate_path: - :ref:`String` **_validate_path** **(** :ref:`String` path **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_scrollbar.rst b/classes/class_scrollbar.rst index bd122fbc9..da6fcec34 100644 --- a/classes/class_scrollbar.rst +++ b/classes/class_scrollbar.rst @@ -24,13 +24,11 @@ Scrollbars are a :ref:`Range`-based :ref:`Control`, Properties ---------- -+---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`custom_step` | ``-1.0`` | -+---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | size_flags_vertical | ``0`` (overrides :ref:`Control`) | -+---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`float` | step | ``0.0`` (overrides :ref:`Range`) | -+---------------------------+----------------------------------------------------------+------------------------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------+-------------------------------------------------------------+ +| :ref:`float` | :ref:`custom_step` | ``-1.0`` | ++---------------------------+----------------------------------------------------------+-------------------------------------------------------------+ +| :ref:`float` | step | ``0.0`` (overrides :ref:`Range`) | ++---------------------------+----------------------------------------------------------+-------------------------------------------------------------+ Signals ------- diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 9d2dd81f4..55d6159e4 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -154,6 +154,10 @@ Controls whether horizontal scrollbar can be used and when it should be visible. | *Getter* | get_deadzone() | +-----------+---------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_ScrollContainer_property_scroll_horizontal: diff --git a/classes/class_shaderglobalsoverride.rst b/classes/class_shaderglobalsoverride.rst index b224b948f..7ee4e92ee 100644 --- a/classes/class_shaderglobalsoverride.rst +++ b/classes/class_shaderglobalsoverride.rst @@ -12,7 +12,9 @@ ShaderGlobalsOverride **Inherits:** :ref:`Node` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_shaderinclude.rst b/classes/class_shaderinclude.rst index 41d01cde9..ceb5319d4 100644 --- a/classes/class_shaderinclude.rst +++ b/classes/class_shaderinclude.rst @@ -12,7 +12,9 @@ ShaderInclude **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -36,6 +38,10 @@ Property Descriptions | *Getter* | get_code() | +-----------+-----------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_signal.rst b/classes/class_signal.rst index 4e021f13c..e7ee28ae1 100644 --- a/classes/class_signal.rst +++ b/classes/class_signal.rst @@ -162,6 +162,10 @@ Returns ``true`` if the specified :ref:`Callable` is connected t - :ref:`bool` **is_null** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + Operator Descriptions --------------------- @@ -169,12 +173,20 @@ Operator Descriptions - :ref:`bool` **operator !=** **(** :ref:`Signal` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_Signal_operator_eq_bool: - :ref:`bool` **operator ==** **(** :ref:`Signal` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_skeleton3d.rst b/classes/class_skeleton3d.rst index e1f16d44a..3dec401b5 100644 --- a/classes/class_skeleton3d.rst +++ b/classes/class_skeleton3d.rst @@ -195,6 +195,10 @@ Property Descriptions | *Getter* | get_animate_physical_bones() | +-----------+-----------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_Skeleton3D_property_motion_scale: @@ -227,6 +231,10 @@ Multiplies the position 3D track animation. | *Getter* | is_show_rest_only() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + Method Descriptions ------------------- @@ -268,6 +276,10 @@ Removes the local pose override on all bones in the skeleton. - :ref:`Skin` **create_skin_from_rest_transforms** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skeleton3D_method_execute_modifications: @@ -388,18 +400,30 @@ Returns the pose transform of the specified bone. Pose is applied on top of the - :ref:`Vector3` **get_bone_pose_position** **(** :ref:`int` bone_idx **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skeleton3D_method_get_bone_pose_rotation: - :ref:`Quaternion` **get_bone_pose_rotation** **(** :ref:`int` bone_idx **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skeleton3D_method_get_bone_pose_scale: - :ref:`Vector3` **get_bone_pose_scale** **(** :ref:`int` bone_idx **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skeleton3D_method_get_bone_rest: @@ -584,6 +608,10 @@ Sets the local pose transform, ``pose``, for the bone at ``bone_idx``. - void **set_bone_name** **(** :ref:`int` bone_idx, :ref:`String` name **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skeleton3D_method_set_bone_parent: @@ -600,18 +628,30 @@ Sets the bone index ``parent_idx`` as the parent of the bone at ``bone_idx``. If - void **set_bone_pose_position** **(** :ref:`int` bone_idx, :ref:`Vector3` position **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skeleton3D_method_set_bone_pose_rotation: - void **set_bone_pose_rotation** **(** :ref:`int` bone_idx, :ref:`Quaternion` rotation **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skeleton3D_method_set_bone_pose_scale: - void **set_bone_pose_scale** **(** :ref:`int` bone_idx, :ref:`Vector3` scale **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skeleton3D_method_set_bone_rest: diff --git a/classes/class_skeletonmodification3dlookat.rst b/classes/class_skeletonmodification3dlookat.rst index fe99db14d..1201f22d8 100644 --- a/classes/class_skeletonmodification3dlookat.rst +++ b/classes/class_skeletonmodification3dlookat.rst @@ -139,6 +139,10 @@ Sets the amount of extra rotation to be applied after the LookAt modification ex - void **set_lock_rotation_plane** **(** :ref:`int` plane **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_SkeletonModification3DLookAt_method_set_lock_rotation_to_plane: diff --git a/classes/class_skeletonprofile.rst b/classes/class_skeletonprofile.rst index eb07b144f..fa5199b5a 100644 --- a/classes/class_skeletonprofile.rst +++ b/classes/class_skeletonprofile.rst @@ -127,6 +127,10 @@ Property Descriptions | *Getter* | get_bone_size() | +-----------+----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_SkeletonProfile_property_group_size: @@ -141,6 +145,10 @@ Property Descriptions | *Getter* | get_group_size() | +-----------+-----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_SkeletonProfile_property_root_bone: diff --git a/classes/class_skeletonprofilehumanoid.rst b/classes/class_skeletonprofilehumanoid.rst index 76486014e..96f9dd9c1 100644 --- a/classes/class_skeletonprofilehumanoid.rst +++ b/classes/class_skeletonprofilehumanoid.rst @@ -12,8 +12,6 @@ SkeletonProfileHumanoid **Inherits:** :ref:`SkeletonProfile` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` - - Description ----------- diff --git a/classes/class_skin.rst b/classes/class_skin.rst index 2e2e1608b..d1fc195a2 100644 --- a/classes/class_skin.rst +++ b/classes/class_skin.rst @@ -12,7 +12,9 @@ Skin **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -48,66 +50,110 @@ Method Descriptions - void **add_bind** **(** :ref:`int` bone, :ref:`Transform3D` pose **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skin_method_add_named_bind: - void **add_named_bind** **(** :ref:`String` name, :ref:`Transform3D` pose **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skin_method_clear_binds: - void **clear_binds** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skin_method_get_bind_bone: - :ref:`int` **get_bind_bone** **(** :ref:`int` bind_index **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skin_method_get_bind_count: - :ref:`int` **get_bind_count** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skin_method_get_bind_name: - :ref:`StringName` **get_bind_name** **(** :ref:`int` bind_index **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skin_method_get_bind_pose: - :ref:`Transform3D` **get_bind_pose** **(** :ref:`int` bind_index **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skin_method_set_bind_bone: - void **set_bind_bone** **(** :ref:`int` bind_index, :ref:`int` bone **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skin_method_set_bind_count: - void **set_bind_count** **(** :ref:`int` bind_count **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skin_method_set_bind_name: - void **set_bind_name** **(** :ref:`int` bind_index, :ref:`StringName` name **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Skin_method_set_bind_pose: - void **set_bind_pose** **(** :ref:`int` bind_index, :ref:`Transform3D` pose **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_skinreference.rst b/classes/class_skinreference.rst index 78013261f..a1629e512 100644 --- a/classes/class_skinreference.rst +++ b/classes/class_skinreference.rst @@ -12,7 +12,9 @@ SkinReference **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -30,12 +32,20 @@ Method Descriptions - :ref:`RID` **get_skeleton** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_SkinReference_method_get_skin: - :ref:`Skin` **get_skin** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_slider.rst b/classes/class_slider.rst index 75151a564..5fd9fa3c4 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -26,19 +26,19 @@ Base class for GUI sliders. Properties ---------- -+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editable` | ``true`` | -+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | -+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`scrollable` | ``true`` | -+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | size_flags_vertical | ``0`` (overrides :ref:`Control`) | -+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`tick_count` | ``0`` | -+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ticks_on_borders` | ``false`` | -+------------------------------------------+-----------------------------------------------------------------+------------------------------------------------------------------------------+ ++------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ +| :ref:`bool` | :ref:`editable` | ``true`` | ++------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ +| :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | ++------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ +| :ref:`bool` | :ref:`scrollable` | ``true`` | ++------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ +| :ref:`float` | step | ``1.0`` (overrides :ref:`Range`) | ++------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ +| :ref:`int` | :ref:`tick_count` | ``0`` | ++------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ +| :ref:`bool` | :ref:`ticks_on_borders` | ``false`` | ++------------------------------------------+-----------------------------------------------------------------+---------------------------------------------------------------------+ Signals ------- diff --git a/classes/class_sliderjoint3d.rst b/classes/class_sliderjoint3d.rst index d10738e57..8884ab091 100644 --- a/classes/class_sliderjoint3d.rst +++ b/classes/class_sliderjoint3d.rst @@ -542,12 +542,20 @@ Method Descriptions - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_SliderJoint3D_method_set_param: - void **set_param** **(** :ref:`Param` param, :ref:`float` value **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_softbody3d.rst b/classes/class_softbody3d.rst index 110067377..91df615af 100644 --- a/classes/class_softbody3d.rst +++ b/classes/class_softbody3d.rst @@ -148,6 +148,10 @@ The physics layers this SoftBody3D **scans**. Collision objects can scan one or | *Getter* | get_damping_coefficient() | +-----------+--------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_SoftBody3D_property_disable_mode: @@ -178,6 +182,10 @@ Defines the behavior in physics when :ref:`Node.process_mode`! + ---- .. _class_SoftBody3D_property_linear_stiffness: @@ -192,6 +200,10 @@ Defines the behavior in physics when :ref:`Node.process_mode`! + ---- .. _class_SoftBody3D_property_parent_collision_ignore: @@ -222,6 +234,10 @@ Defines the behavior in physics when :ref:`Node.process_mode`! + ---- .. _class_SoftBody3D_property_ray_pickable: @@ -309,6 +325,10 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_physics_rid** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_SoftBody3D_method_get_point_transform: diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index 92b651123..14c9fecec 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -53,21 +53,25 @@ See :ref:`Range` class for more options over the ``SpinBox``. Properties ---------- -+-------------------------------------------------------------------+------------------------------------------------------------------------------+-----------+ -| :ref:`HorizontalAlignment` | :ref:`alignment` | ``0`` | -+-------------------------------------------------------------------+------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`custom_arrow_step` | ``0.0`` | -+-------------------------------------------------------------------+------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`editable` | ``true`` | -+-------------------------------------------------------------------+------------------------------------------------------------------------------+-----------+ -| :ref:`String` | :ref:`prefix` | ``""`` | -+-------------------------------------------------------------------+------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`select_all_on_focus` | ``false`` | -+-------------------------------------------------------------------+------------------------------------------------------------------------------+-----------+ -| :ref:`String` | :ref:`suffix` | ``""`` | -+-------------------------------------------------------------------+------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`update_on_text_changed` | ``false`` | -+-------------------------------------------------------------------+------------------------------------------------------------------------------+-----------+ ++-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`HorizontalAlignment` | :ref:`alignment` | ``0`` | ++-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`custom_arrow_step` | ``0.0`` | ++-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`editable` | ``true`` | ++-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`prefix` | ``""`` | ++-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`select_all_on_focus` | ``false`` | ++-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | size_flags_vertical | ``1`` (overrides :ref:`Control`) | ++-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | step | ``1.0`` (overrides :ref:`Range`) | ++-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`suffix` | ``""`` | ++-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`update_on_text_changed` | ``false`` | ++-------------------------------------------------------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------------+ Methods ------- @@ -100,6 +104,10 @@ Property Descriptions | *Getter* | get_horizontal_alignment() | +-----------+---------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_SpinBox_property_custom_arrow_step: diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index 9250be4a7..164f253c1 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -118,6 +118,10 @@ The number of columns in the sprite sheet. | *Getter* | is_region_enabled() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_Sprite3D_property_region_rect: diff --git a/classes/class_streampeerextension.rst b/classes/class_streampeerextension.rst index 0280777b7..ba79c56ab 100644 --- a/classes/class_streampeerextension.rst +++ b/classes/class_streampeerextension.rst @@ -12,7 +12,9 @@ StreamPeerExtension **Inherits:** :ref:`StreamPeer` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -36,30 +38,50 @@ Method Descriptions - :ref:`int` **_get_available_bytes** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_StreamPeerExtension_method__get_data: - :ref:`Error` **_get_data** **(** uint8_t* r_buffer, :ref:`int` r_bytes, int32_t* r_received **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_StreamPeerExtension_method__get_partial_data: - :ref:`Error` **_get_partial_data** **(** uint8_t* r_buffer, :ref:`int` r_bytes, int32_t* r_received **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_StreamPeerExtension_method__put_data: - :ref:`Error` **_put_data** **(** const uint8_t* p_data, :ref:`int` p_bytes, int32_t* r_sent **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_StreamPeerExtension_method__put_partial_data: - :ref:`Error` **_put_partial_data** **(** const uint8_t* p_data, :ref:`int` p_bytes, int32_t* r_sent **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_streampeertls.rst b/classes/class_streampeertls.rst index b496ccf7b..0b107cadd 100644 --- a/classes/class_streampeertls.rst +++ b/classes/class_streampeertls.rst @@ -92,6 +92,10 @@ Property Descriptions | *Getter* | is_blocking_handshake_enabled() | +-----------+---------------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + Method Descriptions ------------------- diff --git a/classes/class_string.rst b/classes/class_string.rst index eae665b44..a05bce38a 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -348,7 +348,7 @@ Returns a copy of the string with special characters escaped using the C languag - :ref:`String` **c_unescape** **(** **)** |const| -Returns a copy of the string with escaped characters replaced by their meanings. Supported escape sequences are ``\'``, ``\"``, ``\?``, ``\\``, ``\a``, ``\b``, ``\f``, ``\n``, ``\r``, ``\t``, ``\v``. +Returns a copy of the string with escaped characters replaced by their meanings. Supported escape sequences are ``\'``, ``\"``, ``\\``, ``\a``, ``\b``, ``\f``, ``\n``, ``\r``, ``\t``, ``\v``. \ **Note:** Unlike the GDScript parser, this method doesn't support the ``\uXXXX`` escape sequence. @@ -919,6 +919,10 @@ Converts a signed :ref:`int` to a string representation of a number. - :ref:`String` **num_scientific** **(** :ref:`float` number **)** |static| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_String_method_num_uint64: @@ -1384,62 +1388,106 @@ Operator Descriptions - :ref:`bool` **operator !=** **(** :ref:`String` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- - :ref:`bool` **operator !=** **(** :ref:`StringName` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_String_operator_mod_String: - :ref:`String` **operator %** **(** :ref:`Variant` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_String_operator_sum_String: - :ref:`String` **operator +** **(** :ref:`String` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_String_operator_lt_bool: - :ref:`bool` **operator <** **(** :ref:`String` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_String_operator_lte_bool: - :ref:`bool` **operator <=** **(** :ref:`String` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_String_operator_eq_bool: - :ref:`bool` **operator ==** **(** :ref:`String` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- - :ref:`bool` **operator ==** **(** :ref:`StringName` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_String_operator_gt_bool: - :ref:`bool` **operator >** **(** :ref:`String` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_String_operator_gte_bool: - :ref:`bool` **operator >=** **(** :ref:`String` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_String_operator_idx_String: - :ref:`String` **operator []** **(** :ref:`int` index **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_stringname.rst b/classes/class_stringname.rst index 5c54500dd..44d285c79 100644 --- a/classes/class_stringname.rst +++ b/classes/class_stringname.rst @@ -97,44 +97,76 @@ Operator Descriptions - :ref:`bool` **operator !=** **(** :ref:`String` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- - :ref:`bool` **operator !=** **(** :ref:`StringName` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_StringName_operator_lt_bool: - :ref:`bool` **operator <** **(** :ref:`StringName` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_StringName_operator_lte_bool: - :ref:`bool` **operator <=** **(** :ref:`StringName` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_StringName_operator_eq_bool: - :ref:`bool` **operator ==** **(** :ref:`String` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- - :ref:`bool` **operator ==** **(** :ref:`StringName` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_StringName_operator_gt_bool: - :ref:`bool` **operator >** **(** :ref:`StringName` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + ---- .. _class_StringName_operator_gte_bool: - :ref:`bool` **operator >=** **(** :ref:`StringName` right **)** +.. container:: contribute + + There is currently no description for this operator. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index 16bfebf56..e6896c90a 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -155,30 +155,50 @@ Method Descriptions - void **_draw** **(** :ref:`RID` to_canvas_item, :ref:`Rect2` rect **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_StyleBox_method__get_center_size: - :ref:`Vector2` **_get_center_size** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_StyleBox_method__get_draw_rect: - :ref:`Rect2` **_get_draw_rect** **(** :ref:`Rect2` rect **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_StyleBox_method__get_style_margin: - :ref:`float` **_get_style_margin** **(** :ref:`Side` side **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_StyleBox_method__test_mask: - :ref:`bool` **_test_mask** **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_StyleBox_method_draw: diff --git a/classes/class_textserverdummy.rst b/classes/class_textserverdummy.rst index 5476cbabc..b2f5fcb39 100644 --- a/classes/class_textserverdummy.rst +++ b/classes/class_textserverdummy.rst @@ -12,7 +12,9 @@ TextServerDummy **Inherits:** :ref:`TextServerExtension` **<** :ref:`TextServer` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index 341b83d0e..6b1421d71 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -407,1122 +407,1870 @@ Method Descriptions - :ref:`RID` **_create_font** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__create_shaped_text: - :ref:`RID` **_create_shaped_text** **(** :ref:`Direction` direction, :ref:`Orientation` orientation **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__draw_hex_code_box: - void **_draw_hex_code_box** **(** :ref:`RID` canvas, :ref:`int` size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_clear_glyphs: - void **_font_clear_glyphs** **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_clear_kerning_map: - void **_font_clear_kerning_map** **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_clear_size_cache: - void **_font_clear_size_cache** **(** :ref:`RID` font_rid **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_clear_textures: - void **_font_clear_textures** **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_draw_glyph: - void **_font_draw_glyph** **(** :ref:`RID` font_rid, :ref:`RID` canvas, :ref:`int` size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_draw_glyph_outline: - void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RID` canvas, :ref:`int` size, :ref:`int` outline_size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_antialiasing: - :ref:`FontAntialiasing` **_font_get_antialiasing** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_ascent: - :ref:`float` **_font_get_ascent** **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_descent: - :ref:`float` **_font_get_descent** **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_embolden: - :ref:`float` **_font_get_embolden** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_face_count: - :ref:`int` **_font_get_face_count** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_face_index: - :ref:`int` **_font_get_face_index** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_fixed_size: - :ref:`int` **_font_get_fixed_size** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_generate_mipmaps: - :ref:`bool` **_font_get_generate_mipmaps** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_global_oversampling: - :ref:`float` **_font_get_global_oversampling** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_glyph_advance: - :ref:`Vector2` **_font_get_glyph_advance** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_glyph_contours: - :ref:`Dictionary` **_font_get_glyph_contours** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_glyph_index: - :ref:`int` **_font_get_glyph_index** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` char, :ref:`int` variation_selector **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_glyph_list: - :ref:`PackedInt32Array` **_font_get_glyph_list** **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_glyph_offset: - :ref:`Vector2` **_font_get_glyph_offset** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_glyph_size: - :ref:`Vector2` **_font_get_glyph_size** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_glyph_texture_idx: - :ref:`int` **_font_get_glyph_texture_idx** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_glyph_texture_rid: - :ref:`RID` **_font_get_glyph_texture_rid** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_glyph_texture_size: - :ref:`Vector2` **_font_get_glyph_texture_size** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_glyph_uv_rect: - :ref:`Rect2` **_font_get_glyph_uv_rect** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_hinting: - :ref:`Hinting` **_font_get_hinting** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_kerning: - :ref:`Vector2` **_font_get_kerning** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_kerning_list: - :ref:`Vector2i[]` **_font_get_kerning_list** **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_language_support_override: - :ref:`bool` **_font_get_language_support_override** **(** :ref:`RID` font_rid, :ref:`String` language **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_language_support_overrides: - :ref:`PackedStringArray` **_font_get_language_support_overrides** **(** :ref:`RID` font_rid **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_msdf_pixel_range: - :ref:`int` **_font_get_msdf_pixel_range** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_msdf_size: - :ref:`int` **_font_get_msdf_size** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_name: - :ref:`String` **_font_get_name** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_opentype_feature_overrides: - :ref:`Dictionary` **_font_get_opentype_feature_overrides** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_oversampling: - :ref:`float` **_font_get_oversampling** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_scale: - :ref:`float` **_font_get_scale** **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_script_support_override: - :ref:`bool` **_font_get_script_support_override** **(** :ref:`RID` font_rid, :ref:`String` script **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_script_support_overrides: - :ref:`PackedStringArray` **_font_get_script_support_overrides** **(** :ref:`RID` font_rid **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_size_cache_list: - :ref:`Vector2i[]` **_font_get_size_cache_list** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_style: - :ref:`FontStyle` **_font_get_style** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_style_name: - :ref:`String` **_font_get_style_name** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_subpixel_positioning: - :ref:`SubpixelPositioning` **_font_get_subpixel_positioning** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_supported_chars: - :ref:`String` **_font_get_supported_chars** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_texture_count: - :ref:`int` **_font_get_texture_count** **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_texture_image: - :ref:`Image` **_font_get_texture_image** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_texture_offsets: - :ref:`PackedInt32Array` **_font_get_texture_offsets** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_transform: - :ref:`Transform2D` **_font_get_transform** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_underline_position: - :ref:`float` **_font_get_underline_position** **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_underline_thickness: - :ref:`float` **_font_get_underline_thickness** **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_get_variation_coordinates: - :ref:`Dictionary` **_font_get_variation_coordinates** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_has_char: - :ref:`bool` **_font_has_char** **(** :ref:`RID` font_rid, :ref:`int` char **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_is_force_autohinter: - :ref:`bool` **_font_is_force_autohinter** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_is_language_supported: - :ref:`bool` **_font_is_language_supported** **(** :ref:`RID` font_rid, :ref:`String` language **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_is_multichannel_signed_distance_field: - :ref:`bool` **_font_is_multichannel_signed_distance_field** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_is_script_supported: - :ref:`bool` **_font_is_script_supported** **(** :ref:`RID` font_rid, :ref:`String` script **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_remove_glyph: - void **_font_remove_glyph** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_remove_kerning: - void **_font_remove_kerning** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_remove_language_support_override: - void **_font_remove_language_support_override** **(** :ref:`RID` font_rid, :ref:`String` language **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_remove_script_support_override: - void **_font_remove_script_support_override** **(** :ref:`RID` font_rid, :ref:`String` script **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_remove_size_cache: - void **_font_remove_size_cache** **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_remove_texture: - void **_font_remove_texture** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_render_glyph: - void **_font_render_glyph** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` index **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_render_range: - void **_font_render_range** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` start, :ref:`int` end **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_antialiasing: - void **_font_set_antialiasing** **(** :ref:`RID` font_rid, :ref:`FontAntialiasing` antialiasing **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_ascent: - void **_font_set_ascent** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` ascent **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_data: - void **_font_set_data** **(** :ref:`RID` font_rid, :ref:`PackedByteArray` data **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_data_ptr: - void **_font_set_data_ptr** **(** :ref:`RID` font_rid, const uint8_t* data_ptr, :ref:`int` data_size **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_descent: - void **_font_set_descent** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` descent **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_embolden: - void **_font_set_embolden** **(** :ref:`RID` font_rid, :ref:`float` strength **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_face_index: - void **_font_set_face_index** **(** :ref:`RID` font_rid, :ref:`int` face_index **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_fixed_size: - void **_font_set_fixed_size** **(** :ref:`RID` font_rid, :ref:`int` fixed_size **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_force_autohinter: - void **_font_set_force_autohinter** **(** :ref:`RID` font_rid, :ref:`bool` force_autohinter **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_generate_mipmaps: - void **_font_set_generate_mipmaps** **(** :ref:`RID` font_rid, :ref:`bool` generate_mipmaps **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_global_oversampling: - void **_font_set_global_oversampling** **(** :ref:`float` oversampling **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_glyph_advance: - void **_font_set_glyph_advance** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph, :ref:`Vector2` advance **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_glyph_offset: - void **_font_set_glyph_offset** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` offset **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_glyph_size: - void **_font_set_glyph_size** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` gl_size **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_glyph_texture_idx: - void **_font_set_glyph_texture_idx** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`int` texture_idx **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_glyph_uv_rect: - void **_font_set_glyph_uv_rect** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Rect2` uv_rect **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_hinting: - void **_font_set_hinting** **(** :ref:`RID` font_rid, :ref:`Hinting` hinting **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_kerning: - void **_font_set_kerning** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair, :ref:`Vector2` kerning **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_language_support_override: - void **_font_set_language_support_override** **(** :ref:`RID` font_rid, :ref:`String` language, :ref:`bool` supported **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_msdf_pixel_range: - void **_font_set_msdf_pixel_range** **(** :ref:`RID` font_rid, :ref:`int` msdf_pixel_range **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_msdf_size: - void **_font_set_msdf_size** **(** :ref:`RID` font_rid, :ref:`int` msdf_size **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_multichannel_signed_distance_field: - void **_font_set_multichannel_signed_distance_field** **(** :ref:`RID` font_rid, :ref:`bool` msdf **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_name: - void **_font_set_name** **(** :ref:`RID` font_rid, :ref:`String` name **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_opentype_feature_overrides: - void **_font_set_opentype_feature_overrides** **(** :ref:`RID` font_rid, :ref:`Dictionary` overrides **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_oversampling: - void **_font_set_oversampling** **(** :ref:`RID` font_rid, :ref:`float` oversampling **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_scale: - void **_font_set_scale** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` scale **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_script_support_override: - void **_font_set_script_support_override** **(** :ref:`RID` font_rid, :ref:`String` script, :ref:`bool` supported **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_style: - void **_font_set_style** **(** :ref:`RID` font_rid, :ref:`FontStyle` style **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_style_name: - void **_font_set_style_name** **(** :ref:`RID` font_rid, :ref:`String` name_style **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_subpixel_positioning: - void **_font_set_subpixel_positioning** **(** :ref:`RID` font_rid, :ref:`SubpixelPositioning` subpixel_positioning **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_texture_image: - void **_font_set_texture_image** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`Image` image **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_texture_offsets: - void **_font_set_texture_offsets** **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`PackedInt32Array` offset **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_transform: - void **_font_set_transform** **(** :ref:`RID` font_rid, :ref:`Transform2D` transform **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_underline_position: - void **_font_set_underline_position** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` underline_position **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_underline_thickness: - void **_font_set_underline_thickness** **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` underline_thickness **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_set_variation_coordinates: - void **_font_set_variation_coordinates** **(** :ref:`RID` font_rid, :ref:`Dictionary` variation_coordinates **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_supported_feature_list: - :ref:`Dictionary` **_font_supported_feature_list** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__font_supported_variation_list: - :ref:`Dictionary` **_font_supported_variation_list** **(** :ref:`RID` font_rid **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__format_number: - :ref:`String` **_format_number** **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__free_rid: - void **_free_rid** **(** :ref:`RID` rid **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__get_features: - :ref:`int` **_get_features** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__get_hex_code_box_size: - :ref:`Vector2` **_get_hex_code_box_size** **(** :ref:`int` size, :ref:`int` index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__get_name: - :ref:`String` **_get_name** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__get_support_data_filename: - :ref:`String` **_get_support_data_filename** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__get_support_data_info: - :ref:`String` **_get_support_data_info** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__has: - :ref:`bool` **_has** **(** :ref:`RID` rid **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__has_feature: - :ref:`bool` **_has_feature** **(** :ref:`Feature` feature **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__is_confusable: - :ref:`int` **_is_confusable** **(** :ref:`String` string, :ref:`PackedStringArray` dict **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__is_locale_right_to_left: - :ref:`bool` **_is_locale_right_to_left** **(** :ref:`String` locale **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__is_valid_identifier: - :ref:`bool` **_is_valid_identifier** **(** :ref:`String` string **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__load_support_data: - :ref:`bool` **_load_support_data** **(** :ref:`String` filename **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__name_to_tag: - :ref:`int` **_name_to_tag** **(** :ref:`String` name **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__parse_number: - :ref:`String` **_parse_number** **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__parse_structured_text: - :ref:`Vector2i[]` **_parse_structured_text** **(** :ref:`StructuredTextParser` parser_type, :ref:`Array` args, :ref:`String` text **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__percent_sign: - :ref:`String` **_percent_sign** **(** :ref:`String` language **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__save_support_data: - :ref:`bool` **_save_support_data** **(** :ref:`String` filename **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_get_span_count: - :ref:`int` **_shaped_get_span_count** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_get_span_meta: - :ref:`Variant` **_shaped_get_span_meta** **(** :ref:`RID` shaped, :ref:`int` index **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_set_span_update_font: - void **_shaped_set_span_update_font** **(** :ref:`RID` shaped, :ref:`int` index, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_add_object: - :ref:`bool` **_shaped_text_add_object** **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align, :ref:`int` length **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_add_string: - :ref:`bool` **_shaped_text_add_string** **(** :ref:`RID` shaped, :ref:`String` text, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features, :ref:`String` language, :ref:`Variant` meta **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_clear: - void **_shaped_text_clear** **(** :ref:`RID` shaped **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_draw: - void **_shaped_text_draw** **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l, :ref:`float` clip_r, :ref:`Color` color **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_draw_outline: - void **_shaped_text_draw_outline** **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l, :ref:`float` clip_r, :ref:`int` outline_size, :ref:`Color` color **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_fit_to_width: - :ref:`float` **_shaped_text_fit_to_width** **(** :ref:`RID` shaped, :ref:`float` width, :ref:`JustificationFlag` jst_flags **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_ascent: - :ref:`float` **_shaped_text_get_ascent** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_carets: - void **_shaped_text_get_carets** **(** :ref:`RID` shaped, :ref:`int` position, CaretInfo* caret **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_custom_punctuation: - :ref:`String` **_shaped_text_get_custom_punctuation** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_descent: - :ref:`float` **_shaped_text_get_descent** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_direction: - :ref:`Direction` **_shaped_text_get_direction** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_dominant_direction_in_range: - :ref:`int` **_shaped_text_get_dominant_direction_in_range** **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` end **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_ellipsis_glyph_count: - :ref:`int` **_shaped_text_get_ellipsis_glyph_count** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_ellipsis_glyphs: - const Glyph* **_shaped_text_get_ellipsis_glyphs** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_ellipsis_pos: - :ref:`int` **_shaped_text_get_ellipsis_pos** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_glyph_count: - :ref:`int` **_shaped_text_get_glyph_count** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_glyphs: - const Glyph* **_shaped_text_get_glyphs** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_grapheme_bounds: - :ref:`Vector2` **_shaped_text_get_grapheme_bounds** **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_inferred_direction: - :ref:`Direction` **_shaped_text_get_inferred_direction** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_line_breaks: - :ref:`PackedInt32Array` **_shaped_text_get_line_breaks** **(** :ref:`RID` shaped, :ref:`float` width, :ref:`int` start, :ref:`LineBreakFlag` break_flags **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_line_breaks_adv: - :ref:`PackedInt32Array` **_shaped_text_get_line_breaks_adv** **(** :ref:`RID` shaped, :ref:`PackedFloat32Array` width, :ref:`int` start, :ref:`bool` once, :ref:`LineBreakFlag` break_flags **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_object_rect: - :ref:`Rect2` **_shaped_text_get_object_rect** **(** :ref:`RID` shaped, :ref:`Variant` key **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_objects: - :ref:`Array` **_shaped_text_get_objects** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_orientation: - :ref:`Orientation` **_shaped_text_get_orientation** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_parent: - :ref:`RID` **_shaped_text_get_parent** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_preserve_control: - :ref:`bool` **_shaped_text_get_preserve_control** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_preserve_invalid: - :ref:`bool` **_shaped_text_get_preserve_invalid** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_range: - :ref:`Vector2i` **_shaped_text_get_range** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_selection: - :ref:`PackedVector2Array` **_shaped_text_get_selection** **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` end **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_size: - :ref:`Vector2` **_shaped_text_get_size** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_spacing: - :ref:`int` **_shaped_text_get_spacing** **(** :ref:`RID` shaped, :ref:`SpacingType` spacing **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_trim_pos: - :ref:`int` **_shaped_text_get_trim_pos** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_underline_position: - :ref:`float` **_shaped_text_get_underline_position** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_underline_thickness: - :ref:`float` **_shaped_text_get_underline_thickness** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_width: - :ref:`float` **_shaped_text_get_width** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_get_word_breaks: - :ref:`PackedInt32Array` **_shaped_text_get_word_breaks** **(** :ref:`RID` shaped, :ref:`GraphemeFlag` grapheme_flags **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_hit_test_grapheme: - :ref:`int` **_shaped_text_hit_test_grapheme** **(** :ref:`RID` shaped, :ref:`float` coord **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_hit_test_position: - :ref:`int` **_shaped_text_hit_test_position** **(** :ref:`RID` shaped, :ref:`float` coord **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_is_ready: - :ref:`bool` **_shaped_text_is_ready** **(** :ref:`RID` shaped **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_next_grapheme_pos: - :ref:`int` **_shaped_text_next_grapheme_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_overrun_trim_to_width: - void **_shaped_text_overrun_trim_to_width** **(** :ref:`RID` shaped, :ref:`float` width, :ref:`TextOverrunFlag` trim_flags **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_prev_grapheme_pos: - :ref:`int` **_shaped_text_prev_grapheme_pos** **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_resize_object: - :ref:`bool` **_shaped_text_resize_object** **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_set_bidi_override: - void **_shaped_text_set_bidi_override** **(** :ref:`RID` shaped, :ref:`Array` override **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_set_custom_punctuation: - void **_shaped_text_set_custom_punctuation** **(** :ref:`RID` shaped, :ref:`String` punct **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_set_direction: - void **_shaped_text_set_direction** **(** :ref:`RID` shaped, :ref:`Direction` direction **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_set_orientation: - void **_shaped_text_set_orientation** **(** :ref:`RID` shaped, :ref:`Orientation` orientation **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_set_preserve_control: - void **_shaped_text_set_preserve_control** **(** :ref:`RID` shaped, :ref:`bool` enabled **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_set_preserve_invalid: - void **_shaped_text_set_preserve_invalid** **(** :ref:`RID` shaped, :ref:`bool` enabled **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_set_spacing: - void **_shaped_text_set_spacing** **(** :ref:`RID` shaped, :ref:`SpacingType` spacing, :ref:`int` value **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_shape: - :ref:`bool` **_shaped_text_shape** **(** :ref:`RID` shaped **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_sort_logical: - const Glyph* **_shaped_text_sort_logical** **(** :ref:`RID` shaped **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_substr: - :ref:`RID` **_shaped_text_substr** **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` length **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_tab_align: - :ref:`float` **_shaped_text_tab_align** **(** :ref:`RID` shaped, :ref:`PackedFloat32Array` tab_stops **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_update_breaks: - :ref:`bool` **_shaped_text_update_breaks** **(** :ref:`RID` shaped **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__shaped_text_update_justification_ops: - :ref:`bool` **_shaped_text_update_justification_ops** **(** :ref:`RID` shaped **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__spoof_check: - :ref:`bool` **_spoof_check** **(** :ref:`String` string **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__string_get_word_breaks: - :ref:`PackedInt32Array` **_string_get_word_breaks** **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__string_to_lower: - :ref:`String` **_string_to_lower** **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__string_to_upper: - :ref:`String` **_string_to_upper** **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__strip_diacritics: - :ref:`String` **_strip_diacritics** **(** :ref:`String` string **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextServerExtension_method__tag_to_name: - :ref:`String` **_tag_to_name** **(** :ref:`int` tag **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 76b16d06a..23e51a139 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -14,7 +14,12 @@ Texture **Inherited By:** :ref:`Texture2D`, :ref:`Texture3D`, :ref:`TextureLayered` +Base class for all texture types. +Description +----------- + +``Texture`` is the base class for all texture types. Common texture types are :ref:`Texture2D` and :ref:`ImageTexture`. See also :ref:`Image`. .. |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.)` diff --git a/classes/class_texture2d.rst b/classes/class_texture2d.rst index 787211511..ace8cf1c2 100644 --- a/classes/class_texture2d.rst +++ b/classes/class_texture2d.rst @@ -69,42 +69,62 @@ Method Descriptions - void **_draw** **(** :ref:`RID` to_canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate, :ref:`bool` transpose **)** |virtual| |const| +Called when the entire ``Texture2D`` is requested to be drawn over a :ref:`CanvasItem`, with the top-left offset specified in ``pos``. ``modulate`` specifies a multiplier for the colors being drawn, while ``transpose`` specifies whether drawing should be performed in column-major order instead of row-major order (resulting in 90-degree clockwise rotation). + +\ **Note:** This is only used in 2D rendering, not 3D. + ---- .. _class_Texture2D_method__draw_rect: - void **_draw_rect** **(** :ref:`RID` to_canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate, :ref:`bool` transpose **)** |virtual| |const| +Called when the ``Texture2D`` is requested to be drawn onto :ref:`CanvasItem`'s specified ``rect``. ``modulate`` specifies a multiplier for the colors being drawn, while ``transpose`` specifies whether drawing should be performed in column-major order instead of row-major order (resulting in 90-degree clockwise rotation). + +\ **Note:** This is only used in 2D rendering, not 3D. + ---- .. _class_Texture2D_method__draw_rect_region: - void **_draw_rect_region** **(** :ref:`RID` to_canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate, :ref:`bool` transpose, :ref:`bool` clip_uv **)** |virtual| |const| +Called when a part of the ``Texture2D`` specified by ``src_rect``'s coordinates is requested to be drawn onto :ref:`CanvasItem`'s specified ``rect``. ``modulate`` specifies a multiplier for the colors being drawn, while ``transpose`` specifies whether drawing should be performed in column-major order instead of row-major order (resulting in 90-degree clockwise rotation). + +\ **Note:** This is only used in 2D rendering, not 3D. + ---- .. _class_Texture2D_method__get_height: - :ref:`int` **_get_height** **(** **)** |virtual| |const| +Called when the ``Texture2D``'s height is queried. + ---- .. _class_Texture2D_method__get_width: - :ref:`int` **_get_width** **(** **)** |virtual| |const| +Called when the ``Texture2D``'s width is queried. + ---- .. _class_Texture2D_method__has_alpha: - :ref:`bool` **_has_alpha** **(** **)** |virtual| |const| +Called when the presence of an alpha channel in the ``Texture2D`` is queried. + ---- .. _class_Texture2D_method__is_pixel_opaque: - :ref:`bool` **_is_pixel_opaque** **(** :ref:`int` x, :ref:`int` y **)** |virtual| |const| +Called when a pixel's opaque state in the ``Texture2D`` is queried at the specified ``(x, y)`` position. + ---- .. _class_Texture2D_method_draw: @@ -135,7 +155,7 @@ Draws a part of the texture using a :ref:`CanvasItem` with the - :ref:`int` **get_height** **(** **)** |const| -Returns the texture height. +Returns the texture height in pixels. ---- @@ -153,7 +173,7 @@ Returns an :ref:`Image` that is a copy of data from this ``Texture2 - :ref:`Vector2` **get_size** **(** **)** |const| -Returns the texture size. +Returns the texture size in pixels. ---- @@ -161,7 +181,7 @@ Returns the texture size. - :ref:`int` **get_width** **(** **)** |const| -Returns the texture width. +Returns the texture width in pixels. ---- diff --git a/classes/class_texture2darray.rst b/classes/class_texture2darray.rst index 531c7ae66..fe56ca570 100644 --- a/classes/class_texture2darray.rst +++ b/classes/class_texture2darray.rst @@ -17,10 +17,12 @@ A single texture resource which consists of multiple, separate images. Each imag Description ----------- -A Texture2DArray is different from a Texture3D: The Texture2DArray does not support trilinear interpolation between the :ref:`Image`\ s, i.e. no blending. +A Texture2DArray is different from a Texture3D: The Texture2DArray does not support trilinear interpolation between the :ref:`Image`\ s, i.e. no blending. See also :ref:`Cubemap` and :ref:`CubemapArray`, which are texture arrays with specialized cubemap functions. A Texture2DArray is also different from an :ref:`AtlasTexture`: In a Texture2DArray, all images are treated separately. In an atlas, the regions (i.e. the single images) can be of different sizes. Furthermore, you usually need to add a padding around the regions, to prevent accidental UV mapping to more than one region. The same goes for mipmapping: Mipmap chains are handled separately for each layer. In an atlas, the slicing has to be done manually in the fragment shader. +To create such a texture file yourself, reimport your image files using the Godot Editor import presets. + .. |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.)` diff --git a/classes/class_texture3d.rst b/classes/class_texture3d.rst index 638bd7237..788f3f69e 100644 --- a/classes/class_texture3d.rst +++ b/classes/class_texture3d.rst @@ -14,7 +14,16 @@ Texture3D **Inherited By:** :ref:`CompressedTexture3D`, :ref:`ImageTexture3D`, :ref:`PlaceholderTexture3D` +Base class for 3-dimensionnal textures. +Description +----------- + +Base class for :ref:`ImageTexture3D` and :ref:`CompressedTexture3D`. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. ``Texture3D`` is the base class for all 3-dimensional texture types. See also :ref:`TextureLayered`. + +All images need to have the same width, height and number of mipmap levels. + +To create such a texture file yourself, reimport your image files using the Godot Editor import presets. Methods ------- @@ -52,72 +61,96 @@ Method Descriptions - :ref:`Image[]` **_get_data** **(** **)** |virtual| |const| +Called when the ``Texture3D``'s data is queried. + ---- .. _class_Texture3D_method__get_depth: - :ref:`int` **_get_depth** **(** **)** |virtual| |const| +Called when the ``Texture3D``'s depth is queried. + ---- .. _class_Texture3D_method__get_format: - :ref:`Format` **_get_format** **(** **)** |virtual| |const| +Called when the ``Texture3D``'s format is queried. + ---- .. _class_Texture3D_method__get_height: - :ref:`int` **_get_height** **(** **)** |virtual| |const| +Called when the ``Texture3D``'s height is queried. + ---- .. _class_Texture3D_method__get_width: - :ref:`int` **_get_width** **(** **)** |virtual| |const| +Called when the ``Texture3D``'s width is queried. + ---- .. _class_Texture3D_method__has_mipmaps: - :ref:`bool` **_has_mipmaps** **(** **)** |virtual| |const| +Called when the presence of mipmaps in the ``Texture3D`` is queried. + ---- .. _class_Texture3D_method_get_data: - :ref:`Image[]` **get_data** **(** **)** |const| +Returns the ``Texture3D``'s data as an array of :ref:`Image`\ s. Each :ref:`Image` represents a *slice* of the ``Texture3D``, with different slices mapping to different depth (Z axis) levels. + ---- .. _class_Texture3D_method_get_depth: - :ref:`int` **get_depth** **(** **)** |const| +Returns the ``Texture3D``'s depth in pixels. Depth is typically represented by the Z axis (a dimension not present in :ref:`Texture2D`). + ---- .. _class_Texture3D_method_get_format: - :ref:`Format` **get_format** **(** **)** |const| +Returns the current format being used by this texture. See :ref:`Format` for details. + ---- .. _class_Texture3D_method_get_height: - :ref:`int` **get_height** **(** **)** |const| +Returns the ``Texture3D``'s height in pixels. Width is typically represented by the Y axis. + ---- .. _class_Texture3D_method_get_width: - :ref:`int` **get_width** **(** **)** |const| +Returns the ``Texture3D``'s width in pixels. Width is typically represented by the X axis. + ---- .. _class_Texture3D_method_has_mipmaps: - :ref:`bool` **has_mipmaps** **(** **)** |const| +Returns ``true`` if the ``Texture3D`` has generated mipmaps. + .. |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.)` diff --git a/classes/class_texturelayered.rst b/classes/class_texturelayered.rst index 3c9719de5..2de43d355 100644 --- a/classes/class_texturelayered.rst +++ b/classes/class_texturelayered.rst @@ -19,17 +19,15 @@ Base class for texture types which contain the data of multiple :ref:`Image`, :ref:`Cubemap` and :ref:`CubemapArray`. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. +Base class for :ref:`ImageTextureLayered`. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. See also :ref:`Texture3D`. Data is set on a per-layer basis. For :ref:`Texture2DArray`\ s, the layer specifies the array layer. All images need to have the same width, height and number of mipmap levels. -A ``TextureLayered`` can be loaded with ``method ResourceFormatLoader.load``. +A ``TextureLayered`` can be loaded with :ref:`ResourceLoader.load`. -To create such a texture file yourself, re-import your image files using the Godot Editor import presets. - -Internally, Godot maps these files to their respective counterparts in the target rendering driver (GLES3, Vulkan). +Internally, Godot maps these files to their respective counterparts in the target rendering driver (Vulkan, GLES3). Methods ------- @@ -77,11 +75,11 @@ Enumerations enum **LayeredType**: -- **LAYERED_TYPE_2D_ARRAY** = **0** +- **LAYERED_TYPE_2D_ARRAY** = **0** --- Texture is a generic :ref:`Texture2DArray`. -- **LAYERED_TYPE_CUBEMAP** = **1** +- **LAYERED_TYPE_CUBEMAP** = **1** --- Texture is a :ref:`Cubemap`, with each side in its own layer (6 in total). -- **LAYERED_TYPE_CUBEMAP_ARRAY** = **2** +- **LAYERED_TYPE_CUBEMAP_ARRAY** = **2** --- Texture is a :ref:`CubemapArray`, with each cubemap being made of 6 layers. Method Descriptions ------------------- @@ -90,42 +88,56 @@ Method Descriptions - :ref:`Format` **_get_format** **(** **)** |virtual| |const| +Called when the ``TextureLayered``'s format is queried. + ---- .. _class_TextureLayered_method__get_height: - :ref:`int` **_get_height** **(** **)** |virtual| |const| +Called when the the ``TextureLayered``'s height is queried. + ---- .. _class_TextureLayered_method__get_layer_data: - :ref:`Image` **_get_layer_data** **(** :ref:`int` layer_index **)** |virtual| |const| +Called when the data for a layer in the ``TextureLayered`` is queried. + ---- .. _class_TextureLayered_method__get_layered_type: - :ref:`int` **_get_layered_type** **(** **)** |virtual| |const| +Called when the layers' type in the ``TextureLayered`` is queried. + ---- .. _class_TextureLayered_method__get_layers: - :ref:`int` **_get_layers** **(** **)** |virtual| |const| +Called when the number of layers in the ``TextureLayered`` is queried. + ---- .. _class_TextureLayered_method__get_width: - :ref:`int` **_get_width** **(** **)** |virtual| |const| +Called when the ``TextureLayered``'s width queried. + ---- .. _class_TextureLayered_method__has_mipmaps: - :ref:`bool` **_has_mipmaps** **(** **)** |virtual| |const| +Called when the presence of mipmaps in the ``TextureLayered`` is queried. + ---- .. _class_TextureLayered_method_get_format: @@ -140,7 +152,7 @@ Returns the current format being used by this texture. See :ref:`Format` **get_height** **(** **)** |const| -Returns the height of the texture. Height is typically represented by the Y-axis. +Returns the height of the texture in pixels. Height is typically represented by the Y axis. ---- @@ -156,6 +168,8 @@ Returns an :ref:`Image` resource with the data from specified ``lay - :ref:`LayeredType` **get_layered_type** **(** **)** |const| +Returns the ``TextureLayered``'s type. The type determines how the data is accessed, with cubemaps having special types. + ---- .. _class_TextureLayered_method_get_layers: @@ -170,7 +184,7 @@ Returns the number of referenced :ref:`Image`\ s. - :ref:`int` **get_width** **(** **)** |const| -Returns the width of the texture. Width is typically represented by the X-axis. +Returns the width of the texture in pixels. Width is typically represented by the X axis. ---- diff --git a/classes/class_textureprogressbar.rst b/classes/class_textureprogressbar.rst index ed27f8e0d..fa0fd0064 100644 --- a/classes/class_textureprogressbar.rst +++ b/classes/class_textureprogressbar.rst @@ -22,41 +22,45 @@ TextureProgressBar works like :ref:`ProgressBar`, but uses up Properties ---------- -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`fill_mode` | ``0`` | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`MouseFilter` | mouse_filter | ``1`` (overrides :ref:`Control`) | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`nine_patch_stretch` | ``false`` | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`radial_center_offset` | ``Vector2(0, 0)`` | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_fill_degrees` | ``360.0`` | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`float` | :ref:`radial_initial_angle` | ``0.0`` | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`stretch_margin_bottom` | ``0`` | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`stretch_margin_left` | ``0`` | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`stretch_margin_right` | ``0`` | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`int` | :ref:`stretch_margin_top` | ``0`` | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Texture2D` | :ref:`texture_over` | | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Texture2D` | :ref:`texture_progress` | | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`texture_progress_offset` | ``Vector2(0, 0)`` | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Texture2D` | :ref:`texture_under` | | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Color` | :ref:`tint_over` | ``Color(1, 1, 1, 1)`` | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Color` | :ref:`tint_progress` | ``Color(1, 1, 1, 1)`` | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Color` | :ref:`tint_under` | ``Color(1, 1, 1, 1)`` | -+----------------------------------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`fill_mode` | ``0`` | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`MouseFilter` | mouse_filter | ``1`` (overrides :ref:`Control`) | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`nine_patch_stretch` | ``false`` | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`radial_center_offset` | ``Vector2(0, 0)`` | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`radial_fill_degrees` | ``360.0`` | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`radial_initial_angle` | ``0.0`` | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | size_flags_vertical | ``1`` (overrides :ref:`Control`) | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`float` | step | ``1.0`` (overrides :ref:`Range`) | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`stretch_margin_bottom` | ``0`` | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`stretch_margin_left` | ``0`` | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`stretch_margin_right` | ``0`` | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`stretch_margin_top` | ``0`` | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`texture_over` | | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`texture_progress` | | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`texture_progress_offset` | ``Vector2(0, 0)`` | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`texture_under` | | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`tint_over` | ``Color(1, 1, 1, 1)`` | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`tint_progress` | ``Color(1, 1, 1, 1)`` | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`tint_under` | ``Color(1, 1, 1, 1)`` | ++----------------------------------------------+-------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ Methods ------- @@ -372,12 +376,20 @@ Method Descriptions - :ref:`int` **get_stretch_margin** **(** :ref:`Side` margin **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TextureProgressBar_method_set_stretch_margin: - void **set_stretch_margin** **(** :ref:`Side` margin, :ref:`int` value **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_tiledata.rst b/classes/class_tiledata.rst index e1ba8c3cd..902de4e09 100644 --- a/classes/class_tiledata.rst +++ b/classes/class_tiledata.rst @@ -12,7 +12,9 @@ TileData **Inherits:** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -116,6 +118,10 @@ Property Descriptions | *Getter* | get_flip_h() | +-----------+-------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_TileData_property_flip_v: @@ -130,6 +136,10 @@ Property Descriptions | *Getter* | get_flip_v() | +-----------+-------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_TileData_property_material: @@ -158,6 +168,10 @@ The :ref:`Material` to use for this ``TileData``. This can be a | *Getter* | get_modulate() | +-----------+-----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_TileData_property_probability: @@ -172,6 +186,10 @@ The :ref:`Material` to use for this ``TileData``. This can be a | *Getter* | get_probability() | +-----------+------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_TileData_property_terrain: @@ -186,6 +204,10 @@ The :ref:`Material` to use for this ``TileData``. This can be a | *Getter* | get_terrain() | +-----------+--------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_TileData_property_terrain_set: @@ -200,6 +222,10 @@ The :ref:`Material` to use for this ``TileData``. This can be a | *Getter* | get_terrain_set() | +-----------+------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_TileData_property_texture_offset: @@ -214,6 +240,10 @@ The :ref:`Material` to use for this ``TileData``. This can be a | *Getter* | get_texture_offset() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_TileData_property_transpose: @@ -228,6 +258,10 @@ The :ref:`Material` to use for this ``TileData``. This can be a | *Getter* | get_transpose() | +-----------+----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_TileData_property_y_sort_origin: @@ -242,6 +276,10 @@ The :ref:`Material` to use for this ``TileData``. This can be a | *Getter* | get_y_sort_origin() | +-----------+--------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_TileData_property_z_index: @@ -256,6 +294,10 @@ The :ref:`Material` to use for this ``TileData``. This can be a | *Getter* | get_z_index() | +-----------+--------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + Method Descriptions ------------------- diff --git a/classes/class_transform3d.rst b/classes/class_transform3d.rst index 28ac71ca7..735297773 100644 --- a/classes/class_transform3d.rst +++ b/classes/class_transform3d.rst @@ -181,6 +181,10 @@ Constructs a Transform3D from a :ref:`Basis` and :ref:`Vector3` **Transform3D** **(** :ref:`Projection` from **)** +.. container:: contribute + + There is currently no description for this constructor. Please help us by :ref:`contributing one `! + ---- - :ref:`Transform3D` **Transform3D** **(** :ref:`Vector3` x_axis, :ref:`Vector3` y_axis, :ref:`Vector3` z_axis, :ref:`Vector3` origin **)** diff --git a/classes/class_translation.rst b/classes/class_translation.rst index 71e1bff92..834e07fb5 100644 --- a/classes/class_translation.rst +++ b/classes/class_translation.rst @@ -57,6 +57,8 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`get_plural_message` **(** :ref:`StringName` src_message, :ref:`StringName` src_plural_message, :ref:`int` n, :ref:`StringName` context="" **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`get_translated_message_list` **(** **)** |const| | ++---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -154,6 +156,14 @@ Returns a message's translation involving plurals. The number ``n`` is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language. +---- + +.. _class_Translation_method_get_translated_message_list: + +- :ref:`PackedStringArray` **get_translated_message_list** **(** **)** |const| + +Returns all the messages (translated text). + .. |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.)` diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 0290e7ac5..2bc7c5984 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -155,6 +155,8 @@ Methods +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_column_title_language` **(** :ref:`int` column, :ref:`String` language **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selected` **(** :ref:`TreeItem` item, :ref:`int` column **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Theme Properties ---------------- @@ -675,6 +677,10 @@ Returns the column index at ``position``, or -1 if no item is there. - :ref:`int` **get_column_expand_ratio** **(** :ref:`int` column **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Tree_method_get_column_title: @@ -848,12 +854,20 @@ To tell whether a column of an item is selected, use :ref:`TreeItem.is_selected< - :ref:`bool` **is_column_clipping_content** **(** :ref:`int` column **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Tree_method_is_column_expanding: - :ref:`bool` **is_column_expanding** **(** :ref:`int` column **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Tree_method_scroll_to_item: @@ -868,6 +882,10 @@ Causes the ``Tree`` to jump to the specified :ref:`TreeItem`. - void **set_column_clip_content** **(** :ref:`int` column, :ref:`bool` enable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Tree_method_set_column_custom_minimum_width: @@ -890,6 +908,10 @@ If ``true``, the column will have the "Expand" flag of :ref:`Control` column, :ref:`int` ratio **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Tree_method_set_column_title: @@ -914,6 +936,14 @@ Sets column title base writing direction. Sets language code of column title used for line-breaking and text shaping algorithms, if left empty current locale is used instead. +---- + +.. _class_Tree_method_set_selected: + +- void **set_selected** **(** :ref:`TreeItem` item, :ref:`int` column **)** + +Selects the specified :ref:`TreeItem` and column. + Theme Property Descriptions --------------------------- diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index d30ae6e69..b5de6e445 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -606,12 +606,20 @@ Returns a dictionary containing the range parameters for a given column. The key - :ref:`StructuredTextParser` **get_structured_text_bidi_override** **(** :ref:`int` column **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TreeItem_method_get_structured_text_bidi_override_options: - :ref:`Array` **get_structured_text_bidi_override_options** **(** :ref:`int` column **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TreeItem_method_get_suffix: @@ -692,6 +700,10 @@ Returns ``true`` if the given ``column`` is checked. - :ref:`bool` **is_custom_set_as_button** **(** :ref:`int` column **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TreeItem_method_is_editable: @@ -822,6 +834,10 @@ Collapses or uncollapses this ``TreeItem`` and all the descendants of this item. - void **set_custom_as_button** **(** :ref:`int` column, :ref:`bool` enable **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TreeItem_method_set_custom_bg_color: @@ -970,12 +986,20 @@ If ``true``, the given column is selectable. - void **set_structured_text_bidi_override** **(** :ref:`int` column, :ref:`StructuredTextParser` parser **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TreeItem_method_set_structured_text_bidi_override_options: - void **set_structured_text_bidi_override_options** **(** :ref:`int` column, :ref:`Array` args **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_TreeItem_method_set_suffix: @@ -1022,6 +1046,10 @@ Sets the given column's tooltip text. - void **uncollapse_tree** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_tubetrailmesh.rst b/classes/class_tubetrailmesh.rst index 61b58d664..a18d69145 100644 --- a/classes/class_tubetrailmesh.rst +++ b/classes/class_tubetrailmesh.rst @@ -12,7 +12,9 @@ TubeTrailMesh **Inherits:** :ref:`PrimitiveMesh` **<** :ref:`Mesh` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -44,6 +46,10 @@ Property Descriptions | *Getter* | get_curve() | +----------+------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_TubeTrailMesh_property_radial_steps: @@ -58,6 +64,10 @@ Property Descriptions | *Getter* | get_radial_steps() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_TubeTrailMesh_property_radius: @@ -72,6 +82,10 @@ Property Descriptions | *Getter* | get_radius() | +-----------+-------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_TubeTrailMesh_property_section_length: @@ -86,6 +100,10 @@ Property Descriptions | *Getter* | get_section_length() | +-----------+---------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_TubeTrailMesh_property_section_rings: @@ -100,6 +118,10 @@ Property Descriptions | *Getter* | get_section_rings() | +-----------+--------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_TubeTrailMesh_property_sections: @@ -114,6 +136,10 @@ Property Descriptions | *Getter* | get_sections() | +-----------+---------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 24b6a1564..be2606bc1 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -905,6 +905,10 @@ If ``true``, the objects rendered by viewport become subjects of mouse picking p | *Getter* | get_positional_shadow_atlas_16_bits() | +-----------+--------------------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_Viewport_property_positional_shadow_atlas_quad_0: @@ -1055,6 +1059,10 @@ Sets the screen-space antialiasing method used. Screen-space antialiasing works | *Getter* | get_sdf_oversize() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_Viewport_property_sdf_scale: @@ -1069,6 +1077,10 @@ Sets the screen-space antialiasing method used. Screen-space antialiasing works | *Getter* | get_sdf_scale() | +-----------+----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_Viewport_property_snap_2d_transforms_to_pixel: @@ -1083,6 +1095,10 @@ Sets the screen-space antialiasing method used. Screen-space antialiasing works | *Getter* | is_snap_2d_transforms_to_pixel_enabled() | +-----------+------------------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_Viewport_property_snap_2d_vertices_to_pixel: @@ -1097,6 +1113,10 @@ Sets the screen-space antialiasing method used. Screen-space antialiasing works | *Getter* | is_snap_2d_vertices_to_pixel_enabled() | +-----------+----------------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_Viewport_property_texture_mipmap_bias: @@ -1334,6 +1354,10 @@ Returns the :ref:`PositionalShadowAtlasQuadrantSubdiv` **get_render_info** **(** :ref:`RenderInfoType` type, :ref:`RenderInfo` info **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Viewport_method_get_screen_transform: @@ -1454,6 +1478,10 @@ If an earlier method marks the input as handled via :ref:`set_input_as_handled` text **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_Viewport_method_push_unhandled_input: diff --git a/classes/class_viewporttexture.rst b/classes/class_viewporttexture.rst index 1dd74d1a9..2f823564b 100644 --- a/classes/class_viewporttexture.rst +++ b/classes/class_viewporttexture.rst @@ -37,11 +37,9 @@ Tutorials Properties ---------- -+---------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`bool` | resource_local_to_scene | ``true`` (overrides :ref:`Resource`) | -+---------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`viewport_path` | ``NodePath("")`` | -+---------------------------------+--------------------------------------------------------------------+---------------------------------------------------------------------------------------+ ++---------------------------------+--------------------------------------------------------------------+------------------+ +| :ref:`NodePath` | :ref:`viewport_path` | ``NodePath("")`` | ++---------------------------------+--------------------------------------------------------------------+------------------+ Property Descriptions --------------------- diff --git a/classes/class_visibleonscreenenabler3d.rst b/classes/class_visibleonscreenenabler3d.rst index 8df5dcae5..6763059cb 100644 --- a/classes/class_visibleonscreenenabler3d.rst +++ b/classes/class_visibleonscreenenabler3d.rst @@ -68,6 +68,10 @@ Property Descriptions | *Getter* | get_enable_mode() | +-----------+------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_VisibleOnScreenEnabler3D_property_enable_node_path: @@ -82,6 +86,10 @@ Property Descriptions | *Getter* | get_enable_node_path() | +-----------+-----------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_visualinstance3d.rst b/classes/class_visualinstance3d.rst index d8c859cae..06be305a3 100644 --- a/classes/class_visualinstance3d.rst +++ b/classes/class_visualinstance3d.rst @@ -75,6 +75,10 @@ Method Descriptions - :ref:`AABB` **_get_aabb** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_VisualInstance3D_method_get_aabb: diff --git a/classes/class_visualshader.rst b/classes/class_visualshader.rst index c248a356b..df9144809 100644 --- a/classes/class_visualshader.rst +++ b/classes/class_visualshader.rst @@ -219,6 +219,10 @@ Adds the specified ``node`` to the shader. - void **add_varying** **(** :ref:`String` name, :ref:`VaryingMode` mode, :ref:`VaryingType` type **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_VisualShader_method_can_connect_nodes: @@ -289,12 +293,20 @@ Returns the position of the specified node within the shader graph. - :ref:`int` **get_valid_node_id** **(** :ref:`Type` type **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_VisualShader_method_has_varying: - :ref:`bool` **has_varying** **(** :ref:`String` name **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_VisualShader_method_is_node_connection: @@ -317,6 +329,10 @@ Removes the specified node from the shader. - void **remove_varying** **(** :ref:`String` name **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_VisualShader_method_replace_node: diff --git a/classes/class_visualshadernodedistancefade.rst b/classes/class_visualshadernodedistancefade.rst index ff4cef9a6..86c4ec4f0 100644 --- a/classes/class_visualshadernodedistancefade.rst +++ b/classes/class_visualshadernodedistancefade.rst @@ -12,7 +12,9 @@ VisualShaderNodeDistanceFade **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_visualshadernodeintparameter.rst b/classes/class_visualshadernodeintparameter.rst index b3edac9c2..cb51cdb4f 100644 --- a/classes/class_visualshadernodeintparameter.rst +++ b/classes/class_visualshadernodeintparameter.rst @@ -12,7 +12,9 @@ VisualShaderNodeIntParameter **Inherits:** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -69,6 +71,10 @@ Property Descriptions | *Getter* | get_default_value() | +-----------+--------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_VisualShaderNodeIntParameter_property_default_value_enabled: @@ -83,6 +89,10 @@ Property Descriptions | *Getter* | is_default_value_enabled() | +-----------+----------------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_VisualShaderNodeIntParameter_property_hint: @@ -97,6 +107,10 @@ Property Descriptions | *Getter* | get_hint() | +-----------+-----------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_VisualShaderNodeIntParameter_property_max: @@ -111,6 +125,10 @@ Property Descriptions | *Getter* | get_max() | +-----------+----------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_VisualShaderNodeIntParameter_property_min: @@ -125,6 +143,10 @@ Property Descriptions | *Getter* | get_min() | +-----------+----------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_VisualShaderNodeIntParameter_property_step: @@ -139,6 +161,10 @@ Property Descriptions | *Getter* | get_step() | +-----------+-----------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_visualshadernodelinearscenedepth.rst b/classes/class_visualshadernodelinearscenedepth.rst index c5c75eaff..456a4a875 100644 --- a/classes/class_visualshadernodelinearscenedepth.rst +++ b/classes/class_visualshadernodelinearscenedepth.rst @@ -12,7 +12,9 @@ VisualShaderNodeLinearSceneDepth **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_visualshadernodeparameter.rst b/classes/class_visualshadernodeparameter.rst index 1ff933af3..13cf3615d 100644 --- a/classes/class_visualshadernodeparameter.rst +++ b/classes/class_visualshadernodeparameter.rst @@ -84,6 +84,10 @@ Name of the parameter, by which it can be accessed through the :ref:`ShaderMater | *Getter* | get_qualifier() | +-----------+----------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_visualshadernodeparticleaccelerator.rst b/classes/class_visualshadernodeparticleaccelerator.rst index c0774fb14..6d2593058 100644 --- a/classes/class_visualshadernodeparticleaccelerator.rst +++ b/classes/class_visualshadernodeparticleaccelerator.rst @@ -12,7 +12,9 @@ VisualShaderNodeParticleAccelerator **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -59,6 +61,10 @@ Property Descriptions | *Getter* | get_mode() | +-----------+-----------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_visualshadernodeparticleboxemitter.rst b/classes/class_visualshadernodeparticleboxemitter.rst index d33b792a4..f3bd96bd8 100644 --- a/classes/class_visualshadernodeparticleboxemitter.rst +++ b/classes/class_visualshadernodeparticleboxemitter.rst @@ -12,7 +12,9 @@ VisualShaderNodeParticleBoxEmitter **Inherits:** :ref:`VisualShaderNodeParticleEmitter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_visualshadernodeparticleconevelocity.rst b/classes/class_visualshadernodeparticleconevelocity.rst index 62d656b1c..debdc77ed 100644 --- a/classes/class_visualshadernodeparticleconevelocity.rst +++ b/classes/class_visualshadernodeparticleconevelocity.rst @@ -12,7 +12,9 @@ VisualShaderNodeParticleConeVelocity **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_visualshadernodeparticleemit.rst b/classes/class_visualshadernodeparticleemit.rst index fb0b830b4..a3f612c80 100644 --- a/classes/class_visualshadernodeparticleemit.rst +++ b/classes/class_visualshadernodeparticleemit.rst @@ -12,7 +12,9 @@ VisualShaderNodeParticleEmit **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -63,6 +65,10 @@ Property Descriptions | *Getter* | get_flags() | +-----------+------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_visualshadernodeparticlemeshemitter.rst b/classes/class_visualshadernodeparticlemeshemitter.rst index ba910da08..ab593eb4d 100644 --- a/classes/class_visualshadernodeparticlemeshemitter.rst +++ b/classes/class_visualshadernodeparticlemeshemitter.rst @@ -12,7 +12,9 @@ VisualShaderNodeParticleMeshEmitter **Inherits:** :ref:`VisualShaderNodeParticleEmitter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! 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 `! + ---- .. _class_VisualShaderNodeParticleMeshEmitter_property_surface_index: @@ -52,6 +58,10 @@ Property Descriptions | *Getter* | get_surface_index() | +-----------+--------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_VisualShaderNodeParticleMeshEmitter_property_use_all_surfaces: @@ -66,6 +76,10 @@ Property Descriptions | *Getter* | is_use_all_surfaces() | +-----------+-----------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst b/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst index 275c47634..75ab79d2b 100644 --- a/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst +++ b/classes/class_visualshadernodeparticlemultiplybyaxisangle.rst @@ -12,7 +12,9 @@ VisualShaderNodeParticleMultiplyByAxisAngle **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -36,6 +38,10 @@ Property Descriptions | *Getter* | is_degrees_mode() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_visualshadernodeparticleoutput.rst b/classes/class_visualshadernodeparticleoutput.rst index ff1cee97b..722cf2d09 100644 --- a/classes/class_visualshadernodeparticleoutput.rst +++ b/classes/class_visualshadernodeparticleoutput.rst @@ -12,7 +12,9 @@ VisualShaderNodeParticleOutput **Inherits:** :ref:`VisualShaderNodeOutput` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_visualshadernodeparticlerandomness.rst b/classes/class_visualshadernodeparticlerandomness.rst index 99c63430f..64eb70ff7 100644 --- a/classes/class_visualshadernodeparticlerandomness.rst +++ b/classes/class_visualshadernodeparticlerandomness.rst @@ -12,7 +12,9 @@ VisualShaderNodeParticleRandomness **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- diff --git a/classes/class_visualshadernodeparticleringemitter.rst b/classes/class_visualshadernodeparticleringemitter.rst index fdca45ce7..dc5937517 100644 --- a/classes/class_visualshadernodeparticleringemitter.rst +++ b/classes/class_visualshadernodeparticleringemitter.rst @@ -12,7 +12,9 @@ VisualShaderNodeParticleRingEmitter **Inherits:** :ref:`VisualShaderNodeParticleEmitter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_visualshadernodeparticlesphereemitter.rst b/classes/class_visualshadernodeparticlesphereemitter.rst index 67f55c08a..8112c14a7 100644 --- a/classes/class_visualshadernodeparticlesphereemitter.rst +++ b/classes/class_visualshadernodeparticlesphereemitter.rst @@ -12,7 +12,9 @@ VisualShaderNodeParticleSphereEmitter **Inherits:** :ref:`VisualShaderNodeParticleEmitter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_visualshadernodeproximityfade.rst b/classes/class_visualshadernodeproximityfade.rst index e3236fc7e..3512c3893 100644 --- a/classes/class_visualshadernodeproximityfade.rst +++ b/classes/class_visualshadernodeproximityfade.rst @@ -12,7 +12,9 @@ VisualShaderNodeProximityFade **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_visualshadernoderandomrange.rst b/classes/class_visualshadernoderandomrange.rst index cf70c7181..9a4994c77 100644 --- a/classes/class_visualshadernoderandomrange.rst +++ b/classes/class_visualshadernoderandomrange.rst @@ -12,7 +12,9 @@ VisualShaderNodeRandomRange **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_visualshadernoderemap.rst b/classes/class_visualshadernoderemap.rst index 04d8df3fc..354f687e8 100644 --- a/classes/class_visualshadernoderemap.rst +++ b/classes/class_visualshadernoderemap.rst @@ -12,7 +12,9 @@ VisualShaderNodeRemap **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_visualshadernodetexture2darrayparameter.rst b/classes/class_visualshadernodetexture2darrayparameter.rst index 20502f2a0..a1c8bedd3 100644 --- a/classes/class_visualshadernodetexture2darrayparameter.rst +++ b/classes/class_visualshadernodetexture2darrayparameter.rst @@ -12,7 +12,9 @@ VisualShaderNodeTexture2DArrayParameter **Inherits:** :ref:`VisualShaderNodeTextureParameter` **<** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_visualshadernodeuvpolarcoord.rst b/classes/class_visualshadernodeuvpolarcoord.rst index fb670e402..454af6f60 100644 --- a/classes/class_visualshadernodeuvpolarcoord.rst +++ b/classes/class_visualshadernodeuvpolarcoord.rst @@ -12,7 +12,9 @@ VisualShaderNodeUVPolarCoord **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_visualshadernodevarying.rst b/classes/class_visualshadernodevarying.rst index 061b55cec..579c9d213 100644 --- a/classes/class_visualshadernodevarying.rst +++ b/classes/class_visualshadernodevarying.rst @@ -14,7 +14,9 @@ VisualShaderNodeVarying **Inherited By:** :ref:`VisualShaderNodeVaryingGetter`, :ref:`VisualShaderNodeVaryingSetter` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- @@ -40,6 +42,10 @@ Property Descriptions | *Getter* | get_varying_name() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + ---- .. _class_VisualShaderNodeVarying_property_varying_type: @@ -54,6 +60,10 @@ Property Descriptions | *Getter* | get_varying_type() | +-----------+-------------------------+ +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_visualshadernodevaryinggetter.rst b/classes/class_visualshadernodevaryinggetter.rst index 47e651bae..dcc229bd1 100644 --- a/classes/class_visualshadernodevaryinggetter.rst +++ b/classes/class_visualshadernodevaryinggetter.rst @@ -12,7 +12,9 @@ VisualShaderNodeVaryingGetter **Inherits:** :ref:`VisualShaderNodeVarying` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_visualshadernodevaryingsetter.rst b/classes/class_visualshadernodevaryingsetter.rst index 2b5a5c9f3..5073b8249 100644 --- a/classes/class_visualshadernodevaryingsetter.rst +++ b/classes/class_visualshadernodevaryingsetter.rst @@ -12,7 +12,9 @@ VisualShaderNodeVaryingSetter **Inherits:** :ref:`VisualShaderNodeVarying` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! .. |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.)` diff --git a/classes/class_voxelgidata.rst b/classes/class_voxelgidata.rst index f6b7adff4..8112f784f 100644 --- a/classes/class_voxelgidata.rst +++ b/classes/class_voxelgidata.rst @@ -184,6 +184,10 @@ Method Descriptions - void **allocate** **(** :ref:`Transform3D` to_cell_xform, :ref:`AABB` aabb, :ref:`Vector3` octree_size, :ref:`PackedByteArray` octree_cells, :ref:`PackedByteArray` data_cells, :ref:`PackedByteArray` distance_field, :ref:`PackedInt32Array` level_counts **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_VoxelGIData_method_get_bounds: @@ -200,30 +204,50 @@ Returns the bounds of the baked voxel data as an :ref:`AABB`, which - :ref:`PackedByteArray` **get_data_cells** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_VoxelGIData_method_get_level_counts: - :ref:`PackedInt32Array` **get_level_counts** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_VoxelGIData_method_get_octree_cells: - :ref:`PackedByteArray` **get_octree_cells** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_VoxelGIData_method_get_octree_size: - :ref:`Vector3` **get_octree_size** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_VoxelGIData_method_get_to_cell_xform: - :ref:`Transform3D` **get_to_cell_xform** **(** **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_webrtcdatachannel.rst b/classes/class_webrtcdatachannel.rst index d040b6ae8..b33ec73bb 100644 --- a/classes/class_webrtcdatachannel.rst +++ b/classes/class_webrtcdatachannel.rst @@ -14,7 +14,9 @@ WebRTCDataChannel **Inherited By:** :ref:`WebRTCDataChannelExtension` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Properties ---------- diff --git a/classes/class_webrtcdatachannelextension.rst b/classes/class_webrtcdatachannelextension.rst index 9fd441425..a7e9b1a95 100644 --- a/classes/class_webrtcdatachannelextension.rst +++ b/classes/class_webrtcdatachannelextension.rst @@ -12,7 +12,9 @@ WebRTCDataChannelExtension **Inherits:** :ref:`WebRTCDataChannel` **<** :ref:`PacketPeer` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -62,108 +64,180 @@ Method Descriptions - void **_close** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__get_available_packet_count: - :ref:`int` **_get_available_packet_count** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__get_buffered_amount: - :ref:`int` **_get_buffered_amount** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__get_id: - :ref:`int` **_get_id** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__get_label: - :ref:`String` **_get_label** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__get_max_packet_life_time: - :ref:`int` **_get_max_packet_life_time** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__get_max_packet_size: - :ref:`int` **_get_max_packet_size** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__get_max_retransmits: - :ref:`int` **_get_max_retransmits** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__get_packet: - :ref:`Error` **_get_packet** **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__get_protocol: - :ref:`String` **_get_protocol** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__get_ready_state: - :ref:`ChannelState` **_get_ready_state** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__get_write_mode: - :ref:`WriteMode` **_get_write_mode** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__is_negotiated: - :ref:`bool` **_is_negotiated** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__is_ordered: - :ref:`bool` **_is_ordered** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__poll: - :ref:`Error` **_poll** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__put_packet: - :ref:`Error` **_put_packet** **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__set_write_mode: - void **_set_write_mode** **(** :ref:`WriteMode` p_write_mode **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCDataChannelExtension_method__was_string_packet: - :ref:`bool` **_was_string_packet** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_webrtcpeerconnectionextension.rst b/classes/class_webrtcpeerconnectionextension.rst index 0dac5f4fe..0eaa9ce31 100644 --- a/classes/class_webrtcpeerconnectionextension.rst +++ b/classes/class_webrtcpeerconnectionextension.rst @@ -12,7 +12,9 @@ WebRTCPeerConnectionExtension **Inherits:** :ref:`WebRTCPeerConnection` **<** :ref:`RefCounted` **<** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -48,66 +50,110 @@ Method Descriptions - :ref:`Error` **_add_ice_candidate** **(** :ref:`String` p_sdp_mid_name, :ref:`int` p_sdp_mline_index, :ref:`String` p_sdp_name **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCPeerConnectionExtension_method__close: - void **_close** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCPeerConnectionExtension_method__create_data_channel: - :ref:`Object` **_create_data_channel** **(** :ref:`String` p_label, :ref:`Dictionary` p_config **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCPeerConnectionExtension_method__create_offer: - :ref:`Error` **_create_offer** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCPeerConnectionExtension_method__get_connection_state: - :ref:`ConnectionState` **_get_connection_state** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCPeerConnectionExtension_method__get_gathering_state: - :ref:`GatheringState` **_get_gathering_state** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCPeerConnectionExtension_method__get_signaling_state: - :ref:`SignalingState` **_get_signaling_state** **(** **)** |virtual| |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCPeerConnectionExtension_method__initialize: - :ref:`Error` **_initialize** **(** :ref:`Dictionary` p_config **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCPeerConnectionExtension_method__poll: - :ref:`Error` **_poll** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCPeerConnectionExtension_method__set_local_description: - :ref:`Error` **_set_local_description** **(** :ref:`String` p_type, :ref:`String` p_sdp **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WebRTCPeerConnectionExtension_method__set_remote_description: - :ref:`Error` **_set_remote_description** **(** :ref:`String` p_type, :ref:`String` p_sdp **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_workerthreadpool.rst b/classes/class_workerthreadpool.rst index 165a6007b..ea025e982 100644 --- a/classes/class_workerthreadpool.rst +++ b/classes/class_workerthreadpool.rst @@ -12,7 +12,9 @@ WorkerThreadPool **Inherits:** :ref:`Object` +.. container:: contribute + There is currently no description for this class. Please help us by :ref:`contributing one `! Methods ------- @@ -40,42 +42,70 @@ Method Descriptions - :ref:`int` **add_group_task** **(** :ref:`Callable` action, :ref:`int` elements, :ref:`int` tasks_needed=-1, :ref:`bool` high_priority=false, :ref:`String` description="" **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WorkerThreadPool_method_add_task: - :ref:`int` **add_task** **(** :ref:`Callable` action, :ref:`bool` high_priority=false, :ref:`String` description="" **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WorkerThreadPool_method_get_group_processed_element_count: - :ref:`int` **get_group_processed_element_count** **(** :ref:`int` group_id **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WorkerThreadPool_method_is_group_task_completed: - :ref:`bool` **is_group_task_completed** **(** :ref:`int` group_id **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WorkerThreadPool_method_is_task_completed: - :ref:`bool` **is_task_completed** **(** :ref:`int` task_id **)** |const| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WorkerThreadPool_method_wait_for_group_task_completion: - void **wait_for_group_task_completion** **(** :ref:`int` group_id **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_WorkerThreadPool_method_wait_for_task_completion: - void **wait_for_task_completion** **(** :ref:`int` task_id **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)` diff --git a/classes/class_xrinterface.rst b/classes/class_xrinterface.rst index 77c379e87..afabaeaaa 100644 --- a/classes/class_xrinterface.rst +++ b/classes/class_xrinterface.rst @@ -51,10 +51,14 @@ Methods +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector3Array` | :ref:`get_play_area` **(** **)** |const| | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Projection` | :ref:`get_projection_for_view` **(** :ref:`int` view, :ref:`float` aspect, :ref:`float` near, :ref:`float` far **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_render_target_size` **(** **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TrackingStatus` | :ref:`get_tracking_status` **(** **)** |const| | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform3D` | :ref:`get_transform_for_view` **(** :ref:`int` view, :ref:`Transform3D` cam_transform **)** | ++--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_view_count` **(** **)** | +--------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`initialize` **(** **)** | @@ -258,6 +262,14 @@ Returns an array of vectors that denotes the physical play area mapped to the vi ---- +.. _class_XRInterface_method_get_projection_for_view: + +- :ref:`Projection` **get_projection_for_view** **(** :ref:`int` view, :ref:`float` aspect, :ref:`float` near, :ref:`float` far **)** + +Returns the projection matrix for a view/eye. + +---- + .. _class_XRInterface_method_get_render_target_size: - :ref:`Vector2` **get_render_target_size** **(** **)** @@ -274,6 +286,18 @@ If supported, returns the status of our tracking. This will allow you to provide ---- +.. _class_XRInterface_method_get_transform_for_view: + +- :ref:`Transform3D` **get_transform_for_view** **(** :ref:`int` view, :ref:`Transform3D` cam_transform **)** + +Returns the transform for a view/eye. + +\ ``view`` is the view/eye index. + +\ ``cam_transform`` is the transform that maps device coordinates to scene coordinates, typically the global_transform of the current XROrigin3D. + +---- + .. _class_XRInterface_method_get_view_count: - :ref:`int` **get_view_count** **(** **)** diff --git a/classes/class_xrinterfaceextension.rst b/classes/class_xrinterfaceextension.rst index b99b7e995..dc2eb11ed 100644 --- a/classes/class_xrinterfaceextension.rst +++ b/classes/class_xrinterfaceextension.rst @@ -65,8 +65,6 @@ Methods +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_initialized` **(** **)** |virtual| |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_notification` **(** :ref:`int` what **)** |virtual| | -+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_post_draw_viewport` **(** :ref:`RID` render_target, :ref:`Rect2` screen_rect **)** |virtual| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_pre_draw_viewport` **(** :ref:`RID` render_target **)** |virtual| | @@ -247,6 +245,10 @@ Returns the number of views this interface requires, 1 for mono, 2 for stereosco - :ref:`RID` **_get_vrs_texture** **(** **)** |virtual| +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_XRInterfaceExtension_method__initialize: @@ -265,14 +267,6 @@ Returns ``true`` if this interface has been initialized. ---- -.. _class_XRInterfaceExtension_method__notification: - -- void **_notification** **(** :ref:`int` what **)** |virtual| - -Informs the interface of an applicable system notification. - ----- - .. _class_XRInterfaceExtension_method__post_draw_viewport: - void **_post_draw_viewport** **(** :ref:`RID` render_target, :ref:`Rect2` screen_rect **)** |virtual| @@ -357,12 +351,20 @@ Blits our render results to screen optionally applying lens distortion. This can - :ref:`RID` **get_color_texture** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_XRInterfaceExtension_method_get_depth_texture: - :ref:`RID` **get_depth_texture** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + ---- .. _class_XRInterfaceExtension_method_get_render_target_texture: @@ -377,6 +379,10 @@ Returns a valid :ref:`RID` for a texture to which we should render th - :ref:`RID` **get_velocity_texture** **(** **)** +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + .. |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.)`