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

Class AreaEntity

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

All Implemented Interfaces:

Killer, Cloneable, Iterable<String>, Serializable

Direct Known Subclasses:

Allotment, BlockTarget, ConditionAndActionArea, CreatureProtectionArea, GameBoard, MessagingArea, OccupantArea, OnePlayerArea, SokobanBoard, TargetMarker, TiledArea, WalkBlocker, Wall

public class AreaEntity
extends Entity

A base area entity.

Nested Class Summary

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

RPObject.ID

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	ATTR_NAME	The name attribute 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
AreaEntity()	Creates a one by one area entity.
AreaEntity(int width, int height)	Create an area entity.

Method Summary

Modifier and Type	Method	Description
void	addBehaviour(AreaBehaviour behaviour)	adds a Behaviour to this area
static void	generateRPClass()	Generate the RPClass (compatible with manual init/order).
String	getDescriptionName(boolean definite)	Returns the name or something that can be used to identify the entity for the player.
String	getName()	Get the entity name.
String	getTitle()	Get the nicely formatted entity title/name.
void	onAdded(StendhalRPZone zone)	Called when this object is added to a zone.
void	onRemoved(StendhalRPZone zone)	Called when this object is being removed from a zone.
void	setName(String name)	Set the name.

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

Field Details

ATTR_NAME

protected static final String ATTR_NAME

The name attribute name.

See Also:

Constant Field Values

Constructor Details

AreaEntity

public AreaEntity()

Creates a one by one area entity.

AreaEntity

public AreaEntity(int width,
 int height)

Create an area entity.

Parameters:

width - Width of this area

height - Height of this area

Method Details

generateRPClass

public static void generateRPClass()

Generate the RPClass (compatible with manual init/order). NOTE: This MUST be called during environment initialization.

getName

public String getName()

Get the entity name.

Specified by:

getName in interface Killer

Overrides:

getName in class Entity

Returns:

The entity's name, or null if undefined.

setName

public void setName(String name)

Set the name.

Parameters:

name - The area name.

getDescriptionName

public String getDescriptionName(boolean definite)

Returns the name or something that can be used to identify the entity for the player.

Overrides:

getDescriptionName in class Entity

Parameters:

definite - true for "the", and false for "a/an" in case the entity has no name.

Returns:

The description name.

getTitle

public String getTitle()

Get the nicely formatted entity title/name.

Overrides:

getTitle in class Entity

Returns:

The title, or null if unknown.

addBehaviour

public void addBehaviour(AreaBehaviour behaviour)

adds a Behaviour to this area

Parameters:

behaviour - behaviour to add

onAdded

public void onAdded(StendhalRPZone zone)

Description copied from class: Entity

Called when this object is added to a zone.

Overrides:

onAdded in class Entity

Parameters:

zone - The zone this was added to.

onRemoved

public void onRemoved(StendhalRPZone zone)

Description copied from class: Entity

Called when this object is being removed from a zone.

Overrides:

onRemoved in class Entity

Parameters:

zone - The zone this will be removed from.