2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-04-01 10:33:56 +00:00
<class name= "ReflectionProbe" inherits= "VisualInstance" category= "Core" version= "3.2" >
2017-09-12 20:42:36 +00:00
<brief_description >
2019-10-08 17:21:21 +00:00
Captures its surroundings to create reflections.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2019-10-08 17:21:21 +00:00
Capture its surroundings as a dual parabolid image, and stores versions of it with increasing levels of blur to simulate different material roughnesses.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
2018-11-05 07:46:27 +00:00
<link > https://docs.godotengine.org/en/latest/tutorials/3d/reflection_probes.html</link>
2017-09-12 20:42:36 +00:00
</tutorials>
<methods >
</methods>
<members >
2019-06-29 10:38:01 +00:00
<member name= "box_projection" type= "bool" setter= "set_enable_box_projection" getter= "is_box_projection_enabled" default= "false" >
2019-10-08 17:21:21 +00:00
If [code]true[/code], enables box projection. This makes reflections look more correct in rectangle-shaped rooms by offsetting the reflection center depending on the camera's location.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "cull_mask" type= "int" setter= "set_cull_mask" getter= "get_cull_mask" default= "1048575" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "enable_shadows" type= "bool" setter= "set_enable_shadows" getter= "are_shadows_enabled" default= "false" >
2019-10-08 17:21:21 +00:00
If [code]true[/code], computes shadows in the reflection probe. This makes the reflection probe slower to render; you may want to disable this if using the [constant UPDATE_ALWAYS] [member update_mode].
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "extents" type= "Vector3" setter= "set_extents" getter= "get_extents" default= "Vector3( 1, 1, 1 )" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "intensity" type= "float" setter= "set_intensity" getter= "get_intensity" default= "1.0" >
2019-10-08 17:21:21 +00:00
Defines the reflection intensity.
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "interior_ambient_color" type= "Color" setter= "set_interior_ambient" getter= "get_interior_ambient" default= "Color( 0, 0, 0, 1 )" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "interior_ambient_contrib" type= "float" setter= "set_interior_ambient_probe_contribution" getter= "get_interior_ambient_probe_contribution" default= "0.0" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "interior_ambient_energy" type= "float" setter= "set_interior_ambient_energy" getter= "get_interior_ambient_energy" default= "1.0" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "interior_enable" type= "bool" setter= "set_as_interior" getter= "is_set_as_interior" default= "false" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "max_distance" type= "float" setter= "set_max_distance" getter= "get_max_distance" default= "0.0" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "origin_offset" type= "Vector3" setter= "set_origin_offset" getter= "get_origin_offset" default= "Vector3( 0, 0, 0 )" >
2017-09-12 20:42:36 +00:00
</member>
2019-06-29 10:38:01 +00:00
<member name= "update_mode" type= "int" setter= "set_update_mode" getter= "get_update_mode" enum= "ReflectionProbe.UpdateMode" default= "0" >
2017-09-12 20:42:36 +00:00
</member>
</members>
<constants >
2017-11-24 22:16:30 +00:00
<constant name= "UPDATE_ONCE" value= "0" enum= "UpdateMode" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "UPDATE_ALWAYS" value= "1" enum= "UpdateMode" >
2017-09-12 20:42:36 +00:00
</constant>
</constants>
</class>