<doc>
  <legacy_id>1576</legacy_id>
  <name>regular</name>
  <type>keyword</type>
  <syntax>
  </syntax>
  <library></library>
  <objects>
  </objects>
  <synonyms>
    <synonym>regular polygon</synonym>
    <synonym>reg polygon</synonym>
    <synonym>regular poly</synonym>
    <synonym>reg poly</synonym>
  </synonyms>
  <classification>
    <category>Appearance &amp; Positioning</category>
    <category>Developing with LiveCode</category>
  </classification>
  <references>
    <command tag="choose">choose Command</command>
    <property tag="brushColor">brushColor Property</property>
    <property tag="brushPattern">brushPattern Property</property>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
    <ios/>
    <android/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
    <mobile/>
  </classes>
  <security>
  </security>
  <summary>Designates the <glossary tag="paint tool">paint tool</glossary> used to draw <glossary tag="regular polygon">regular polygons</glossary>. It also specifies, through the <property tag="style">style</property> <glossary tag="property">property</glossary>, that a <keyword tag="graphic">graphic</keyword> is a <keyword tag="regular">regular polygon</keyword>.</summary>
  <examples>
    <example>set the style of graphic "All Angles" to regular</example>
    <example>choose regular polygon tool</example>
  </examples>
  <description>
    <p>Use the <b>regular</b> <glossary tag="keyword">keyword</glossary> to paint a <keyword tag="regular">regular polygon</keyword> with the <b>penColor</b> or to change a <keyword tag="graphic">graphic</keyword> to a <keyword tag="regular">regular polygon</keyword> shape.</p><p/><p><b>Comments:</b></p><p>Regular polygons are geometric shapes whose sides are all the same length, such as squares, equilateral triangles, hexagons, and so on. (You set the number of sides with the <b>polySides</b> property.)</p><p/><p>When using the Regular tool, the cursor is a crosshairs shape (over stack windows) or an arrow (anywhere else). This tool is used to draw a polygon in the <b>penColor</b>, filled with the <property tag="brushColor">brushColor</property> (or <property tag="brushPattern">brushPattern</property>). The number of sides is determined by the <command tag="global">global</command> <property tag="polySides">polySides</property> <glossary tag="property">property</glossary>.</p><p/><p>If you try to paint with the Regular tool on a card that has no images, an image the size of the card is created to hold the painting. If the current card already has one or more images, painting outside the image has no effect.</p><p/><p>Setting the <b>style</b> of a <keyword tag="graphic">graphic</keyword> to "regular" makes the <keyword tag="graphic">graphic</keyword> into a <keyword tag="regular">regular polygon</keyword>. <keyword tag="regular">Regular polygon</keyword> <glossary tag="graphic">graphics</glossary>, unlike painted <glossary tag="polygon">polygons</glossary>, can be changed and reshaped: use the <property tag="polySides">polySides</property> <property tag="properties">properties</property> to change the shape.</p><p/><p><code/><img src="202653"/> <b>Important!</b><code/> You can use the synonyms--<code>regular polygon</code>,<code> reg polygon</code>,<code> regular poly</code>, and<code> reg poly</code>--to choose the <b>regular</b> <glossary tag="paint tool">paint tool</glossary>, but not to set a <glossary tag="graphic">graphic's</glossary> <property tag="style">style</property> <glossary tag="property">property</glossary>.</p>
  </description>
</doc>