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

Class SummonScroll

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

All Implemented Interfaces:

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

public class SummonScroll
extends Scroll

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

Method Summary

Modifier and Type	Method	Description
String	describe()	Describes the entity (if a players looks at it).
protected boolean	useScroll(Player player)	Is invoked when a summon scroll is 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, 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

SummonScroll

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

Creates a new summon scroll.

Parameters:

name -

clazz -

subclass -

attributes -

SummonScroll

public SummonScroll(SummonScroll item)

Copy constructor.

Parameters:

item - item to copy

Method Details

useScroll

protected boolean useScroll(Player player)

Is invoked when a summon scroll is used.

Overrides:

useScroll in class Scroll

Parameters:

player - The player who used the scroll

Returns:

true iff summoning was successful

describe

public String describe()

Description copied from class: Entity

Describes the entity (if a players looks at it).

Overrides:

describe in class Item

Returns:

description from the players point of view