godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve the GeometryInstance class documentation 

This adds a mention that LOD properties currently have no effect.

(cherry picked from commit b84b46d5df)
This commit is contained in:
Hugo Locurcio 2019-08-21 14:04:56 +02:00 committed by Rémi Verschelde
parent 0d401e11b1
commit 1ef9a47ede
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/classes/GeometryInstance.xml
View File

@ -19,22 +19,26 @@
</member> </member>
<member name="lod_max_distance" type="float" setter="set_lod_max_distance" getter="get_lod_max_distance"> <member name="lod_max_distance" type="float" setter="set_lod_max_distance" getter="get_lod_max_distance">
The GeometryInstance's max LOD distance. The GeometryInstance's max LOD distance.
[b]Note:[/b] This property currently has no effect.
</member> </member>
<member name="lod_max_hysteresis" type="float" setter="set_lod_max_hysteresis" getter="get_lod_max_hysteresis"> <member name="lod_max_hysteresis" type="float" setter="set_lod_max_hysteresis" getter="get_lod_max_hysteresis">
The GeometryInstance's max LOD margin. The GeometryInstance's max LOD margin.
[b]Note:[/b] This property currently has no effect.
</member> </member>
<member name="lod_min_distance" type="float" setter="set_lod_min_distance" getter="get_lod_min_distance"> <member name="lod_min_distance" type="float" setter="set_lod_min_distance" getter="get_lod_min_distance">
The GeometryInstance's min LOD distance. The GeometryInstance's min LOD distance.
[b]Note:[/b] This property currently has no effect.
</member> </member>
<member name="lod_min_hysteresis" type="float" setter="set_lod_min_hysteresis" getter="get_lod_min_hysteresis"> <member name="lod_min_hysteresis" type="float" setter="set_lod_min_hysteresis" getter="get_lod_min_hysteresis">
The GeometryInstance's min LOD margin. The GeometryInstance's min LOD margin.
[b]Note:[/b] This property currently has no effect.
</member> </member>
<member name="material_override" type="Material" setter="set_material_override" getter="get_material_override"> <member name="material_override" type="Material" setter="set_material_override" getter="get_material_override">
The material override for the whole geometry. The material override for the whole geometry.
If there is a material in [code]material_override[/code], it will be used instead of any material set in any material slot of the mesh. If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh.
</member> </member>
<member name="use_in_baked_light" type="bool" setter="set_flag" getter="get_flag"> <member name="use_in_baked_light" type="bool" setter="set_flag" getter="get_flag">
If [code]true[/code], this GeometryInstance will be used when baking lights using a [GIProbe] and/or any other form of baked lighting. If [code]true[/code], this GeometryInstance will be used when baking lights using a [GIProbe] or [BakedLightmap].
</member> </member>
</members> </members>
<constants> <constants>
@ -51,10 +55,10 @@
</constant> </constant>
<constant name="SHADOW_CASTING_SETTING_SHADOWS_ONLY" value="3" enum="ShadowCastingSetting"> <constant name="SHADOW_CASTING_SETTING_SHADOWS_ONLY" value="3" enum="ShadowCastingSetting">
Will only show the shadows casted from this object. Will only show the shadows casted from this object.
In other words: The actual mesh will not be visible, only the shadows casted from the mesh. In other words, the actual mesh will not be visible, only the shadows casted from the mesh will be.
</constant> </constant>
<constant name="FLAG_USE_BAKED_LIGHT" value="0" enum="Flags"> <constant name="FLAG_USE_BAKED_LIGHT" value="0" enum="Flags">
Will allow the GeometryInstance to be used when baking lights using a [GIProbe] and/or any other form of baked lighting. Will allow the GeometryInstance to be used when baking lights using a [GIProbe] or [BakedLightmap].
</constant> </constant>
<constant name="FLAG_MAX" value="2" enum="Flags"> <constant name="FLAG_MAX" value="2" enum="Flags">
Represents the size of the [enum Flags] enum. Represents the size of the [enum Flags] enum.