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/BakedLightmap.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/BakedLightmap.xml')
| -rw-r--r-- | doc/classes/BakedLightmap.xml | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/classes/BakedLightmap.xml b/doc/classes/BakedLightmap.xml index 735e55cd39..af9666b6e4 100644 --- a/doc/classes/BakedLightmap.xml +++ b/doc/classes/BakedLightmap.xml @@ -34,10 +34,10 @@ <member name="bake_energy" type="float" setter="set_energy" getter="get_energy"> </member> <member name="bake_extents" type="Vector3" setter="set_extents" getter="get_extents"> - Size of affected area. + The size of the affected area. </member> <member name="bake_hdr" type="bool" setter="set_hdr" getter="is_hdr"> - If [code]true[/code], lightmap can capture light values greater than [code]1.0[/code]. Turning this off will result in a smaller lightmap. Default value:[code]false[/code]. + If [code]true[/code], the lightmap can capture light values greater than [code]1.0[/code]. Turning this off will result in a smaller file size. Default value: [code]false[/code]. </member> <member name="bake_mode" type="int" setter="set_bake_mode" getter="get_bake_mode" enum="BakedLightmap.BakeMode"> Lightmapping mode. See [enum BakeMode]. @@ -51,7 +51,7 @@ Grid size used for real-time capture information on dynamic objects. Cannot be larger than [member bake_cell_size]. </member> <member name="image_path" type="String" setter="set_image_path" getter="get_image_path"> - Location where lightmaps will be saved. + The location where lightmaps will be saved. </member> <member name="light_data" type="BakedLightmapData" setter="set_light_data" getter="get_light_data"> The calculated light data. @@ -59,13 +59,13 @@ </members> <constants> <constant name="BAKE_QUALITY_LOW" value="0" enum="BakeQuality"> - Lowest bake quality mode. Fastest to calculate. + The lowest bake quality mode. Fastest to calculate. </constant> <constant name="BAKE_QUALITY_MEDIUM" value="1" enum="BakeQuality"> - Default bake quality mode. + The default bake quality mode. </constant> <constant name="BAKE_QUALITY_HIGH" value="2" enum="BakeQuality"> - Highest bake quality mode. Takes longer to calculate. + The highest bake quality mode. Takes longer to calculate. </constant> <constant name="BAKE_MODE_CONE_TRACE" value="0" enum="BakeMode"> Less precise but faster bake mode. |