diff options
Diffstat (limited to 'doc/classes/GeometryInstance.xml')
| -rw-r--r-- | doc/classes/GeometryInstance.xml | 38 |
1 files changed, 25 insertions, 13 deletions
diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml index 6a89d81aa0..eb1847a055 100644 --- a/doc/classes/GeometryInstance.xml +++ b/doc/classes/GeometryInstance.xml @@ -1,39 +1,48 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="GeometryInstance" inherits="VisualInstance" category="Core" version="3.2"> <brief_description> - Base node for geometry based visual instances. + Base node for geometry-based visual instances. </brief_description> <description> - Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials. + Base node for geometry-based visual instances. Shares some common functionality like visibility and custom materials. </description> <tutorials> </tutorials> <methods> + <method name="set_custom_aabb"> + <return type="void"> + </return> + <argument index="0" name="aabb" type="AABB"> + </argument> + <description> + Overrides the bounding box of this node with a custom one. To remove it, set an [AABB] with all fields set to zero. + </description> + </method> </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 name="cast_shadow" type="int" setter="set_cast_shadows_setting" getter="get_cast_shadows_setting" enum="GeometryInstance.ShadowCastingSetting" default="1"> + The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values. </member> - <member name="extra_cull_margin" type="float" setter="set_extra_cull_margin" getter="get_extra_cull_margin"> + <member name="extra_cull_margin" type="float" setter="set_extra_cull_margin" getter="get_extra_cull_margin" default="0.0"> 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"> + <member name="lod_max_distance" type="float" setter="set_lod_max_distance" getter="get_lod_max_distance" default="0.0"> The GeometryInstance's max LOD distance. </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" default="0.0"> The GeometryInstance's max LOD margin. </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" default="0.0"> The GeometryInstance's min LOD distance. </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" default="0.0"> The GeometryInstance's min LOD margin. </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" default="null"> 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. + 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. </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" default="false"> 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> @@ -55,9 +64,12 @@ </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_DRAW_NEXT_FRAME_IF_VISIBLE" value="1" enum="Flags"> + Unused in this class, exposed for consistency with [enum VisualServer.InstanceFlags]. </constant> <constant name="FLAG_MAX" value="2" enum="Flags"> + Represents the size of the [enum Flags] enum. </constant> </constants> </class> |