====== PLAY method (Animate) ======


 
==== Description ====
 
 
Begins the playback of an animation file.
 
 
 
 
==== Syntax ====
 
<code>
bSuccess = Exec_Method( CtrlEntID,   
                        "PLAY",      
                        Repetitions, 
                        StartFrame,  
                        StopFrame )
 
</code>
 
 
==== Parameters ====
 
 
 
 
 
 
 
^Name^Required^Description^
|Repetitions|No|Specifies the number of times to play the animation.  Defaults to -1.\\ See the [[repetitions_property_animate|REPETITIONS]] property above.|
|StartFrame|No|Specifies the frame number from which to begin playing.  Defaults to 1.\\ See the [[startframe_property_animate|STARTFRAME]] property above.|
|StopFrame|Yes|Specifies the last frame number to display when playing a clip.  Defaults to -1.\\ See the [[stopframe_property_animate|STOPFRAME]] property above.|

 


 
==== Returns ====
 
 
"1" (TRUE$) if the clip was started successfully, "0" (FALSE$) otherwise.
 
 
 
 
==== Remarks ====
 
 
N/A
 
 
 
 
==== Example ====
 
<code>
 
// Example:

   //

   // Open an AVI file called "FileCopyXP.avi" and begin playing

   // from frames 4 to 8, with 10 repetitions

   

   $Insert Logical

   

   Call Set_Property_Only( @Window : ".ANI_COPYING", 

                           "CLIPNAME",               

                           ".\avi\filecopyxp.avi" )

 

   Call Exec_Method( @Window : ".ANI_COPYING", "PLAY", 10, 4, 8 )
 
 
 

</code>

 
==== See Also ====
 
 
N/A