com.tootsville.npc
Class SmudgeStain

java.lang.Object
  com.tootsville.npc.SmudgeStain

public class SmudgeStain
extends Object

WRITEME: Document this type.

Author:

brpocock@star-hope.org

Nested Class Summary

(package private) static class

SmudgeStain.StepOnMe WRITEME: Document this type.

Field Summary

private static int	CIRCLING_STEPS WRITEME
private static double	DIAMETER WRITEME
private String	eventZone the zone ID assigned for the event area containing this oil slick
private int	id unique ID
protected static AtomicInteger	idAssigner WRITEME: Document this brpocock@star-hope.org
private String	itemString the item ID (in the room variables) used to place this oil slick's graphic
private ActionHandler	myHandler WRITEME: Document this brpocock@star-hope.org
private Room	myRoom WRITEME: Document this brpocock@star-hope.org
private org.starhope.appius.geometry.Polygon	polygon The polygonal area surrounding this stain
private static double	TRIG_SCALAR WRITEME

Constructor Summary

SmudgeStain(Room room, org.starhope.appius.geometry.Coord3D position)
WRITEME: Document this constructor brpocock@star-hope.org

Method Summary

protected void	cleanUp(AbstractUser cleaner) WRITEME: Document this method brpocock@star-hope.org
protected void	ewwSticky(AbstractUser steppedInIt) WRITEME: Document this method brpocock@star-hope.org
private int	getID()
String	getItemString()
org.starhope.appius.geometry.Polygon	getPolygon()
Room	getRoom()
private String	randomSmudge()

Methods inherited from class java.lang.Object

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

Field Detail

CIRCLING_STEPS

private static final int CIRCLING_STEPS

WRITEME

See Also:

Constant Field Values

DIAMETER

private static final double DIAMETER

WRITEME

See Also:

Constant Field Values

TRIG_SCALAR

private static final double TRIG_SCALAR

WRITEME

See Also:

Constant Field Values

idAssigner

protected static final AtomicInteger idAssigner

WRITEME: Document this brpocock@star-hope.org

id

private final int id

unique ID

myHandler

private final ActionHandler myHandler

WRITEME: Document this brpocock@star-hope.org

myRoom

private final Room myRoom

WRITEME: Document this brpocock@star-hope.org

eventZone

private final String eventZone

the zone ID assigned for the event area containing this oil slick

itemString

private final String itemString

the item ID (in the room variables) used to place this oil slick's graphic

polygon

private final org.starhope.appius.geometry.Polygon polygon

The polygonal area surrounding this stain

Constructor Detail

SmudgeStain

public SmudgeStain(Room room,
                   org.starhope.appius.geometry.Coord3D position)

WRITEME: Document this constructor brpocock@star-hope.org

Parameters:

room - WRITEME

position - WRITEME

Method Detail

cleanUp

protected void cleanUp(AbstractUser cleaner)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

cleaner - user who cleaned up the mess

ewwSticky

protected void ewwSticky(AbstractUser steppedInIt)

WRITEME: Document this method brpocock@star-hope.org

Parameters:

steppedInIt - who stepped in the icky spot

getID

private int getID()

Returns:

this stain's particular ID

getItemString

public String getItemString()

Returns:

the itemString

getPolygon

public org.starhope.appius.geometry.Polygon getPolygon()

Returns:

the event region for this stain

getRoom

public Room getRoom()

Returns:

the myRoom

randomSmudge

private String randomSmudge()

Returns:

an oily slick item number to be placed in the room