diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-09-29 10:42:34 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-29 10:42:34 +0200 |
| commit | 7f72d92cb024232132473335765fc40bb2387c50 (patch) | |
| tree | e4354494df5a321e780e03e979389e038819e4de /doc/classes | |
| parent | c217498aa654c869c858f702d3916ba69427d808 (diff) | |
| parent | 90d1eda90e3b16702c0c2f693af47e7fbaacdae9 (diff) | |
| download | redot-engine-7f72d92cb024232132473335765fc40bb2387c50.tar.gz | |
Merge pull request #36067 from jsl118/distancefadefix
doc: Improve distance_fade documentation
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/BaseMaterial3D.xml | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/classes/BaseMaterial3D.xml b/doc/classes/BaseMaterial3D.xml index cc4568dda6..8c92975b9c 100644 --- a/doc/classes/BaseMaterial3D.xml +++ b/doc/classes/BaseMaterial3D.xml @@ -175,10 +175,12 @@ If [code]true[/code], the object receives no shadow that would otherwise be cast onto it. </member> <member name="distance_fade_max_distance" type="float" setter="set_distance_fade_max_distance" getter="get_distance_fade_max_distance"> - Distance at which the object fades fully and is no longer visible. + Distance at which the object appears fully opaque. + [b]Note:[/b] If [code]distance_fade_max_distance[/code] is less than [code]distance_fade_min_distance[/code], the behavior will be reversed. The object will start to fade away at [code]distance_fade_max_distance[/code] and will fully disappear once it reaches [code]distance_fade_min_distance[/code]. </member> <member name="distance_fade_min_distance" type="float" setter="set_distance_fade_min_distance" getter="get_distance_fade_min_distance"> - Distance at which the object starts to fade. If the object is less than this distance away it will appear normal. + Distance at which the object starts to become visible. If the object is less than this distance away, it will be invisible. + [b]Note:[/b] If [code]distance_fade_min_distance[/code] is greater than [code]distance_fade_max_distance[/code], the behavior will be reversed. The object will start to fade away at [code]distance_fade_max_distance[/code] and will fully disappear once it reaches [code]distance_fade_min_distance[/code]. </member> <member name="distance_fade_mode" type="int" setter="set_distance_fade" getter="get_distance_fade" enum="BaseMaterial3D.DistanceFadeMode" default="0"> Specifies which type of fade to use. Can be any of the [enum DistanceFadeMode]s. |