asskoala/GTSchoolShit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
GTSchoolShit/CS2335/FinalSubmission/apidoc/edu/gatech/cs2335/lemmings/engine/package-summary.html
Jose Caban 388ac241f0 first commit
2025-06-07 01:59:34 -04:00

322 lines
17 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.4.2_03) on Fri Apr 23 12:22:22 EDT 2004 -->
<TITLE>
edu.gatech.cs2335.lemmings.engine
</TITLE>
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.engine package">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="edu.gatech.cs2335.lemmings.engine";
}
</SCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV PACKAGE&nbsp;
&nbsp;<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/lemmingjob/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package edu.gatech.cs2335.lemmings.engine
</H2>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/ICleanable.html" title="interface in edu.gatech.cs2335.lemmings.engine">ICleanable</A></B></TD>
<TD>Interface ICleanable: The implementing objects will be able to be
cleaned up.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Class Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/AbstractGameState.html" title="class in edu.gatech.cs2335.lemmings.engine">AbstractGameState</A></B></TD>
<TD>This is the parent of all the game state classes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/AttractState.html" title="class in edu.gatech.cs2335.lemmings.engine">AttractState</A></B></TD>
<TD>Class GamePlayState: where the actual game is displayed and played</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/BloodParticle.html" title="class in edu.gatech.cs2335.lemmings.engine">BloodParticle</A></B></TD>
<TD>Class Particle: When a lemming blows up, he makes particles.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/BoneParticle.html" title="class in edu.gatech.cs2335.lemmings.engine">BoneParticle</A></B></TD>
<TD>Class Particle: When a lemming blows up, he makes particles.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/CreditsState.html" title="class in edu.gatech.cs2335.lemmings.engine">CreditsState</A></B></TD>
<TD>Class CreditsState: Displays the credits screen, and when we are
done - goes back to the main menu.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/DirtParticle.html" title="class in edu.gatech.cs2335.lemmings.engine">DirtParticle</A></B></TD>
<TD>Class Particle: When a lemming blows up, he makes particles.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/EstablishingConnectionState.html" title="class in edu.gatech.cs2335.lemmings.engine">EstablishingConnectionState</A></B></TD>
<TD>Class EstablishingConnectionState: This state will load a level,
and then wait for a connection to be established.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/FlameParticle.html" title="class in edu.gatech.cs2335.lemmings.engine">FlameParticle</A></B></TD>
<TD>Class Particle: When a lemming blows up, he makes particles.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/FlingTrap.html" title="class in edu.gatech.cs2335.lemmings.engine">FlingTrap</A></B></TD>
<TD>Class FlingTrap: when the lemming comes close to this one, it flings him.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/GameEngine.html" title="class in edu.gatech.cs2335.lemmings.engine">GameEngine</A></B></TD>
<TD>This class will manage the states of the game and their
transitions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/GamePlayState.html" title="class in edu.gatech.cs2335.lemmings.engine">GamePlayState</A></B></TD>
<TD>The game state, where the actual game is displayed and played.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/HelpState.html" title="class in edu.gatech.cs2335.lemmings.engine">HelpState</A></B></TD>
<TD>Class HelpState: Help screen...</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Lemming.html" title="class in edu.gatech.cs2335.lemmings.engine">Lemming</A></B></TD>
<TD>Represents a generic lemming, that can move around, and do
stuff.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LemmingDrown.html" title="class in edu.gatech.cs2335.lemmings.engine">LemmingDrown</A></B></TD>
<TD>Class LemmingDrown: This pretty sprite is created when the lemming
drowns.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LemmingSplat.html" title="class in edu.gatech.cs2335.lemmings.engine">LemmingSplat</A></B></TD>
<TD>Class LemmingSplat: When the lemming falls too far and smashes into
the ground, this blood-splattering animation will be played.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LemmingsSoul.html" title="class in edu.gatech.cs2335.lemmings.engine">LemmingsSoul</A></B></TD>
<TD>Class LemmingsSoul: You have failed, The lemming is DEAD, His soul
goes to heaven.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html" title="class in edu.gatech.cs2335.lemmings.engine">Level</A></B></TD>
<TD>This is a playable level.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LevelData.html" title="class in edu.gatech.cs2335.lemmings.engine">LevelData</A></B></TD>
<TD>This class contains the data associated with a certain level.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LevelEntrance.html" title="class in edu.gatech.cs2335.lemmings.engine">LevelEntrance</A></B></TD>
<TD>Class LevelEntrance: This is where lemmings enter a level.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LevelExit.html" title="class in edu.gatech.cs2335.lemmings.engine">LevelExit</A></B></TD>
<TD>Class LevelExit: This is where lemmings exit a level.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LevelResultsState.html" title="class in edu.gatech.cs2335.lemmings.engine">LevelResultsState</A></B></TD>
<TD>Class LevelResultsState: Shows the results of a level.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LevelSelectionState.html" title="class in edu.gatech.cs2335.lemmings.engine">LevelSelectionState</A></B></TD>
<TD>This is the main menu state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LoadLevelState.html" title="class in edu.gatech.cs2335.lemmings.engine">LoadLevelState</A></B></TD>
<TD>Class LoadLevelState: The display to show random humorous messages
while the user is waiting for the level to load.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/MainMenuState.html" title="class in edu.gatech.cs2335.lemmings.engine">MainMenuState</A></B></TD>
<TD>This is the main menu state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Map.html" title="class in edu.gatech.cs2335.lemmings.engine">Map</A></B></TD>
<TD>The map on which stuff will be happening.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/MapSettings.html" title="class in edu.gatech.cs2335.lemmings.engine">MapSettings</A></B></TD>
<TD>Map Settings, thanks to PMD, a Singleton class
Holds Physics Constants</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/MultiLevelResultsState.html" title="class in edu.gatech.cs2335.lemmings.engine">MultiLevelResultsState</A></B></TD>
<TD>Class MultiLevelResultsState: this is the multilevel result state.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/MultiplayerGameplayState.html" title="class in edu.gatech.cs2335.lemmings.engine">MultiplayerGameplayState</A></B></TD>
<TD>The mutiplayer game state, where the actual game is displayed and played.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/MultiplayerSetupState.html" title="class in edu.gatech.cs2335.lemmings.engine">MultiplayerSetupState</A></B></TD>
<TD>Class MultiplayerSetupState: This is where the player can either
start up the server, or join an existing game.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/NetworkErrorState.html" title="class in edu.gatech.cs2335.lemmings.engine">NetworkErrorState</A></B></TD>
<TD>Class NetworkErrorState: Displays a network error...</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Particle.html" title="class in edu.gatech.cs2335.lemmings.engine">Particle</A></B></TD>
<TD>Class Particle: When a lemming blows up, he makes particles.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Portal.html" title="class in edu.gatech.cs2335.lemmings.engine">Portal</A></B></TD>
<TD>Class Portal: Represents a portal in the map.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PortalFactory.html" title="class in edu.gatech.cs2335.lemmings.engine">PortalFactory</A></B></TD>
<TD>Class PortalFactory: Creates different portals.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html" title="class in edu.gatech.cs2335.lemmings.engine">PrettySprite</A></B></TD>
<TD>Class PrettySprite: This is basically an eye-candy sprite.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/ProgramRunner.html" title="class in edu.gatech.cs2335.lemmings.engine">ProgramRunner</A></B></TD>
<TD>This class will essentially run the Lemmings game.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/SavedLemming.html" title="class in edu.gatech.cs2335.lemmings.engine">SavedLemming</A></B></TD>
<TD>Class SavedLemming: This thing will basically show the animation of
the lemming going upstairs into the exit.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/SplashScreenState.html" title="class in edu.gatech.cs2335.lemmings.engine">SplashScreenState</A></B></TD>
<TD>This state basically represents the splash screen.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/WaterParticle.html" title="class in edu.gatech.cs2335.lemmings.engine">WaterParticle</A></B></TD>
<TD>Class Particle: When a lemming blows up, he makes particles.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV PACKAGE&nbsp;
&nbsp;<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/lemmingjob/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink