Sprite

new Sprite(x: number, y: number, settings: object) → {}

 // create a single sprite from a standalone image, with anchor in the center
 let sprite = new me.Sprite(0, 0, {
     image : "PlayerTexture",
     framewidth : 64,
     frameheight : 64,
     anchorPoint : new me.Vector2d(0.5, 0.5)
 });

 // create a single sprite from a packed texture
 mytexture = new me.TextureAtlas(
     me.loader.getJSON("texture"),
     me.loader.getImage("texture")
 );
 let sprite = new me.Sprite(0, 0, {
     image : mytexture,
     region : "npc2.png",
 });

 // create a video sprite
 let videoSprite = new me.Sprite(0, 0, {
     image : me.loader.getVideo("bigbunny"),
     anchorPoint : new me.Vector2d(0.5, 0.5)
 });
 // scale the video sprite
 videoSprite.currentTransform.scale(2);
 // start playing the video (if video is preloaded with `autoplay` set to false)
 videoSprite.play();

animationpause sprite.js:62

animationpause: boolean = false

boolean

animationspeed sprite.js:68

animationspeed: number = 100

number

isVideo sprite.js:82

isVideo: boolean = false

boolean

offset sprite.js:75

offset: Vector2d = <0.0,0.0>

Vector2d

source sprite.js:96

source: TextureAtlas = undefined

TextureAtlas

addAnimation sprite.js:302

addAnimation(name: string, index: Array<number> | Array<string> | Array<object>, animationspeed: number) → {number}

// walking animation
this.addAnimation("walk", [ 0, 1, 2, 3, 4, 5 ]);
// standing animation
this.addAnimation("stand", [ 11, 12 ]);
// eating animation
this.addAnimation("eat", [ 6, 6 ]);
// rolling animation
this.addAnimation("roll", [ 7, 8, 9, 10 ]);
// slower animation
this.addAnimation("roll", [ 7, 8, 9, 10 ], 200);
// or get more specific with delay for each frame. Good solution instead of repeating:
this.addAnimation("turn", [{ name: 0, delay: 200 }, { name: 1, delay: 100 }])
// can do this with atlas values as well:
this.addAnimation("turn", [{ name: "turnone", delay: 200 }, { name: "turntwo", delay: 100 }])
// define an dying animation that stop on the last frame
this.addAnimation("die", [{ name: 3, delay: 200 }, { name: 4, delay: 100 }, { name: 5, delay: Infinity }])
// set the standing animation as default
this.setCurrentAnimation("stand");

flicker sprite.js:277

flicker(duration: number, callback: Function) → {Sprite}

// make the object flicker for 1 second
// and then remove it
this.flicker(1000, function () {
    world.removeChild(this);
});

getCurrentAnimationFrame sprite.js:535

getCurrentAnimationFrame() → {number}

isCurrentAnimation sprite.js:477

isCurrentAnimation(name: string) → {boolean}

if (!this.isCurrentAnimation("walk")) {
    // do something funny...
}

isFlickering sprite.js:255

isFlickering() → {boolean}

pause sprite.js:270

pause() → {}

play sprite.js:263

play() → {}

reverseAnimation sprite.js:461

reverseAnimation(name: string) → {Sprite}

setAnimationFrame sprite.js:522

setAnimationFrame(index: number) → {Sprite}

// reset the current animation to the first frame
this.setAnimationFrame();

setCurrentAnimation sprite.js:400

setCurrentAnimation(name: string, resetAnim: string | Function, preserve_dt: boolean) → {Sprite}

 // set "walk" animation
 this.setCurrentAnimation("walk");

 // set "walk" animation if it is not the current animation
 if (this.isCurrentAnimation("walk")) {
     this.setCurrentAnimation("walk");
 }

 // set "eat" animation, and switch to "walk" when complete
 this.setCurrentAnimation("eat", "walk");

 // set "die" animation, and remove the object when finished
 this.setCurrentAnimation("die", () => {
    world.removeChild(this);
    return false; // do not reset to first frame
 });

 // set "attack" animation, and pause for a short duration
 this.setCurrentAnimation("die", () => {
    this.animationpause = true;

    // back to "standing" animation after 1 second
    setTimeout(function () {
        this.setCurrentAnimation("standing");
    }, 1000);

    return false; // do not reset to first frame
 });

setRegion sprite.js:490

setRegion(region: object) → {Sprite}

// change the sprite to "shadedDark13.png";
mySprite.setRegion(mytexture.getRegion("shadedDark13.png"));

draw sprite.js:619

protected draw(renderer: CanvasRenderer | WebGLRenderer, viewport: Camera2d) → {}

update sprite.js:553

protected update(dt: number) → {boolean}