diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2023-02-26 14:24:46 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2023-02-26 14:24:46 +0100 |
| commit | 898ad308e5d15047f9347543fb763a6699994015 (patch) | |
| tree | a933ce6c509115633cbc0a91e4f49640fc43dbc9 | |
| parent | 84a80721c5308df36c7295949c76a622c5e0edb9 (diff) | |
| parent | 6e86afb4876a974cdffc27d70c968f4a26662b36 (diff) | |
Merge pull request #73956 from hakro/document-sorting-offset-unit
Document VisualInstance3D offset unit
| -rw-r--r-- | doc/classes/VisualInstance3D.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/VisualInstance3D.xml b/doc/classes/VisualInstance3D.xml index 3781045c02..b2bc6709a0 100644 --- a/doc/classes/VisualInstance3D.xml +++ b/doc/classes/VisualInstance3D.xml @@ -62,7 +62,7 @@ For [Light3D]s, this can be used to control which [VisualInstance3D]s are affected by a specific light. For [GPUParticles3D], this can be used to control which particles are effected by a specific attractor. For [Decal]s, this can be used to control which [VisualInstance3D]s are affected by a specific decal. </member> <member name="sorting_offset" type="float" setter="set_sorting_offset" getter="get_sorting_offset" default="0.0"> - The sorting offset used by this [VisualInstance3D]. Adjusting it to a higher value will make the [VisualInstance3D] reliably draw on top of other [VisualInstance3D]s that are otherwise positioned at the same spot. + The amount by which the depth of this [VisualInstance3D] will be adjusted when sorting by depth. Uses the same units as the engine (which are typically meters). Adjusting it to a higher value will make the [VisualInstance3D] reliably draw on top of other [VisualInstance3D]s that are otherwise positioned at the same spot. To ensure it always draws on top of other objects around it (not positioned at the same spot), set the value to be greater than the distance between this [VisualInstance3D] and the other nearby [VisualInstance3D]s. </member> <member name="sorting_use_aabb_center" type="bool" setter="set_sorting_use_aabb_center" getter="is_sorting_use_aabb_center"> If [code]true[/code], the object is sorted based on the [AABB] center. The object will be sorted based on the global position otherwise. |