pl.isangeles.senlin.gui.tools

Class UserInterface

java.lang.Object

pl.isangeles.senlin.gui.tools.UserInterface

All Implemented Interfaces:

org.newdawn.slick.ControlledInputReciever, org.newdawn.slick.KeyListener, org.newdawn.slick.MouseListener, SaveElement

public class UserInterface
extends java.lang.Object
implements org.newdawn.slick.MouseListener, org.newdawn.slick.KeyListener, SaveElement

Class for game graphical interface

Author:

Isangeles

Constructor Summary

Constructors

Constructor and Description
UserInterface(org.newdawn.slick.GameContainer gc, CommandInterface cli, Character player, GameWorld gw) UI constructor, calls all UI elements constructors

Method Summary

Modifier and Type	Method and Description
void	closeAll() Closes all UI windows
void	draw(org.newdawn.slick.Graphics g) Draws ui elements
void	drawPointners() Draws UI pointers, like destination point or target point
Camera	getCamera() Returns UI camera
java.lang.String	getLoadName()
org.w3c.dom.Element	getSave(org.w3c.dom.Document doc) Saves UI configuration to XML document element
java.lang.String	getSaveName()
static GameCursor	getUiCursor() Deprecated.
void	inputEnded()
void	inputStarted()
boolean	isAcceptingInput()
boolean	isExitReq() Checks if exit game is requested
boolean	isLocked() Checks if UI is locked
boolean	isMouseOver() Checks if mouse is over one of ui elements
boolean	isPauseReq() Checks if game pause is requested
void	keyPressed(int key, char c)
void	keyReleased(int key, char c)
void	mouseClicked(int button, int x, int y, int clickCount)
void	mouseDragged(int oldx, int oldy, int newx, int newy)
void	mouseMoved(int oldx, int oldy, int newx, int newy)
void	mousePressed(int button, int x, int y)
void	mouseReleased(int button, int x, int y)
void	mouseWheelMoved(int change)
void	setInput(org.newdawn.slick.Input input)
void	setLayout(UiLayout layout) Sets specified UI layout
void	setLock(boolean lock) Lock on unlocks UI
boolean	takeLoadReq()
boolean	takeSaveReq()
boolean	takeScreenshotReq() Takes screenshot requested
void	update(org.newdawn.slick.GameContainer gc) Updates ui elements

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserInterface

public UserInterface(org.newdawn.slick.GameContainer gc,
                     CommandInterface cli,
                     Character player,
                     GameWorld gw)
              throws org.newdawn.slick.SlickException,
                     java.io.IOException,
                     java.awt.FontFormatException

UI constructor, calls all UI elements constructors

Parameters:

gc - Game container for superclass and ui elements

cli - Command line interface

player - Player character

gw - Game world

Throws:

org.newdawn.slick.SlickException

java.io.IOException

java.awt.FontFormatException

Method Detail

draw

public void draw(org.newdawn.slick.Graphics g)

Draws ui elements

drawPointners

public void drawPointners()

Draws UI pointers, like destination point or target point

update

public void update(org.newdawn.slick.GameContainer gc)

Updates ui elements

isMouseOver

public boolean isMouseOver()

Checks if mouse is over one of ui elements

Returns:

isExitReq

public boolean isExitReq()

Checks if exit game is requested

Returns:

True if game should be closed or false otherwise

isPauseReq

public boolean isPauseReq()

Checks if game pause is requested

Returns:

True if game should be paused or false otherwise

takeSaveReq

public boolean takeSaveReq()

takeLoadReq

public boolean takeLoadReq()

getSaveName

public java.lang.String getSaveName()

getLoadName

public java.lang.String getLoadName()

getCamera

public Camera getCamera()

Returns UI camera

Returns:

UI camera

isLocked

public boolean isLocked()

Checks if UI is locked

Returns:

True if UI is locked, false otherwise

takeScreenshotReq

public boolean takeScreenshotReq()

Takes screenshot requested

Returns:

True if screenshot is requested, false otherwise

setLayout

public void setLayout(UiLayout layout)

Sets specified UI layout

Parameters:

layout - UI layout to set

setLock

public void setLock(boolean lock)

Lock on unlocks UI

Parameters:

lock - True to lock UI, false to unlock

closeAll

public void closeAll()

Closes all UI windows

inputEnded

public void inputEnded()

Specified by:

inputEnded in interface org.newdawn.slick.ControlledInputReciever

inputStarted

public void inputStarted()

Specified by:

inputStarted in interface org.newdawn.slick.ControlledInputReciever

isAcceptingInput

public boolean isAcceptingInput()

Specified by:

isAcceptingInput in interface org.newdawn.slick.ControlledInputReciever

setInput

public void setInput(org.newdawn.slick.Input input)

Specified by:

setInput in interface org.newdawn.slick.ControlledInputReciever

mouseClicked

public void mouseClicked(int button,
                         int x,
                         int y,
                         int clickCount)

Specified by:

mouseClicked in interface org.newdawn.slick.MouseListener

mouseDragged

public void mouseDragged(int oldx,
                         int oldy,
                         int newx,
                         int newy)

Specified by:

mouseDragged in interface org.newdawn.slick.MouseListener

mouseMoved

public void mouseMoved(int oldx,
                       int oldy,
                       int newx,
                       int newy)

Specified by:

mouseMoved in interface org.newdawn.slick.MouseListener

mousePressed

public void mousePressed(int button,
                         int x,
                         int y)

Specified by:

mousePressed in interface org.newdawn.slick.MouseListener

mouseReleased

public void mouseReleased(int button,
                          int x,
                          int y)

Specified by:

mouseReleased in interface org.newdawn.slick.MouseListener

mouseWheelMoved

public void mouseWheelMoved(int change)

Specified by:

mouseWheelMoved in interface org.newdawn.slick.MouseListener

keyPressed

public void keyPressed(int key,
                       char c)

Specified by:

keyPressed in interface org.newdawn.slick.KeyListener

keyReleased

public void keyReleased(int key,
                        char c)

Specified by:

keyReleased in interface org.newdawn.slick.KeyListener

getUiCursor

public static GameCursor getUiCursor()

Deprecated.

UNUSED

Returns:

getSave

public org.w3c.dom.Element getSave(org.w3c.dom.Document doc)

Saves UI configuration to XML document element

Specified by:

getSave in interface SaveElement

Parameters:

doc - Document for save game file

Returns:

XML document element