godot-docs/classes/class_reflectionprobe.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ReflectionProbe.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_ReflectionProbe:

ReflectionProbe
===============

**Inherits:** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------



Properties
----------

+----------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                            | :ref:`box_projection<class_ReflectionProbe_property_box_projection>`                     |
+----------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                              | :ref:`cull_mask<class_ReflectionProbe_property_cull_mask>`                               |
+----------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                            | :ref:`enable_shadows<class_ReflectionProbe_property_enable_shadows>`                     |
+----------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>`                      | :ref:`extents<class_ReflectionProbe_property_extents>`                                   |
+----------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                          | :ref:`intensity<class_ReflectionProbe_property_intensity>`                               |
+----------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`                          | :ref:`interior_ambient_color<class_ReflectionProbe_property_interior_ambient_color>`     |
+----------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                          | :ref:`interior_ambient_contrib<class_ReflectionProbe_property_interior_ambient_contrib>` |
+----------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                          | :ref:`interior_ambient_energy<class_ReflectionProbe_property_interior_ambient_energy>`   |
+----------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                            | :ref:`interior_enable<class_ReflectionProbe_property_interior_enable>`                   |
+----------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`                          | :ref:`max_distance<class_ReflectionProbe_property_max_distance>`                         |
+----------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>`                      | :ref:`origin_offset<class_ReflectionProbe_property_origin_offset>`                       |
+----------------------------------------------------+------------------------------------------------------------------------------------------+
| :ref:`UpdateMode<enum_ReflectionProbe_UpdateMode>` | :ref:`update_mode<class_ReflectionProbe_property_update_mode>`                           |
+----------------------------------------------------+------------------------------------------------------------------------------------------+

Enumerations
------------

.. _enum_ReflectionProbe_UpdateMode:

.. _class_ReflectionProbe_constant_UPDATE_ONCE:

.. _class_ReflectionProbe_constant_UPDATE_ALWAYS:

enum **UpdateMode**:

- **UPDATE_ONCE** = **0**

- **UPDATE_ALWAYS** = **1**

Tutorials
---------

- :doc:`../tutorials/3d/reflection_probes`

Property Descriptions
---------------------

.. _class_ReflectionProbe_property_box_projection:

- :ref:`bool<class_bool>` **box_projection**

+----------+----------------------------------+
| *Setter* | set_enable_box_projection(value) |
+----------+----------------------------------+
| *Getter* | is_box_projection_enabled()      |
+----------+----------------------------------+

.. _class_ReflectionProbe_property_cull_mask:

- :ref:`int<class_int>` **cull_mask**

+----------+----------------------+
| *Setter* | set_cull_mask(value) |
+----------+----------------------+
| *Getter* | get_cull_mask()      |
+----------+----------------------+

.. _class_ReflectionProbe_property_enable_shadows:

- :ref:`bool<class_bool>` **enable_shadows**

+----------+---------------------------+
| *Setter* | set_enable_shadows(value) |
+----------+---------------------------+
| *Getter* | are_shadows_enabled()     |
+----------+---------------------------+

.. _class_ReflectionProbe_property_extents:

- :ref:`Vector3<class_Vector3>` **extents**

+----------+--------------------+
| *Setter* | set_extents(value) |
+----------+--------------------+
| *Getter* | get_extents()      |
+----------+--------------------+

.. _class_ReflectionProbe_property_intensity:

- :ref:`float<class_float>` **intensity**

+----------+----------------------+
| *Setter* | set_intensity(value) |
+----------+----------------------+
| *Getter* | get_intensity()      |
+----------+----------------------+

.. _class_ReflectionProbe_property_interior_ambient_color:

- :ref:`Color<class_Color>` **interior_ambient_color**

+----------+-----------------------------+
| *Setter* | set_interior_ambient(value) |
+----------+-----------------------------+
| *Getter* | get_interior_ambient()      |
+----------+-----------------------------+

.. _class_ReflectionProbe_property_interior_ambient_contrib:

- :ref:`float<class_float>` **interior_ambient_contrib**

+----------+------------------------------------------------+
| *Setter* | set_interior_ambient_probe_contribution(value) |
+----------+------------------------------------------------+
| *Getter* | get_interior_ambient_probe_contribution()      |
+----------+------------------------------------------------+

.. _class_ReflectionProbe_property_interior_ambient_energy:

- :ref:`float<class_float>` **interior_ambient_energy**

+----------+------------------------------------+
| *Setter* | set_interior_ambient_energy(value) |
+----------+------------------------------------+
| *Getter* | get_interior_ambient_energy()      |
+----------+------------------------------------+

.. _class_ReflectionProbe_property_interior_enable:

- :ref:`bool<class_bool>` **interior_enable**

+----------+------------------------+
| *Setter* | set_as_interior(value) |
+----------+------------------------+
| *Getter* | is_set_as_interior()   |
+----------+------------------------+

.. _class_ReflectionProbe_property_max_distance:

- :ref:`float<class_float>` **max_distance**

+----------+-------------------------+
| *Setter* | set_max_distance(value) |
+----------+-------------------------+
| *Getter* | get_max_distance()      |
+----------+-------------------------+

.. _class_ReflectionProbe_property_origin_offset:

- :ref:`Vector3<class_Vector3>` **origin_offset**

+----------+--------------------------+
| *Setter* | set_origin_offset(value) |
+----------+--------------------------+
| *Getter* | get_origin_offset()      |
+----------+--------------------------+

.. _class_ReflectionProbe_property_update_mode:

- :ref:`UpdateMode<enum_ReflectionProbe_UpdateMode>` **update_mode**

+----------+------------------------+
| *Setter* | set_update_mode(value) |
+----------+------------------------+
| *Getter* | get_update_mode()      |
+----------+------------------------+