diff options
| -rw-r--r-- | doc/classes/GeometryInstance.xml | 18 | ||||
| -rw-r--r-- | doc/classes/VisualInstance.xml | 7 |
2 files changed, 25 insertions, 0 deletions
diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml index 93db093c8b..981873b1fe 100644 --- a/doc/classes/GeometryInstance.xml +++ b/doc/classes/GeometryInstance.xml @@ -14,32 +14,50 @@ </methods> <members> <member name="cast_shadow" type="int" setter="set_cast_shadows_setting" getter="get_cast_shadows_setting" enum="GeometryInstance.ShadowCastingSetting"> + The selected shadow casting flag. See SHADOW_CASTING_SETTING_* constants for values. </member> <member name="extra_cull_margin" type="float" setter="set_extra_cull_margin" getter="get_extra_cull_margin"> + The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box. </member> <member name="lod_max_distance" type="float" setter="set_lod_max_distance" getter="get_lod_max_distance"> + The GeometryInstance's max LOD distance. </member> <member name="lod_max_hysteresis" type="float" setter="set_lod_max_hysteresis" getter="get_lod_max_hysteresis"> + The GeometryInstance's max LOD margin. </member> <member name="lod_min_distance" type="float" setter="set_lod_min_distance" getter="get_lod_min_distance"> + The GeometryInstance's min LOD distance. </member> <member name="lod_min_hysteresis" type="float" setter="set_lod_min_hysteresis" getter="get_lod_min_hysteresis"> + The GeometryInstance's min LOD margin. </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 material_override, 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. </member> </members> <constants> <constant name="SHADOW_CASTING_SETTING_OFF" value="0" enum="ShadowCastingSetting"> + Will not cast any shadows. </constant> <constant name="SHADOW_CASTING_SETTING_ON" value="1" enum="ShadowCastingSetting"> + Will cast shadows from all visible faces in the GeometryInstance. + Will take culling into account, so faces not being rendered will not be taken into account when shadow casting. </constant> <constant name="SHADOW_CASTING_SETTING_DOUBLE_SIDED" value="2" enum="ShadowCastingSetting"> + Will cast shadows from all visible faces in the GeometryInstance. + Will not take culling into account, so all faces will be taken into account when shadow casting. </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. </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. + Added documentation for GeometryInstance and VisualInstance </constant> <constant name="FLAG_MAX" value="1" enum="Flags"> </constant> diff --git a/doc/classes/VisualInstance.xml b/doc/classes/VisualInstance.xml index 2c9fe4f43e..bd66880719 100644 --- a/doc/classes/VisualInstance.xml +++ b/doc/classes/VisualInstance.xml @@ -13,12 +13,15 @@ <return type="AABB"> </return> <description> + Returns the [AABB] (also known as the bounding box) for this VisualInstance. </description> </method> <method name="get_transformed_aabb" qualifiers="const"> <return type="AABB"> </return> <description> + Returns the transformed [AABB] (also known as the bounding box) for this VisualInstance. + Transformed in this case means the [AABB] plus the position, rotation, and scale of the [Spatial]s [Transform] </description> </method> <method name="set_base"> @@ -27,11 +30,15 @@ <argument index="0" name="base" type="RID"> </argument> <description> + Sets the base of the VisualInstance, which changes how the engine handles the VisualInstance under the hood. + It is recommended to only use set_base if you know what you're doing. </description> </method> </methods> <members> <member name="layers" type="int" setter="set_layer_mask" getter="get_layer_mask"> + The render layer(s) this VisualInstance is drawn on. + This object will only be visible for [Camera]s whose cull mask includes the render object this VisualInstance is set to. </member> </members> <constants> |