summaryrefslogtreecommitdiff
path: root/doc/base
diff options
context:
space:
mode:
authorBrickcaster <dralon@yahoo.com>2015-10-25 10:58:38 -0400
committerBrickcaster <dralon@yahoo.com>2015-11-01 20:58:06 -0500
commit18964798b77c3a2c47078a22664d8851e50bbca6 (patch)
tree0b5f5ee8d1b415f919a393cc8ad29456dd321e52 /doc/base
parent44057ed4aec3e8a04a71dcc1bebeb20e43809eb7 (diff)
classes/color - Documenting a trick with set_modulate
I wanted to document a trick using class color to highlight a sprite.
Diffstat (limited to 'doc/base')
-rw-r--r--doc/base/classes.xml4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 32115e604a..a26931d5aa 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -7291,7 +7291,7 @@
Color in RGBA format.
</brief_description>
<description>
- A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point, ranging from 0 to 1.
+ A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some methods (such as set_modulate() ) may accept values > 1.
</description>
<methods>
<method name="blend">
@@ -31619,7 +31619,7 @@
<argument index="0" name="modulate" type="Color">
</argument>
<description>
- Set color modulation for the sprite. All sprite pixels are multiplied by this color.
+ Set color modulation for the sprite. All sprite pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect.
</description>
</method>
<method name="get_modulate" qualifiers="const">