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
Extends
Classes
Members
(static) defaultOptions :SpriteOptions
Type:
- SpriteOptions
- Source
(static) events :SpriteEvents
Type:
- SpriteEvents
- Source
Methods
(static) from(definition) → {Sprite}
Parameters:
| Name | Type | Description |
|---|---|---|
definition | Object |
- Source
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
Returns:
- Type:
- Spritesheet
pause() → {Sprite}
Put the sprite on pause
- Source
Returns:
Itself
- Type:
- Sprite
play(speedopt) → {Sprite}
Play the sprite animation
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
speed | Number | <optional> | Choose a play speed |
- Source
Returns:
Itself
- Type:
- Sprite
setFrame(frame) → {Sprite}
Parameters:
| Name | Type | Description |
|---|---|---|
frame | Number | Number of the frame to set |
- Source
Returns:
Itself
- Type:
- Sprite
Type Definitions
Frame
Type:
Properties- Object
| Name | Type | Description |
|---|---|---|
x | Number | Horizontal position |
y | Number | Vertical position |
w | Number | Width |
h | Number | Height |
- Source
FrameData
Type:
Properties- Object
| Name | Type | Description |
|---|---|---|
frame | Frame | Data about this frame in the sprite-sheet |
spriteSourceSize | Frame | Data about the original file |
- Source
SpriteEvents
Type:
Properties- Object
| Name | Type | Description |
|---|---|---|
start | String | |
frame | String | |
end | String |
- Source
SpriteOptions
Type:
Properties- Object
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
speed | Number | <optional> | 1 | |
loop | Boolean | <optional> | true |
- Source