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

Class PasswordPortal

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

All Implemented Interfaces:

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

public class PasswordPortal
extends Portal

a portal which requires a password to pass through

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.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
PasswordPortal()	Creates a default PasswordPortal
PasswordPortal(String password)	creates a portal which requires a password to be said by the player

Method Summary

Modifier and Type	Method	Description
String	getPassword()	gets the password
String	getRejectedMessage()	gets the reject message
void	logic()
boolean	onUsed(RPEntity user)	Override so portal does not get "used"
void	setAcceptedMessage(String message)	Optional message to be sent to player when portal is successfully used
void	setListeningRadius(int radius)
void	setPassword(String password)	sets the required password
void	setRejectedMessage(String message)	sets the reject message

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

Constructor Details

PasswordPortal

public PasswordPortal()

Creates a default PasswordPortal

PasswordPortal

public PasswordPortal(String password)

creates a portal which requires a password to be said by the player

Parameters:

password - password to say

Method Details

getPassword

public String getPassword()

gets the password

Returns:

password

getRejectedMessage

public String getRejectedMessage()

gets the reject message

Returns:

reject message

logic

public void logic()

Overrides:

logic in class Portal

onUsed

public boolean onUsed(RPEntity user)

Override so portal does not get "used"

Specified by:

onUsed in interface UseListener

Overrides:

onUsed in class Portal

Parameters:

user - the RPEntity who uses the object

Returns:

true if successful

setAcceptedMessage

public void setAcceptedMessage(String message)

Optional message to be sent to player when portal is successfully used

Parameters:

message - Message to be sent

setListeningRadius

public void setListeningRadius(int radius)

Parameters:

radius - Radius at which portal will listen for player's speech

setPassword

public void setPassword(String password)

sets the required password

Parameters:

password - new password

setRejectedMessage

public void setRejectedMessage(String message)

sets the reject message

Parameters:

message - message informing the player about the failed condition