Tint

Summary

The Tint effect colours an asset.

In most cases, the Enabled parameter is used to toggle the colour on and off based on a condition.

Parameters

ColourA

Type: Colour Bindable Default: 1,0,0,1

The primary colour for the object to turn. If Flashrate is 0, this colour will not change over time.

ColourB

Type: Colour Bindable Default: 0,1,0,1

The secondary colour for the object to turn. If Flashrate is a number other than 0, the asset will change colours between ColourA and ColourB flashrate times per second.

FlashRate

Type: Float Bindable Default: 0

If this value is a number other than zero, the asset will regularly change colours between ColourA and ColourB flashrate times every second.

This property also supports the Standard Effect Properties.

Examples

<tint coloura="1,0,0,1"/>
The object appears red.
<tint coloura="1,0,0,1" colourb="0,1,0,1" flashrate="2"/>
The object flashes between red and green 2 times every second.
<tint coloura="1,0,0,1" colourb="0,1,0,1" flashrate="2"/>
The object flashes between red and green 2 times every second.
<tint coloura="1,0,0,1" colourb="0,1,0,1" flashrate="2" enabled="[Mode|1]"/>
The object flashes between green and red, but only when the value of the 'Mode' property is '1'.