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

Class CreatureProtectionArea

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

All Implemented Interfaces:

Killer, Cloneable, Iterable<String>, Serializable

public class CreatureProtectionArea
extends AreaEntity

An area prevents creatures from entering. This allows a layered chain of criteria. Think of this as a creature firewall.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CreatureProtectionArea.Entry	An entry representing creature criteria.

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

RPObject.ID

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	defaultBlocked	Whether to block on no match.
protected List<CreatureProtectionArea.Entry>	entries	The list (if any specific) of blocked creatures.

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
CreatureProtectionArea()	Create a 1x1 creature protection area.
CreatureProtectionArea(int width, int height)	Create a creature protection area.
CreatureProtectionArea(int width, int height, boolean defaultBlocked)	Create a creature protection area.

Method Summary

Modifier and Type	Method	Description
void	add(String clazz)	Add a blocked criteria entry.
void	add(String clazz, String subclazz)	Add a blocked criteria entry.
void	add(String clazz, String subclazz, boolean blocked)	Add a criteria entry.
boolean	isObstacle(Entity entity)	Checks whether a creature can enter.
protected boolean	matchesCriteria(Creature creature, boolean defaultAnswer)	Does a creature match a criteria entry.

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

addBehaviour, generateRPClass, getDescriptionName, getName, getTitle, onAdded, onRemoved, 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, 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

defaultBlocked

protected boolean defaultBlocked

Whether to block on no match.

entries

protected List<CreatureProtectionArea.Entry> entries

The list (if any specific) of blocked creatures.

Constructor Details

CreatureProtectionArea

public CreatureProtectionArea()

Create a 1x1 creature protection area.

CreatureProtectionArea

public CreatureProtectionArea(int width,
 int height)

Create a creature protection area.

Parameters:

width - The area width.

height - The area height.

CreatureProtectionArea

public CreatureProtectionArea(int width,
 int height,
 boolean defaultBlocked)

Create a creature protection area.

Parameters:

width - The area width.

height - The area height.

defaultBlocked - Whether blocked on no match.

Method Details

add

public void add(String clazz)

Add a blocked criteria entry.

Parameters:

clazz - A creature class to match (or null for any).

add

public void add(String clazz,
 String subclazz)

Add a blocked criteria entry.

Parameters:

clazz - A creature class to match (or null for any).

subclazz - A creature subclass to match (or null for any).

add

public void add(String clazz,
 String subclazz,
 boolean blocked)

Add a criteria entry.

Parameters:

clazz - A creature class to match (or null for any).

subclazz - A creature subclass to match (or null for any).

blocked - Whether to block.

matchesCriteria

protected boolean matchesCriteria(Creature creature,
 boolean defaultAnswer)

Does a creature match a criteria entry.

Parameters:

creature - The creature to compare.

defaultAnswer - The answer if no match is found.

Returns:

The matching criteria, or default response.

isObstacle

public boolean isObstacle(Entity entity)

Checks whether a creature can enter.

Overrides:

isObstacle in class Entity

Parameters:

entity - The entity to check against.

Returns:

true if a matching creature is given.