Uses of Class
games.stendhal.server.entity.RPEntity

Packages that use RPEntity

Package	Description
games.stendhal.server.core.engine
games.stendhal.server.core.engine.db
games.stendhal.server.core.engine.dbcommand
games.stendhal.server.core.events
games.stendhal.server.core.rp
games.stendhal.server.core.scripting	the scripting backend.
games.stendhal.server.core.scripting.lua
games.stendhal.server.entity	Entities are all the interactive objects of the gaming world (including players, NPCs, creatures, items, signs, chests, portals, ...)
games.stendhal.server.entity.creature
games.stendhal.server.entity.creature.impl.attack
games.stendhal.server.entity.item
games.stendhal.server.entity.item.behavior
games.stendhal.server.entity.item.consumption
games.stendhal.server.entity.item.scroll
games.stendhal.server.entity.item.timed
games.stendhal.server.entity.mapstuff
games.stendhal.server.entity.mapstuff.area
games.stendhal.server.entity.mapstuff.chest
games.stendhal.server.entity.mapstuff.game
games.stendhal.server.entity.mapstuff.portal
games.stendhal.server.entity.mapstuff.sign
games.stendhal.server.entity.mapstuff.spawner
games.stendhal.server.entity.mapstuff.useable
games.stendhal.server.entity.npc
games.stendhal.server.entity.player
games.stendhal.server.entity.status	This package handles status effects such as eating, poisoned, confused.
games.stendhal.server.maps.nalwor.forest
games.stendhal.server.maps.quests.captureflag
games.stendhal.server.maps.semos.city
games.stendhal.server.maps.semos.tavern.market

Uses of RPEntity in games.stendhal.server.core.engine

Methods in games.stendhal.server.core.engine that return types with arguments of type RPEntity

Modifier and Type	Method	Description
List<RPEntity>	StendhalRPZone.getPlayerAndFriends()	Gets all players in this zone, as well as friendly entities such as sheep.

Methods in games.stendhal.server.core.engine with parameters of type RPEntity

Modifier and Type	Method	Description
void	StendhalRPZone.addToPlayersAndFriends(RPEntity object)	adds an RPEntity to the playersAndFriends list.
void	ItemLogger.destroy(RPEntity entity, RPSlot slot, RPObject item)
void	ItemLogger.destroy(RPEntity entity, RPSlot slot, RPObject item, String reason)
void	StendhalRPRuleProcessor.killRPEntity(RPEntity entity, Entity killer)	Kills an RPEntity.
void	ItemLogger.merge(RPEntity entity, Item oldItem, Item outlivingItem)
void	ItemLogger.splitOff(RPEntity player, Item item, int quantity)
void	ItemLogger.splitOff(RPEntity player, Item item, Item newItem, int quantity)

Uses of RPEntity in games.stendhal.server.core.engine.db

Methods in games.stendhal.server.core.engine.db with parameters of type RPEntity

Modifier and Type	Method	Description
void	StendhalItemDAO.itemLogWriteEntry(DBTransaction transaction, Timestamp timestamp, int itemid, RPEntity player, String event, String param1, String param2, String param3, String param4)	writes a log entry
void	StendhalItemDAO.itemLogWriteEntry(DBTransaction transaction, Timestamp timestamp, RPObject item, RPEntity player, String event, String param1, String param2, String param3, String param4)	writes a log entry

Uses of RPEntity in games.stendhal.server.core.engine.dbcommand

Constructors in games.stendhal.server.core.engine.dbcommand with parameters of type RPEntity

Modifier	Constructor	Description
	LogMergeItemEventCommand(RPEntity player, RPObject oldItem, RPObject outlivingItem)	logs merging of item stacks
	LogSimpleItemEventCommand(RPObject item, RPEntity player, String event, String param1, String param2, String param3, String param4)	creates a simple item log command
	LogSplitItemEventCommand(RPEntity player, RPObject item, RPObject newItem)	logs merging of item stacks

Uses of RPEntity in games.stendhal.server.core.events

Methods in games.stendhal.server.core.events with parameters of type RPEntity

Modifier and Type	Method	Description
boolean	UseListener.onUsed(RPEntity user)	Invoked when the object is used.

Uses of RPEntity in games.stendhal.server.core.rp

Methods in games.stendhal.server.core.rp with parameters of type RPEntity

Modifier and Type	Method	Description
static boolean	StendhalRPAction.playerAttack(Player player, RPEntity defender)	Lets the attacker try to attack the defender.
static void	StendhalRPAction.startAttack(Player player, RPEntity victim)	Do logic for starting an attack on an entity.

Uses of RPEntity in games.stendhal.server.core.scripting

Subclasses of RPEntity in games.stendhal.server.core.scripting

Modifier and Type	Class	Description
class	ScriptingNPC

Methods in games.stendhal.server.core.scripting with parameters of type RPEntity

Modifier and Type	Method	Description
void	ScriptingSandbox.modify(RPEntity entity)

Uses of RPEntity in games.stendhal.server.core.scripting.lua

Methods in games.stendhal.server.core.scripting.lua with parameters of type RPEntity

Modifier and Type	Method	Description
void	LuaEntityHelper.setPath(RPEntity entity, org.luaj.vm2.LuaTable table, Boolean loop)	Deprecated. Use {@link games.stendhal.server.entity.GuidedEntity#setPath(FixedPath).
void	LuaEntityHelper.setPathAndPosition(RPEntity entity, org.luaj.vm2.LuaTable table, Boolean loop)	Deprecated. Use GuidedEntity.setPathAndPosition(FixedPath).

Uses of RPEntity in games.stendhal.server.entity

Subclasses of RPEntity in games.stendhal.server.entity

Modifier and Type	Class	Description
class	DressedEntity	Defines an entity whose appearance (outfit) can be changed.

Methods in games.stendhal.server.entity that return RPEntity

Modifier and Type	Method	Description
RPEntity	RPEntity.getAttackTarget()	Return the RPEntity that this entity is attacking.

Methods in games.stendhal.server.entity that return types with arguments of type RPEntity

Modifier and Type	Method	Description
List<RPEntity>	RPEntity.getAttackingRPEntities()	Returns the RPEntities that are attacking this character.

Methods in games.stendhal.server.entity with parameters of type RPEntity

Modifier and Type	Method	Description
protected void	RPEntity.applyDefXP(RPEntity entity)
boolean	RPEntity.canDoRangeAttack(RPEntity target, int maxrange)	Can this entity do a distance attack on the given target?
boolean	RPEntity.canHit(RPEntity defender)	Chooses randomly if this has hit the defender, or if this missed him.
int	RPEntity.damageDone(RPEntity defender, double attackingWeaponsValue, Nature damageType)	Is called when this has hit the given defender.
boolean	RPEntity.getsFightXpFrom(RPEntity enemy)
void	RPEntity.handleLifesteal(RPEntity attacker, List<Item> attackerWeapons, int damage)	Calculate lifesteal and update hp of source.
String	RPEntity.maybeDropDroppables(RPEntity attacker)	if defender (this entity) is carrying a droppable item, then attacker and defender both roll d20, and if attacker rolls higher, the defender drops the droppable.
void	RPEntity.setTarget(RPEntity target)	Modify the entity to order to attack the target entity.

Uses of RPEntity in games.stendhal.server.entity.creature

Subclasses of RPEntity in games.stendhal.server.entity.creature

Modifier and Type	Class	Description
class	ArenaCreature	An creature that will only target enemies which are within a specified area.
class	AttackableCreature	A creature that will be attacked by normal Creatures.
class	BabyDragon	A baby dragon is a domestic animal that can be owned by a player.
class	Cat	A cat is a domestic animal that can be owned by a player.
class	Creature	Server-side representation of a creature.
class	DeathMatchCreature	A creature that will give no XP to killers.
class	DomesticAnimal	A domestic animal can be owned by a player;
class	ItemChangeGuardCreature	An ItemChangeGuardCreature is a creature that is responsible for guarding a special item (e.g.
class	ItemGuardCreature	An ItemGuardCreature is a creature that is responsible for guarding a special item (e.g.
class	Pet	A pet is a domestic animal that can be owned by a player.
class	PurpleDragon	A purple dragon is a domestic animal that can be owned by a player.
class	RaidCreature	A Raid creature is a creature that doesn't make players killed by it to lose any XP, ATK or DEF.
class	Sheep

Methods in games.stendhal.server.entity.creature that return RPEntity

Modifier and Type	Method	Description
RPEntity	CircumstancesOfDeath.getKiller()
RPEntity	Creature.getNearestEnemy(double range)	Returns the nearest enemy, which is reachable or otherwise attackable.
RPEntity	CircumstancesOfDeath.getVictim()

Methods in games.stendhal.server.entity.creature that return types with arguments of type RPEntity

Modifier and Type	Method	Description
List<RPEntity>	ArenaCreature.getEnemyList()
List<RPEntity>	AttackableCreature.getEnemyList()
List<RPEntity>	Creature.getEnemyList()	Returns a list of enemies.

Methods in games.stendhal.server.entity.creature with parameters of type RPEntity

Modifier and Type	Method	Description
int	LevelBasedComparator.compare(RPEntity o1, RPEntity o2)

Constructors in games.stendhal.server.entity.creature with parameters of type RPEntity

Modifier	Constructor	Description
	CircumstancesOfDeath(RPEntity killer, RPEntity victim, StendhalRPZone zone)

Uses of RPEntity in games.stendhal.server.entity.creature.impl.attack

Methods in games.stendhal.server.entity.creature.impl.attack with parameters of type RPEntity

Modifier and Type	Method	Description
boolean	AttackStrategy.canAttackNow(Creature attacker, RPEntity target)	Can the specified creature do an attack against a specified target?

Uses of RPEntity in games.stendhal.server.entity.item

Methods in games.stendhal.server.entity.item with parameters of type RPEntity

Modifier and Type	Method	Description
boolean	OwnedItem.canEquipToSlot(RPEntity entity, String slot)	Override to check if an entity can equip to slot.
void	BreakableItem.deteriorate(RPEntity user)
void	Item.deteriorate(RPEntity user)	Can be overridden to handle actions on user entity.
void	OwnedItem.onEquipFail(RPEntity entity, String slot)	Override for action to take when an entity cannot equip to specified slot.
boolean	CaptureTheFlagFlag.onEquipped(RPEntity equipper, String slot)	if flag is held, update player's outfit.
boolean	Item.onEquipped(RPEntity equipper, String slot)	opportunity to affect the player when equipped currently returns boolean, to indicate whether it made any change TODO: should this return some sort of undoable thing (if it can be undone?)
boolean	RingOfLife.onEquipped(RPEntity entity, String slot)	Notify the player that it is not required to carry this ring in the finger slot to get its benefits.
boolean	SlotActivatedItem.onEquipped(RPEntity owner, String slot)	Action to take when item is equipped.
boolean	AreaUseItem.onUsed(RPEntity user)
boolean	Bestiary.onUsed(RPEntity user)
boolean	Box.onUsed(RPEntity user)
boolean	ConsumableItem.onUsed(RPEntity user)	Verifies item is near to player.
boolean	FoodMill.onUsed(RPEntity user)
boolean	Item.onUsed(RPEntity user)
boolean	NecroStaff.onUsed(RPEntity user)	Is invoked when the necromancer staff is used.
boolean	OwnedItem.onUsed(RPEntity user)
boolean	Seed.onUsed(RPEntity user)
boolean	TwilightElixir.onUsed(RPEntity user)	the overridden method verifies item is near to player.
boolean	WeddingRing.onUsed(RPEntity user)
protected boolean	AreaUseItem.onUsedInArea(RPEntity user)	Inheriting classes can override this to determine action to execute when item is used in correct area.
protected boolean	AreaUseItem.onUsedInArea(RPEntity user, StendhalRPZone zone, int x, int y)	Inheriting classes can override this to determine action to execute when item is used in correct area.
protected boolean	MetalDetector.onUsedInArea(RPEntity user, StendhalRPZone zone, int x, int y)
protected boolean	Shovel.onUsedInArea(RPEntity user, StendhalRPZone zone, int x, int y)
void	OwnedItem.onUseFail(RPEntity user)

Constructors in games.stendhal.server.entity.item with parameters of type RPEntity

Modifier	Constructor	Description
	Corpse(RPEntity victim, String killerName)	Create a corpse.
	RaidCreatureCorpse(RPEntity victim, String killerName)	Create a corpse.

Uses of RPEntity in games.stendhal.server.entity.item.behavior

Methods in games.stendhal.server.entity.item.behavior with parameters of type RPEntity

Modifier and Type	Method	Description
boolean	MessagingUseBehavior.use(RPEntity user, Item item)
boolean	UseBehavior.use(RPEntity user, Item item)	Called when the item is used.

Uses of RPEntity in games.stendhal.server.entity.item.consumption

Constructors in games.stendhal.server.entity.item.consumption with parameters of type RPEntity

Modifier	Constructor	Description
	StatusHealerEater(RPEntity entity, StatusType status)	Constructor defining one status healed by the item.
	StatusHealerEater(RPEntity entity, Set<StatusType> status)	Constructor defining multiple statuses healed by the item.

Uses of RPEntity in games.stendhal.server.entity.item.scroll

Methods in games.stendhal.server.entity.item.scroll with parameters of type RPEntity

Modifier and Type	Method	Description
boolean	Scroll.onUsed(RPEntity user)

Uses of RPEntity in games.stendhal.server.entity.item.timed

Methods in games.stendhal.server.entity.item.timed with parameters of type RPEntity

Modifier and Type	Method	Description
boolean	TimedStackableItem.onUsed(RPEntity user)

Uses of RPEntity in games.stendhal.server.entity.mapstuff

Methods in games.stendhal.server.entity.mapstuff with parameters of type RPEntity

Modifier and Type	Method	Description
boolean	Fire.onUsed(RPEntity user)

Uses of RPEntity in games.stendhal.server.entity.mapstuff.area

Methods in games.stendhal.server.entity.mapstuff.area with parameters of type RPEntity

Modifier and Type	Method	Description
protected void	OccupantArea.addTarget(RPEntity entity)	Add an entity to the target list.
protected float	DamagingArea.calculateDefense(RPEntity entity)	Calculate the entity's final defense value.
protected boolean	DamagingArea.doDamage(RPEntity entity)	Inflict damage on an entity.
protected boolean	LifeDrainArea.doDamage(RPEntity entity)	Inflict damage on an entity.
protected boolean	DamagingArea.handleAdded(RPEntity entity)	An entity has entered the area.
protected boolean	LifeDrainArea.handleAdded(RPEntity entity)	An entity has entered the area.
protected boolean	OccupantArea.handleAdded(RPEntity entity)	An entity has entered the area.
protected boolean	DamagingArea.handleInterval(RPEntity entity)	Apply actions done at regular intervals.
protected boolean	LifeDrainArea.handleInterval(RPEntity entity)	Apply actions done at regular intervals.
protected boolean	OccupantArea.handleInterval(RPEntity entity)	Apply actions done at regular intervals.
protected boolean	DamagingArea.handleMovement(RPEntity entity)	Apply actions done while moving.
protected boolean	OccupantArea.handleMovement(RPEntity entity)	Apply actions done while moving.
protected void	DamagingArea.handleRemoved(RPEntity entity)	An entity has left the area.
protected void	LifeDrainArea.handleRemoved(RPEntity entity)	An entity has left the area.
protected void	OccupantArea.handleRemoved(RPEntity entity)	An entity has left the area.
boolean	OccupantArea.isOccupant(RPEntity entity)	Check if an entity is an [acknowledged] occupant of this area.
protected void	OccupantArea.removeTarget(RPEntity entity)	Remove an entity from the target list.

Uses of RPEntity in games.stendhal.server.entity.mapstuff.chest

Methods in games.stendhal.server.entity.mapstuff.chest that return RPEntity

Modifier and Type	Method	Description
RPEntity	PersonalChest.getAttending()	Gets the entitiy which is currently served by this chest.

Methods in games.stendhal.server.entity.mapstuff.chest with parameters of type RPEntity

Modifier and Type	Method	Description
boolean	Chest.onUsed(RPEntity user)
boolean	NPCOwnedChest.onUsed(RPEntity user)
boolean	PersonalChest.onUsed(RPEntity user)
void	PersonalChest.open(RPEntity user)	Open the chest for an attending user.

Uses of RPEntity in games.stendhal.server.entity.mapstuff.game

Methods in games.stendhal.server.entity.mapstuff.game with parameters of type RPEntity

Modifier and Type	Method	Description
boolean	NineSwitchesGameSwitch.onUsed(RPEntity user)	someone clicked a switch.
void	NineSwitchesGameBoard.usedSwitch(RPEntity user, NineSwitchesGameSwitch gameSwitch)	use the specified switch.

Uses of RPEntity in games.stendhal.server.entity.mapstuff.portal

Methods in games.stendhal.server.entity.mapstuff.portal with parameters of type RPEntity

Modifier and Type	Method	Description
protected boolean	ConditionAndActionPortal.isAllowed(RPEntity user)	Determine if this portal can be used.
protected boolean	Gate.isAllowed(RPEntity user)	Check if a player can use the gate.
protected boolean	HousePortal.isAllowed(RPEntity user)
protected boolean	KeyedPortal.isAllowed(RPEntity user)	Determine if this portal can be used.
protected boolean	LevelCheckingPortal.isAllowed(RPEntity user)	Determine if this portal can be used.
protected boolean	LockedDoor.isAllowed(RPEntity user)
protected boolean	OnePlayerRoomDoor.isAllowed(RPEntity user)
protected boolean	QuestCheckingPortal.isAllowed(RPEntity user)	Determine if this portal can be used.
protected boolean	QuestCompletedPortal.isAllowed(RPEntity user)	Determine if this portal can be used.
void	Portal.onPushedOntoFrom(RPEntity pushed, RPEntity pusher, Point prevPos)	Sub-classes can override for actions to be taken if entity was pushed onto portal.
boolean	ConditionAndActionPortal.onUsed(RPEntity user)
boolean	Door.onUsed(RPEntity user)	Teleport (if the door is now open).
boolean	Gate.onUsed(RPEntity user)
boolean	KeyDestroyingDoor.onUsed(RPEntity user)
boolean	OneWayPortalDestination.onUsed(RPEntity user)
boolean	PasswordPortal.onUsed(RPEntity user)	Override so portal does not get "used"
boolean	Portal.onUsed(RPEntity user)
void	Door.onUsedBackwards(RPEntity user, boolean hadPath)
void	Portal.onUsedBackwards(RPEntity user, boolean hadPath)	If this portal is the destination of another portal used.
protected void	LevelCheckingPortal.rejected(RPEntity user)	Called when the user is rejected.

Uses of RPEntity in games.stendhal.server.entity.mapstuff.sign

Methods in games.stendhal.server.entity.mapstuff.sign with parameters of type RPEntity

Modifier and Type	Method	Description
boolean	PopupImage.onUsed(RPEntity user)
boolean	ShopSign.onUsed(RPEntity user)	Handles use-actions.

Uses of RPEntity in games.stendhal.server.entity.mapstuff.spawner

Methods in games.stendhal.server.entity.mapstuff.spawner with parameters of type RPEntity

Modifier and Type	Method	Description
boolean	GrainField.onUsed(RPEntity entity)	Is called when a player tries to harvest this grain field.
boolean	VegetableGrower.onUsed(RPEntity entity)	Is called when a player tries to harvest this item.

Uses of RPEntity in games.stendhal.server.entity.mapstuff.useable

Methods in games.stendhal.server.entity.mapstuff.useable with parameters of type RPEntity

Modifier and Type	Method	Description
boolean	PlayerActivityEntity.onUsed(RPEntity entity)	Is called when a player initiates the activity.
boolean	PlaySoundEntity.onUsed(RPEntity user)	plays a sound
boolean	ViewChangeEntity.onUsed(RPEntity user)

Uses of RPEntity in games.stendhal.server.entity.npc

Subclasses of RPEntity in games.stendhal.server.entity.npc

Modifier and Type	Class	Description
class	ActorNPC	Simple entity used in spectacles.
class	CroupierNPC
class	GhostNPCBase	Base class for ghost NPCs.
class	NPC
class	PassiveNPC
class	RatKidsNPCBase	Base class for rat kid NPCs.
class	SilentNPC	A stripped down SpeakerNPC that does not interact with players
class	SpeakerNPC	This is a finite state machine that implements a chat system.
class	TrainingDummy	An entity that can be used for training a player's ATK & RATK stats.

Methods in games.stendhal.server.entity.npc that return RPEntity

Modifier and Type	Method	Description
RPEntity	EventRaiser.getAttending()	gets the RPEntity the SpeakerNPC is attending to
RPEntity	SpeakerNPC.getAttending()	The entity who is currently talking to the NPC, or null if the NPC is currently not taking part in a conversation.

Methods in games.stendhal.server.entity.npc with parameters of type RPEntity

Modifier and Type	Method	Description
boolean	TrainingDummy.canBeAttacked(RPEntity entity)	Checks requirements for attacking this entity.
protected void	SpeakerNPC.onGoodbye(RPEntity attending2)	Is called when the NPC stops chatting with a player.
void	SpeakerNPC.onRejectedAttackStart(RPEntity attacker)	someone tried to attack us
void	EventRaiser.setAttending(RPEntity rpentity)	Sets the rpentity to whom the SpeakerNPC is currently listening.
void	SpeakerNPC.setAttending(RPEntity rpentity)	Sets the rpentity to whom the NPC is currently listening.

Uses of RPEntity in games.stendhal.server.entity.player

Subclasses of RPEntity in games.stendhal.server.entity.player

Modifier and Type	Class	Description
class	Player

Methods in games.stendhal.server.entity.player with parameters of type RPEntity

Modifier and Type	Method	Description
protected void	Player.applyDefXP(RPEntity entity)
boolean	Player.canPush(RPEntity entity)	Return true if player can push entity.
protected void	Jail.imprison(Player criminal, RPEntity policeman, int minutes)
void	Jail.imprison(String criminalName, RPEntity policeman, int minutes, String reason)
void	Player.onPush(RPEntity entity)	Called when player push entity.
boolean	Player.onUsed(RPEntity user)	Invoked when the object is used.

Uses of RPEntity in games.stendhal.server.entity.status

Methods in games.stendhal.server.entity.status with parameters of type RPEntity

Modifier and Type	Method	Description
void	PoisonAttacker.onAttackAttempt(RPEntity target, RPEntity attacker)
void	StatusAttacker.onAttackAttempt(RPEntity target, RPEntity attacker)	an attempt to attack the target, it may succeed or not
void	PoisonAttacker.onHit(RPEntity target, RPEntity attacker, int damage)
void	StatusAttacker.onHit(RPEntity target, RPEntity attacker, int damage)	the target was hit, this may or may not have caused damage

Constructors in games.stendhal.server.entity.status with parameters of type RPEntity

Modifier	Constructor	Description
	StatusList(RPEntity entity)	StatusList for an entity

Uses of RPEntity in games.stendhal.server.maps.nalwor.forest

Subclasses of RPEntity in games.stendhal.server.maps.nalwor.forest

Modifier and Type	Class	Description
class	AssassinRepairerAdder.AssassinRepairer
static class	TrainingArea.TrainerNPC	NPC class that manages access to training area.

Methods in games.stendhal.server.maps.nalwor.forest with parameters of type RPEntity

Modifier and Type	Method	Description
boolean	TrainingArea.isExiting(RPEntity trainee)	Checks if the entity is exiting the training area.
void	AssassinRepairerAdder.AssassinRepairer.onGoodbye(RPEntity attending)

Uses of RPEntity in games.stendhal.server.maps.quests.captureflag

Methods in games.stendhal.server.maps.quests.captureflag with parameters of type RPEntity

Modifier and Type	Method	Description
boolean	CaptureFlagUseListener.onUsed(RPEntity user)	this is called when another player left-clicks on this.target

Uses of RPEntity in games.stendhal.server.maps.semos.city

Subclasses of RPEntity in games.stendhal.server.maps.semos.city

Modifier and Type	Class	Description
class	SheepBuyerNPC.SheepBuyerSpeakerNPC

Uses of RPEntity in games.stendhal.server.maps.semos.tavern.market

Subclasses of RPEntity in games.stendhal.server.maps.semos.tavern.market

Modifier and Type	Class	Description
class	MarketManagerNPC

Methods in games.stendhal.server.maps.semos.tavern.market with parameters of type RPEntity

Modifier and Type	Method	Description
protected void	MarketManagerNPC.onGoodbye(RPEntity player)