diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-06-22 01:04:47 +0200 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2019-06-27 22:30:19 +0200 |
| commit | f7f6115f7627df24a08a9a0882b2f573cc838eb1 (patch) | |
| tree | 03fd75145084c88702dbbb7e54c42c7c02d54fa6 /doc/classes/OmniLight.xml | |
| parent | 538c8eec15d72b67e102f47f9df7624c29d14607 (diff) | |
Proofread and improve the whole class reference
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
Diffstat (limited to 'doc/classes/OmniLight.xml')
| -rw-r--r-- | doc/classes/OmniLight.xml | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/classes/OmniLight.xml b/doc/classes/OmniLight.xml index 408018fdcb..b051f62bfb 100644 --- a/doc/classes/OmniLight.xml +++ b/doc/classes/OmniLight.xml @@ -13,10 +13,10 @@ </methods> <members> <member name="omni_attenuation" type="float" setter="set_param" getter="get_param"> - The light's attenuation (drop-off) curve. A number of presets are available in the Inspector. + 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"> - Maximum distance the light affects. + The light's radius. </member> <member name="omni_shadow_detail" type="int" setter="set_shadow_detail" getter="get_shadow_detail" enum="OmniLight.ShadowDetail"> See [enum ShadowDetail]. @@ -27,8 +27,10 @@ </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> <constant name="SHADOW_DETAIL_VERTICAL" value="0" enum="ShadowDetail"> </constant> |