Meta_ReflectionProbe
A ReflectionProbe represents a local skybox providing dynamic reflections of the surrounding environment.
These are positioned in the scene by adding them as a child of an Assembly node and transforming that.
Public Types
Property index.
| Idx_Enabled | bool - If enabled, the light probe cubemap will be dynamically updated and used as an environment map on intersecting scene geometry. |
| Idx_Resolution | int - Resolution of each cubemap face. |
| Idx_ProxyType | ProxyType (int) - The type of proxy geometry to use. |
| Idx_ProxySize | vec3f - The world-space size of the light probes proxy geometry, everything inside this geometry will use the light probes cubemap as an environment map. |
| Idx_Shadows | bool - Whether or not to render shadows into the probe. |
| Idx_UpdateMode | UpdateMode (int) - Describes how the probe should update itself. |
| Idx_UpdateAndStoreNow | bool - Transient property used as an event to trigger the manual rendering of the baked texture. Resets back to false after updating. |
| Idx_Texture | link - The custom texture used when Mode==Probe_Custom |
| Idx_Mode | ProbeMode (int) - Whether the probes image is rendered in-engine or comes from an external image file. |
| Idx_BakedTexture | link - The baked texture used when Mode==Probe_Bake |
Values for Idx_Mode.
| Probe_Bake | Render the probe image using the scene geometry. (Symbols - C: "Probe_Bake", Lua: __LightProbe_Probe_Bake) |
| Probe_Custom | Use the Idx_Texture image instead of rendering. (Symbols - C: "Probe_Custom", Lua: __LightProbe_Probe_Custom) |
Values for Idx_ProxyType.
| Proxy_None | No proxy geometry (Symbols - C: "Proxy_None", Lua: __LightProbe_Proxy_None) |
| Proxy_Ellipsoid | Ellipsoid proxy (Symbols - C: "Proxy_Ellipsoid", Lua: __LightProbe_Proxy_Ellipsoid) |
| Proxy_Box | Box proxy (Symbols - C: "Proxy_Box", Lua: __LightProbe_Proxy_Box) |
Values for Idx_UpdateMode.
| Update_Auto | Update when the probe, or something in the scene changes; moves, is enabled/disabled etc. (Symbols - C: "Update_Auto", Lua: __LightProbe_Update_Auto) |
| Update_Always | Continually re-draw the cubemap regardless of whether or not anything changes; useful if the change isn't being picked up. (Symbols - C: "Update_Always", Lua: __LightProbe_Update_Always) |
| Update_Manual | Only update when "UpdateAndStoreNow" property is set to true, which causes it to draw the cubemap and save the result in the texture pointed to by the "Texture" property (it will create one if null), then it sets the "UpdateAndStoreNow" property back to false. On load if this mode is active the probe will just use the content of the linked "Texture". (Symbols - C: "Update_Manual", Lua: __LightProbe_Update_Manual) |