edu.gatech.cs2335.lemmings.engine
Class HelpState

java.lang.Object
  edu.gatech.cs2335.lemmings.engine.AbstractGameState
      edu.gatech.cs2335.lemmings.engine.HelpState

All Implemented Interfaces:

java.awt.event.ActionListener, java.util.EventListener

public class HelpState

extends AbstractGameState

Class HelpState: Help screen...

 Revision History:
     v1.0 (Apr. 21, 2004) - Created the HelpState class
 

Version:

Version 1.0, Apr. 21, 2004

Author:

Andrew Knight

Field Summary

static boolean

VERBOSE Display debug information?

Constructor Summary

HelpState()
Creates a new HelpState instance.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent ae) This function essentially processes the action event that may have been thrown by the UI.
boolean	cleanUp() This method will perform all of the necessary clean up operations once the object is no longer needed.
boolean	initialize() This method will initialize the state that it belongs to.

Methods inherited from class edu.gatech.cs2335.lemmings.engine.AbstractGameState

getUI, setUI

Methods inherited from class java.lang.Object

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

Field Detail

VERBOSE

public static final boolean VERBOSE

Display debug information?

See Also:

Constant Field Values

Constructor Detail

HelpState

public HelpState()

Creates a new HelpState instance.

Method Detail

initialize

public boolean initialize()

This method will initialize the state that it belongs to. It will then return true upon success, and false upon failure.

Specified by:

initialize in class AbstractGameState

Returns:

boolean

cleanUp

public boolean cleanUp()

This method will perform all of the necessary clean up operations once the object is no longer needed.

Specified by:

cleanUp in class AbstractGameState

Returns:

boolean

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent ae)

This function essentially processes the action event that may have been thrown by the UI.

Parameters:

ae - ae