Package games.stendhal.server.entity.mapstuff.area

Class OnePlayerArea

java.lang.Object

marauroa.common.game.Attributes

marauroa.common.game.SlotOwner

marauroa.common.game.RPObject

games.stendhal.server.entity.Entity

games.stendhal.server.entity.mapstuff.area.AreaEntity

games.stendhal.server.entity.mapstuff.area.OnePlayerArea

All Implemented Interfaces:

MovementListener, Killer, Cloneable, Iterable<String>, Serializable

public class OnePlayerArea
extends AreaEntity
implements MovementListener

An area that only allows one play at a time to enter.

Nested Class Summary

Nested classes/interfaces inherited from class marauroa.common.game.RPObject

RPObject.ID

Field Summary

Fields

Modifier and Type	Field	Description
protected WeakReference<Player>	occupantRef	The reference to the entity currently in the area.

Fields inherited from class games.stendhal.server.entity.mapstuff.area.AreaEntity

ATTR_NAME

Fields inherited from class games.stendhal.server.entity.Entity

area

Fields inherited from class marauroa.common.game.RPObject

INVALID_ID

Fields inherited from class marauroa.common.game.SlotOwner

slots

Constructor Summary

Constructors

Constructor	Description
OnePlayerArea(int width, int height)	Create a one player area.

Method Summary

Modifier and Type	Method	Description
void	beforeMove(ActiveEntity entity, StendhalRPZone zone, int oldX, int oldY, int newX, int newY)	Invoked before an entity moves while over the object area.
protected void	clearOccupant()	Clear the occupant.
protected boolean	contains(Entity entity)	Check if an entity is in this area.
protected Player	getOccupant()	Get the occupant.
boolean	isObstacle(Entity entity)	Checks whether players, NPC's, etc.
void	onAdded(StendhalRPZone zone)	Called when this object is added to a zone.
void	onEntered(ActiveEntity entity, StendhalRPZone zone, int newX, int newY)	Invoked when an entity enters the object area.
void	onExited(ActiveEntity entity, StendhalRPZone zone, int oldX, int oldY)	Invoked when an entity leaves the object area.
void	onMoved(ActiveEntity entity, StendhalRPZone zone, int oldX, int oldY, int newX, int newY)	Invoked when an entity moves while over the object area.
void	onRemoved(StendhalRPZone zone)	Called when this object is being removed from a zone.
protected void	setOccupant(Player player)	Set the occupant.
void	update()	Handle object attribute change(s).

Methods inherited from class games.stendhal.server.entity.mapstuff.area.AreaEntity

addBehaviour, generateRPClass, getDescriptionName, getName, getTitle, setName

Methods inherited from class games.stendhal.server.entity.Entity

describe, getAdjacentNodes, getArea, getArea, getCursor, getDescription, getEntitySlot, getHeight, getOrigin, getResistance, getResistance, getWidth, getX, getY, getZone, hasDescription, isInSight, nextTo, nextTo, notifyWorldAboutChanges, onMoved, setCursor, setDescription, setEntityClass, setEntitySubclass, setMenu, setPosition, setResistance, setSize, setVisibility, slotIterator, slots, squaredDistance, squaredDistance, stopped

Methods inherited from class marauroa.common.game.RPObject

addEvent, addLink, addLink, addMap, addSlot, addSlot, applyDifferences, clearEvents, clearVisible, clone, containsKey, equals, events, eventsIterator, fill, get, getBaseContainer, getBoolean, getContainer, getContainerBaseOwner, getContainerOwner, getContainerSlot, getDifferences, getDouble, getFromSlots, getID, getInt, getLink, getLinkedObject, getMap, getSlot, has, hashCode, hasLink, hasMap, hasSlot, hide, isContained, isEmpty, isHidden, isStorable, maps, put, put, put, put, readObject, remove, removeLink, removeMap, removeSlot, resetAddedAndDeleted, resetAddedAndDeletedMaps, resetAddedAndDeletedRPLink, resetAddedAndDeletedRPSlot, setAddedMaps, setAddedRPSlot, setContainer, setDeletedMaps, setDeletedRPSlot, setID, size, slots, slotsIterator, store, toString, unhide, unstore, writeObject, writeObject, writeToJson

Methods inherited from class marauroa.common.game.SlotOwner

deserializeRPSlots, fill, serializeRPSlots

Methods inherited from class marauroa.common.game.Attributes

add, applyDifferences, get, getBool, getDouble, getInt, getList, getLong, getRPClass, has, instanceOf, iterator, put, put, put, put, put, readFromMap, remove, resetAddedAndDeletedAttributes, setAddedAttributes, setDeletedAttributes, setRPClass, setRPClass, toAttributeString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface games.stendhal.server.entity.Killer

clone

Methods inherited from interface games.stendhal.server.core.events.MovementListener

getArea

Field Details

occupantRef

protected WeakReference<Player> occupantRef

The reference to the entity currently in the area.

Constructor Details

OnePlayerArea

public OnePlayerArea(int width,
 int height)

Create a one player area.

Parameters:

width - The area width.

height - The area height.

Method Details

clearOccupant

protected void clearOccupant()

Clear the occupant.

contains

protected boolean contains(Entity entity)

Check if an entity is in this area.

Parameters:

entity - The entity to check.

Returns:

true if the entity is in this area.

getOccupant

protected Player getOccupant()

Get the occupant.

Returns:

The area occupant, or null in none.

setOccupant

protected void setOccupant(Player player)

Set the occupant.

Parameters:

player - The occupant to set.

isObstacle

public boolean isObstacle(Entity entity)

Checks whether players, NPC's, etc. can walk over this entity.

Overrides:

isObstacle in class Entity

Parameters:

entity - The entity trying to enter.

Returns:

true if a Player is given and it is occupied by someone else.

onAdded

public void onAdded(StendhalRPZone zone)

Called when this object is added to a zone.

Overrides:

onAdded in class AreaEntity

Parameters:

zone - The zone this was added to.

onRemoved

public void onRemoved(StendhalRPZone zone)

Called when this object is being removed from a zone.

Overrides:

onRemoved in class AreaEntity

Parameters:

zone - The zone this will be removed from.

update

public void update()

Handle object attribute change(s).

Overrides:

update in class Entity

onEntered

public void onEntered(ActiveEntity entity,
 StendhalRPZone zone,
 int newX,
 int newY)

Invoked when an entity enters the object area.

Specified by:

onEntered in interface MovementListener

Parameters:

entity - The entity that moved.

zone - The new zone.

newX - The new X coordinate.

newY - The new Y coordinate.

onExited

public void onExited(ActiveEntity entity,
 StendhalRPZone zone,
 int oldX,
 int oldY)

Invoked when an entity leaves the object area.

Specified by:

onExited in interface MovementListener

Parameters:

entity - The entity that entered.

zone - The old zone.

oldX - The old X coordinate.

oldY - The old Y coordinate.

onMoved

public void onMoved(ActiveEntity entity,
 StendhalRPZone zone,
 int oldX,
 int oldY,
 int newX,
 int newY)

Invoked when an entity moves while over the object area.

Specified by:

onMoved in interface MovementListener

Parameters:

entity - The entity that left.

zone - The zone.

oldX - The old X coordinate.

oldY - The old Y coordinate.

newX - The new X coordinate.

newY - The new Y coordinate.

beforeMove

public void beforeMove(ActiveEntity entity,
 StendhalRPZone zone,
 int oldX,
 int oldY,
 int newX,
 int newY)

Description copied from interface: MovementListener

Invoked before an entity moves while over the object area.

Specified by:

beforeMove in interface MovementListener

Parameters:

entity - The entity that left.

zone - The zone.

oldX - The old X coordinate.

oldY - The old Y coordinate.

newX - The new X coordinate.

newY - The new Y coordinate.