path: root/docs/scripting.txt

Mana Scripting Specification - DRAFT v0.2

Generic scripting interfaces for various in-game objects.

Functions Library - provided by server scripting bindings.
Public Interface  - public interface provided by script.
Public Variables   - public variables provided by script.
Persistent Variabls - Variables which persist.

All prototypes are in a C like syntax.

Global Function Library (accessible by all script types):
  string getName(void)	- Get name of player.
  uint getX(void)	- Get X position of player.
  uint getY(void)	- Get Y position of player.
  string getMap(void)	- Get map name.
  uint getLevel(void)	- Get player level.
  uint getHealth(void)	- Get current health of player using item.
  uint getMaxHealth(void)	- Get maximum health player can have.
  uint getAttack(void)	- Get attack stats of player.
  uint getDefense(void)	- Get defense stats of player.
  uint getLuck(void)	- Get luck stats of player.
  uint getVitality(void)	- Get vitality stats of player.

  void setHealth(uint hp)	- Set player health points.

  void createItem(uint id)	- Spawn/create item at player position.
  void createBeing(uint id)	- Spawn/create being at player position.


Item Scripting:
  Function Library:
  Public Interface:
    void use(void)	- Called when player uses the item.

  Public Variables:
    string name	- Name of item.
    int type	- Type of item (weapon, armor, usable, etc.)

    *Special Properties*
    int attack	- Attack addition.
    int defense	- Defense addition.
    int luck	- Luck addition.
    int vitality- Vitality addition.
    (These will add to the players statistical properties when equipped.
    Note that they are not unsigned allowing negative properties.)
    ...

  Persistent Variables:


Skill Scripting:
  Function Library:
    uint getSkillLevel(void)	- Get level of skill.

  Public Interface:
    void use(void)	- Called when player uses skill.

  Public Variables:
  Persistent Variables:

Being Scripting:
  Function Library:
  Public Interface:
  Public Variables:
  Persistent Variables:


- nym