<doc>
  <legacy_id>1870</legacy_id>
  <name>revStopAnimation</name>
  <type>command</type>
  <syntax>
    <example>revStopAnimation <i>animationName</i></example>
  </syntax>
  <library>Animation library</library>
  <objects>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Images &amp; Multimedia</category>
    <category>Standalone Applications</category>
  </classification>
  <references>
    <command tag="play">play Command</command>
    <command tag="revGoToFramePaused">revGoToFramePaused Command</command>
    <command tag="revPlayAnimation">revPlayAnimation Command</command>
    <command tag="stop">stop Command</command>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
    <removed version="2.5">No longer present.</removed>
  </history>
  <platforms>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
  </classes>
  <security>
  </security>
  <summary>No longer supported and included for backwards compatibility, halts an animation created with the Animation Builder in LiveCode versions older than 2.5.</summary>
  <examples>
    <example>revStopAnimation "Flying Circus"</example>
    <example>revStopAnimation (the animName of the target)</example>
  </examples>
  <description>
    <p>The <b>revStopAnimation</b> command is no longer supported as the Animation Builder was removed in LiveCode 2.5, however it is included for backwards compatibility with older applications that used the Animation Builder.</p><p/><p>Use the <b>revStopAnimation</b> <glossary tag="command">command</glossary> from within a <glossary tag="handler">handler</glossary> that's <glossary tag="trigger">triggered</glossary> by a <glossary tag="key frame">key frame</glossary> to stop the current animation from playing.</p><p/><p><b>Parameters:</b></p><p>The <i>animationName</i> is an <glossary tag="expression">expression</glossary> that <glossary tag="evaluate">evaluates</glossary> to the name of an animation on the <glossary tag="current card">current card</glossary>.</p><p/><p><b>Comments:</b></p><p>Animations were created using the Animation Builder in old versions of LiveCode. The Animation builder is no longer available.</p><p/><p>The <i>animationName</i> must be an animation that was created on the <glossary tag="current card">current card</glossary> of the <property tag="defaultStack">defaultStack</property>.</p><p/><p><img src="202653"/> <b>Important!</b> The <b>revStopAnimation</b> <glossary tag="command">command</glossary> is part of the <glossary tag="Animation library">Animation library</glossary>. To ensure that the <glossary tag="command">command</glossary> works in a <glossary tag="standalone application">standalone application</glossary>, you must include this <glossary tag="LiveCode custom library">custom library</glossary> when you create your <glossary tag="standalone application">standalone</glossary>. In the Inclusions section on the General screen of the <glossary tag="Standalone Application Settings">Standalone Application Settings</glossary> window, make sure that "Animation Library" is selected in the list of script libraries.</p><p/><p><b>Note:</b> When included in a <glossary tag="standalone application">standalone application</glossary>, the <glossary tag="Animation library">Animation library</glossary> is implemented as a hidden <command tag="group">group</command> and made available when the <command tag="group">group</command> receives its first <message tag="openBackground">openBackground</message> message. During the first part of the <glossary tag="application">application's</glossary> startup process, before this <keyword tag="message box">message</keyword> is sent, the <b>revStopAnimation</b> <glossary tag="command">command</glossary> is not yet available. This may affect attempts to use this <glossary tag="command">command</glossary> in <message tag="startup">startup</message>, <message tag="preOpenStack">preOpenStack</message>, <message tag="openStack">openStack</message>, or <message tag="preOpenCard">preOpenCardhandlers</message> in the <glossary tag="main stack">main stack</glossary>. Once the <glossary tag="application">application</glossary> has finished starting up, the <command tag="start using">library</command> is available and the <b>revStopAnimation</b> <glossary tag="command">command</glossary> can be used in any <glossary tag="handler">handler</glossary>.</p>
  </description>
</doc>