Constructor # new module:Sprite(positionDefinition, url, frames, optionsopt) Sprite constructor Parameters: Name Type Attributes Description positionDefinition PositionDefinition url String frames Array.<FrameData> options SpriteOptions <optional> Drawing options Source: modules/sprite/sprite.js, line 16 Extends module:Image Classes Spritesheet Members # (static) defaultOptions :SpriteOptions Type: SpriteOptions Source: modules/sprite/sprite.js, line 173 # (static) events :SpriteEvents Type: SpriteEvents Source: modules/sprite/sprite.js, line 191 Methods # (static) from(definition) → {Sprite} Parameters: Name Type Description definition Object Source: modules/sprite/sprite.js, line 139 Returns: Type Sprite # (async, static) sheet(url) → {Spritesheet} Load and return a spritesheet json file Parameters: Name Type Description url String Url to the file Source: modules/sprite/sprite.js, line 154 Returns: Type Spritesheet # pause() → {Sprite} Put the sprite on pause Source: modules/sprite/sprite.js, line 106 Returns: Itself Type Sprite # play(speedopt) → {Sprite} Play the sprite animation Parameters: Name Type Attributes Description speed Number <optional> Choose a play speed Source: modules/sprite/sprite.js, line 94 Returns: Itself Type Sprite # setFrame(frame) → {Sprite} Parameters: Name Type Description frame Number Number of the frame to set Source: modules/sprite/sprite.js, line 116 Returns: Itself Type Sprite Type Definitions # Frame Type: Object Properties Name Type Description x Number Horizontal position y Number Vertical position w Number Width h Number Height Source: modules/sprite/sprite.js, line 17 # FrameData Type: Object Properties Name Type Description frame Frame Data about this frame in the sprite-sheet spriteSourceSize Frame Data about the original file Source: modules/sprite/sprite.js, line 24 # SpriteEvents Type: Object Properties Name Type Description start String frame String end String Source: modules/sprite/sprite.js, line 181 # SpriteOptions Type: Object Properties Name Type Attributes Default Description speed Number <optional> 1 loop Boolean <optional> true Source: modules/sprite/sprite.js, line 164