.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/ReflectionProbe.xml. .. _class_ReflectionProbe: ReflectionProbe =============== **Inherits:** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+ | :ref:`Color` | :ref:`ambient_color` | ``Color(0, 0, 0, 1)`` | +------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`ambient_color_energy` | ``1.0`` | +------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+ | :ref:`AmbientMode` | :ref:`ambient_mode` | ``1`` | +------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`box_projection` | ``false`` | +------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`cull_mask` | ``1048575`` | +------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`enable_shadows` | ``false`` | +------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`intensity` | ``1.0`` | +------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+ | :ref:`bool` | :ref:`interior` | ``false`` | +------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`max_distance` | ``0.0`` | +------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+ | :ref:`float` | :ref:`mesh_lod_threshold` | ``1.0`` | +------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+ | :ref:`Vector3` | :ref:`origin_offset` | ``Vector3(0, 0, 0)`` | +------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+ | :ref:`int` | :ref:`reflection_mask` | ``1048575`` | +------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+ | :ref:`Vector3` | :ref:`size` | ``Vector3(20, 20, 20)`` | +------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+ | :ref:`UpdateMode` | :ref:`update_mode` | ``0`` | +------------------------------------------------------+----------------------------------------------------------------------------------+-------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_ReflectionProbe_UpdateMode: .. rst-class:: classref-enumeration enum **UpdateMode**: .. _class_ReflectionProbe_constant_UPDATE_ONCE: .. rst-class:: classref-enumeration-constant :ref:`UpdateMode` **UPDATE_ONCE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_ReflectionProbe_constant_UPDATE_ALWAYS: .. rst-class:: classref-enumeration-constant :ref:`UpdateMode` **UPDATE_ALWAYS** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_ReflectionProbe_AmbientMode: .. rst-class:: classref-enumeration enum **AmbientMode**: .. _class_ReflectionProbe_constant_AMBIENT_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`AmbientMode` **AMBIENT_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_ReflectionProbe_constant_AMBIENT_ENVIRONMENT: .. rst-class:: classref-enumeration-constant :ref:`AmbientMode` **AMBIENT_ENVIRONMENT** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_ReflectionProbe_constant_AMBIENT_COLOR: .. rst-class:: classref-enumeration-constant :ref:`AmbientMode` **AMBIENT_COLOR** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_ReflectionProbe_property_ambient_color: .. rst-class:: classref-property :ref:`Color` **ambient_color** = ``Color(0, 0, 0, 1)`` .. rst-class:: classref-property-setget - void **set_ambient_color** **(** :ref:`Color` value **)** - :ref:`Color` **get_ambient_color** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ReflectionProbe_property_ambient_color_energy: .. rst-class:: classref-property :ref:`float` **ambient_color_energy** = ``1.0`` .. rst-class:: classref-property-setget - void **set_ambient_color_energy** **(** :ref:`float` value **)** - :ref:`float` **get_ambient_color_energy** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ReflectionProbe_property_ambient_mode: .. rst-class:: classref-property :ref:`AmbientMode` **ambient_mode** = ``1`` .. rst-class:: classref-property-setget - void **set_ambient_mode** **(** :ref:`AmbientMode` value **)** - :ref:`AmbientMode` **get_ambient_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ReflectionProbe_property_box_projection: .. rst-class:: classref-property :ref:`bool` **box_projection** = ``false`` .. rst-class:: classref-property-setget - void **set_enable_box_projection** **(** :ref:`bool` value **)** - :ref:`bool` **is_box_projection_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ReflectionProbe_property_cull_mask: .. rst-class:: classref-property :ref:`int` **cull_mask** = ``1048575`` .. rst-class:: classref-property-setget - void **set_cull_mask** **(** :ref:`int` value **)** - :ref:`int` **get_cull_mask** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ReflectionProbe_property_enable_shadows: .. rst-class:: classref-property :ref:`bool` **enable_shadows** = ``false`` .. rst-class:: classref-property-setget - void **set_enable_shadows** **(** :ref:`bool` value **)** - :ref:`bool` **are_shadows_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ReflectionProbe_property_intensity: .. rst-class:: classref-property :ref:`float` **intensity** = ``1.0`` .. rst-class:: classref-property-setget - void **set_intensity** **(** :ref:`float` value **)** - :ref:`float` **get_intensity** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ReflectionProbe_property_interior: .. rst-class:: classref-property :ref:`bool` **interior** = ``false`` .. rst-class:: classref-property-setget - void **set_as_interior** **(** :ref:`bool` value **)** - :ref:`bool` **is_set_as_interior** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ReflectionProbe_property_max_distance: .. rst-class:: classref-property :ref:`float` **max_distance** = ``0.0`` .. rst-class:: classref-property-setget - void **set_max_distance** **(** :ref:`float` value **)** - :ref:`float` **get_max_distance** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ReflectionProbe_property_mesh_lod_threshold: .. rst-class:: classref-property :ref:`float` **mesh_lod_threshold** = ``1.0`` .. rst-class:: classref-property-setget - void **set_mesh_lod_threshold** **(** :ref:`float` value **)** - :ref:`float` **get_mesh_lod_threshold** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ReflectionProbe_property_origin_offset: .. rst-class:: classref-property :ref:`Vector3` **origin_offset** = ``Vector3(0, 0, 0)`` .. rst-class:: classref-property-setget - void **set_origin_offset** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_origin_offset** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ReflectionProbe_property_reflection_mask: .. rst-class:: classref-property :ref:`int` **reflection_mask** = ``1048575`` .. rst-class:: classref-property-setget - void **set_reflection_mask** **(** :ref:`int` value **)** - :ref:`int` **get_reflection_mask** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ReflectionProbe_property_size: .. rst-class:: classref-property :ref:`Vector3` **size** = ``Vector3(20, 20, 20)`` .. rst-class:: classref-property-setget - void **set_size** **(** :ref:`Vector3` value **)** - :ref:`Vector3` **get_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_ReflectionProbe_property_update_mode: .. rst-class:: classref-property :ref:`UpdateMode` **update_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_update_mode** **(** :ref:`UpdateMode` value **)** - :ref:`UpdateMode` **get_update_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`