Package games.stendhal.server.entity.item.scroll

Class TeleportScroll

java.lang.Object

marauroa.common.game.Attributes

marauroa.common.game.SlotOwner

marauroa.common.game.RPObject

games.stendhal.server.entity.Entity

games.stendhal.server.entity.PassiveEntity

games.stendhal.server.entity.item.Item

games.stendhal.server.entity.item.StackableItem

games.stendhal.server.entity.item.scroll.Scroll

games.stendhal.server.entity.item.scroll.TeleportScroll

All Implemented Interfaces:

EquipListener, TurnListener, UseListener, Stackable<StackableItem>, Killer, Cloneable, Iterable<String>, Serializable

Direct Known Subclasses:

InvitationScroll, MarkedScroll, TimedTeleportScroll

public abstract class TeleportScroll
extends Scroll

Represents a general teleport scroll.

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.item.Item

DEGRADATION_TIMEOUT

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
TeleportScroll(TeleportScroll item)	Copy constructor.
TeleportScroll(String name, String clazz, String subclass, Map<String,String> attributes)	Creates a new teleport scroll.

Method Summary

Modifier and Type	Method	Description
protected boolean	useScroll(Player player)	Is invoked when a teleporting scroll is used.
protected abstract boolean	useTeleportScroll(Player player)	Is invoked when a teleporting scroll is actually used.

Methods inherited from class games.stendhal.server.entity.item.scroll.Scroll

onUsed

Methods inherited from class games.stendhal.server.entity.item.StackableItem

add, getCapacity, getQuantity, isStackable, removeOne, setCapacity, setQuantity, splitOff, sub, update

Methods inherited from class games.stendhal.server.entity.item.Item

addStatusAttacker, autobind, canBeEquippedIn, describe, deteriorate, deteriorate, generateRPClass, getAttack, getAttackRate, getAttackRate, getBoundTo, getDamageType, getDefaultAttackRate, getDefense, getDescriptionName, getDeterioration, getItemClass, getItemData, getItemSubclass, getMinLevel, getName, getPlantGrower, getPossibleSlots, getRangedAttack, getState, getStatusAttackers, getSusceptibility, getTitle, getWeaponType, initializeActiveSlotsList, initializeStatusResistancesList, isBound, isFromCorpse, isOfClass, isPersistent, isUndroppableOnDeath, onEquipped, onPickedUp, onPutOnGround, onPutOnGround, onRemoveFromGround, onTurnReached, onUnequipped, removeFromWorld, repair, setBoundTo, setDamageType, setEquipableSlots, setFromCorpse, setItemData, setPersistent, setPlantGrower, setState, setSusceptibilities, setUndroppableOnDeath, setUseBehavior, toString

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

getAdjacentNodes, getArea, getArea, getCursor, getDescription, getEntitySlot, getHeight, getOrigin, getResistance, getResistance, 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

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, 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

TeleportScroll

public TeleportScroll(String name,
 String clazz,
 String subclass,
 Map<String,String> attributes)

Creates a new teleport scroll.

Parameters:

name -

clazz -

subclass -

attributes -

TeleportScroll

public TeleportScroll(TeleportScroll item)

Copy constructor.

Parameters:

item - item to copy

Method Details

useTeleportScroll

protected abstract boolean useTeleportScroll(Player player)

Is invoked when a teleporting scroll is actually used.

Parameters:

player - The player who used the scroll and who will be teleported

Returns:

true iff teleport was successful

useScroll

protected boolean useScroll(Player player)

Is invoked when a teleporting scroll is used. Tries to put the player on the scroll's destination, or near it.

Overrides:

useScroll in class Scroll

Parameters:

player - The player who used the scroll and who will be teleported

Returns:

true iff teleport was successful