diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-03-30 20:32:11 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-30 20:32:11 +0200 |
| commit | f3c74afd2869859fa117271264e9294d36be16e5 (patch) | |
| tree | 7533def8a2a7fd1a8b52b1fe965c318eb027e781 /doc/classes/OmniLight3D.xml | |
| parent | 6fed21c7cb85c4dd5842d8cb9fc268957a0429fd (diff) | |
| parent | eaaee63b629d6999fcc0c84e38886b964f6d051d (diff) | |
Merge pull request #37436 from akien-mga/doc-node-renames
doc: Update classref with node renames
Diffstat (limited to 'doc/classes/OmniLight3D.xml')
| -rw-r--r-- | doc/classes/OmniLight3D.xml | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/classes/OmniLight3D.xml b/doc/classes/OmniLight3D.xml new file mode 100644 index 0000000000..0bbc987156 --- /dev/null +++ b/doc/classes/OmniLight3D.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="OmniLight3D" inherits="Light3D" version="4.0"> + <brief_description> + Omnidirectional light, such as a light bulb or a candle. + </brief_description> + <description> + An Omnidirectional light is a type of [Light3D] that emits light in all directions. The light is attenuated by distance and this attenuation can be configured by changing its energy, radius, and attenuation parameters. + </description> + <tutorials> + <link>https://docs.godotengine.org/en/latest/tutorials/3d/lights_and_shadows.html</link> + </tutorials> + <methods> + </methods> + <members> + <member name="omni_attenuation" type="float" setter="set_param" getter="get_param" default="1.0"> + The light's attenuation (drop-off) curve. A number of presets are available in the [b]Inspector[/b] by right-clicking the curve. + </member> + <member name="omni_range" type="float" setter="set_param" getter="get_param" default="5.0"> + The light's radius. + </member> + <member name="omni_shadow_mode" type="int" setter="set_shadow_mode" getter="get_shadow_mode" enum="OmniLight3D.ShadowMode" default="1"> + See [enum ShadowMode]. + </member> + </members> + <constants> + <constant name="SHADOW_DUAL_PARABOLOID" value="0" enum="ShadowMode"> + Shadows are rendered to a dual-paraboloid texture. Faster than [constant SHADOW_CUBE], but lower-quality. + </constant> + <constant name="SHADOW_CUBE" value="1" enum="ShadowMode"> + Shadows are rendered to a cubemap. Slower than [constant SHADOW_DUAL_PARABOLOID], but higher-quality. + </constant> + </constants> +</class> |