From fab3e43781ca4db3228a38b27dd0fcfe6a88d634 Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Sat, 14 Oct 2023 03:21:01 +0000 Subject: [PATCH] classref: Sync with current master branch (a574c02) --- classes/class_@globalscope.rst | 2 +- classes/class_diraccess.rst | 16 + classes/class_editorsettings.rst | 30 ++ classes/class_enetconnection.rst | 2 +- classes/class_fileaccess.rst | 4 + classes/class_fontfile.rst | 19 + classes/class_gpuparticles2d.rst | 42 +++ classes/class_gpuparticles3d.rst | 42 +++ classes/class_input.rst | 2 +- classes/class_lightmapgi.rst | 44 ++- classes/class_os.rst | 2 +- classes/class_particleprocessmaterial.rst | 395 +++++++++++++++++++- classes/class_projectsettings.rst | 98 ++++- classes/class_refcounted.rst | 2 +- classes/class_renderingserver.rst | 42 +++ classes/class_resourceimporterbmfont.rst | 24 +- classes/class_resourceimporterimagefont.rst | 14 + classes/class_scriptlanguageextension.rst | 16 + classes/class_spinbox.rst | 2 + classes/class_textserver.rst | 62 +++ classes/class_textserverextension.rst | 32 ++ classes/class_tilemap.rst | 28 ++ classes/class_viewport.rst | 21 +- 23 files changed, 914 insertions(+), 27 deletions(-) diff --git a/classes/class_@globalscope.rst b/classes/class_@globalscope.rst index 2c00051427c..11ca3076501 100644 --- a/classes/class_@globalscope.rst +++ b/classes/class_@globalscope.rst @@ -2601,7 +2601,7 @@ Game controller SDL guide button. Corresponds to the Sony PS, Xbox Home button. :ref:`JoyButton` **JOY_BUTTON_START** = ``6`` -Game controller SDL start button. Corresponds to the Nintendo + button. +Game controller SDL start button. Corresponds to the Sony Options, Xbox Menu, Nintendo + button. .. _class_@GlobalScope_constant_JOY_BUTTON_LEFT_STICK: diff --git a/classes/class_diraccess.rst b/classes/class_diraccess.rst index b7aa67573f5..830a982bd7f 100644 --- a/classes/class_diraccess.rst +++ b/classes/class_diraccess.rst @@ -152,6 +152,8 @@ Methods +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_space_left` **(** **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_case_sensitive` **(** :ref:`String` path **)** |const| | + +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`list_dir_begin` **(** **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`list_dir_end` **(** **)** | @@ -477,6 +479,20 @@ Returns the available space on the current directory's disk, in bytes. Returns ` ---- +.. _class_DirAccess_method_is_case_sensitive: + +.. rst-class:: classref-method + +:ref:`bool` **is_case_sensitive** **(** :ref:`String` path **)** |const| + +Returns ``true`` if the file system or directory use case sensitive file names. + +\ **Note:** This method is implemented on macOS, Linux (for EXT4 and F2FS filesystems only) and Windows. On other platforms, it always returns ``true``. + +.. rst-class:: classref-item-separator + +---- + .. _class_DirAccess_method_list_dir_begin: .. rst-class:: classref-method diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 4f48cb0a664..1c51943a532 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -251,6 +251,8 @@ Properties +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`filesystem/on_save/safe_save_on_backup_then_rename` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`String` | :ref:`filesystem/tools/oidn/oidn_denoise_path` | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`interface/editor/accept_dialog_cancel_ok_buttons` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`interface/editor/automatically_open_screenshots` | @@ -527,6 +529,8 @@ Properties +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`text_editor/theme/highlighting/current_line_color` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`text_editor/theme/highlighting/doc_comment_color` | + +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`text_editor/theme/highlighting/engine_type_color` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`text_editor/theme/highlighting/executing_line_color` | @@ -1865,6 +1869,20 @@ If ``true``, when saving a file, the editor will rename the old file to a differ ---- +.. _class_EditorSettings_property_filesystem/tools/oidn/oidn_denoise_path: + +.. rst-class:: classref-property + +:ref:`String` **filesystem/tools/oidn/oidn_denoise_path** + +The path to the directory containing the Open Image Denoise (OIDN) executable, used optionally for denoising lightmaps. It can be downloaded from `openimagedenoise.org `__. + +To enable this feature for your specific project, use :ref:`ProjectSettings.rendering/lightmapping/denoising/denoiser`. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_interface/editor/accept_dialog_cancel_ok_buttons: .. rst-class:: classref-property @@ -3599,6 +3617,18 @@ The script editor's background color for the line the caret is currently on. Thi ---- +.. _class_EditorSettings_property_text_editor/theme/highlighting/doc_comment_color: + +.. rst-class:: classref-property + +:ref:`Color` **text_editor/theme/highlighting/doc_comment_color** + +The script editor's documentation comment color. In GDScript, this is used for comments starting with ``##``. In C#, this is used for comments starting with ``///`` or ``/**``. + +.. rst-class:: classref-item-separator + +---- + .. _class_EditorSettings_property_text_editor/theme/highlighting/engine_type_color: .. rst-class:: classref-property diff --git a/classes/class_enetconnection.rst b/classes/class_enetconnection.rst index 8e7c9b69eb0..aab015037a7 100644 --- a/classes/class_enetconnection.rst +++ b/classes/class_enetconnection.rst @@ -177,7 +177,7 @@ A peer has disconnected. This event is generated on a successful completion of a :ref:`EventType` **EVENT_RECEIVE** = ``3`` -A packet has been received from a peer. The array will contain the peer which sent the packet, the channel number upon which the packet was received, and the received packet. +A packet has been received from a peer. The array will contain the peer which sent the packet and the channel number upon which the packet was received. The received packet will be queued to the associated :ref:`ENetPacketPeer`. .. rst-class:: classref-item-separator diff --git a/classes/class_fileaccess.rst b/classes/class_fileaccess.rst index 61e42b35bae..49dd92b2cce 100644 --- a/classes/class_fileaccess.rst +++ b/classes/class_fileaccess.rst @@ -644,6 +644,8 @@ Returns the last error that happened when trying to perform operations. Compare Returns the whole ``path`` file contents as a :ref:`PackedByteArray` without any decoding. +Returns an empty :ref:`PackedByteArray` if an error occurred while opening the file. You can use :ref:`get_open_error` to check the error that occurred. + .. rst-class:: classref-item-separator ---- @@ -656,6 +658,8 @@ Returns the whole ``path`` file contents as a :ref:`PackedByteArray`. Text is interpreted as being UTF-8 encoded. +Returns an empty :ref:`String` if an error occurred while opening the file. You can use :ref:`get_open_error` to check the error that occurred. + .. rst-class:: classref-item-separator ---- diff --git a/classes/class_fontfile.rst b/classes/class_fontfile.rst index f1678eddd99..ea93c40942e 100644 --- a/classes/class_fontfile.rst +++ b/classes/class_fontfile.rst @@ -73,6 +73,8 @@ Properties +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`fixed_size` | ``0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ + | :ref:`FixedSizeScaleMode` | :ref:`fixed_size_scale_mode` | ``0`` | + +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`String` | :ref:`font_name` | ``""`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`font_stretch` | ``100`` | @@ -319,6 +321,23 @@ Font size, used only for the bitmap fonts. ---- +.. _class_FontFile_property_fixed_size_scale_mode: + +.. rst-class:: classref-property + +:ref:`FixedSizeScaleMode` **fixed_size_scale_mode** = ``0`` + +.. rst-class:: classref-property-setget + +- void **set_fixed_size_scale_mode** **(** :ref:`FixedSizeScaleMode` value **)** +- :ref:`FixedSizeScaleMode` **get_fixed_size_scale_mode** **(** **)** + +Scaling mode, used only for the bitmap fonts with :ref:`fixed_size` greater than zero. + +.. rst-class:: classref-item-separator + +---- + .. _class_FontFile_property_font_name: .. rst-class:: classref-property diff --git a/classes/class_gpuparticles2d.rst b/classes/class_gpuparticles2d.rst index 737133cfe46..b80b11ae97b 100644 --- a/classes/class_gpuparticles2d.rst +++ b/classes/class_gpuparticles2d.rst @@ -47,6 +47,8 @@ Properties +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`int` | :ref:`amount` | ``8`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ + | :ref:`float` | :ref:`amount_ratio` | ``1.0`` | + +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`float` | :ref:`collision_base_size` | ``1.0`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`DrawOrder` | :ref:`draw_order` | ``1`` | @@ -59,6 +61,8 @@ Properties +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`bool` | :ref:`fract_delta` | ``true`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ + | :ref:`float` | :ref:`interp_to_end` | ``0.0`` | + +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`bool` | :ref:`interpolate` | ``true`` | +-------------------------------------------------+---------------------------------------------------------------------------------------------+---------------------------------+ | :ref:`float` | :ref:`lifetime` | ``1.0`` | @@ -242,6 +246,25 @@ Number of particles emitted in one emission cycle. ---- +.. _class_GPUParticles2D_property_amount_ratio: + +.. rst-class:: classref-property + +:ref:`float` **amount_ratio** = ``1.0`` + +.. rst-class:: classref-property-setget + +- void **set_amount_ratio** **(** :ref:`float` value **)** +- :ref:`float` **get_amount_ratio** **(** **)** + +The ratio of particles that should actually be emitted. If set to a value lower than ``1.0``, this will set the amount of emitted particles throughout the lifetime to ``amount * amount_ratio``. Unlike changing :ref:`amount`, changing :ref:`amount_ratio` while emitting does not affect already-emitted particles and doesn't cause the particle system to restart. :ref:`amount_ratio` can be used to create effects that make the number of emitted particles vary over time. + +\ **Note:** Reducing the :ref:`amount_ratio` has no performance benefit, since resources need to be allocated and processed for the total :ref:`amount` of particles regardless of the :ref:`amount_ratio`. + +.. rst-class:: classref-item-separator + +---- + .. _class_GPUParticles2D_property_collision_base_size: .. rst-class:: classref-property @@ -344,6 +367,25 @@ If ``true``, results in fractional delta calculation which has a smoother partic ---- +.. _class_GPUParticles2D_property_interp_to_end: + +.. rst-class:: classref-property + +:ref:`float` **interp_to_end** = ``0.0`` + +.. rst-class:: classref-property-setget + +- void **set_interp_to_end** **(** :ref:`float` value **)** +- :ref:`float` **get_interp_to_end** **(** **)** + +Causes all the particles in this node to interpolate towards the end of their lifetime. + +\ **Note**: This only works when used with a :ref:`ParticleProcessMaterial`. It needs to be manually implemented for custom process shaders. + +.. rst-class:: classref-item-separator + +---- + .. _class_GPUParticles2D_property_interpolate: .. rst-class:: classref-property diff --git a/classes/class_gpuparticles3d.rst b/classes/class_gpuparticles3d.rst index 4af0e8624f8..e270cbd66ca 100644 --- a/classes/class_gpuparticles3d.rst +++ b/classes/class_gpuparticles3d.rst @@ -45,6 +45,8 @@ Properties +-----------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------+ | :ref:`int` | :ref:`amount` | ``8`` | +-----------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------+ + | :ref:`float` | :ref:`amount_ratio` | ``1.0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------+ | :ref:`float` | :ref:`collision_base_size` | ``0.01`` | +-----------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------+ | :ref:`DrawOrder` | :ref:`draw_order` | ``0`` | @@ -69,6 +71,8 @@ Properties +-----------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------+ | :ref:`bool` | :ref:`fract_delta` | ``true`` | +-----------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------+ + | :ref:`float` | :ref:`interp_to_end` | ``0.0`` | + +-----------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------+ | :ref:`bool` | :ref:`interpolate` | ``true`` | +-----------------------------------------------------------+-------------------------------------------------------------------------------+-------------------------------+ | :ref:`float` | :ref:`lifetime` | ``1.0`` | @@ -319,6 +323,25 @@ Number of particles to emit. ---- +.. _class_GPUParticles3D_property_amount_ratio: + +.. rst-class:: classref-property + +:ref:`float` **amount_ratio** = ``1.0`` + +.. rst-class:: classref-property-setget + +- void **set_amount_ratio** **(** :ref:`float` value **)** +- :ref:`float` **get_amount_ratio** **(** **)** + +The ratio of particles that should actually be emitted. If set to a value lower than ``1.0``, this will set the amount of emitted particles throughout the lifetime to ``amount * amount_ratio``. Unlike changing :ref:`amount`, changing :ref:`amount_ratio` while emitting does not affect already-emitted particles and doesn't cause the particle system to restart. :ref:`amount_ratio` can be used to create effects that make the number of emitted particles vary over time. + +\ **Note:** Reducing the :ref:`amount_ratio` has no performance benefit, since resources need to be allocated and processed for the total :ref:`amount` of particles regardless of the :ref:`amount_ratio`. + +.. rst-class:: classref-item-separator + +---- + .. _class_GPUParticles3D_property_collision_base_size: .. rst-class:: classref-property @@ -529,6 +552,25 @@ If ``true``, results in fractional delta calculation which has a smoother partic ---- +.. _class_GPUParticles3D_property_interp_to_end: + +.. rst-class:: classref-property + +:ref:`float` **interp_to_end** = ``0.0`` + +.. rst-class:: classref-property-setget + +- void **set_interp_to_end** **(** :ref:`float` value **)** +- :ref:`float` **get_interp_to_end** **(** **)** + +Causes all the particles in this node to interpolate towards the end of their lifetime. + +\ **Note**: This only works when used with a :ref:`ParticleProcessMaterial`. It needs to be manually implemented for custom process shaders. + +.. rst-class:: classref-item-separator + +---- + .. _class_GPUParticles3D_property_interpolate: .. rst-class:: classref-property diff --git a/classes/class_input.rst b/classes/class_input.rst index 02c6607890b..88b34a7fd4d 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -512,7 +512,7 @@ If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref: :ref:`float` **get_action_strength** **(** :ref:`StringName` action, :ref:`bool` exact_match=false **)** |const| -Returns a value between 0 and 1 representing the intensity of the given action. In a joypad, for example, the further away the axis (analog sticks or L2, R2 triggers) is from the dead zone, the closer the value will be to 1. If the action is mapped to a control that has no axis as the keyboard, the value returned will be 0 or 1. +Returns a value between 0 and 1 representing the intensity of the given action. In a joypad, for example, the further away the axis (analog sticks or L2, R2 triggers) is from the dead zone, the closer the value will be to 1. If the action is mapped to a control that has no axis such as the keyboard, the value returned will be 0 or 1. If ``exact_match`` is ``false``, it ignores additional input modifiers for :ref:`InputEventKey` and :ref:`InputEventMouseButton` events, and the direction for :ref:`InputEventJoypadMotion` events. diff --git a/classes/class_lightmapgi.rst b/classes/class_lightmapgi.rst index 5a37823cf3a..b5dda39a98a 100644 --- a/classes/class_lightmapgi.rst +++ b/classes/class_lightmapgi.rst @@ -49,6 +49,8 @@ Properties +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`float` | :ref:`bias` | ``0.0005`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ + | :ref:`float` | :ref:`bounce_indirect_energy` | ``1.0`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`int` | :ref:`bounces` | ``3`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`CameraAttributes` | :ref:`camera_attributes` | | @@ -77,6 +79,8 @@ Properties +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`bool` | :ref:`use_denoiser` | ``true`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ + | :ref:`bool` | :ref:`use_texture_for_bounces` | ``true`` | + +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ .. rst-class:: classref-section-separator @@ -335,6 +339,25 @@ The bias to use when computing shadows. Increasing :ref:`bias` **bounce_indirect_energy** = ``1.0`` + +.. rst-class:: classref-property-setget + +- void **set_bounce_indirect_energy** **(** :ref:`float` value **)** +- :ref:`float` **get_bounce_indirect_energy** **(** **)** + +The energy multiplier for each bounce. Higher values will make indirect lighting brighter. A value of ``1.0`` represents physically accurate behavior, but higher values can be used to make indirect lighting propagate more visibly when using a low number of bounces. This can be used to speed up bake times by lowering the number of :ref:`bounces` then increasing :ref:`bounce_indirect_energy`. + +\ **Note:** :ref:`bounce_indirect_energy` only has an effect if :ref:`bounces` is set to a value greater than or equal to ``1``. + +.. rst-class:: classref-item-separator + +---- + .. _class_LightmapGI_property_bounces: .. rst-class:: classref-property @@ -380,7 +403,7 @@ The :ref:`CameraAttributes` resource that specifies expo - void **set_denoiser_strength** **(** :ref:`float` value **)** - :ref:`float` **get_denoiser_strength** **(** **)** -The strength of denoising step applied to the generated lightmaps. Only effective if :ref:`use_denoiser` is ``true``. +The strength of denoising step applied to the generated lightmaps. Only effective if :ref:`use_denoiser` is ``true`` and :ref:`ProjectSettings.rendering/lightmapping/denoising/denoiser` is set to JNLM. .. rst-class:: classref-item-separator @@ -577,6 +600,25 @@ To further speed up bake times, decrease :ref:`bounces` **use_texture_for_bounces** = ``true`` + +.. rst-class:: classref-property-setget + +- void **set_use_texture_for_bounces** **(** :ref:`bool` value **)** +- :ref:`bool` **is_using_texture_for_bounces** **(** **)** + +If ``true``, a texture with the lighting information will be generated to speed up the generation of indirect lighting at the cost of some accuracy. The geometry might exhibit extra light leak artifacts when using low resolution lightmaps or UVs that stretch the lightmap significantly across surfaces. Leave :ref:`use_texture_for_bounces` at its default value of ``true`` if unsure. + +\ **Note:** :ref:`use_texture_for_bounces` only has an effect if :ref:`bounces` is set to a value greater than or equal to ``1``. + .. |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_os.rst b/classes/class_os.rst index 9c2875123ce..943115a16be 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -900,7 +900,7 @@ On the web, this is ``"Web"``. case "Linux": case "FreeBSD": case "NetBSD": - case "OpenBSD" + case "OpenBSD": case "BSD": GD.Print("Linux/BSD"); break; diff --git a/classes/class_particleprocessmaterial.rst b/classes/class_particleprocessmaterial.rst index eca8109515e..6dbb10c4ad1 100644 --- a/classes/class_particleprocessmaterial.rst +++ b/classes/class_particleprocessmaterial.rst @@ -29,6 +29,8 @@ Properties .. table:: :widths: auto + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture2D` | :ref:`alpha_curve` | | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`Texture2D` | :ref:`angle_curve` | | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ @@ -78,10 +80,18 @@ Properties +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`Vector3` | :ref:`direction` | ``Vector3(1, 0, 0)`` | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture2D` | :ref:`directional_velocity_curve` | | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`directional_velocity_max` | | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`directional_velocity_min` | | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`Vector3` | :ref:`emission_box_extents` | | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`Texture2D` | :ref:`emission_color_texture` | | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture2D` | :ref:`emission_curve` | | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`Texture2D` | :ref:`emission_normal_texture` | | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`emission_point_count` | | @@ -98,6 +108,10 @@ Properties +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`EmissionShape` | :ref:`emission_shape` | ``0`` | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Vector3` | :ref:`emission_shape_offset` | ``Vector3(0, 0, 0)`` | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Vector3` | :ref:`emission_shape_scale` | ``Vector3(1, 1, 1)`` | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`emission_sphere_radius` | | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`flatness` | ``0.0`` | @@ -110,6 +124,8 @@ Properties +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`hue_variation_min` | ``0.0`` | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`inherit_velocity_ratio` | ``0.0`` | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`initial_velocity_max` | ``0.0`` | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`initial_velocity_min` | ``0.0`` | @@ -124,12 +140,14 @@ Properties +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`Texture2D` | :ref:`orbit_velocity_curve` | | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`orbit_velocity_max` | | + | :ref:`float` | :ref:`orbit_velocity_max` | ``0.0`` | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ - | :ref:`float` | :ref:`orbit_velocity_min` | | + | :ref:`float` | :ref:`orbit_velocity_min` | ``0.0`` | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`particle_flag_align_y` | ``false`` | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`bool` | :ref:`particle_flag_damping_as_friction` | ``false`` | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`particle_flag_disable_z` | ``false`` | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`particle_flag_rotate_y` | ``false`` | @@ -140,12 +158,24 @@ Properties +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`radial_accel_min` | ``0.0`` | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture2D` | :ref:`radial_velocity_curve` | | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`radial_velocity_max` | ``0.0`` | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`radial_velocity_min` | ``0.0`` | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`Texture2D` | :ref:`scale_curve` | | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`scale_max` | ``1.0`` | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`scale_min` | ``1.0`` | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture2D` | :ref:`scale_over_velocity_curve` | | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`scale_over_velocity_max` | ``0.0`` | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`float` | :ref:`scale_over_velocity_min` | ``0.0`` | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`spread` | ``45.0`` | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`sub_emitter_amount_at_collision` | | @@ -184,6 +214,10 @@ Properties +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`turbulence_noise_strength` | ``1.0`` | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Texture2D` | :ref:`velocity_limit_curve` | | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ + | :ref:`Vector3` | :ref:`velocity_pivot` | ``Vector3(0, 0, 0)`` | + +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+-------------------------+ .. rst-class:: classref-reftable-group @@ -322,11 +356,35 @@ Use with :ref:`set_param_min Use with :ref:`set_param_min`, :ref:`set_param_max`, and :ref:`set_param_texture` to set animation offset properties. +.. _class_ParticleProcessMaterial_constant_PARAM_RADIAL_VELOCITY: + +.. rst-class:: classref-enumeration-constant + +:ref:`Parameter` **PARAM_RADIAL_VELOCITY** = ``15`` + +Use with :ref:`set_param_min`, :ref:`set_param_max`, and :ref:`set_param_texture` to set radial velocity properties. + +.. _class_ParticleProcessMaterial_constant_PARAM_DIRECTIONAL_VELOCITY: + +.. rst-class:: classref-enumeration-constant + +:ref:`Parameter` **PARAM_DIRECTIONAL_VELOCITY** = ``16`` + +Use with :ref:`set_param_min`, :ref:`set_param_max`, and :ref:`set_param_texture` to set directional velocity properties. + +.. _class_ParticleProcessMaterial_constant_PARAM_SCALE_OVER_VELOCITY: + +.. rst-class:: classref-enumeration-constant + +:ref:`Parameter` **PARAM_SCALE_OVER_VELOCITY** = ``17`` + +Use with :ref:`set_param_min`, :ref:`set_param_max`, and :ref:`set_param_texture` to set scale over velocity properties. + .. _class_ParticleProcessMaterial_constant_PARAM_MAX: .. rst-class:: classref-enumeration-constant -:ref:`Parameter` **PARAM_MAX** = ``15`` +:ref:`Parameter` **PARAM_MAX** = ``18`` Represents the size of the :ref:`Parameter` enum. @@ -388,11 +446,19 @@ Use with :ref:`set_particle_flag` to set :ref:`particle_flag_disable_z`. +.. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_DAMPING_AS_FRICTION: + +.. rst-class:: classref-enumeration-constant + +:ref:`ParticleFlags` **PARTICLE_FLAG_DAMPING_AS_FRICTION** = ``3`` + + + .. _class_ParticleProcessMaterial_constant_PARTICLE_FLAG_MAX: .. rst-class:: classref-enumeration-constant -:ref:`ParticleFlags` **PARTICLE_FLAG_MAX** = ``3`` +:ref:`ParticleFlags` **PARTICLE_FLAG_MAX** = ``4`` Represents the size of the :ref:`ParticleFlags` enum. @@ -571,6 +637,23 @@ Represents the size of the :ref:`CollisionMode` **alpha_curve** + +.. rst-class:: classref-property-setget + +- void **set_alpha_curve** **(** :ref:`Texture2D` value **)** +- :ref:`Texture2D` **get_alpha_curve** **(** **)** + +The alpha value of each particle's color will be multiplied by this :ref:`CurveTexture` over its lifetime. + +.. rst-class:: classref-item-separator + +---- + .. _class_ParticleProcessMaterial_property_angle_curve: .. rst-class:: classref-property @@ -995,6 +1078,63 @@ Unit vector specifying the particles' emission direction. ---- +.. _class_ParticleProcessMaterial_property_directional_velocity_curve: + +.. rst-class:: classref-property + +:ref:`Texture2D` **directional_velocity_curve** + +.. rst-class:: classref-property-setget + +- void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture2D` texture **)** +- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| + +A curve that specifies the velocity along each of the axes of the particle system along its lifetime. + +\ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve` instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ParticleProcessMaterial_property_directional_velocity_max: + +.. rst-class:: classref-property + +:ref:`float` **directional_velocity_max** + +.. rst-class:: classref-property-setget + +- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** +- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| + +Maximum directional velocity value, which is multiplied by :ref:`directional_velocity_curve`. + +\ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve` instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ParticleProcessMaterial_property_directional_velocity_min: + +.. rst-class:: classref-property + +:ref:`float` **directional_velocity_min** + +.. rst-class:: classref-property-setget + +- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** +- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| + +Minimum directional velocity value, which is multiplied by :ref:`directional_velocity_curve`. + +\ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve` instead. + +.. rst-class:: classref-item-separator + +---- + .. _class_ParticleProcessMaterial_property_emission_box_extents: .. rst-class:: classref-property @@ -1031,6 +1171,25 @@ Particle color will be modulated by color determined by sampling this texture at ---- +.. _class_ParticleProcessMaterial_property_emission_curve: + +.. rst-class:: classref-property + +:ref:`Texture2D` **emission_curve** + +.. rst-class:: classref-property-setget + +- void **set_emission_curve** **(** :ref:`Texture2D` value **)** +- :ref:`Texture2D` **get_emission_curve** **(** **)** + +Each particle's color will be multiplied by this :ref:`CurveTexture` over its lifetime. + +\ **Note:** This property won't have a visible effect unless the render material is marked as unshaded. + +.. rst-class:: classref-item-separator + +---- + .. _class_ParticleProcessMaterial_property_emission_normal_texture: .. rst-class:: classref-property @@ -1167,6 +1326,40 @@ Particles will be emitted inside this region. Use :ref:`EmissionShape` **emission_shape_offset** = ``Vector3(0, 0, 0)`` + +.. rst-class:: classref-property-setget + +- void **set_emission_shape_offset** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_emission_shape_offset** **(** **)** + +The offset for the :ref:`emission_shape`, in local space. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ParticleProcessMaterial_property_emission_shape_scale: + +.. rst-class:: classref-property + +:ref:`Vector3` **emission_shape_scale** = ``Vector3(1, 1, 1)`` + +.. rst-class:: classref-property-setget + +- void **set_emission_shape_scale** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_emission_shape_scale** **(** **)** + +The scale of the :ref:`emission_shape`, in local space. + +.. rst-class:: classref-item-separator + +---- + .. _class_ParticleProcessMaterial_property_emission_sphere_radius: .. rst-class:: classref-property @@ -1269,6 +1462,23 @@ Minimum equivalent of :ref:`hue_variation_max` **inherit_velocity_ratio** = ``0.0`` + +.. rst-class:: classref-property-setget + +- void **set_inherit_velocity_ratio** **(** :ref:`float` value **)** +- :ref:`float` **get_inherit_velocity_ratio** **(** **)** + +Percentage of the velocity of the respective :ref:`GPUParticles2D` or :ref:`GPUParticles3D` inherited by each particle when spawning. + +.. rst-class:: classref-item-separator + +---- + .. _class_ParticleProcessMaterial_property_initial_velocity_max: .. rst-class:: classref-property @@ -1384,6 +1594,10 @@ Minimum equivalent of :ref:`linear_accel_max`. +\ **Note:** For 3D orbital velocity, use a :ref:`CurveXYZTexture`. + +\ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve` instead. + .. rst-class:: classref-item-separator ---- @@ -1392,7 +1606,7 @@ Each particle's orbital velocity will vary along this :ref:`CurveTexture` **orbit_velocity_max** +:ref:`float` **orbit_velocity_max** = ``0.0`` .. rst-class:: classref-property-setget @@ -1401,7 +1615,7 @@ Each particle's orbital velocity will vary along this :ref:`CurveTexture` is ``true``. +\ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve` instead. .. rst-class:: classref-item-separator @@ -1411,7 +1625,7 @@ Only available when :ref:`particle_flag_disable_z` **orbit_velocity_min** +:ref:`float` **orbit_velocity_min** = ``0.0`` .. rst-class:: classref-property-setget @@ -1420,6 +1634,8 @@ Only available when :ref:`particle_flag_disable_z`. +\ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve` instead. + .. rst-class:: classref-item-separator ---- @@ -1441,6 +1657,23 @@ Align Y axis of particle with the direction of its velocity. ---- +.. _class_ParticleProcessMaterial_property_particle_flag_damping_as_friction: + +.. rst-class:: classref-property + +:ref:`bool` **particle_flag_damping_as_friction** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_particle_flag** **(** :ref:`ParticleFlags` particle_flag, :ref:`bool` enable **)** +- :ref:`bool` **get_particle_flag** **(** :ref:`ParticleFlags` particle_flag **)** |const| + +Changes the behavior of the damping properties from a linear deceleration to a deceleration based on speed percentage. + +.. rst-class:: classref-item-separator + +---- + .. _class_ParticleProcessMaterial_property_particle_flag_disable_z: .. rst-class:: classref-property @@ -1526,6 +1759,63 @@ Minimum equivalent of :ref:`radial_accel_max` **radial_velocity_curve** + +.. rst-class:: classref-property-setget + +- void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture2D` texture **)** +- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| + +A :ref:`CurveTexture` that defines the velocity over the particle's lifetime away (or toward) the :ref:`velocity_pivot`. + +\ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve` instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ParticleProcessMaterial_property_radial_velocity_max: + +.. rst-class:: classref-property + +:ref:`float` **radial_velocity_max** = ``0.0`` + +.. rst-class:: classref-property-setget + +- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** +- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| + +Maximum radial velocity applied to each particle. Makes particles move away from the :ref:`velocity_pivot`, or toward it if negative. + +\ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve` instead. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ParticleProcessMaterial_property_radial_velocity_min: + +.. rst-class:: classref-property + +:ref:`float` **radial_velocity_min** = ``0.0`` + +.. rst-class:: classref-property-setget + +- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** +- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| + +Minimum radial velocity applied to each particle. Makes particles move away from the :ref:`velocity_pivot`, or toward it if negative. + +\ **Note:** Animated velocities will not be affected by damping, use :ref:`velocity_limit_curve` instead. + +.. rst-class:: classref-item-separator + +---- + .. _class_ParticleProcessMaterial_property_scale_curve: .. rst-class:: classref-property @@ -1577,6 +1867,61 @@ Minimum equivalent of :ref:`scale_max` **scale_over_velocity_curve** + +.. rst-class:: classref-property-setget + +- void **set_param_texture** **(** :ref:`Parameter` param, :ref:`Texture2D` texture **)** +- :ref:`Texture2D` **get_param_texture** **(** :ref:`Parameter` param **)** |const| + +Either a :ref:`CurveTexture` or a :ref:`CurveXYZTexture` that scales each particle based on its velocity. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ParticleProcessMaterial_property_scale_over_velocity_max: + +.. rst-class:: classref-property + +:ref:`float` **scale_over_velocity_max** = ``0.0`` + +.. rst-class:: classref-property-setget + +- void **set_param_max** **(** :ref:`Parameter` param, :ref:`float` value **)** +- :ref:`float` **get_param_max** **(** :ref:`Parameter` param **)** |const| + +Maximum velocity value reference for :ref:`scale_over_velocity_curve`. + +\ :ref:`scale_over_velocity_curve` will be interpolated between :ref:`scale_over_velocity_min` and :ref:`scale_over_velocity_max`. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ParticleProcessMaterial_property_scale_over_velocity_min: + +.. rst-class:: classref-property + +:ref:`float` **scale_over_velocity_min** = ``0.0`` + +.. rst-class:: classref-property-setget + +- void **set_param_min** **(** :ref:`Parameter` param, :ref:`float` value **)** +- :ref:`float` **get_param_min** **(** :ref:`Parameter` param **)** |const| + +Minimum velocity value reference for :ref:`scale_over_velocity_curve`. + +\ :ref:`scale_over_velocity_curve` will be interpolated between :ref:`scale_over_velocity_min` and :ref:`scale_over_velocity_max`. + +.. rst-class:: classref-item-separator + +---- + .. _class_ParticleProcessMaterial_property_spread: .. rst-class:: classref-property @@ -1922,6 +2267,42 @@ A value of 0.0 will result in a fixed pattern. The turbulence noise strength. Increasing this will result in a stronger, more contrasting, flow pattern. +.. rst-class:: classref-item-separator + +---- + +.. _class_ParticleProcessMaterial_property_velocity_limit_curve: + +.. rst-class:: classref-property + +:ref:`Texture2D` **velocity_limit_curve** + +.. rst-class:: classref-property-setget + +- void **set_velocity_limit_curve** **(** :ref:`Texture2D` value **)** +- :ref:`Texture2D` **get_velocity_limit_curve** **(** **)** + +A :ref:`CurveTexture` that defines the maximum velocity of a particle during its lifetime. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ParticleProcessMaterial_property_velocity_pivot: + +.. rst-class:: classref-property + +:ref:`Vector3` **velocity_pivot** = ``Vector3(0, 0, 0)`` + +.. rst-class:: classref-property-setget + +- void **set_velocity_pivot** **(** :ref:`Vector3` value **)** +- :ref:`Vector3` **get_velocity_pivot** **(** **)** + +.. container:: contribute + + There is currently no description for this property. Please help us by :ref:`contributing one `! + .. rst-class:: classref-section-separator ---- diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 02f8b3d68a1..47b3ed2d3bd 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -145,6 +145,10 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`compression/formats/zstd/window_log_size` | ``27`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`Color` | :ref:`debug/canvas_items/debug_redraw_color` | ``Color(1, 0.2, 0.2, 0.5)`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`float` | :ref:`debug/canvas_items/debug_redraw_time` | ``1.0`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/file_logging/enable_file_logging` | ``false`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/file_logging/enable_file_logging.pc` | ``true`` | @@ -665,6 +669,10 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`input_devices/pen_tablet/driver.windows` | | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`input_devices/pointing/android/enable_long_press_as_right_click` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`input_devices/pointing/android/enable_pan_and_scale_gestures` | ``false`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`input_devices/pointing/emulate_mouse_from_touch` | ``true`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`input_devices/pointing/emulate_touch_from_mouse` | ``false`` | @@ -1337,19 +1345,21 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/lightmapping/bake_quality/high_quality_probe_ray_count` | ``512`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/lightmapping/bake_quality/high_quality_ray_count` | ``256`` | + | :ref:`int` | :ref:`rendering/lightmapping/bake_quality/high_quality_ray_count` | ``512`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/lightmapping/bake_quality/low_quality_probe_ray_count` | ``64`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/lightmapping/bake_quality/low_quality_ray_count` | ``16`` | + | :ref:`int` | :ref:`rendering/lightmapping/bake_quality/low_quality_ray_count` | ``32`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/lightmapping/bake_quality/medium_quality_probe_ray_count` | ``256`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/lightmapping/bake_quality/medium_quality_ray_count` | ``64`` | + | :ref:`int` | :ref:`rendering/lightmapping/bake_quality/medium_quality_ray_count` | ``128`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rendering/lightmapping/bake_quality/ultra_quality_probe_ray_count` | ``2048`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | :ref:`int` | :ref:`rendering/lightmapping/bake_quality/ultra_quality_ray_count` | ``1024`` | + | :ref:`int` | :ref:`rendering/lightmapping/bake_quality/ultra_quality_ray_count` | ``2048`` | + +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ + | :ref:`int` | :ref:`rendering/lightmapping/denoising/denoiser` | ``0`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`rendering/lightmapping/primitive_meshes/texel_size` | ``0.2`` | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ @@ -2272,6 +2282,30 @@ Largest size limit (in power of 2) allowed when compressing using long-distance ---- +.. _class_ProjectSettings_property_debug/canvas_items/debug_redraw_color: + +.. rst-class:: classref-property + +:ref:`Color` **debug/canvas_items/debug_redraw_color** = ``Color(1, 0.2, 0.2, 0.5)`` + +If canvas item redraw debugging is active, this color will be flashed on canvas items when they redraw. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_debug/canvas_items/debug_redraw_time: + +.. rst-class:: classref-property + +:ref:`float` **debug/canvas_items/debug_redraw_time** = ``1.0`` + +If canvas item redraw debugging is active, this will be the time the flash will last each time they redraw. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_debug/file_logging/enable_file_logging: .. rst-class:: classref-property @@ -5632,6 +5666,30 @@ Override for :ref:`input_devices/pen_tablet/driver` **input_devices/pointing/android/enable_long_press_as_right_click** = ``false`` + +If ``true``, long press events on an Android touchscreen are transformed into right click events. + +.. rst-class:: classref-item-separator + +---- + +.. _class_ProjectSettings_property_input_devices/pointing/android/enable_pan_and_scale_gestures: + +.. rst-class:: classref-property + +:ref:`bool` **input_devices/pointing/android/enable_pan_and_scale_gestures** = ``false`` + +If ``true``, multi-touch pan and scale gestures are enabled on Android devices. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_input_devices/pointing/emulate_mouse_from_touch: .. rst-class:: classref-property @@ -9840,7 +9898,7 @@ The number of rays to use for baking dynamic object lighting in :ref:`LightmapPr .. rst-class:: classref-property -:ref:`int` **rendering/lightmapping/bake_quality/high_quality_ray_count** = ``256`` +:ref:`int` **rendering/lightmapping/bake_quality/high_quality_ray_count** = ``512`` The number of rays to use for baking lightmaps with :ref:`LightmapGI` when :ref:`LightmapGI.quality` is :ref:`LightmapGI.BAKE_QUALITY_HIGH`. @@ -9864,7 +9922,7 @@ The number of rays to use for baking dynamic object lighting in :ref:`LightmapPr .. rst-class:: classref-property -:ref:`int` **rendering/lightmapping/bake_quality/low_quality_ray_count** = ``16`` +:ref:`int` **rendering/lightmapping/bake_quality/low_quality_ray_count** = ``32`` The number of rays to use for baking lightmaps with :ref:`LightmapGI` when :ref:`LightmapGI.quality` is :ref:`LightmapGI.BAKE_QUALITY_LOW`. @@ -9888,7 +9946,7 @@ The number of rays to use for baking dynamic object lighting in :ref:`LightmapPr .. rst-class:: classref-property -:ref:`int` **rendering/lightmapping/bake_quality/medium_quality_ray_count** = ``64`` +:ref:`int` **rendering/lightmapping/bake_quality/medium_quality_ray_count** = ``128`` The number of rays to use for baking lightmaps with :ref:`LightmapGI` when :ref:`LightmapGI.quality` is :ref:`LightmapGI.BAKE_QUALITY_MEDIUM`. @@ -9912,7 +9970,7 @@ The number of rays to use for baking dynamic object lighting in :ref:`LightmapPr .. rst-class:: classref-property -:ref:`int` **rendering/lightmapping/bake_quality/ultra_quality_ray_count** = ``1024`` +:ref:`int` **rendering/lightmapping/bake_quality/ultra_quality_ray_count** = ``2048`` The number of rays to use for baking lightmaps with :ref:`LightmapGI` when :ref:`LightmapGI.quality` is :ref:`LightmapGI.BAKE_QUALITY_ULTRA`. @@ -9920,6 +9978,30 @@ The number of rays to use for baking lightmaps with :ref:`LightmapGI` **rendering/lightmapping/denoising/denoiser** = ``0`` + +Denoiser tool used for denoising lightmaps. + +Using `OpenImageDenoise `__ (OIDN) requires configuring a path to an OIDN executable in the editor settings at :ref:`EditorSettings.filesystem/tools/oidn/oidn_denoise_path`. OIDN can be downloaded from `OpenImageDenoise's downloads page `__. + +OIDN will use GPU acceleration when available. Unlike JNLM which uses compute shaders for acceleration, OIDN uses vendor-specific acceleration methods. For GPU acceleration to be available, the following libraries must be installed on the system depending on your GPU: + +- NVIDIA GPUs: CUDA libraries + +- AMD GPUs: HIP libraries + +- Intel GPUs: SYCL libraries + +If no GPU acceleration is configured on the system, multi-threaded CPU-based denoising will be performed instead. This CPU-based denoising is significantly slower than the JNLM denoiser in most cases. + +.. rst-class:: classref-item-separator + +---- + .. _class_ProjectSettings_property_rendering/lightmapping/primitive_meshes/texel_size: .. rst-class:: classref-property diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index 83bcb96b64f..95ae8d6544e 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -111,7 +111,7 @@ Returns ``true`` if the increment was successful, ``false`` otherwise. Decrements the internal reference counter. Use this only if you really know what you are doing. -Returns ``true`` if the decrement was successful, ``false`` otherwise. +Returns ``true`` if the object should be freed after the decrement, ``false`` otherwise. .. |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_renderingserver.rst b/classes/class_renderingserver.rst index 26a699cd94c..40d83e29c5c 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -667,6 +667,8 @@ Methods +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_amount` **(** :ref:`RID` particles, :ref:`int` amount **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`particles_set_amount_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | + +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_collision_base_size` **(** :ref:`RID` particles, :ref:`float` size **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_custom_aabb` **(** :ref:`RID` particles, :ref:`AABB` aabb **)** | @@ -679,6 +681,8 @@ Methods +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_emission_transform` **(** :ref:`RID` particles, :ref:`Transform3D` transform **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`particles_set_emitter_velocity` **(** :ref:`RID` particles, :ref:`Vector3` velocity **)** | + +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_emitting` **(** :ref:`RID` particles, :ref:`bool` emitting **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_explosiveness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | @@ -687,6 +691,8 @@ Methods +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_fractional_delta` **(** :ref:`RID` particles, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`particles_set_interp_to_end` **(** :ref:`RID` particles, :ref:`float` factor **)** | + +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_interpolate` **(** :ref:`RID` particles, :ref:`bool` enable **)** | +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`particles_set_lifetime` **(** :ref:`RID` particles, :ref:`float` lifetime **)** | @@ -9247,6 +9253,18 @@ Sets the number of particles to be drawn and allocates the memory for them. Equi ---- +.. _class_RenderingServer_method_particles_set_amount_ratio: + +.. rst-class:: classref-method + +void **particles_set_amount_ratio** **(** :ref:`RID` particles, :ref:`float` ratio **)** + +Sets the amount ratio for particles to be emitted. Equivalent to :ref:`GPUParticles3D.amount_ratio`. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_particles_set_collision_base_size: .. rst-class:: classref-method @@ -9321,6 +9339,18 @@ Sets the :ref:`Transform3D` that will be used by the particle ---- +.. _class_RenderingServer_method_particles_set_emitter_velocity: + +.. rst-class:: classref-method + +void **particles_set_emitter_velocity** **(** :ref:`RID` particles, :ref:`Vector3` velocity **)** + +Sets the velocity of a particle node, that will be used by :ref:`ParticleProcessMaterial.inherit_velocity_ratio`. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_particles_set_emitting: .. rst-class:: classref-method @@ -9369,6 +9399,18 @@ If ``true``, uses fractional delta which smooths the movement of the particles. ---- +.. _class_RenderingServer_method_particles_set_interp_to_end: + +.. rst-class:: classref-method + +void **particles_set_interp_to_end** **(** :ref:`RID` particles, :ref:`float` factor **)** + +Sets the value that informs a :ref:`ParticleProcessMaterial` to rush all particles towards the end of their lifetime. + +.. rst-class:: classref-item-separator + +---- + .. _class_RenderingServer_method_particles_set_interpolate: .. rst-class:: classref-method diff --git a/classes/class_resourceimporterbmfont.rst b/classes/class_resourceimporterbmfont.rst index 5a1da3f944b..b9d61017320 100644 --- a/classes/class_resourceimporterbmfont.rst +++ b/classes/class_resourceimporterbmfont.rst @@ -40,11 +40,13 @@ Properties .. table:: :widths: auto - +---------------------------+-------------------------------------------------------------------+----------+ - | :ref:`bool` | :ref:`compress` | ``true`` | - +---------------------------+-------------------------------------------------------------------+----------+ - | :ref:`Array` | :ref:`fallbacks` | ``[]`` | - +---------------------------+-------------------------------------------------------------------+----------+ + +---------------------------+-------------------------------------------------------------------------+----------+ + | :ref:`bool` | :ref:`compress` | ``true`` | + +---------------------------+-------------------------------------------------------------------------+----------+ + | :ref:`Array` | :ref:`fallbacks` | ``[]`` | + +---------------------------+-------------------------------------------------------------------------+----------+ + | :ref:`int` | :ref:`scaling_mode` | ``2`` | + +---------------------------+-------------------------------------------------------------------------+----------+ .. rst-class:: classref-section-separator @@ -75,6 +77,18 @@ If ``true``, uses lossless compression for the resulting font. List of font fallbacks to use if a glyph isn't found in this bitmap font. Fonts at the beginning of the array are attempted first. +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterBMFont_property_scaling_mode: + +.. rst-class:: classref-property + +:ref:`int` **scaling_mode** = ``2`` + +Font scaling mode. + .. |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_resourceimporterimagefont.rst b/classes/class_resourceimporterimagefont.rst index b443200fbec..dc159bf44c6 100644 --- a/classes/class_resourceimporterimagefont.rst +++ b/classes/class_resourceimporterimagefont.rst @@ -53,6 +53,8 @@ Properties +---------------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`rows` | ``1`` | +---------------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ + | :ref:`int` | :ref:`scaling_mode` | ``2`` | + +---------------------------------------------------+------------------------------------------------------------------------------------+-------------------------+ .. rst-class:: classref-section-separator @@ -147,6 +149,18 @@ Margin to cut on the sides of the entire image. This can be used to cut parts of Number of rows in the font image. See also :ref:`columns`. +.. rst-class:: classref-item-separator + +---- + +.. _class_ResourceImporterImageFont_property_scaling_mode: + +.. rst-class:: classref-property + +:ref:`int` **scaling_mode** = ``2`` + +Font scaling mode. + .. |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_scriptlanguageextension.rst b/classes/class_scriptlanguageextension.rst index eb527922118..becc00f6d67 100644 --- a/classes/class_scriptlanguageextension.rst +++ b/classes/class_scriptlanguageextension.rst @@ -67,6 +67,8 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`_get_comment_delimiters` **(** **)** |virtual| |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`PackedStringArray` | :ref:`_get_doc_comment_delimiters` **(** **)** |virtual| |const| | + +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_extension` **(** **)** |virtual| |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`_get_global_class_name` **(** :ref:`String` path **)** |virtual| |const| | @@ -672,6 +674,20 @@ void **_frame** **(** **)** |virtual| ---- +.. _class_ScriptLanguageExtension_method__get_doc_comment_delimiters: + +.. rst-class:: classref-method + +:ref:`PackedStringArray` **_get_doc_comment_delimiters** **(** **)** |virtual| |const| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_ScriptLanguageExtension_method__get_extension: .. rst-class:: classref-method diff --git a/classes/class_spinbox.rst b/classes/class_spinbox.rst index 80055f8fcf2..889e47da01c 100644 --- a/classes/class_spinbox.rst +++ b/classes/class_spinbox.rst @@ -48,6 +48,8 @@ The above code will create a **SpinBox**, disable context menu on it and set the See :ref:`Range` class for more options over the **SpinBox**. +\ **Note:** With the **SpinBox**'s context menu disabled, you can right-click the bottom half of the spinbox to set the value to its minimum, while right-clicking the top half sets the value to its maximum. + \ **Note:** **SpinBox** relies on an underlying :ref:`LineEdit` node. To theme a **SpinBox**'s background, add theme items for :ref:`LineEdit` and customize them. \ **Note:** If you want to implement drag and drop for the underlying :ref:`LineEdit`, you can use :ref:`Control.set_drag_forwarding` on the node returned by :ref:`get_line_edit`. diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index f3d7a101cbe..796b9d242dc 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -68,6 +68,8 @@ Methods +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`font_get_fixed_size` **(** :ref:`RID` font_rid **)** |const| | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FixedSizeScaleMode` | :ref:`font_get_fixed_size_scale_mode` **(** :ref:`RID` font_rid **)** |const| | + +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`font_get_generate_mipmaps` **(** :ref:`RID` font_rid **)** |const| | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`font_get_global_oversampling` **(** **)** |const| | @@ -194,6 +196,8 @@ Methods +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`font_set_fixed_size` **(** :ref:`RID` font_rid, :ref:`int` fixed_size **)** | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`font_set_fixed_size_scale_mode` **(** :ref:`RID` font_rid, :ref:`FixedSizeScaleMode` fixed_size_scale_mode **)** | + +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`font_set_force_autohinter` **(** :ref:`RID` font_rid, :ref:`bool` force_autohinter **)** | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`font_set_generate_mipmaps` **(** :ref:`RID` font_rid, :ref:`bool` generate_mipmaps **)** | @@ -1474,6 +1478,40 @@ BiDi override for GDScript. User defined structured text BiDi override function. +.. rst-class:: classref-item-separator + +---- + +.. _enum_TextServer_FixedSizeScaleMode: + +.. rst-class:: classref-enumeration + +enum **FixedSizeScaleMode**: + +.. _class_TextServer_constant_FIXED_SIZE_SCALE_DISABLE: + +.. rst-class:: classref-enumeration-constant + +:ref:`FixedSizeScaleMode` **FIXED_SIZE_SCALE_DISABLE** = ``0`` + +Bitmap font is not scaled. + +.. _class_TextServer_constant_FIXED_SIZE_SCALE_INTEGER_ONLY: + +.. rst-class:: classref-enumeration-constant + +:ref:`FixedSizeScaleMode` **FIXED_SIZE_SCALE_INTEGER_ONLY** = ``1`` + +Bitmap font is scaled to the closest integer multiple of the font's fixed size. This is the recommended option for pixel art fonts. + +.. _class_TextServer_constant_FIXED_SIZE_SCALE_ENABLED: + +.. rst-class:: classref-enumeration-constant + +:ref:`FixedSizeScaleMode` **FIXED_SIZE_SCALE_ENABLED** = ``2`` + +Bitmap font is scaled to an arbitrary (fractional) size. This is the recommended option for non-pixel art fonts. + .. rst-class:: classref-section-separator ---- @@ -1715,6 +1753,18 @@ Returns bitmap font fixed size. ---- +.. _class_TextServer_method_font_get_fixed_size_scale_mode: + +.. rst-class:: classref-method + +:ref:`FixedSizeScaleMode` **font_get_fixed_size_scale_mode** **(** :ref:`RID` font_rid **)** |const| + +Returned bitmap font scaling mode. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_font_get_generate_mipmaps: .. rst-class:: classref-method @@ -2487,6 +2537,18 @@ Sets bitmap font fixed size. If set to value greater than zero, same cache entry ---- +.. _class_TextServer_method_font_set_fixed_size_scale_mode: + +.. rst-class:: classref-method + +void **font_set_fixed_size_scale_mode** **(** :ref:`RID` font_rid, :ref:`FixedSizeScaleMode` fixed_size_scale_mode **)** + +Sets bitmap font scaling mode. This property is used only if ``fixed_size`` is greater than zero. + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServer_method_font_set_force_autohinter: .. rst-class:: classref-method diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index 81d601797c2..9fbb536303f 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -70,6 +70,8 @@ Methods +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_font_get_fixed_size` **(** :ref:`RID` font_rid **)** |virtual| |const| | +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`FixedSizeScaleMode` | :ref:`_font_get_fixed_size_scale_mode` **(** :ref:`RID` font_rid **)** |virtual| |const| | + +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_font_get_generate_mipmaps` **(** :ref:`RID` font_rid **)** |virtual| |const| | +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`_font_get_global_oversampling` **(** **)** |virtual| |const| | @@ -198,6 +200,8 @@ Methods +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_font_set_fixed_size` **(** :ref:`RID` font_rid, :ref:`int` fixed_size **)** |virtual| | +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`_font_set_fixed_size_scale_mode` **(** :ref:`RID` font_rid, :ref:`FixedSizeScaleMode` fixed_size_scale_mode **)** |virtual| | + +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_font_set_force_autohinter` **(** :ref:`RID` font_rid, :ref:`bool` force_autohinter **)** |virtual| | +-----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_font_set_generate_mipmaps` **(** :ref:`RID` font_rid, :ref:`bool` generate_mipmaps **)** |virtual| | @@ -716,6 +720,20 @@ void **_font_draw_glyph_outline** **(** :ref:`RID` font_rid, :ref:`RI ---- +.. _class_TextServerExtension_method__font_get_fixed_size_scale_mode: + +.. rst-class:: classref-method + +:ref:`FixedSizeScaleMode` **_font_get_fixed_size_scale_mode** **(** :ref:`RID` font_rid **)** |virtual| |const| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_method__font_get_generate_mipmaps: .. rst-class:: classref-method @@ -1612,6 +1630,20 @@ void **_font_set_fixed_size** **(** :ref:`RID` font_rid, :ref:`int` font_rid, :ref:`FixedSizeScaleMode` fixed_size_scale_mode **)** |virtual| + +.. container:: contribute + + There is currently no description for this method. Please help us by :ref:`contributing one `! + +.. rst-class:: classref-item-separator + +---- + .. _class_TextServerExtension_method__font_set_force_autohinter: .. rst-class:: classref-method diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index ee224bfcbf0..314222c59c5 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -129,6 +129,8 @@ Methods +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_layer_enabled` **(** :ref:`int` layer **)** |const| | +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | :ref:`bool` | :ref:`is_layer_navigation_enabled` **(** :ref:`int` layer **)** |const| | + +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_layer_y_sort_enabled` **(** :ref:`int` layer **)** |const| | +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`local_to_map` **(** :ref:`Vector2` local_position **)** |const| | @@ -155,6 +157,8 @@ Methods +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_layer_name` **(** :ref:`int` layer, :ref:`String` name **)** | +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | void | :ref:`set_layer_navigation_enabled` **(** :ref:`int` layer, :ref:`bool` enabled **)** | + +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_layer_navigation_map` **(** :ref:`int` layer, :ref:`RID` map **)** | +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_layer_y_sort_enabled` **(** :ref:`int` layer, :ref:`bool` y_sort_enabled **)** | @@ -729,6 +733,18 @@ If ``layer`` is negative, the layers are accessed from the last one. ---- +.. _class_TileMap_method_is_layer_navigation_enabled: + +.. rst-class:: classref-method + +:ref:`bool` **is_layer_navigation_enabled** **(** :ref:`int` layer **)** |const| + +Returns if a layer's built-in navigation regions generation is enabled. + +.. rst-class:: classref-item-separator + +---- + .. _class_TileMap_method_is_layer_y_sort_enabled: .. rst-class:: classref-method @@ -923,6 +939,18 @@ If ``layer`` is negative, the layers are accessed from the last one. ---- +.. _class_TileMap_method_set_layer_navigation_enabled: + +.. rst-class:: classref-method + +void **set_layer_navigation_enabled** **(** :ref:`int` layer, :ref:`bool` enabled **)** + +Enables or disables a layer's built-in navigation regions generation. Disable this if you need to bake navigation regions from a TileMap using a :ref:`NavigationRegion2D` node. + +.. rst-class:: classref-item-separator + +---- + .. _class_TileMap_method_set_layer_navigation_map: .. rst-class:: classref-method diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index 00d5f59346b..ed482a8e63e 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -75,6 +75,8 @@ Properties +-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------+ | :ref:`DebugDraw` | :ref:`debug_draw` | ``0`` | +-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------+ + | :ref:`bool` | :ref:`disable_2d` | ``false`` | + +-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------+ | :ref:`bool` | :ref:`disable_3d` | ``false`` | +-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------+ | :ref:`float` | :ref:`fsr_sharpness` | ``0.2`` | @@ -1106,6 +1108,23 @@ The overlay mode for test rendered geometry in debug purposes. ---- +.. _class_Viewport_property_disable_2d: + +.. rst-class:: classref-property + +:ref:`bool` **disable_2d** = ``false`` + +.. rst-class:: classref-property-setget + +- void **set_disable_2d** **(** :ref:`bool` value **)** +- :ref:`bool` **is_2d_disabled** **(** **)** + +If ``true``, disables 2D rendering while keeping 3D rendering. See also :ref:`disable_3d`. + +.. rst-class:: classref-item-separator + +---- + .. _class_Viewport_property_disable_3d: .. rst-class:: classref-property @@ -1117,7 +1136,7 @@ The overlay mode for test rendered geometry in debug purposes. - void **set_disable_3d** **(** :ref:`bool` value **)** - :ref:`bool` **is_3d_disabled** **(** **)** -Disable 3D rendering (but keep 2D rendering). +If ``true``, disables 3D rendering while keeping 2D rendering. See also :ref:`disable_2d`. .. rst-class:: classref-item-separator