---

Contents

---

Introduction

Object instance: game

---

Description

The main object that handles setting zone & adding entities to game.

---

Methods

---

game:add

• Adds an object or entity instance to the current zone.
• Parameters:
  • obj RPObject Object to add.
  • expire bool true if the item should expire according to its normal behavior, false otherwise.
  • npc NPC NPC to add.
  • creature Creature Creature to add.
  • x int Horizontal position of where to add creature.
  • y int Vertical position of where to add creature.
• Returns: Creature (game:add(creature) only)

---

game:addGameEvent

• Raises a new game event. Same function as game:raiseEvent.
• Parameters:
  • source string Source of the event, usually a character.
  • event string Name of event.
  • params: List<String> Event parameters.
• See: ScriptingSandbox.addGameEvent

---

game:createEvent

• Creates a new game event.
• Parameters:
  • source string Source of the event, usually a character.
  • event string Name of event.
  • param string Event parameter.
  • params table<string> List of event parameters.
• Returns: GameEvent New game event instance.
• See also:
  • game:raiseEvent

---

game:getCreature

• Retrieves a registered creature.
  • clazz string Name of the creature.
• Returns: Creature or nil if not registered.
• See: ScriptingSandbox.getCreature

---

game:getCreatures

• Retrieves all registered creatures.
• Returns: Creature[] An array of all available creatures.
• See: ScriptingSandbox.getCreatures
• TODO:
  • should return Lua table

---

game:getItem

• Retrieves a registered item.
• Parameters:
  • name string Name of the item.
• Returns: Item Item or nil if not registered.

---

game:getItems

• Retrieves all registered items.
• Returns: Item[] An array of all available items.

---

game:getMessage

• Retrieves exception message set by script.
• Returns: string

---

game:getZone

• Retrieves a registered zone.
• Parameters:
  • name string Retrieve zone by name.
  • obj RPObject Retreive zone where obj is located.
• Returns: StendhalRPZone Zone or nil if not registered.

---

game:modify

• Notifies the StendhalRPWorld that this entity's attributes have changed.
• Parameters:
  • entity RPEntity Entity being modified.

---

game:playerIsInZone

• Checks if a player is in a specific zone.
• Parameters:
  • player Player Player to check.
  • zone string Name of zone.
• Returns: bool true if player's zone matches zone.

---

game:privateText

• Sends a private text to a player.
• Parameters:
  • player Player Player to receive the message.
  • text string Message text to send to player.

---

game:raiseEvent

• Raises a new game event.
• Parameters:
  • source string Source of the event, usually a character.
  • event string Name of event.
  • param string Event parameter.
  • params table<string> List of event parameters.
• See also:
  • game:createEvent

---

game:remove

• Removes an object or entity from world.
• Parameters:
  • object RPObject Object to remove.
  • npc NPC NPC to remove.

---

game:runAfter

• Executes a function after a specified number of turns.
• Parameters:
  • turns int Number of turns to wait.
  • func function Function to be executed.
• TODO:
  • how to invoke with parameters?

---

game:setMusic

• Sets the background music for the current zone.
• Parameters:
  • filename string File basename excluding .ogg extension.
  • args table Table of key=value integer values.
    • Keys:
      • volume Volume level (default: 100).
      • x The X coordinate of the sound source (default: 1).
      • y The Y coordinate of the sound source (default: 1).
      • radius The radius from which the music can be heard (default: 10000).

---

game:setZone

• Selects the zone to be configured.
• Parameters:
  • name string String name identifier.
  • zone StendhalRPZone Zone instance.
• Returns: bool true if zone was successfully set.