瀏覽代碼

Improve the GeometryInstance class documentation

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

(cherry picked from commit b84b46d5df0ba7634bb1d07c525146c5bb10017a)
Hugo Locurcio 6 年之前
父節點
當前提交
1ef9a47ede
共有 1 個文件被更改,包括 8 次插入4 次删除
  1. 8 4
      doc/classes/GeometryInstance.xml

+ 8 - 4
doc/classes/GeometryInstance.xml

@@ -19,22 +19,26 @@
 		</member>
 		<member name="lod_max_distance" type="float" setter="set_lod_max_distance" getter="get_lod_max_distance">
 			The GeometryInstance's max LOD distance.
+			[b]Note:[/b] This property currently has no effect.
 		</member>
 		<member name="lod_max_hysteresis" type="float" setter="set_lod_max_hysteresis" getter="get_lod_max_hysteresis">
 			The GeometryInstance's max LOD margin.
+			[b]Note:[/b] This property currently has no effect.
 		</member>
 		<member name="lod_min_distance" type="float" setter="set_lod_min_distance" getter="get_lod_min_distance">
 			The GeometryInstance's min LOD distance.
+			[b]Note:[/b] This property currently has no effect.
 		</member>
 		<member name="lod_min_hysteresis" type="float" setter="set_lod_min_hysteresis" getter="get_lod_min_hysteresis">
 			The GeometryInstance's min LOD margin.
+			[b]Note:[/b] This property currently has no effect.
 		</member>
 		<member name="material_override" type="Material" setter="set_material_override" getter="get_material_override">
 			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 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>
 	</members>
 	<constants>
@@ -51,10 +55,10 @@
 		</constant>
 		<constant name="SHADOW_CASTING_SETTING_SHADOWS_ONLY" value="3" enum="ShadowCastingSetting">
 			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 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 name="FLAG_MAX" value="2" enum="Flags">
 			Represents the size of the [enum Flags] enum.