Smartface Native Framework extension to display sprites via sprite sheets.
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
sample Using sf-core instead of nf-core May 1, 2017
.npmignore add npmignore. May 12, 2017
CODE_OF_CONDUCT.md add code_of_conduct. Apr 10, 2017
LICENSE
README.md Update README.md Aug 11, 2018
braid.gif
index.js Using sf-core instead of nf-core May 1, 2017
package.json update npm version. May 12, 2017

README.md

SpriteView Extension from Smartface

Twitter: @Smartface_io License

An extension to make sprite animations with Smartface Native Framework.

Installation

SpriteView can be installed via npm easily from our public npm repository. The installation is pretty easy via Smartface Cloud IDE.

  • Run command (cd ~/workspace/scripts && npm i -S sf-extension-spriteview)
  • Require the extension as: require("sf-extension-spriteview")

How to use

SpriteView is nothing but an ImageView with additional methods. Since it extends ImageView, you can add it inside layouts.

  1. Put the sprite sheet under the folder images on the Cloud IDE.
  2. Set the sheet to the SpriteView object as:
spriteObject.setSprite({
	sheet: Image.createFromFile("images://spritesheet.png"),
	frameX: << #frames in axis-X >>, // Number
	frameY: << #frames in axis-Y >>, // Number
	frameCount: << #frames in the sheet >> // Number
});
  1. Finally you must make the sprite play by using:
spriteObject.play(<< loop duration in ms >>); // Number

Sample

The folder sample holds the example codes and the sprite sheet. You can put them into your workspace and start using it.

Need Help?

Please submit an issue on GitHub and provide information about your problem.

Support & Documentation & Useful Links

Code of Conduct

We are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. Please read and follow our Code of Conduct.

License

This project is licensed under the terms of the MIT license. See the LICENSE file. Within the scope of this license, all modifications to the source code, regardless of the fact that it is used commercially or not, shall be committed as a contribution back to this repository.