<?xml version='1.0'?>
<?xml:stylesheet type="text/xsl" href="function.xsl" ?>
<function-list>
  <function>
    <name>SpriteFrameRate Property</name>
    <description>Defines how often a sprite's frame changes.</description>
    <syntax>Game1.SpriteFrameRate(lSpriteNum)[=iValue]</syntax>
    <param-list>
      <param>
        <name>lSpriteNum</name>
	    <description>Long. A unique Sprite ID used in call to SpriteDefine. </description>
      </param>
      <param>
        <name>iValue</name>
	    <description>Integer. The number of TimerFired events (displayed frames) to wait between frame changes.</description>
      </param>
    </param-list>
	<remarks>Setting this property makes a sprite increment it's frames at a specified interval. Use in conjunction with SpriteSetFrameRange to set detailed animation properties of a sprite.</remarks>
	<example>
' set up a sprite to "slowly" animate through frames 64 to 71, then stop.
' each sprite frame change will stay 10 game frames before changing.
Game1.SpriteSetFrameRange SPRITE_BUG, 64, 71, False
Game1.SpriteFrameRate(SPRITE_BUG) = 10

	</example>
  </function>
</function-list>
