Package games.stendhal.server.entity.mapstuff.portal

Class KeyedPortal

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.portal.Portal

games.stendhal.server.entity.mapstuff.portal.AccessCheckingPortal

games.stendhal.server.entity.mapstuff.portal.KeyedPortal

All Implemented Interfaces:

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

public class KeyedPortal
extends AccessCheckingPortal

A keyed portal is a special kind of portal which requires a key to pass it. If the player carries the key with him, he can use the portal just like a normal portal.

Nested Class Summary

Nested classes/interfaces inherited from class games.stendhal.server.entity.mapstuff.portal.AccessCheckingPortal

AccessCheckingPortal.SendMessage

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

RPObject.ID

Field Summary

Fields

Modifier and Type	Field	Description
protected String	key	The key item needed.
protected int	quantity	The minimum number of items.

Fields inherited from class games.stendhal.server.entity.mapstuff.portal.AccessCheckingPortal

forceStop, instantAction, listeningRadius, passwordAcceptedMessage, passwordRejectedMessage, portalID, portalIDCounter, rejectedAction, rejectedMessage, requiredPassword

Fields inherited from class games.stendhal.server.entity.mapstuff.portal.Portal

ATTR_FACE, ATTR_HIDDEN, ATTR_OFFSET, ATTR_USE

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
KeyedPortal(String key)	Creates a new keyed portal.
KeyedPortal(String key, int quantity)	Creates a new keyed portal.
KeyedPortal(String key, int quantity, String rejectMessage)	Creates a new keyed portal.

Method Summary

Modifier and Type	Method	Description
protected boolean	isAllowed(RPEntity user)	Determine if this portal can be used.

Methods inherited from class games.stendhal.server.entity.mapstuff.portal.AccessCheckingPortal

getListeningRadius, getPasswordAcceptedMessage, getPasswordRejectedMessage, getRejectedMessage, getRequiredPassword, hasInstanceAction, logic, onUsed, playerIsPortalUnlocked, rejected, sendMessage, setForceStop, setInstantAction, setListeningRadius, setPasswordAcceptedMessage, setPasswordRejectedMessage, setRejectedAction, setRejectedMessage, setRequiredPassword

Methods inherited from class games.stendhal.server.entity.mapstuff.portal.Portal

generateRPClass, getDestinationReference, getDestinationZone, getFaceDirection, getIdentifier, getOffset, hasFaceDirection, hasOffset, isHidden, loaded, onPushedOntoFrom, onUsedBackwards, setDestination, setFaceDirection, setFaceDirection, setHidden, setIdentifier, setIgnoreNoDestination, toString, usePortal

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

describe, getAdjacentNodes, getArea, getArea, getCursor, getDescription, getDescriptionName, getEntitySlot, getHeight, getName, getOrigin, getResistance, getResistance, getTitle, getWidth, getX, getY, getZone, hasDescription, isInSight, isObstacle, nextTo, nextTo, notifyWorldAboutChanges, onAdded, onMoved, onRemoved, 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, 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, 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

key

protected String key

The key item needed.

quantity

protected int quantity

The minimum number of items.

Constructor Details

KeyedPortal

public KeyedPortal(String key)

Creates a new keyed portal.

Parameters:

key - The name of the required key.

KeyedPortal

public KeyedPortal(String key,
 int quantity)

Creates a new keyed portal.

Parameters:

key - The name of the required key.

quantity - The key quantity required.

KeyedPortal

public KeyedPortal(String key,
 int quantity,
 String rejectMessage)

Creates a new keyed portal.

Parameters:

key - The name of the required key.

quantity - The key quantity required.

rejectMessage - The message given when rejected.

Method Details

isAllowed

protected boolean isAllowed(RPEntity user)

Determine if this portal can be used.

Specified by:

isAllowed in class AccessCheckingPortal

Parameters:

user - The user to be checked.

Returns:

true if the user can use the portal.