GeometryInstance

    Inherited By: , ImmediateGeometry, , MultiMeshInstance, , SpriteBase3D

    Category: Core

    Base node for geometry based visual instances.

    enum ShadowCastingSetting:

    • SHADOW_CASTING_SETTING_ON = 1 — 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.

    • SHADOW_CASTING_SETTING_DOUBLE_SIDED = 2 — 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.

    • SHADOW_CASTING_SETTING_SHADOWS_ONLY = 3 — Will only show the shadows casted from this object.

    enum Flags:

    • FLAG_USE_BAKED_LIGHT = 0 — Will allow the GeometryInstance to be used when baking lights using a or BakedLightmap.
    • FLAG_MAX = 2 — Represents the size of the enum.

    Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials.

    Setterset_cast_shadows_setting(value)
    Getterget_cast_shadows_setting()

    The selected shadow casting flag. See ShadowCastingSetting for possible values.

    • extra_cull_margin
    Setterset_extra_cull_margin(value)
    Getterget_extra_cull_margin()

    The extra distance added to the GeometryInstance’s bounding box (AABB) to increase its cull box.

    • lod_max_distance

    The GeometryInstance’s max LOD distance.

    Note: This property currently has no effect.

    • float lod_max_hysteresis
    Setterset_lod_max_hysteresis(value)
    Getterget_lod_max_hysteresis()

    Note: This property currently has no effect.

    • lod_min_distance
    Setterset_lod_min_distance(value)
    Getterget_lod_min_distance()

    The GeometryInstance’s min LOD distance.

    Note: This property currently has no effect.

    • float lod_min_hysteresis

    The GeometryInstance’s min LOD margin.

    Note: This property currently has no effect.

    Setterset_material_override(value)
    Getterget_material_override()

    The material override for the whole geometry.

    • use_in_baked_light
    Setterset_flag(value)
    Getterget_flag()

    If , this GeometryInstance will be used when baking lights using a GIProbe or .