<

<default> - Class Diagram

 

A

add(GameEntity) - Method in class GameEntityList

 

add(GameEntity) - Method in class ListBasedPriorityQueue

 

add(GameEntity) - Method in interface PriorityQueue

This method adds a GameEntity into the queue.

addEntity(GameEntity) - Method in class BasicScreen

 

addEntity(GameEntity) - Method in interface Screen

Add the specified entity to the list for this screen.

addLink(int,int) - Method in class ScreenEditor.ScreenSelector

 

addScreen(int) - Method in class ScreenEditor.ScreenSelector

 

B

BasicBlock - class BasicBlock

 

BasicBlock() - Constructor for class BasicBlock

 

BasicEntity - class BasicEntity

 

BasicEntity(Location) - Constructor for class BasicEntity

 

BasicPlayer - class BasicPlayer

 

BasicPlayer(Location) - Constructor for class BasicPlayer

 

BasicScreen - class BasicScreen

This class is a very basic implementation of the Screen interface.

BasicScreen() - Constructor for class BasicScreen

 

BasicScreen(int,int) - Constructor for class BasicScreen

 

Block - interface Block

This interface will be implemented for any class that should represent a
block on a screen in the game.

blockSelected() - Method in class ScreenEditor

 

BlockSelectorPanel - class BlockSelectorPanel

 

BlockSelectorPanel(Screen,ScreenEditor) - Constructor for class BlockSelectorPanel

 

C

constructVariables() - Static method in class GameSetup

This method should be called in your main before you create your MainFrame.

createEntityIterator() - Method in class BasicScreen

Returns an Iterator object that can be used to "walk through" the list of
entities on this screen.

createEntityIterator() - Method in interface Screen

Returns an Iterator object that can be used to "walk through" the list of
entities on this screen.

createIterator() - Method in class GameEntityList

 

D

draw(Player) - Method in class MainDisplay

Draw the display assuming the player passed in.

E

EAST_PANEL - Static variable in interface Player

 

editor - Variable in class SelectorPanel

 

EditorDisplay - class EditorDisplay

 

EditorDisplay.LinkDisplay - class EditorDisplay.LinkDisplay

This class is simply a little panel that displays links.

EditorDisplay.LinkDisplay() - Constructor for class EditorDisplay.LinkDisplay

 

EditorDisplay(EditorPlayer,ScreenEditor) - Constructor for class EditorDisplay

 

EditorPlayer - class EditorPlayer

This class is just used by the editor to help it interact with the MainDisplay
class.

EditorPlayer() - Constructor for class EditorPlayer

 

editPropertiesPanel() - Method in class BasicScreen

 

editPropertiesPanel() - Method in interface Screen

This method returns a panel that should be set up so that users can
edit the properties of this screen.

entitySelected() - Method in class ScreenEditor

 

EntitySelectorPanel - class EntitySelectorPanel

 

EntitySelectorPanel(Screen,ScreenEditor) - Constructor for class EntitySelectorPanel

 

equals(java.lang.Object) - Method in class Location

This method overrides the same method from object.

F

followLinks() - Method in class BasicEntity

 

followLinks() - Method in class BasicPlayer

 

followLinks() - Method in class EditorPlayer

 

followLinks() - Method in interface GameEntity

Tells if this entity should follow links from one screen to another.

G

GAME_RUNNING - Static variable in interface Player

 

GAME_SUCCESS - Static variable in interface Player

 

GameEntity - interface GameEntity

This interface will be implemented for any class that should represent an
entity in the game.

GameEntityList - class GameEntityList

 

GameEntityList() - Constructor for class GameEntityList

 

GameSetup - class GameSetup

This class provides methods for the main frame to get the components of the
game.

gameStatus() - Method in class BasicPlayer

 

gameStatus() - Method in class EditorPlayer

 

gameStatus() - Method in interface Player

Returns one of the three constants above telling what the status of the game is.

getBlock(int,int) - Method in class BasicScreen

 

getBlock(int,int) - Method in interface Screen

Returns the block at location x,y.

getBlockOfType(int) - Method in class BasicScreen

 

getBlockOfType(int) - Method in interface Screen

Takes a number between 0 and getNumBlockTypes()-1 and returns an
instance of a block corresponding to that number.

getClickLocation(int,int) - Method in class MainDisplay

This function does a conversion from display coordinates to the locations
coordinates in the screen that it is displaying.

getDisplay() - Method in class MainFrame

This returns the display object for the frame.

getDrawX(Location) - Method in class MainDisplay

This function tells you the physical display x for a given location on
the screen.

getDrawY(Location) - Method in class MainDisplay

This function tells you the physical display y for a given location on
the screen.

getEditPropertiesPanel() - Method in class BasicBlock

 

getEditPropertiesPanel() - Method in class BasicEntity

 

getEditPropertiesPanel() - Method in class BasicPlayer

 

getEditPropertiesPanel() - Method in class EditorPlayer

 

getEditPropertiesPanel() - Method in interface Block

This method returns a panel that should be set up so that users can
edit the properties of this block.

getEditPropertiesPanel() - Method in interface GameEntity

This method should return a java.awt.Container with GUI components set
up in it to edit the properties of this entity.

getEntityOfType(int) - Method in class BasicScreen

 

getEntityOfType(int) - Method in interface Screen

Takes a number between 0 and getNumEntityTypes()-1 and returns an
instance of an entity corresponding to that number.

getFirst() - Method in class ListBasedPriorityQueue

 

getFirst() - Method in interface PriorityQueue

This method should return the first entity in the queue.

getGameStatusPanel(int) - Method in class BasicPlayer

 

getGameStatusPanel(int) - Method in class EditorPlayer

 

getGameStatusPanel(int) - Method in interface Player

This method returns a GUI container that shows extra information in your
game.

getImage() - Method in class BasicBlock

 

getImage() - Method in class BasicEntity

 

getImage() - Method in class BasicPlayer

 

getImage() - Method in class EditorPlayer

 

getImage() - Method in interface Block

This returns the image that should be drawn for this block.

getImage() - Method in interface GameEntity

This returns the image that should be drawn for this entity.

getImage(int) - Method in class BlockSelectorPanel

 

getImage(int) - Method in class EntitySelectorPanel

 

getImage(int) - Method in class SelectorPanel

 

getLinkLocation() - Method in class BasicBlock

 

getLinkLocation() - Method in interface Block

Returns the location that this block links to.

getLinkPanel() - Method in class EditorDisplay

 

getLocalPlayer() - Static method in class GameSetup

Returns the instance of your Player subclass that should be used in this game.

getLocation() - Method in class BasicEntity

 

getLocation() - Method in class BasicPlayer

 

getLocation() - Method in class EditorPlayer

 

getLocation() - Method in interface GameEntity

This returns the location of this entity.

getLocX() - Method in class Location

Returns the x block location.

getLocY() - Method in class Location

Returns the y block location.

getMenuBar() - Static method in class GameSetup

This function returns a JMenuBar object that will be added to the main
display window.

getNumBlockTypes() - Method in class BasicScreen

 

getNumBlockTypes() - Method in interface Screen

Returns the number of different blocks that the screen editor should
set up for adding on this type of screen.

getNumEntityTypes() - Method in class BasicScreen

 

getNumEntityTypes() - Method in interface Screen

Returns the number of different entities that the screen editor should
set up for adding on this type of screen.

getNumSelected() - Method in class SelectorPanel

 

getNumTypes() - Method in class SelectorPanel

 

getPartialsInWhole() - Static method in class Location

 

getPartialX() - Method in class Location

Returns the x partial block location.

getPartialY() - Method in class Location

Returns the y partial block location.

getPreferredSize() - Method in class ImageEditor.ImageSelectionPanel

 

getPreferredSize() - Method in class MainDisplay

Returns the size that this display would be without any scaling for the
drawing options it was first set up to use.

getPreferredSize() - Method in class SelectorPanel

 

getPriorityQueue() - Static method in class GameSetup

Return the priority queue that you are using for the game.

getScaling() - Static method in class GameSetup

This method tells the display class if the images in the game should be
scaled.

getScreen() - Method in class Location

Returns the Screen object that this location is in.

getScrolling() - Static method in class GameSetup

Tells the display class is this game has a scrolling background.

getSelectedBlock() - Method in class ScreenEditor

 

getSelectedEntity() - Method in class EditorDisplay

 

getSelectedGameEntity() - Method in class ScreenEditor

 

getSelectedScreen(int) - Method in class ScreenEditor.ScreenSelector

 

getSize() - Method in class BasicScreen

 

getSize() - Method in interface Screen

This method returns how many blocks the screen is in width and height.

getSub1() - Method in class ImageEditor.ImageSelectionPanel

 

getSub2() - Method in class ImageEditor.ImageSelectionPanel

 

getTimer() - Method in class MainFrame

This method returns that javax.swing.Timer object that is used to keep
the game going.

getUpdateTime() - Method in class BasicEntity

 

getUpdateTime() - Method in class BasicPlayer

 

getUpdateTime() - Method in class EditorPlayer

 

getUpdateTime() - Method in interface GameEntity

This method returns the next time at which the entity should have its
update method called.

I

ImageEditor - class ImageEditor

A class for editing small images for use in the games.

ImageEditor.ImagePanel - class ImageEditor.ImagePanel

 

ImageEditor.ImagePanel() - Constructor for class ImageEditor.ImagePanel

 

ImageEditor.ImageSelectionPanel - class ImageEditor.ImageSelectionPanel

 

ImageEditor.ImageSelectionPanel() - Constructor for class ImageEditor.ImageSelectionPanel

 

ImageEditor() - Constructor for class ImageEditor

The default constructor

imageRemoved() - Method in class ImageEditor.ImageSelectionPanel

 

K

keyPressed(java.awt.event.KeyEvent) - Method in class BasicPlayer

 

keyReleased(java.awt.event.KeyEvent) - Method in class BasicPlayer

 

keyTyped(java.awt.event.KeyEvent) - Method in class BasicPlayer

I'm not using this because it is linked to the key repeat rate.

L

lastScreen - Variable in class MainDisplay

 

links - Variable in class ScreenEditor.ScreenRepresentation

 

ListBasedPriorityQueue - class ListBasedPriorityQueue

This is an implementation of the PriorityQueue interface that uses a linked
list.

Location - class Location

This class represents a location in the game.

Location(Location) - Constructor for class Location

This copy constructor isn't really needed because this is an immutable
class.

Location(Screen,int,int,int,int) - Constructor for class Location

Constructor that sets all the location coordinates.

Location(Screen,int,int) - Constructor for class Location

Constructor that sets the main location coordinates.

M

main(java.lang.String[]) - Static method in class ImageEditor

The main method simply creates an object of type ImageEditor.

main(java.lang.String[]) - Static method in class ScreenEditor

 

main(java.lang.String[]) - Static method in class SimpleMain

 

MainDisplay - class MainDisplay

This class is the panel on which the action part of the game is rendered.

MainDisplay(MainFrame) - Constructor for class MainDisplay

This mainly figures out what size this panel should "prefer" to be.

MainFrame - class MainFrame

This class represents the frame/window that the game is played in.

MainFrame() - Constructor for class MainFrame

Setup the GUI.

mouseClicked(java.awt.event.MouseEvent) - Method in class EditorDisplay

 

mouseClicked(java.awt.event.MouseEvent) - Method in class ImageEditor.ImagePanel

 

mouseClicked(java.awt.event.MouseEvent) - Method in class ImageEditor.ImageSelectionPanel

 

mouseClicked(java.awt.event.MouseEvent) - Method in class ScreenEditor.ScreenSelector

 

mouseDragged(java.awt.event.MouseEvent) - Method in class EditorDisplay

 

mouseDragged(java.awt.event.MouseEvent) - Method in class ImageEditor.ImagePanel

 

mouseDragged(java.awt.event.MouseEvent) - Method in class ScreenEditor.ScreenSelector

 

mouseEntered(java.awt.event.MouseEvent) - Method in class EditorDisplay

 

mouseEntered(java.awt.event.MouseEvent) - Method in class ImageEditor.ImagePanel

 

mouseEntered(java.awt.event.MouseEvent) - Method in class ImageEditor.ImageSelectionPanel

 

mouseEntered(java.awt.event.MouseEvent) - Method in class ScreenEditor.ScreenSelector

 

mouseExited(java.awt.event.MouseEvent) - Method in class EditorDisplay

 

mouseExited(java.awt.event.MouseEvent) - Method in class ImageEditor.ImagePanel

 

mouseExited(java.awt.event.MouseEvent) - Method in class ImageEditor.ImageSelectionPanel

 

mouseExited(java.awt.event.MouseEvent) - Method in class ScreenEditor.ScreenSelector

 

mouseMoved(java.awt.event.MouseEvent) - Method in class EditorDisplay

 

mouseMoved(java.awt.event.MouseEvent) - Method in class ImageEditor.ImagePanel

 

mouseMoved(java.awt.event.MouseEvent) - Method in class ScreenEditor.ScreenSelector

 

mousePressed(java.awt.event.MouseEvent) - Method in class EditorDisplay

 

mousePressed(java.awt.event.MouseEvent) - Method in class ImageEditor.ImagePanel

 

mousePressed(java.awt.event.MouseEvent) - Method in class ImageEditor.ImageSelectionPanel

 

mousePressed(java.awt.event.MouseEvent) - Method in class ScreenEditor.ScreenSelector

 

mouseReleased(java.awt.event.MouseEvent) - Method in class EditorDisplay

 

mouseReleased(java.awt.event.MouseEvent) - Method in class ImageEditor.ImagePanel

 

mouseReleased(java.awt.event.MouseEvent) - Method in class ImageEditor.ImageSelectionPanel

 

mouseReleased(java.awt.event.MouseEvent) - Method in class ScreenEditor.ScreenSelector

 

N

NORTH_PANEL - Static variable in interface Player

 

P

paint(java.awt.Graphics) - Method in class EditorDisplay

 

paint(java.awt.Graphics) - Method in class ImageEditor.ImagePanel

 

paint(java.awt.Graphics) - Method in class ImageEditor.ImageSelectionPanel

 

paint(java.awt.Graphics) - Method in class ScreenEditor.ScreenSelector

 

paint(java.awt.Graphics) - Method in class SelectorPanel

 

paintComponent(java.awt.Graphics) - Method in class MainDisplay

Renders the image drawn by the draw method to the provided Graphics object.

partialMove(int,int) - Method in class Location

Returns a Location object that has been offset from this one by
the specified partial block distance.

Player - interface Player

This interface will be implemented for any class that should represent a
player in the game.

PLAYER_DEAD - Static variable in interface Player

 

PriorityQueue - interface PriorityQueue

The PriorityQueue class it used to keep track of which entities should be
updated in any given time step.

R

readImageArray2D(java.io.DataInputStream) - Static method in class ImageEditor

This method reads in a 2D array of images from a file.

readImageArray2D(java.lang.String) - Static method in class ImageEditor

This method reads in a 2D array of images from a file.

readScreenReps(java.io.InputStream) - Method in class ScreenEditor.ScreenSelector

 

readScreenVector(java.io.InputStream) - Static method in class ScreenEditor

Call this function to read in Screen objects that have been saved by the
ScreenEditor.

readScreenVector(java.lang.String) - Static method in class ScreenEditor

Call this function to read in Screen objects that have been saved by the
ScreenEditor.

remove(GameEntity) - Method in class GameEntityList

 

removeEntity() - Method in class EditorDisplay

 

removeEntity(GameEntity) - Method in class BasicScreen

 

removeEntity(GameEntity) - Method in interface Screen

This method searches for the specified entity in this screen and removes
it if found.

removeFirst() - Method in class ListBasedPriorityQueue

 

removeFirst() - Method in interface PriorityQueue

This method removes the first entity from the queue assuming one is present.

removeLink(int,int) - Method in class ScreenEditor.ScreenSelector

 

S

Screen - interface Screen

This class represents a single "screen" in the game.

ScreenEditor - class ScreenEditor

This class is designed to let humans easily interact with and build
screens once the class for that screen has been written.

ScreenEditor.PropertiesDialog - class ScreenEditor.PropertiesDialog

 

ScreenEditor.PropertiesDialog(javax.swing.JFrame,java.lang.String,java.awt.Container) - Constructor for class ScreenEditor.PropertiesDialog

 

ScreenEditor.ScreenRepresentation - class ScreenEditor.ScreenRepresentation

 

ScreenEditor.ScreenRepresentation(int,int) - Constructor for class ScreenEditor.ScreenRepresentation

 

ScreenEditor.ScreenSelector - class ScreenEditor.ScreenSelector

 

ScreenEditor.ScreenSelector() - Constructor for class ScreenEditor.ScreenSelector

 

ScreenEditor(java.lang.String,java.lang.String) - Constructor for class ScreenEditor

 

SelectorPanel - class SelectorPanel

 

SelectorPanel(ScreenEditor) - Constructor for class SelectorPanel

 

setBlock(int,int,Block) - Method in class BasicScreen

 

setBlock(int,int,Block) - Method in interface Screen

Sets the block at location x,y to be b.

setForceDraw() - Method in class MainDisplay

Tell the display that at the next draw call (typically the next tick) that
it must redraw all of the blocks for the background and can't use a
buffered image.

setLabels() - Method in class EditorDisplay.LinkDisplay

 

setLinkLocation(Location) - Method in class BasicBlock

 

setLinkLocation(Location) - Method in interface Block

Sets the location that this block links to.

setLocation(Location) - Method in class BasicEntity

 

setLocation(Location) - Method in class BasicPlayer

 

setLocation(Location) - Method in class EditorPlayer

 

setLocation(Location) - Method in interface GameEntity

This sets the location of this entity.

setMainFrame(MainFrame) - Static method in class GameSetup

This method is called in the constructor of a main frame so that the
GameSetup class will be able to communicate with the frame that the
game is being played in.

setPartialsInWhole(int) - Static method in class Location

 

setSelectedScreen(int,int) - Method in class ScreenEditor.ScreenSelector

 

signalSelect() - Method in class BlockSelectorPanel

 

signalSelect() - Method in class EntitySelectorPanel

 

signalSelect() - Method in class SelectorPanel

 

SimpleMain - class SimpleMain

 

sizex - Variable in class MainDisplay

 

sizey - Variable in class MainDisplay

 

SOUTH_PANEL - Static variable in interface Player

 

stopGame() - Static method in class GameSetup

This function will automatically be called when the player begins to return
something other than GAME_RUNNING.

U

unselect() - Method in class SelectorPanel

 

update(int) - Method in class BasicEntity

 

update(int) - Method in class BasicPlayer

This is the method that should be called to update the player.

update(int) - Method in class EditorPlayer

 

update(int) - Method in interface GameEntity

The update method is where any changes to the entity are made.

updateLocationLabels() - Method in class EditorDisplay

 

useDrawOptimization() - Static method in class GameSetup

If this returns true, the drawing routine will use an optimization of
drawing the images for all the blocks once to a large image and just
putting up that image as long as the player hasn't changed screens.

V

vect - Variable in class SelectorPanel

 

W

WEST_PANEL - Static variable in interface Player

 

writeImageArray2D(java.awt.image.BufferedImage[][],java.io.DataOutputStream) - Method in class ImageEditor

This function writes a 2D array of images out to file.

writeImageArray2D(java.awt.image.BufferedImage[][],java.lang.String) - Method in class ImageEditor

This function writes a 2D array of images out to file.

writeScreenReps(java.io.OutputStream) - Method in class ScreenEditor.ScreenSelector

 

X

x - Variable in class ScreenEditor.ScreenRepresentation

 

Y

y - Variable in class ScreenEditor.ScreenRepresentation