com.codingame.gameengine.module.entities.SpriteAnimation Maven / Gradle / Ivy

Go to download
package com.codingame.gameengine.module.entities;

import java.util.stream.Collectors;
import java.util.stream.Stream;

import com.google.inject.Inject;

/**
 * A SpriteAnimation is a graphical entity which displays a sequence of images. You can use this class to animate a sprite based on
 * milliseconds, rather than frame time.
 */
public class SpriteAnimation extends TextureBasedEntity implements Mask {

    @Inject GraphicEntityModule entityModule;

    private int RESTART_INDEX = 0;

    private String[] images = new String[] {};

    private boolean loop;
    private boolean playing = true;
    private int duration = 1000;

    SpriteAnimation() {
        super();
    }

    @Override
    Entity.Type getType() {
        return Entity.Type.SPRITEANIMATION;
    }

    private static void requireValidDuration(int duration) {
        if (duration < 0) {
            throw new IllegalArgumentException("Invalid duration: " + duration + "ms");
        }
    }

    /**
     * Returns whether the animation is flagged to have the graphical counterpart play the animation or to pause it.
     * 
     * Default is true.
     * 
     * 
     * @return true if the animation is playing.
     * 
     */
    public boolean isPlaying() {
        return playing;
    }

    /**
     * Plays or pause the animation
     * 
     * @param playing
     *            true to play animation, false to pause animation
     * @return this animation.
     */
    public SpriteAnimation setPlaying(boolean playing) {
        this.playing = playing;
        set("playing", playing, null);
        return this;
    }

    /**
     * Reset the progress of the animation
     * 
     * @return this animation.
     */
    public SpriteAnimation reset() {
        set("restarted", RESTART_INDEX++, null);
        return this;
    }

    /**
     * Calls setPlaying(true);
     * 
     * @return this animation.
     */
    public SpriteAnimation play() {
        return setPlaying(true);
    }

    /**
     * Calls setPlaying(false);
     * 
     * @return this animation.
     */
    public SpriteAnimation pause() {
        return setPlaying(false);
    }

    /**
     * Returns whether the animation should loop.
     * 
     * Default is false.
     * 
     * 
     * @return true if the animation loops.
     * 
     */
    public boolean isLoop() {
        return loop;
    }

    /**
     * Sets whether the animation loops. If false, the last image of the animation stays visible at the end.
     * 
     * 
     * Default is false.
     * 
     * 
     * @param loop
     *            true to make this animation loop.
     * @return this animation.
     */
    public SpriteAnimation setLoop(boolean loop) {
        this.loop = loop;
        set("loop", loop, null);
        return this;
    }

    /**
     * Returns the duration of the animation in milliseconds.
     * 
     * Default is 1000.
     * 
     * 
     * @return the duration of the animation in milliseconds.
     * 
     */
    public int getDuration() {
        return duration;
    }

    /**
     * Sets the duration of the animation in milliseconds.
     * 
     * @param duration
     *            the duration of the animation in milliseconds.
     * @return this animation.
     * @throws IllegalArgumentException
     *             if duration is negative.
     */
    public SpriteAnimation setDuration(int duration) {
        requireValidDuration(duration);
        this.duration = duration;
        set("duration", duration, null);
        return this;
    }

    /**
     * Sets the sequence of images for this animation.
     * 
     * @param images
     *            the names of the images to use for this animation.
     * @return this animation.
     * @throws IllegalArgumentException
     *             if images is empty.
     */
    public SpriteAnimation setImages(String... images) {
        if (images.length == 0) {
            throw new IllegalArgumentException("Animation must contain at least 1 image.");
        }
        this.images = images;
        set("images", Stream.of(images).collect(Collectors.joining(",")), null);
        return this;
    }

    /**
     * Returns the names of the images used for this animation.
     * 
     * @return the names of the images used for this animation.
     */
    public String[] getImages() {
        return images;
    }
}