<doc>
  <legacy_id>1610</legacy_id>
  <name>spray</name>
  <type>property</type>
  <syntax>
    <example>set the spray to {<i>brushID </i>| <i>imageID</i>}</example>
  </syntax>
  <library></library>
  <objects>
    <global/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Developing with LiveCode</category>
  </classification>
  <references>
    <command tag="choose">choose Command</command>
    <property tag="brush">brush Property</property>
    <property tag="eraser">eraser Property</property>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
  </classes>
  <security>
  </security>
  <summary>Specifies the shape used for painting with the Spray Can <function tag="tool">tool</function>.</summary>
  <examples>
    <example>set the spray to 30</example>
  </examples>
  <description>
    <p>Use the <b>spray</b> <glossary tag="property">property</glossary> to specify which shape is painted by the Spray Can <function tag="tool">tool</function>.</p><p/><p><b>Value:</b></p><p>The <b>spray</b> is a brush specifier.</p><p/><p>A <i>brushID</i> is a built-in brush number between 1 and 100. (These brushes correspond to LiveCode's built-in patterns 100 to 135.)</p><p/><p>An <i>imageID</i> is the ID of an <keyword tag="image">image</keyword> to use for painting with the spray can. LiveCode looks for the specified <keyword tag="image">image</keyword> first in the <glossary tag="current stack">current stack</glossary>, then in other open <function tag="stacks">stacks</function>.</p><p/><p>By default, the <b>spray</b> is set to 34 (a round splatter pattern).</p><p/><p><b>Comments:</b></p><p>The entire painted area of the brush is used as the spray can shape. The shape painted by the spray can is drawn in the <b>brushColor</b>, regardless of what colors might be in the <keyword tag="image">image</keyword> used for the spray can shape.</p><p/><p>When the Spray Can tool is in use, the cursor is the same as the spray can shape. You can use any size image as a spray can, but the cursor may appear distorted on some systems if the image is not 16x16 pixels.</p>
  </description>
</doc>