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

Class MessagingArea

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.MessagingArea

All Implemented Interfaces:

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

public class MessagingArea
extends AreaEntity
implements MovementListener

Area that sends a private message to any player entering and/or leaving it.

Nested Class Summary

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

RPObject.ID

Field Summary

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
MessagingArea(boolean coversZone, int width, int height, String enterMessage, String leaveMessage, boolean isWarning)	Create a MessagingArea.

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.
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 newX, int newY)	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.
boolean	warnPlayer()

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, isObstacle, nextTo, nextTo, notifyWorldAboutChanges, onMoved, setCursor, setDescription, setEntityClass, setEntitySubclass, setMenu, setPosition, setResistance, setSize, setVisibility, slotIterator, slots, squaredDistance, squaredDistance, stopped, update

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

Constructor Details

MessagingArea

public MessagingArea(boolean coversZone,
 int width,
 int height,
 String enterMessage,
 String leaveMessage,
 boolean isWarning)

Create a MessagingArea.

Parameters:

coversZone - true if the area should cover the whole zone

width - width of the area

height - height of the area

enterMessage - message to be sent to players entering the area

leaveMessage - message to be sent to players leaving the area

isWarning - set to true if the message is a warning that is especially important for the player to see

Method Details

onEntered

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

Description copied from interface: MovementListener

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 newX,
 int newY)

Description copied from interface: MovementListener

Invoked when an entity leaves the object area.

Specified by:

onExited in interface MovementListener

Parameters:

entity - The entity that entered.

zone - The old zone.

newX - The old X coordinate.

newY - The old Y coordinate.

onMoved

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

Description copied from interface: MovementListener

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.

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.

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.

warnPlayer

public boolean warnPlayer()