com.github.mathiewz.slick.state.transition.Transition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of modernized-slick Show documentation

The main purpose of this libraryis to modernize and maintain the slick2D library.

The newest version!

package com.github.mathiewz.slick.state.transition;

import com.github.mathiewz.slick.GameContainer;
import com.github.mathiewz.slick.Graphics;
import com.github.mathiewz.slick.state.GameState;
import com.github.mathiewz.slick.state.StateBasedGame;

/**
 * A transition between two game states
 *
 * @author kevin
 */
public interface Transition {
    /**
     * Update the transition. Cause what ever happens in the transition to happen
     *
     * @param game
     *            The game this transition is being rendered as part of
     * @param container
     *            The container holding the game
     * @param delta
     *            The amount of time passed since last update
     */
    public void update(StateBasedGame game, GameContainer container, int delta);
    
    /**
     * Render the transition before the existing state rendering
     *
     * @param game
     *            The game this transition is being rendered as part of
     * @param container
     *            The container holding the game
     * @param g
     *            The graphics context to use when rendering the transiton
     */
    public void preRender(StateBasedGame game, GameContainer container, Graphics g);
    
    /**
     * Render the transition over the existing state rendering
     *
     * @param game
     *            The game this transition is being rendered as part of
     * @param container
     *            The container holding the game
     * @param g
     *            The graphics context to use when rendering the transiton
     */
    public void postRender(StateBasedGame game, GameContainer container, Graphics g);
    
    /**
     * Check if this transtion has been completed
     *
     * @return True if the transition has been completed
     */
    public boolean isComplete();
    
    /**
     * Initialise the transition
     *
     * @param firstState
     *            The first state we're rendering (this will be rendered by the framework)
     * @param secondState
     *            The second stat we're transitioning to or from (this one won't be rendered)
     */
    public void init(GameState firstState, GameState secondState);
}