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

Class TimedTeleportScroll

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

games.stendhal.server.entity.item.scroll.TimedTeleportScroll

All Implemented Interfaces:

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

Direct Known Subclasses:

BalloonScroll, RainbowBeansScroll, TwilightMossScroll

public class TimedTeleportScroll
extends TeleportScroll

Represents a teleport scroll that takes the player to a specified location for a specified time, after which it will teleport the player to given location.

infostring attribute in items.xml:

1_dreamscape 77 35 5400 0_semos_plains_s -1 -1

where

• 1_dreamscape is the target zone name;
• 77 and 35 are the target x and y position;
• 5400 is the number of turns before return;
• 0_semos_plains_s is the return zone;
• -1 and -1 are the return x and y positions (negative value means a random position)

TODO: This class isn't fully self-containing as the LoginHandler (that handles the players logging in the target zone) must be implemented elsewhere, i.e. in a quest file.

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

Method Summary

Modifier and Type	Method	Description
protected String	getAfterReturnMessage()	override this to show a message after teleporting the player back.
protected String	getBeforeReturnMessage()	override this to show a message before teleporting the player back.
boolean	teleportBack(Player player)	Teleport the player back from the target zone.
protected boolean	useTeleportScroll(Player player)	Is invoked when a teleporting scroll is used.
protected boolean	useTeleportScroll(Player player, String targetZoneName, int x, int y, int timeInTurns)	Is invoked when a teleporting scroll is used.

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

useScroll

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

autobind, canBeEquippedIn, describe, deteriorate, deteriorate, generateRPClass, getAttack, getAttackRate, getAttackRate, getBoundTo, getDamageType, getDefaultAttackRate, getDefense, getDescriptionName, getDeterioration, getInfoString, getItemClass, getItemSubclass, getMinLevel, getName, getPlantGrower, getPossibleSlots, getRangedAttack, getSusceptibility, getTitle, getWeaponType, initializeActiveSlotsList, initializeStatusResistancesList, isBound, isFromCorpse, isOfClass, isPersistent, isUndroppableOnDeath, onEquipped, onPickedUp, onPutOnGround, onPutOnGround, onRemoveFromGround, onTurnReached, onUnequipped, removeFromWorld, repair, setBoundTo, setDamageType, setEquipableSlots, setFromCorpse, setInfoString, setPersistent, setPlantGrower, 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

TimedTeleportScroll

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

Creates a new timed marked teleport scroll.

Parameters:

name -

clazz -

subclass -

attributes -

TimedTeleportScroll

public TimedTeleportScroll(TimedTeleportScroll item)

Copy constructor.

Parameters:

item - item to copy

Method Details

teleportBack

public boolean teleportBack(Player player)

Teleport the player back from the target zone.

Parameters:

player -

Returns:

true if teleport was successful

useTeleportScroll

protected boolean useTeleportScroll(Player player)

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

Specified by:

useTeleportScroll in class TeleportScroll

Parameters:

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

Returns:

true if teleport was successful

useTeleportScroll

protected boolean useTeleportScroll(Player player,
 String targetZoneName,
 int x,
 int y,
 int timeInTurns)

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

Parameters:

player - The player who used the scroll

targetZoneName - The name of the zone where the player tries to teleport

x - x coordinate of the target location

y - y coordinate of the target location

timeInTurns - The time on turns that the player should spend on the the target zone unless she leaves by other means than the scrolls timeout feature

Returns:

true if teleport was succesful

getBeforeReturnMessage

protected String getBeforeReturnMessage()

override this to show a message before teleporting the player back.

Returns:

the message to shown or null for no message

getAfterReturnMessage

protected String getAfterReturnMessage()

override this to show a message after teleporting the player back.

Returns:

the message to shown or null for no message