com.kauridev.lunarbase.GameView Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lunar-base Show documentation

Lunar Base is a simple game framework written in Java. It is written using an entity-component-system architecture.

The newest version!

/*
 * This file is part of the lunar-base package.
 *
 * Copyright (c) 2014 Eric Fritz
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 * and associated documentation files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or
 * substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package com.kauridev.lunarbase;

/**
 * A view represents a state of the game.
 *
 * @author Eric Fritz
 */
public interface GameView
{
	/**
	 * Initializes the view.
	 */
	public void init();

	/**
	 * Called after the view has stopped updating. This is where allocated resources should be
	 * closed or released.
	 */
	public void exit();

	/**
	 * Called when it has been determined that game logic needs to be processed.
	 *
	 * @param elapsed  The number of milliseconds elapsed since the last call to update.
	 * @param hasFocus Whether this view should process user input.
	 */
	public void update(double elapsed, boolean hasFocus);

	/**
	 * Called when it has been determines it is time to render a frame.
	 *
	 * @param elapsed The number of milliseconds elapsed since the last call to render.
	 */
	public void render(double elapsed);

	/**
	 * Returns true if the view is an overlay, false otherwise.
	 * 
	 * Overlay views allow views lower in the stack to accept user input.
	 *
	 * @return true if the view is an overlay, false otherwise.
	 */
	public boolean isOverlay();
}