<doc>
  <legacy_id>3529</legacy_id>
  <name>colorOverlay</name>
  <type>property</type>
  <syntax>
    <example>set the colorOverlay of object to <i>propertiesArray</i></example>
    <example>set the colorOverlay[<i>propertyName</i>] of object to <i>propertyValue</i></example>
  </syntax>
  <library></library>
  <objects>
    <group/>
    <field/>
    <button/>
    <graphic/>
    <scrollbar/>
    <player/>
    <image/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
  </classification>
  <references>
    <property tag="innerGlow">innerGlow Property</property>
    <property tag="innerShadow">innerShadow Property</property>
    <property tag="dropShadow">dropShadow Property</property>
    <property tag="outerGlow">outerGlow Property</property>
    <property tag="blendLevel">blendLevel Property</property>
    <property tag="ink">ink Property</property>
  </references>
  <history>
    <introduced version="4.0.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
    <ios/>
    <android/>
  </platforms>
  <classes>
    <desktop/>
    <web/>
    <mobile/>
  </classes>
  <security>
  </security>
  <summary>Specifies the color overlay to use for an object.</summary>
  <examples>
    <example>set the colorOverlay of button "Ok" to tOverlayPropertiesArray</example>
    <example>set the colorOverlay["color"] of me to "255,0,0"</example>
  </examples>
  <description>
    <p>Use the <b>colorOverlay</b> property to overlay a flat color on an object. The <b>colorOverlay</b> is an array style property, each key of the array controls a different <b>colorOverlay</b> parameter that will affect its final appearance. The easiest way to adjust these properties is by using the Graphic Effects card of the property inspector which has full control over each parameter. To control the effect by script use the following properties:</p>
<p></p>
<p>colorOverlay[&quot;<b>color</b>&quot;]</p>
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The color of the overlay, in the format red,green,blue where each value is between 0 and 255.</p>
<p></p>
<p>colorOverlay[&quot;<b>blendMode</b>&quot;]</p>
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;How the overlay is blended with the object. This is one of the following values:</p>
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;- &quot;normal&quot; : the glow is laid directly over the object.</p>
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;- &quot;multiply&quot; : this results in a darkening effect</p>
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;- &quot;colorDodge&quot; : this results in a lightening effect</p>
<p></p>
<p>colorOverlay[&quot;<b>opacity</b>&quot;]</p>
<p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;How opaque the overlay is. The value is between 0 (fully transparent) and 255 (fully opaque).</p>
  </description>
</doc>