IArcadeGame.java

package com.pixelutilitys.arcade.interfaces;

import java.awt.image.BufferedImage;
import java.util.List;

public interface IArcadeGame {

    /**
     * Theese are the available keys for the Arcade.
     *
     */
    public enum KEY {
        UP(0), DOWN(1), LEFT(2), RIGHT(3), A(4), B(5), X(6), Y(7), L1(8), L2(9), R1(10), R2(11);

        public final int id;

        KEY(int id) {
            this.id = id;
        }
    }

    /**
     * The name of the game. Will be displayed in the game choose menu. Should not be too long so it fits withing the
     * screen bounds.<br>
     * TODO: The name will be line wrapped if it is to long to fit in one line on the screen.
     *
     * @return The gameTitle. Must NOT be null.
     */
    public String getTitle();

    /**
     * Returns the game logo of some sorts. If not null, this logo will be shown in the game choose menu instead of just
     * the name.
     *
     * @return The logo of the game. Can be null. May get resized on the arcade screen if it is to large to fit the game
     *         choose menu.
     */
    public BufferedImage getGameIcon();

    /**
     * Called when the game is loaded.<br>
     * Use this to load any necessary game data (assets, sounds, etc.)<br>
     * <br>
     * <i>Keep in mind that an instance of the game might be kept held in the arcade machine, so you should NOT use the
     * constructor to initialize anything! The constructor maybe will only get called when the arcade initializes
     * itself!</i>
     */
    public void initialize();

    /**
     * Called when this game is going to be unloaded from the arcade machine.<br>
     * You can use this method to save the highscores or whatever.
     */
    public void unload();


    /**
     * Gets the current visible stuff of the game.<br>
     * If the image is smaller than the screens resolution it will be centered on it,
     *
     * Make sure to render the game just in this method, as it might get called independently from doGameTick();
     *
     */
    public BufferedImage renderGraphics();

    public void doGameTick(List<KEY> input);
}