Difference between revisions of "ParticleSystem:setColors"

(Added note about argument limits)
(Added variant that takes tables.)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
{{newin|[[0.8.0]]|080|type=function}}
+
{{newin|[[0.8.0]]|080|type=function|text=It has replaced [[ParticleSystem:setColor]]}}
−
Sets a series of colors to apply to the particle sprite. The particle system will interpolate between each color evenly over the particle's lifetime. Color modulation needs to be activated for this function to have any effect.
+
Sets a series of colors to apply to the particle sprite. The particle system will interpolate between each color evenly over the particle's lifetime.
 +
 
 +
Arguments can be passed in groups of four, representing the components of the desired RGBA value, or as tables of RGBA component values, with a default alpha value of 1 if only three values are given. At least one color must be specified. A maximum of eight may be used.
 +
 
 +
In versions prior to [[11.0]], color component values were within the range of 0 to 255 instead of 0 to 1.
  
−
Arguments are passed in groups of four, representing the components of the desired RGBA value. At least one color must be specified. A maximum of eight may be used.
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 9: Line 12:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
−
{{param|number|r1|First color, red component (0-255).}}
+
{{param|number|r1|First color, red component (0-1).}}
−
{{param|number|g1|First color, green component (0-255).}}
+
{{param|number|g1|First color, green component (0-1).}}
−
{{param|number|b1|First color, blue component (0-255).}}
+
{{param|number|b1|First color, blue component (0-1).}}
−
{{param|number|a1|First color, alpha component (0-255).}}
+
{{param|number|a1|First color, alpha component (0-1).}}
−
{{param|number|r2|Second color, red component (0-255).}}
+
{{param|number|r2|Second color, red component (0-1).}}
−
{{param|number|g2|Second color, green component (0-255).}}
+
{{param|number|g2|Second color, green component (0-1).}}
−
{{param|number|b2|Second color, blue component (0-255).}}
+
{{param|number|b2|Second color, blue component (0-1).}}
−
{{param|number|a2|Second color, alpha component (0-255).}}
+
{{param|number|a2|Second color, alpha component (0-1).}}
−
{{param|number|r8|Eighth color, red component (0-255).}}
+
{{param|number|r8|Eighth color, red component (0-1).}}
−
{{param|number|g8|Eighth color, green component (0-255).}}
+
{{param|number|g8|Eighth color, green component (0-1).}}
−
{{param|number|b8|Eighth color, blue component (0-255).}}
+
{{param|number|b8|Eighth color, blue component (0-1).}}
−
{{param|number|a8|Eighth color, alpha component (0-255).}}
+
{{param|number|a8|Eighth color, alpha component (0-1).}}
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
 +
== Function ==
 +
{{newin|[[0.9.0]]|090|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
ParticleSystem:setColors( rgba1, rgba2, ..., rgba8 )
 +
</source>
 +
=== Arguments ===
 +
{{param|table|rgba1|First color, a numerical indexed table with the red, green, blue and alpha values as numbers (0-1). The alpha is optional and defaults to 1 if it is left out.}}
 +
{{param|table|rgba2|Second color, a numerical indexed table with the red, green, blue and alpha values as numbers (0-1). The alpha is optional and defaults to 1 if it is left out.}}
 +
{{param|table|rgba8|Eighth color, a numerical indexed table with the red, green, blue and alpha values as numbers (0-1). The alpha is optional and defaults to 1 if it is left out.}}
 +
=== Returns ===
 +
Nothing.
 +
 
== See Also ==
 
== See Also ==
 
* [[parent::ParticleSystem]]
 
* [[parent::ParticleSystem]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Sets the colors to apply to the particle sprite.}}
 
{{#set:Description=Sets the colors to apply to the particle sprite.}}
−
{{#set:Since=080}}
 
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|ParticleSystem:setColors}}
 
{{i18n|ParticleSystem:setColors}}

Latest revision as of 15:47, 17 May 2020

Available since LÖVE 0.8.0
It has replaced ParticleSystem:setColor.

Sets a series of colors to apply to the particle sprite. The particle system will interpolate between each color evenly over the particle's lifetime.

Arguments can be passed in groups of four, representing the components of the desired RGBA value, or as tables of RGBA component values, with a default alpha value of 1 if only three values are given. At least one color must be specified. A maximum of eight may be used.

In versions prior to 11.0, color component values were within the range of 0 to 255 instead of 0 to 1.

Function

Synopsis

ParticleSystem:setColors( r1, g1, b1, a1, r2, g2, b2, a2, ..., r8, g8, b8, a8 )

Arguments

number r1
First color, red component (0-1).
number g1
First color, green component (0-1).
number b1
First color, blue component (0-1).
number a1
First color, alpha component (0-1).
number r2
Second color, red component (0-1).
number g2
Second color, green component (0-1).
number b2
Second color, blue component (0-1).
number a2
Second color, alpha component (0-1).
number r8
Eighth color, red component (0-1).
number g8
Eighth color, green component (0-1).
number b8
Eighth color, blue component (0-1).
number a8
Eighth color, alpha component (0-1).

Returns

Nothing.

Function

Available since LÖVE 0.9.0
This variant is not supported in earlier versions.

Synopsis

ParticleSystem:setColors( rgba1, rgba2, ..., rgba8 )

Arguments

table rgba1
First color, a numerical indexed table with the red, green, blue and alpha values as numbers (0-1). The alpha is optional and defaults to 1 if it is left out.
table rgba2
Second color, a numerical indexed table with the red, green, blue and alpha values as numbers (0-1). The alpha is optional and defaults to 1 if it is left out.
table rgba8
Eighth color, a numerical indexed table with the red, green, blue and alpha values as numbers (0-1). The alpha is optional and defaults to 1 if it is left out.

Returns

Nothing.

See Also

Other Languages

Dansk – Deutsch – English – Español – Français – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Polski – Português – Română – Slovenský – Suomi – Svenska – Türkçe – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – ไทย – 日本語 – 正體中文 – 简体中文 – Tiếng Việt – 한국어
More info

Retrieved from "https://love2d.org./w/index.php?title=ParticleSystem:setColors&oldid=25354"