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/SpriteBase3D.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/SpriteBase3D.xml')
-rw-r--r-- | doc/classes/SpriteBase3D.xml | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index 237a8c9d12..b42ba23358 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="SpriteBase3D" inherits="GeometryInstance" category="Core" version="3.2"> <brief_description> - 2D Sprite node in 3D environment. + 2D sprite node in 3D environment. </brief_description> <description> A node that displays 2D texture information in a 3D environment. @@ -50,21 +50,21 @@ The objects visibility on a scale from [code]0[/code] fully invisible to [code]1[/code] fully visible. </member> <member name="pixel_size" type="float" setter="set_pixel_size" getter="get_pixel_size"> - The size of one pixel's width on the Sprite to scale it in 3D. + The size of one pixel's width on the sprite to scale it in 3D. </member> <member name="shaded" type="bool" setter="set_draw_flag" getter="get_draw_flag"> - If [code]true[/code], the [Light] in the [Environment] has effects on the Sprite. Default value: [code]false[/code]. + If [code]true[/code], the [Light] in the [Environment] has effects on the sprite. Default value: [code]false[/code]. </member> <member name="transparent" type="bool" setter="set_draw_flag" getter="get_draw_flag"> - If [code]true[/code], the texture's transparency and the opacity are used to make those parts of the Sprite invisible. Default value: [code]true[/code]. + If [code]true[/code], the texture's transparency and the opacity are used to make those parts of the sprite invisible. Default value: [code]true[/code]. </member> </members> <constants> <constant name="FLAG_TRANSPARENT" value="0" enum="DrawFlags"> - If set, the texture's transparency and the opacity are used to make those parts of the Sprite invisible. + If set, the texture's transparency and the opacity are used to make those parts of the sprite invisible. </constant> <constant name="FLAG_SHADED" value="1" enum="DrawFlags"> - If set, the Light in the Environment has effects on the Sprite. + If set, lights in the environment affect the sprite. </constant> <constant name="FLAG_DOUBLE_SIDED" value="2" enum="DrawFlags"> If set, texture can be seen from the back as well, if not, it is invisible when looking at it from behind. |