1368 lines
45 KiB
HTML
1368 lines
45 KiB
HTML
<!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>
|
|
Level
|
|
</TITLE>
|
|
|
|
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.engine.Level class">
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
parent.document.title="Level";
|
|
}
|
|
</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> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LemmingsSoul.html" title="class in edu.gatech.cs2335.lemmings.engine"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LevelData.html" title="class in edu.gatech.cs2335.lemmings.engine"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="Level.html" target="_top"><B>NO FRAMES</B></A>
|
|
<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>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
edu.gatech.cs2335.lemmings.engine</FONT>
|
|
<BR>
|
|
Class Level</H2>
|
|
<PRE>
|
|
java.lang.Object
|
|
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.engine.Level</B>
|
|
</PRE>
|
|
<DL>
|
|
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/ICleanable.html" title="interface in edu.gatech.cs2335.lemmings.engine">ICleanable</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT>public class <B>Level</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/ICleanable.html" title="interface in edu.gatech.cs2335.lemmings.engine">ICleanable</A></DL>
|
|
|
|
<P>
|
|
This is a playable level.
|
|
|
|
version MAGIC.2 (2004-04-20) - Jose Update
|
|
Fixed memory leaks
|
|
|
|
version MAGIC - (2004-04-15) - Jose Update
|
|
Added code to handle lemmings going offscreen
|
|
no performance hit for catching ArrayIndexOOB
|
|
<P>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>Author:</B></DT>
|
|
<DD><A HREF="mailto:gtg308i@mail.gatech.edu">Vladimir Urazov</A></DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<P>
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
|
|
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
<A NAME="constructor_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Constructor Summary</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#Level()">Level</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Creates a new <code>Level</code> instance.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#addPrettySprite(edu.gatech.cs2335.lemmings.engine.PrettySprite)">addPrettySprite</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html" title="class in edu.gatech.cs2335.lemmings.engine">PrettySprite</A> ps)</CODE>
|
|
|
|
<BR>
|
|
Adds a new pretty sprite to the llist of pretty sprites.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#assignJobToLemming(edu.gatech.cs2335.lemmings.engine.Lemming)">assignJobToLemming</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Lemming.html" title="class in edu.gatech.cs2335.lemmings.engine">Lemming</A> l)</CODE>
|
|
|
|
<BR>
|
|
This function will be called when a lemming has been clicked.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#cleanUp()">cleanUp</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Describe <code>cleanUp</code> method here.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#decreaseLemmingFlow()">decreaseLemmingFlow</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Decrease the lemming flow rate by 1</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html" title="class in edu.gatech.cs2335.lemmings.engine">Level</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#duplicate()">duplicate</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Creates a duplicate copy of this level for multiplayer games</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Lemming.html" title="class in edu.gatech.cs2335.lemmings.engine">Lemming</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#findLemmingAt(java.awt.Point)">findLemmingAt</A></B>(java.awt.Point coordinates)</CODE>
|
|
|
|
<BR>
|
|
Returns the lemming at given world coordinates, or NULL if no
|
|
such lemming exists.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getActiveJobId()">getActiveJobId</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Get the value of activeJobId.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.List</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getActiveLemmings()">getActiveLemmings</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Access method for the activeLemmings property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LevelData.html" title="class in edu.gatech.cs2335.lemmings.engine">LevelData</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getData()">getData</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Access method for the data property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getJobsRemaining(java.lang.String)">getJobsRemaining</A></B>(java.lang.String id)</CODE>
|
|
|
|
<BR>
|
|
Returns the number of jobs with the specified id remaining.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getLemmingFlow()">getLemmingFlow</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Accessor for lemmingFlow rate</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.List</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getLemmingHeaven()">getLemmingHeaven</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Access method for the lemmingHeaven property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getLemmingsDead()">getLemmingsDead</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Access method for the lemmingsDead property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getLemmingsReleased()">getLemmingsReleased</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Access method for the lemmingsReleased property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getLemmingsSaved()">getLemmingsSaved</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Access method for the lemmingsSaved property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.List</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getLevelPortals()">getLevelPortals</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Access method for the levelPortals property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Map.html" title="class in edu.gatech.cs2335.lemmings.engine">Map</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getMap()">getMap</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Access method for the map property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getNumLemmings()">getNumLemmings</A></B>()</CODE>
|
|
|
|
<BR>
|
|
accessor</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.List</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getPendingLemmings()">getPendingLemmings</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Access method for the pendingLemmings property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.List</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getPrettySprites()">getPrettySprites</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Access method for the prettySprites property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getTimeIncrement()">getTimeIncrement</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Get the value of timeIncrement.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#getTimeRemaining()">getTimeRemaining</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Access method for the timeRemaining property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#increaseLemmingFlow()">increaseLemmingFlow</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Increases the lemming flow rate by 1</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#isLevelOver()">isLevelOver</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns true if the level is over.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#isPaused()">isPaused</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Describe <code>isPaused</code> method here.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#killLemming(edu.gatech.cs2335.lemmings.engine.Lemming, boolean)">killLemming</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Lemming.html" title="class in edu.gatech.cs2335.lemmings.engine">Lemming</A> lemming,
|
|
boolean saved)</CODE>
|
|
|
|
<BR>
|
|
Kills the lemming passed in.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#killPrettySprite(edu.gatech.cs2335.lemmings.engine.PrettySprite)">killPrettySprite</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html" title="class in edu.gatech.cs2335.lemmings.engine">PrettySprite</A> ps)</CODE>
|
|
|
|
<BR>
|
|
Kills the pretty sprite.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#nukeEmALL()">nukeEmALL</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Makes all the lemmings explode.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#pause()">pause</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Pauses the level.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#releaseLemming()">releaseLemming</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Releases a new lemming from the release point.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#setActiveJobId(java.lang.String)">setActiveJobId</A></B>(java.lang.String v)</CODE>
|
|
|
|
<BR>
|
|
Set the value of activeJobId.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#setData(edu.gatech.cs2335.lemmings.engine.LevelData)">setData</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LevelData.html" title="class in edu.gatech.cs2335.lemmings.engine">LevelData</A> aData)</CODE>
|
|
|
|
<BR>
|
|
Sets the value of the data property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#setLemmingFlow(int)">setLemmingFlow</A></B>(int rate)</CODE>
|
|
|
|
<BR>
|
|
Sets lemmingFlow</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#setLemmingsDead(int)">setLemmingsDead</A></B>(int aLemmingsDead)</CODE>
|
|
|
|
<BR>
|
|
Sets the value of the lemmingsDead property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#setLemmingsReleased(int)">setLemmingsReleased</A></B>(int aLemmingsReleased)</CODE>
|
|
|
|
<BR>
|
|
Sets the value of the lemmingsReleased property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#setLemmingsSaved(int)">setLemmingsSaved</A></B>(int aLemmingsSaved)</CODE>
|
|
|
|
<BR>
|
|
Sets the value of the lemmingsSaved property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#setMap(edu.gatech.cs2335.lemmings.engine.Map)">setMap</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Map.html" title="class in edu.gatech.cs2335.lemmings.engine">Map</A> aMap)</CODE>
|
|
|
|
<BR>
|
|
Sets the value of the map property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#setNumberOfLemmings(int)">setNumberOfLemmings</A></B>(int num)</CODE>
|
|
|
|
<BR>
|
|
Describe <code>setNumberOfLemmings</code> method here.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#setNumLemmings(int)">setNumLemmings</A></B>(int i)</CODE>
|
|
|
|
<BR>
|
|
mutator</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#setTimeIncrement(long)">setTimeIncrement</A></B>(long v)</CODE>
|
|
|
|
<BR>
|
|
Set the value of timeIncrement.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#setTimeRemaining(long)">setTimeRemaining</A></B>(long aTimeRemaining)</CODE>
|
|
|
|
<BR>
|
|
Sets the value of the timeRemaining property.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#stopLevel()">stopLevel</A></B>()</CODE>
|
|
|
|
<BR>
|
|
This function will be called when the level should be stopped -
|
|
either when the time has run out, or all the lemmings are off the
|
|
map.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#unpause()">unpause</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Unpauses the level.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#updateLevel()">updateLevel</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Runs through the lemmings and updates each one that needs
|
|
updating.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html#updateLevel(edu.gatech.cs2335.lemmings.networking.AbstractMessage)">updateLevel</A></B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> message)</CODE>
|
|
|
|
<BR>
|
|
Updates the level with the message received from the network.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TD><B>Methods inherited from class java.lang.Object</B></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
|
<A NAME="constructor_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Constructor Detail</B></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="Level()"><!-- --></A><H3>
|
|
Level</H3>
|
|
<PRE>
|
|
public <B>Level</B>()</PRE>
|
|
<DL>
|
|
<DD>Creates a new <code>Level</code> instance.
|
|
<P>
|
|
</DL>
|
|
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="getTimeIncrement()"><!-- --></A><H3>
|
|
getTimeIncrement</H3>
|
|
<PRE>
|
|
public long <B>getTimeIncrement</B>()</PRE>
|
|
<DL>
|
|
<DD>Get the value of timeIncrement.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>value of timeIncrement.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setTimeIncrement(long)"><!-- --></A><H3>
|
|
setTimeIncrement</H3>
|
|
<PRE>
|
|
public void <B>setTimeIncrement</B>(long v)</PRE>
|
|
<DL>
|
|
<DD>Set the value of timeIncrement.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>v</CODE> - Value to assign to timeIncrement.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMap()"><!-- --></A><H3>
|
|
getMap</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Map.html" title="class in edu.gatech.cs2335.lemmings.engine">Map</A> <B>getMap</B>()</PRE>
|
|
<DL>
|
|
<DD>Access method for the map property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the current value of the map property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMap(edu.gatech.cs2335.lemmings.engine.Map)"><!-- --></A><H3>
|
|
setMap</H3>
|
|
<PRE>
|
|
public void <B>setMap</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Map.html" title="class in edu.gatech.cs2335.lemmings.engine">Map</A> aMap)</PRE>
|
|
<DL>
|
|
<DD>Sets the value of the map property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>aMap</CODE> - the new value of the map property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getPendingLemmings()"><!-- --></A><H3>
|
|
getPendingLemmings</H3>
|
|
<PRE>
|
|
public java.util.List <B>getPendingLemmings</B>()</PRE>
|
|
<DL>
|
|
<DD>Access method for the pendingLemmings property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the current value of the pendingLemmings property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getActiveLemmings()"><!-- --></A><H3>
|
|
getActiveLemmings</H3>
|
|
<PRE>
|
|
public java.util.List <B>getActiveLemmings</B>()</PRE>
|
|
<DL>
|
|
<DD>Access method for the activeLemmings property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the current value of the activeLemmings property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLemmingHeaven()"><!-- --></A><H3>
|
|
getLemmingHeaven</H3>
|
|
<PRE>
|
|
public java.util.List <B>getLemmingHeaven</B>()</PRE>
|
|
<DL>
|
|
<DD>Access method for the lemmingHeaven property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the current value of the lemmingHeaven property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLevelPortals()"><!-- --></A><H3>
|
|
getLevelPortals</H3>
|
|
<PRE>
|
|
public java.util.List <B>getLevelPortals</B>()</PRE>
|
|
<DL>
|
|
<DD>Access method for the levelPortals property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the current value of the levelPortals property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getPrettySprites()"><!-- --></A><H3>
|
|
getPrettySprites</H3>
|
|
<PRE>
|
|
public java.util.List <B>getPrettySprites</B>()</PRE>
|
|
<DL>
|
|
<DD>Access method for the prettySprites property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the current value of the prettySprites property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getTimeRemaining()"><!-- --></A><H3>
|
|
getTimeRemaining</H3>
|
|
<PRE>
|
|
public long <B>getTimeRemaining</B>()</PRE>
|
|
<DL>
|
|
<DD>Access method for the timeRemaining property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the current value of the timeRemaining property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setTimeRemaining(long)"><!-- --></A><H3>
|
|
setTimeRemaining</H3>
|
|
<PRE>
|
|
public void <B>setTimeRemaining</B>(long aTimeRemaining)</PRE>
|
|
<DL>
|
|
<DD>Sets the value of the timeRemaining property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>aTimeRemaining</CODE> - the new value of the timeRemaining property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLemmingsSaved()"><!-- --></A><H3>
|
|
getLemmingsSaved</H3>
|
|
<PRE>
|
|
public int <B>getLemmingsSaved</B>()</PRE>
|
|
<DL>
|
|
<DD>Access method for the lemmingsSaved property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the current value of the lemmingsSaved property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLemmingsSaved(int)"><!-- --></A><H3>
|
|
setLemmingsSaved</H3>
|
|
<PRE>
|
|
public void <B>setLemmingsSaved</B>(int aLemmingsSaved)</PRE>
|
|
<DL>
|
|
<DD>Sets the value of the lemmingsSaved property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>aLemmingsSaved</CODE> - the new value of the lemmingsSaved property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLemmingsDead()"><!-- --></A><H3>
|
|
getLemmingsDead</H3>
|
|
<PRE>
|
|
public int <B>getLemmingsDead</B>()</PRE>
|
|
<DL>
|
|
<DD>Access method for the lemmingsDead property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the current value of the lemmingsDead property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLemmingsDead(int)"><!-- --></A><H3>
|
|
setLemmingsDead</H3>
|
|
<PRE>
|
|
public void <B>setLemmingsDead</B>(int aLemmingsDead)</PRE>
|
|
<DL>
|
|
<DD>Sets the value of the lemmingsDead property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>aLemmingsDead</CODE> - the new value of the lemmingsDead property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLemmingsReleased()"><!-- --></A><H3>
|
|
getLemmingsReleased</H3>
|
|
<PRE>
|
|
public int <B>getLemmingsReleased</B>()</PRE>
|
|
<DL>
|
|
<DD>Access method for the lemmingsReleased property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the current value of the lemmingsReleased property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLemmingsReleased(int)"><!-- --></A><H3>
|
|
setLemmingsReleased</H3>
|
|
<PRE>
|
|
public void <B>setLemmingsReleased</B>(int aLemmingsReleased)</PRE>
|
|
<DL>
|
|
<DD>Sets the value of the lemmingsReleased property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>aLemmingsReleased</CODE> - the new value of the lemmingsReleased property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getData()"><!-- --></A><H3>
|
|
getData</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LevelData.html" title="class in edu.gatech.cs2335.lemmings.engine">LevelData</A> <B>getData</B>()</PRE>
|
|
<DL>
|
|
<DD>Access method for the data property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the current value of the data property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setNumberOfLemmings(int)"><!-- --></A><H3>
|
|
setNumberOfLemmings</H3>
|
|
<PRE>
|
|
public void <B>setNumberOfLemmings</B>(int num)</PRE>
|
|
<DL>
|
|
<DD>Describe <code>setNumberOfLemmings</code> method here.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>num</CODE> - an <code>int</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setData(edu.gatech.cs2335.lemmings.engine.LevelData)"><!-- --></A><H3>
|
|
setData</H3>
|
|
<PRE>
|
|
public void <B>setData</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LevelData.html" title="class in edu.gatech.cs2335.lemmings.engine">LevelData</A> aData)</PRE>
|
|
<DL>
|
|
<DD>Sets the value of the data property.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>aData</CODE> - the new value of the data property</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getActiveJobId()"><!-- --></A><H3>
|
|
getActiveJobId</H3>
|
|
<PRE>
|
|
public java.lang.String <B>getActiveJobId</B>()</PRE>
|
|
<DL>
|
|
<DD>Get the value of activeJobId.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>value of activeJobId.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setActiveJobId(java.lang.String)"><!-- --></A><H3>
|
|
setActiveJobId</H3>
|
|
<PRE>
|
|
public void <B>setActiveJobId</B>(java.lang.String v)</PRE>
|
|
<DL>
|
|
<DD>Set the value of activeJobId.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>v</CODE> - Value to assign to activeJobId.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getJobsRemaining(java.lang.String)"><!-- --></A><H3>
|
|
getJobsRemaining</H3>
|
|
<PRE>
|
|
public int <B>getJobsRemaining</B>(java.lang.String id)</PRE>
|
|
<DL>
|
|
<DD>Returns the number of jobs with the specified id remaining.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>id</CODE> - a <code>String</code> value
|
|
<DT><B>Returns:</B><DD>an <code>int</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addPrettySprite(edu.gatech.cs2335.lemmings.engine.PrettySprite)"><!-- --></A><H3>
|
|
addPrettySprite</H3>
|
|
<PRE>
|
|
public void <B>addPrettySprite</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html" title="class in edu.gatech.cs2335.lemmings.engine">PrettySprite</A> ps)</PRE>
|
|
<DL>
|
|
<DD>Adds a new pretty sprite to the llist of pretty sprites.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>ps</CODE> - a <code>PrettySprite</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="killPrettySprite(edu.gatech.cs2335.lemmings.engine.PrettySprite)"><!-- --></A><H3>
|
|
killPrettySprite</H3>
|
|
<PRE>
|
|
public void <B>killPrettySprite</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html" title="class in edu.gatech.cs2335.lemmings.engine">PrettySprite</A> ps)</PRE>
|
|
<DL>
|
|
<DD>Kills the pretty sprite. Note that this actually sends the pretty
|
|
sprite to lemming heaven instead of outright killing it, since we
|
|
would like to avoid garbage collection during the game, if
|
|
possible.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>ps</CODE> - a <code>PrettySprite</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="pause()"><!-- --></A><H3>
|
|
pause</H3>
|
|
<PRE>
|
|
public void <B>pause</B>()</PRE>
|
|
<DL>
|
|
<DD>Pauses the level.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="unpause()"><!-- --></A><H3>
|
|
unpause</H3>
|
|
<PRE>
|
|
public void <B>unpause</B>()</PRE>
|
|
<DL>
|
|
<DD>Unpauses the level.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="isPaused()"><!-- --></A><H3>
|
|
isPaused</H3>
|
|
<PRE>
|
|
public boolean <B>isPaused</B>()</PRE>
|
|
<DL>
|
|
<DD>Describe <code>isPaused</code> method here.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>boolean , true for paused, false for unpaused</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="stopLevel()"><!-- --></A><H3>
|
|
stopLevel</H3>
|
|
<PRE>
|
|
public void <B>stopLevel</B>()</PRE>
|
|
<DL>
|
|
<DD>This function will be called when the level should be stopped -
|
|
either when the time has run out, or all the lemmings are off the
|
|
map.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="isLevelOver()"><!-- --></A><H3>
|
|
isLevelOver</H3>
|
|
<PRE>
|
|
public boolean <B>isLevelOver</B>()</PRE>
|
|
<DL>
|
|
<DD>Returns true if the level is over. A level is considered over if
|
|
the time has run out, or if there are no pending or live
|
|
lemmings.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>boolean , whether or not the level is over</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="updateLevel()"><!-- --></A><H3>
|
|
updateLevel</H3>
|
|
<PRE>
|
|
public void <B>updateLevel</B>()</PRE>
|
|
<DL>
|
|
<DD>Runs through the lemmings and updates each one that needs
|
|
updating. Also, if it is time to release a new lemming, does so.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="updateLevel(edu.gatech.cs2335.lemmings.networking.AbstractMessage)"><!-- --></A><H3>
|
|
updateLevel</H3>
|
|
<PRE>
|
|
public void <B>updateLevel</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/networking/AbstractMessage.html" title="class in edu.gatech.cs2335.lemmings.networking">AbstractMessage</A> message)</PRE>
|
|
<DL>
|
|
<DD>Updates the level with the message received from the network.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>message</CODE> - mes</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="releaseLemming()"><!-- --></A><H3>
|
|
releaseLemming</H3>
|
|
<PRE>
|
|
public void <B>releaseLemming</B>()</PRE>
|
|
<DL>
|
|
<DD>Releases a new lemming from the release point.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="nukeEmALL()"><!-- --></A><H3>
|
|
nukeEmALL</H3>
|
|
<PRE>
|
|
public void <B>nukeEmALL</B>()</PRE>
|
|
<DL>
|
|
<DD>Makes all the lemmings explode.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="killLemming(edu.gatech.cs2335.lemmings.engine.Lemming, boolean)"><!-- --></A><H3>
|
|
killLemming</H3>
|
|
<PRE>
|
|
public void <B>killLemming</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Lemming.html" title="class in edu.gatech.cs2335.lemmings.engine">Lemming</A> lemming,
|
|
boolean saved)</PRE>
|
|
<DL>
|
|
<DD>Kills the lemming passed in.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>lemming</CODE> - The lemming to be killed.<DD><CODE>saved</CODE> - If true, then the lemming will be counted as
|
|
saved. Otherwise, it will count as dead.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="assignJobToLemming(edu.gatech.cs2335.lemmings.engine.Lemming)"><!-- --></A><H3>
|
|
assignJobToLemming</H3>
|
|
<PRE>
|
|
public void <B>assignJobToLemming</B>(<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Lemming.html" title="class in edu.gatech.cs2335.lemmings.engine">Lemming</A> l)</PRE>
|
|
<DL>
|
|
<DD>This function will be called when a lemming has been clicked.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>l</CODE> - a <code>Lemming</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="findLemmingAt(java.awt.Point)"><!-- --></A><H3>
|
|
findLemmingAt</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Lemming.html" title="class in edu.gatech.cs2335.lemmings.engine">Lemming</A> <B>findLemmingAt</B>(java.awt.Point coordinates)</PRE>
|
|
<DL>
|
|
<DD>Returns the lemming at given world coordinates, or NULL if no
|
|
such lemming exists.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>coordinates</CODE> - a <code>Point</code> value
|
|
<DT><B>Returns:</B><DD>a <code>Lemming</code> value</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="cleanUp()"><!-- --></A><H3>
|
|
cleanUp</H3>
|
|
<PRE>
|
|
public void <B>cleanUp</B>()</PRE>
|
|
<DL>
|
|
<DD>Describe <code>cleanUp</code> method here.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/ICleanable.html#cleanUp()">cleanUp</A></CODE> in interface <CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/ICleanable.html" title="interface in edu.gatech.cs2335.lemmings.engine">ICleanable</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLemmingFlow()"><!-- --></A><H3>
|
|
getLemmingFlow</H3>
|
|
<PRE>
|
|
public int <B>getLemmingFlow</B>()</PRE>
|
|
<DL>
|
|
<DD>Accessor for lemmingFlow rate
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>int , lemmingFlow rate</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="increaseLemmingFlow()"><!-- --></A><H3>
|
|
increaseLemmingFlow</H3>
|
|
<PRE>
|
|
public void <B>increaseLemmingFlow</B>()</PRE>
|
|
<DL>
|
|
<DD>Increases the lemming flow rate by 1
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="decreaseLemmingFlow()"><!-- --></A><H3>
|
|
decreaseLemmingFlow</H3>
|
|
<PRE>
|
|
public void <B>decreaseLemmingFlow</B>()</PRE>
|
|
<DL>
|
|
<DD>Decrease the lemming flow rate by 1
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getNumLemmings()"><!-- --></A><H3>
|
|
getNumLemmings</H3>
|
|
<PRE>
|
|
public int <B>getNumLemmings</B>()</PRE>
|
|
<DL>
|
|
<DD>accessor
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>int</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setNumLemmings(int)"><!-- --></A><H3>
|
|
setNumLemmings</H3>
|
|
<PRE>
|
|
public void <B>setNumLemmings</B>(int i)</PRE>
|
|
<DL>
|
|
<DD>mutator
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>i</CODE> - value for numLemmings</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLemmingFlow(int)"><!-- --></A><H3>
|
|
setLemmingFlow</H3>
|
|
<PRE>
|
|
public void <B>setLemmingFlow</B>(int rate)</PRE>
|
|
<DL>
|
|
<DD>Sets lemmingFlow
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>rate</CODE> - , new flowrate</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="duplicate()"><!-- --></A><H3>
|
|
duplicate</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Level.html" title="class in edu.gatech.cs2335.lemmings.engine">Level</A> <B>duplicate</B>()</PRE>
|
|
<DL>
|
|
<DD>Creates a duplicate copy of this level for multiplayer games
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>Level</DL>
|
|
</DD>
|
|
</DL>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<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> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LemmingsSoul.html" title="class in edu.gatech.cs2335.lemmings.engine"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/LevelData.html" title="class in edu.gatech.cs2335.lemmings.engine"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="Level.html" target="_top"><B>NO FRAMES</B></A>
|
|
<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>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
|
|
</BODY>
|
|
</HTML>
|