StendhalAPI

• Play
  • Manual
  • Beginner's Guide
  • FAQ
  • Ask for Help
  • Events
  • Videos
  • Rules
  • Groups
• World
  • Atlas
  • Dungeons
  • NPCs
  • Levels
  • Creatures
  • Items
  • Quests
  • Games
  • History
  • Achievements
  • Houses
• GMs
  • Administration
  • How to be a GM
  • Scripts
  • Guide for admin
• Contribute
  • Chat
  • Bugs
  • Testing
  • Graphics
  • Sound
  • Item Ideas
  • Atlas
  • Creature Ideas
  • Quest Ideas
  • NPC Ideas
  • Events Ideas
  • Achievement Ideas
  • Open Tasks
• |
• Extend
  • How to add items
  • How to add Creatures
  • How to add quests
  • How to add NPCs
  • How to create maps
• Develop
  • CVS (Source Code)
  • Bugs
  • Meetings
  • Testing
  • Code Design
  • Jenkins
  • Ideas
  • Open Tasks
  • Patches
  • API Reference

• Build & Host
  • Building
  • IDEs
  • Hosting
• |
• Misc.
  • Third Party Projects

this page is a work-in progress

Description

This page is intended to be a description of the common usable methods for adding or altering the world of Stendhal.

Entities

Base Classes

Entity

• Class: games.stendhal.server.entity.Entity
• Inherits: marauroa.common.game.RPObject
• Implements:
  • games.stendhal.server.entity.Killer

This is the base entity class for all entities in Stendhal.

Public methods:

Entity()

Default constructor.

Entity(object)

Copy constructor.

object: Object to be copied.

setDescription(text)

Sets the description text for the entity.

text: String to be used for description.

getTitle()

Retrieves the entity's title/name text.

returns: (string) The entity's name.

getDescription()

Retrieves the entity's description text.

returns: (string) The entity's description text.

getZone()

returns: (StendhalRPZone) The current zone where the entity is located.

getX()

returns: (int) The horizontal coordinate of the entity's position.

getY()

returns: (int) The vertical coordinate of the entity's position.

getResistance(entity)

Retrieves the resistance this entity has on other entities.

entity: (optional) If set, returned value is combined resistance.

returns: (int) Value between 0-100 (0 = no resistance, 100 = non-traversable).

stopped()

returns: (bool) true if the entity is not moving.

hasDescription()

Checks if the entity has a description.

returns: (bool) true if the "description" attribute is set.

isObstacle(entity)

Determine if this is an obstacle for another entity.

entity: The entity to check against.

returns: (bool) true if combined resistance is above 95.

ActiveEntity

• Class: games.stendhal.server.entity.ActiveEntity
• Inherits: Entity

GuidedEntity

• Class: games.stendhal.server.entity.GuidedEntity
• Inherits: ActiveEntity

RPEntity

• Class: games.stendhal.server.entity.RPEntity
• Inherits: GuidedEntity

See Also

• Stendhal Supported Scripting