asskoala/GTSchoolShit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

first commit

Browse Source
This commit is contained in:
Jose Caban
2025-06-07 01:59:34 -04:00
commit 388ac241f0
3558 changed files with 9116289 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

308
CS2335/FinalSubmission/apidoc/edu/gatech/cs2335/lemmings/engine/Particle.html Normal file
View File

@@ -0,0 +1,308 @@
<!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>
Particle
</TITLE>
<META NAME="keywords" CONTENT="edu.gatech.cs2335.lemmings.engine.Particle class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Particle";
}
</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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></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;<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/NetworkErrorState.html" title="class in edu.gatech.cs2335.lemmings.engine"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Portal.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> &nbsp;
&nbsp;<A HREF="Particle.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>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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 Particle</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/PhysicsObject.html" title="class in edu.gatech.cs2335.lemmings.physics">edu.gatech.cs2335.lemmings.physics.PhysicsObject</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html" title="class in edu.gatech.cs2335.lemmings.engine">edu.gatech.cs2335.lemmings.engine.PrettySprite</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>edu.gatech.cs2335.lemmings.engine.Particle</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>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/BloodParticle.html" title="class in edu.gatech.cs2335.lemmings.engine">BloodParticle</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/BoneParticle.html" title="class in edu.gatech.cs2335.lemmings.engine">BoneParticle</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/DirtParticle.html" title="class in edu.gatech.cs2335.lemmings.engine">DirtParticle</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/FlameParticle.html" title="class in edu.gatech.cs2335.lemmings.engine">FlameParticle</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/WaterParticle.html" title="class in edu.gatech.cs2335.lemmings.engine">WaterParticle</A></DD>
</DL>
<HR>
<DL>
<DT>public abstract class <B>Particle</B><DT>extends <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html" title="class in edu.gatech.cs2335.lemmings.engine">PrettySprite</A></DL>
<P>
Class Particle: When a lemming blows up, he makes particles. Well,
here they are. :)
Description from Jose:
The particle class, used for ! particle effects !
Nothing special to do here, the Physics Engine will handle the
actual effects. The single function is used to test whether or
not the particle should be killed.
<PRE>
Revision History:
v2.0 (2004 - 4 - 20) - Made abstract
v1.0 (Apr. 11, 2004) - Created the Particle class
</PRE>
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>Version 1.0, Apr. 11, 2004</DD>
<DT><B>Author:</B></DT>
<DD><A HREF="mailto:gtg184g@mail.gatech.edu">Jose Caban</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/Particle.html#Particle(java.lang.String)">Particle</A></B>(java.lang.String&nbsp;s)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new <code>Particle</code> instance.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>protected abstract &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Particle.html#canKillSelf()">canKillSelf</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Should return true when the sprite is ready to kill self.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_edu.gatech.cs2335.lemmings.engine.PrettySprite"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class edu.gatech.cs2335.lemmings.engine.<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html" title="class in edu.gatech.cs2335.lemmings.engine">PrettySprite</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html#cleanUp()">cleanUp</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html#getAnimation()">getAnimation</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html#getLevel()">getLevel</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html#setAnimation(java.lang.String)">setAnimation</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html#setLevel(edu.gatech.cs2335.lemmings.engine.Level)">setLevel</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html#updateSprite()">updateSprite</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_edu.gatech.cs2335.lemmings.physics.PhysicsObject"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class edu.gatech.cs2335.lemmings.physics.<A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/PhysicsObject.html" title="class in edu.gatech.cs2335.lemmings.physics">PhysicsObject</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/PhysicsObject.html#accelerate(edu.gatech.cs2335.lemmings.physics.PhysicsVector)">accelerate</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/PhysicsObject.html#getGravityUpdates()">getGravityUpdates</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/PhysicsObject.html#getPosition()">getPosition</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/PhysicsObject.html#getVelocity()">getVelocity</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/PhysicsObject.html#isFalling()">isFalling</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/PhysicsObject.html#setGravityUpdates(int)">setGravityUpdates</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/PhysicsObject.html#setPosition(int, int)">setPosition</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/PhysicsObject.html#setPosition(edu.gatech.cs2335.lemmings.physics.Point)">setPosition</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/PhysicsObject.html#setVelocity(edu.gatech.cs2335.lemmings.physics.PhysicsVector)">setVelocity</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/PhysicsObject.html#toString()">toString</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/PhysicsObject.html#updatePosition(int, int, int)">updatePosition</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/PhysicsObject.html#updatePosition(edu.gatech.cs2335.lemmings.physics.Point)">updatePosition</A>, <A HREF="../../../../../edu/gatech/cs2335/lemmings/physics/PhysicsObject.html#updateVelocity(edu.gatech.cs2335.lemmings.physics.PhysicsVector)">updateVelocity</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<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, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<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="Particle(java.lang.String)"><!-- --></A><H3>
Particle</H3>
<PRE>
public <B>Particle</B>(java.lang.String&nbsp;s)</PRE>
<DL>
<DD>Creates a new <code>Particle</code> instance.
<P>
<DT><B>Parameters:</B><DD><CODE>s</CODE> - s</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="canKillSelf()"><!-- --></A><H3>
canKillSelf</H3>
<PRE>
protected abstract boolean <B>canKillSelf</B>()</PRE>
<DL>
<DD>Should return true when the sprite is ready to kill self.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html#canKillSelf()">canKillSelf</A></CODE> in class <CODE><A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/PrettySprite.html" title="class in edu.gatech.cs2335.lemmings.engine">PrettySprite</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a <code>boolean</code> value</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></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;<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/NetworkErrorState.html" title="class in edu.gatech.cs2335.lemmings.engine"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../edu/gatech/cs2335/lemmings/engine/Portal.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> &nbsp;
&nbsp;<A HREF="Particle.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>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>