diff options
| -rw-r--r-- | scripts/lua/libmana.lua | 150 | ||||
| -rw-r--r-- | src/scripting/lua.cpp | 3542 |
2 files changed, 2340 insertions, 1352 deletions
diff --git a/scripts/lua/libmana.lua b/scripts/lua/libmana.lua index 0636e49..b87de1f 100644 --- a/scripts/lua/libmana.lua +++ b/scripts/lua/libmana.lua @@ -16,7 +16,21 @@ require "scripts/lua/libmana-constants" --- A table that provides access to persistent variables of the current map +--- LUA map (variables) +-- local value = map[string key] +-- map[string key] = value +--- +-- Sets or gets a persistent map variable. The scope of the variable is the +-- map the script runs on. The value is stored in the database and thus will +-- survive a server reboot. +-- +-- **Example:** +-- <code lua> +-- local value = map["a key"] +-- if value == "some value" then +-- map["a key"] = "other value" +-- end +-- </code> map = setmetatable({}, { __index = function(_, key) return getvar_map(key) @@ -26,7 +40,24 @@ map = setmetatable({}, { end, }) --- A table that provides access to persistent global world variables +--- LUA world (variables) +-- local value = world[string key] +-- world[string key] = value +--- +-- Sets or gets a persistent world variable. The value is stored in the +-- database and thus will survive a server reboot. +-- +-- **Important:** When you are using this function, be aware of race +-- conditions: It is impossible to prevent that another map changes the value +-- of a variable between you requesting to old value and setting a new value. +-- +-- **Example:** +-- <code lua> +-- local value = world["a key"] +-- if value == "some value" then +-- world["a key"] = "other value" +-- end +-- </code> world = setmetatable({}, { __index = function(_, key) return getvar_world(key) @@ -36,10 +67,40 @@ world = setmetatable({}, { end, }) --- Some convenient shortcuts for the different log levels +--- LUA ERROR (logging) +-- ERROR(string message) +--- +-- Will log the ''message'' using the log level LOG_ERROR. +-- +-- **Note:** When passing multiple arguments these arguments will get connected +-- using a " ". function ERROR(...) log(LOG_ERROR, table.concat({...}, " ")) end + +--- LUA WARN (logging) +-- WARN(string message) +--- +-- Will log the ''message'' using the log level LOG_WARNING. +-- +-- **Note:** When passing multiple arguments these arguments will get connected +-- using a " ". function WARN(...) log(LOG_WARN, table.concat({...}, " ")) end + +--- LUA INFO (logging) +-- INFO(string message) +--- +-- Will log the ''message'' using the log level LOG_INFO. +-- +-- **Note:** When passing multiple arguments these arguments will get connected +-- using a " ". function INFO(...) log(LOG_INFO, table.concat({...}, " ")) end + +--- LUA DEBUG (logging) +-- DEBUG(string message) +--- +-- Will log the ''message'' using the log level LOG_DEBUG. +-- +-- **Note:** When passing multiple arguments these arguments will get connected +-- using a " ". function DEBUG(...) log(LOG_DEBUG, table.concat({...}, " ")) end -- Array containing the function registered by atinit. @@ -87,7 +148,15 @@ local function mapupdate(mapid) check_schedule(mapid) end --- Registers a function so that it is executed during map initialization. +--- LUA_CATEGORY Scheduling (scheduling) + +--- LUA atinit (scheduling) +-- atinit(function() [function body] end) +--- +-- Adds a function which is executed when the gameserver loads the map this +-- script belongs to. Usually used for placing NPCs or trigger areas and for +-- setting up cronjobs with schedule_every. Any number of functions can be +-- added this way. function atinit(f) local map_id = get_map_id() init_fun[map_id] = init_fun[map_id] or {} @@ -124,7 +193,10 @@ local function job_cmp(job1, job2) return (job1[0] > job2[0]) end --- schedules a function call to be executed once in n seconds +--- LUA schedule_in (scheduling) +-- schedule_in(seconds, function() [function body] end) +--- +-- Executes the ''function body'' in ''seconds'' seconds. function schedule_in(seconds, funct) local job = {} job[0] = os.time() + seconds @@ -136,7 +208,10 @@ function schedule_in(seconds, funct) table.sort(scheduler_jobs[map_id], job_cmp) end --- schedules a function call to be executed at regular intervals of n seconds +--- LUA schedule_every (scheduling) +-- schedule_every(seconds, function() [function body] end) +--- +-- Executes the ''function body'' every ''seconds'' seconds from now on. function schedule_every(seconds, funct) local job = {} job[0] = os.time() + seconds @@ -148,7 +223,10 @@ function schedule_every(seconds, funct) table.sort(scheduler_jobs[map_id], job_cmp) end --- schedules a function call to be executed at a given date +--- LUA schedule_per_date (scheduling) +-- schedule_per_date(year, month, day, hour, minute, function() [function body] end) +--- +-- Executes the ''function body'' at the given date and time. function schedule_per_date(my_year, my_month, my_day, my_hour, my_minute, funct) local job = {} job[0] = os.time{year = my_year, month = my_month, day = my_day, @@ -182,6 +260,16 @@ local function on_worldvar_callback(key, value) end end +--- LUA on_mapvar_changed (variables) +-- on_mapvar_changed(string key, function func) +--- +-- Registers a callback to the key. This callback will be called with the key +-- and value of the changed variable. +-- +-- **Example:** +-- <code lua>on_mapvar_changed(key, function(key, value) +-- log(LOG_DEBUG, "mapvar " .. key .. " has new value " .. value) +-- end)</code> function on_mapvar_changed(key, funct) if not onmapvar_functs[key] then onmapvar_functs[key] = {} @@ -190,6 +278,16 @@ function on_mapvar_changed(key, funct) onmapvar_functs[key][funct] = get_map_id() end +--- LUA on_worldvar_changed (variables) +-- on_worldvar_changed(string key, function func) +--- +-- Registers a callback to the key. This callback will be called with the key +-- and value of the changed variable. +-- +-- **Example:** +-- <code lua>on_worldvar_changed(key, function(key, value) +-- log(LOG_DEBUG, "worldvar " .. key .. " has new value " .. value) +-- end)</code> function on_worldvar_changed(key, funct) if not onworldvar_functs[key] then onworldvar_functs[key] = {} @@ -198,10 +296,18 @@ function on_worldvar_changed(key, funct) onworldvar_functs[key][funct] = true end +--- LUA remove_mapvar_listener (variables) +-- remove_mapvar_listener(string key, function func) +--- +-- Unassigns a function from getting notified from mapvar changes. function remove_mapvar_listener(key, funct) onmapvar_functs[key][funct] = nil end +--- LUA remove_worldvar_listener (variables) +-- remove_worldvar_listener(string key, function func) +--- +-- Unassigns a function from getting notified from worldvar changes. function remove_worldvar_listener(key, funct) onworldvar_functs[key][funct] = nil end @@ -210,8 +316,11 @@ end local ondeath_functs = {} local onremove_functs = {} --- requests the gameserver to notify the script engine when the being --- dies and adds a script function to be executed in this case. +--- LUA on_death (scheduling) +-- on_death(handle being, function() [function body] end) +--- +-- Executes the ''function body'' when ''being'' is killed. Note that this +-- doesn't happen anymore after the being left the map. function on_death(being, funct) if ondeath_functs[being] == nil then ondeath_functs[being] = {} @@ -220,8 +329,12 @@ function on_death(being, funct) being_register(being) end --- requests the gameserver to notify the script engine when the being --- dies and adds a script function to be executed in this case. +--- LUA on_remove (scheduling) +-- on_remove(handle being, function() [function body] end) +--- +-- Executes the ''function body'' when ''being'' is no longer on the map for +-- some reason (leaves the map voluntarily, is warped away, logs out, cleaned +-- up after getting killed or whatever). function on_remove(being, funct) if onremove_functs[being] == nil then onremove_functs[being] = {} @@ -253,6 +366,14 @@ end -- Below are some convenience methods added to the engine API + +--- LUA chr_money_change (inventory) +-- chr_money_change(handle character, int amount) +--- +-- Changes the money currently owned by ''character'' by ''amount''. +-- +-- **Warning:** Before reducing the money make sure to check if the character +-- owns enough money using chr_money. chr_money_change = function(ch, amount) being_set_base_attribute( ch, @@ -260,6 +381,13 @@ chr_money_change = function(ch, amount) being_get_base_attribute(ch, ATTR_GP) + amount) end +--- LUA chr_money (inventory) +-- chr_money(handle character) +--- +-- Changes the money currently owned by ''character'' by ''amount''. +-- +-- **Warning:** Before reducing the money make sure to check if the character +-- owns enough money using chr_money. chr_money = function(ch) return being_get_base_attribute(ch, ATTR_GP) end diff --git a/src/scripting/lua.cpp b/src/scripting/lua.cpp index e305fcd..838ced6 100644 --- a/src/scripting/lua.cpp +++ b/src/scripting/lua.cpp @@ -62,16 +62,27 @@ extern "C" { /* * This file includes all script bindings available to LUA scripts. - * When you add or change a script binding please document it on + * When you add or change a script binding please run the update script in the + * docs repository! * * http://doc.manasource.org/scripting */ +/** LUA_CATEGORY Callbacks (callbacks) + * **Note:** You can only assign a **single** function as callback. + * When setting a new function the old one will not be called anymore. + * Some of this callbacks are already used for the libmana.lua. Be careful when + * using those since they will most likely break your code in other places. + */ -/** - * on_update_derived_attribute( function(Being*) ): void - * Sets a listener function to handle - * recalculation of derived attributes event. +/** LUA on_update_derived_attribute (callbacks) + * on_update_derived_attribute(function ref) + ** + * Will call the function ''ref'' when an attribute changed and other attributes + * need recalculation. The function is expected to recalculate those then. + * + * **See:** [[attributes.xml]] for more info. + * */ static int on_update_derived_attribute(lua_State *s) { @@ -81,9 +92,16 @@ static int on_update_derived_attribute(lua_State *s) } -/** - * on_recalculateBaseAttributeCallback( function(Being*) ): void - * Sets a listener function to the attribute recalculation event. +/** LUA on_recalculate_base_attribute (callbacks) + * on_recalculate_base_attribute(function ref) + ** + * Will call the function ''ref'' when an attribute base needs to be recalculated. + * The function is expected to do this recalculation then. The engine only + * triggers this for characters. However you can use the same function for + * recalculating derived attributes in the + * [[scripting#on_update_derived_attribute|on_update_derived_attribute]] callback. + * + * **See:** [[attributes.xml]] for more info. */ static int on_recalculate_base_attribute(lua_State *s) { @@ -92,7 +110,9 @@ static int on_recalculate_base_attribute(lua_State *s) return 0; } -/** +/** LUA on_character_death (callbacks) + * on_character_death(function ref) + ** * on_character_death( function(Character*) ): void * Sets a listener function to the character death event. */ @@ -103,11 +123,12 @@ static int on_character_death(lua_State *s) return 0; } -/** - * on_character_death_accept( function(Character*) ): void - * Sets a listener function that is called when the player clicks on the OK - * button after the death message appeared. It should be used to implement the - * respawn mechanic. +/** LUA on_character_death_accept (callbacks) + * on_character_death_accept(function ref) + ** + * Will make sure that the function ''ref'' gets called with the character + * as argument as soon a character either pressed the ok dialouge in the death + * message or left the game while being dead. */ static int on_character_death_accept(lua_State *s) { @@ -116,6 +137,12 @@ static int on_character_death_accept(lua_State *s) return 0; } +/** LUA on_character_login (callbacks) + * on_character_login(function ref) + ** + * Will make sure that function ''ref'' gets called with the character + * as argument as soon a character logged in. + */ static int on_character_login(lua_State *s) { luaL_checktype(s, 1, LUA_TFUNCTION); @@ -123,6 +150,12 @@ static int on_character_login(lua_State *s) return 0; } +/** LUA on_being_death (callbacks) + * on_being_death(function ref) + ** + * Will make sure that the function ''ref'' gets called with the being + * as argument as soon a being dies. + */ static int on_being_death(lua_State *s) { luaL_checktype(s, 1, LUA_TFUNCTION); @@ -130,6 +163,12 @@ static int on_being_death(lua_State *s) return 0; } +/** LUA on_being_remove (callbacks) + * on_being_remove(function ref) + ** + * Will make sure that the function ''ref'' gets called with the being + * as argument as soon a being gets removed from a map. + */ static int on_being_remove(lua_State *s) { luaL_checktype(s, 1, LUA_TFUNCTION); @@ -137,6 +176,11 @@ static int on_being_remove(lua_State *s) return 0; } +/** LUA on_update (callbacks) + * on_update(function ref) + ** + * Will make sure that the function ''ref'' gets called every game tick. + */ static int on_update(lua_State *s) { luaL_checktype(s, 1, LUA_TFUNCTION); @@ -144,6 +188,13 @@ static int on_update(lua_State *s) return 0; } +/** LUA on_create_npc_delayed (callbacks) + * on_create_npc_delayed(function ref) + ** + * Will make sure that the function ''ref'' gets called with the + * name, id, gender, x and y values as arguments of the npc when a npc should + * be created at map init (Npcs defined directly in the map files use this). + */ static int on_create_npc_delayed(lua_State *s) { luaL_checktype(s, 1, LUA_TFUNCTION); @@ -151,6 +202,12 @@ static int on_create_npc_delayed(lua_State *s) return 0; } +/** LUA on_map_initialize (callbacks) + * on_map_initialize(function ref) + ** + * Will make sure that the function ''ref'' gets called with the initialized + * map as current map when the map is initialized. + */ static int on_map_initialize(lua_State *s) { luaL_checktype(s, 1, LUA_TFUNCTION); @@ -158,6 +215,13 @@ static int on_map_initialize(lua_State *s) return 0; } +/** LUA on_craft (callbacks) + * on_craft(function ref) + ** + * Will make sure that the function ''ref'' gets called with the the crafting + * character and a table with the recipes {(id, amount}) when a character + * performs crafting. + */ static int on_craft(lua_State *s) { luaL_checktype(s, 1, LUA_TFUNCTION); @@ -165,55 +229,263 @@ static int on_craft(lua_State *s) return 0; } -static int on_mapvar_changed(lua_State *s) +/** LUA on_mapupdate (callbacks) + * on_mapupdate(function ref) + ** + * Will make sure that the function ''ref'' gets called with the the map id + * as argument for each game tick and map. + */ +static int on_mapupdate(lua_State *s) { - const char *key = luaL_checkstring(s, 1); - luaL_checktype(s, 2, LUA_TFUNCTION); - luaL_argcheck(s, key[0] != 0, 2, "empty variable name"); - MapComposite *m = checkCurrentMap(s); - m->setMapVariableCallback(key, getScript(s)); + luaL_checktype(s, 1, LUA_TFUNCTION); + MapComposite::setUpdateCallback(getScript(s)); return 0; } -static int on_worldvar_changed(lua_State *s) + +/** LUA_CATEGORY Creation and removal of stuff (creation) + */ + +/** LUA npc_create (creation) + * npc_create(string name, int spriteID, int gender, int x, int y, function talkfunct, function updatefunct) + ** + * **Return value:** A handle to the created NPC. + * + * Creates a new NPC with the name ''name'' at the coordinates ''x'':''y'' + * which appears to the players with the appearence listed in their npcs.xml + * under ''spriteID'' and the gender ''gender''. Every game tick the function + * ''updatefunct'' is called with the handle of the NPC. When a character talks + * to the NPC the function ''talkfunct'' is called with the NPC handle and the + * character handle. + * + * For setting the gender you can use the constants defined in the + * libmana-constants.lua: + * + * | 0 | GENDER_MALE | + * | 1 | GENDER_FEMALE | + * | 2 | GENDER_UNSPECIFIED | + */ +static int npc_create(lua_State *s) { - const char *key = luaL_checkstring(s, 1); - luaL_checktype(s, 2, LUA_TFUNCTION); - luaL_argcheck(s, key[0] != 0, 2, "empty variable name"); + const char *name = luaL_checkstring(s, 1); + const int id = luaL_checkint(s, 2); + const int gender = luaL_checkint(s, 3); + const int x = luaL_checkint(s, 4); + const int y = luaL_checkint(s, 5); + + if (!lua_isnoneornil(s, 6)) + luaL_checktype(s, 6, LUA_TFUNCTION); + if (!lua_isnoneornil(s, 7)) + luaL_checktype(s, 7, LUA_TFUNCTION); + MapComposite *m = checkCurrentMap(s); - m->setWorldVariableCallback(key, getScript(s)); + + NPC *q = new NPC(name, id); + q->setGender(getGender(gender)); + q->setMap(m); + q->setPosition(Point(x, y)); + + if (lua_isfunction(s, 6)) + { + lua_pushvalue(s, 6); + q->setTalkCallback(luaL_ref(s, LUA_REGISTRYINDEX)); + } + + if (lua_isfunction(s, 7)) + { + lua_pushvalue(s, 7); + q->setUpdateCallback(luaL_ref(s, LUA_REGISTRYINDEX)); + } + + GameState::enqueueInsert(q); + lua_pushlightuserdata(s, q); + return 1; +} + +/** LUA npc_enable (creation) + * npc_disable(handle npc) + ** + * Re-enables an NPC that got disabled before. + */ +static int npc_enable(lua_State *s) +{ + NPC *p = checkNPC(s, 1); + p->setEnabled(true); + GameState::enqueueInsert(p); return 0; } -static int on_mapupdate(lua_State *s) +/** LUA npc_disable (creation) + * npc_disable(handle npc) + ** + * Disable an NPC. + */ +static int npc_disable(lua_State *s) { - luaL_checktype(s, 1, LUA_TFUNCTION); - MapComposite::setUpdateCallback(getScript(s)); + NPC *p = checkNPC(s, 1); + p->setEnabled(false); + GameState::remove(p); return 0; } -static int get_item_class(lua_State *s) +/** LUA monster_create (creation) + * monster_create(int monsterID, int x, int y) + * monster_create(string monstername, int x, int y) + ** + * **Return value:** A handle to the created monster. + * + * Spawns a new monster of type ''monsterID'' or ''monstername'' on the current + * map on the pixel coordinates ''x'':''y''. + */ +static int monster_create(lua_State *s) { - LuaItemClass::push(s, checkItemClass(s, 1)); + MonsterClass *monsterClass = checkMonsterClass(s, 1); + const int x = luaL_checkint(s, 2); + const int y = luaL_checkint(s, 3); + MapComposite *m = checkCurrentMap(s); + + Monster *q = new Monster(monsterClass); + q->setMap(m); + q->setPosition(Point(x, y)); + GameState::enqueueInsert(q); + + lua_pushlightuserdata(s, q); return 1; } -static int get_monster_class(lua_State *s) +/** LUA monster_remove (creation) + * monster_remove(handle monster) + ** + * **Return value:** True if removing the monster suceeded. + * + * Remove the monster ''monster'' from the current map. + */ +static int monster_remove(lua_State *s) { - LuaMonsterClass::push(s, checkMonsterClass(s, 1)); + bool monsterRemoved = false; + if (Monster *m = getMonster(s, 1)) + { + GameState::remove(m); + monsterRemoved = true; + } + lua_pushboolean(s, monsterRemoved); return 1; } -static int get_status_effect(lua_State *s) +/** LUA trigger_create (creation) + * trigger_create(int x, int y, int width, int height, function trigger_function, int arg, bool once) + ** + * Creates a new trigger area with the given ''height'' and ''width'' in pixels + * at the map position ''x'':''y'' in pixels. When a being steps into this area + * the function ''trigger_function'' is called with the being handle and + * ''arg'' as arguments. When ''once'' is false the function is called every + * game tick the being is inside the area. When ''once'' is true it is only + * called again when the being leaves and reenters the area. + */ +static int trigger_create(lua_State *s) { - const char *name = luaL_checkstring(s, 1); - LuaStatusEffect::push(s, StatusManager::getStatusByName(name)); + const int x = luaL_checkint(s, 1); + const int y = luaL_checkint(s, 2); + const int width = luaL_checkint(s, 3); + const int height = luaL_checkint(s, 4); + luaL_checktype(s, 5, LUA_TFUNCTION); + const int id = luaL_checkint(s, 6); + + if (!lua_isboolean(s, 7)) + { + luaL_error(s, "trigger_create called with incorrect parameters."); + return 0; + } + + Script *script = getScript(s); + MapComposite *m = checkCurrentMap(s, script); + + const bool once = lua_toboolean(s, 7); + + Script::Ref function; + lua_pushvalue(s, 5); + script->assignCallback(function); + lua_pop(s, 1); + + ScriptAction *action = new ScriptAction(script, function, id); + Rectangle r = { x, y, width, height }; + TriggerArea *area = new TriggerArea(m, r, action, once); + + LOG_INFO("Created script trigger at " << x << "," << y + << " (" << width << "x" << height << ") id: " << id); + + bool ret = GameState::insert(area); + lua_pushboolean(s, ret); return 1; } -/** - * npc_message(NPC*, Character*, string): void - * Callback for sending a NPC_MESSAGE. +/** LUA effect_create (creation) + * effect_create(int id, int x, int y) + * effect_create(int id, being b) + ** + * Triggers the effect ''id'' from the clients effects.xml + * (particle and/or sound) at map location ''x'':''y'' or on being ''b''. + * This has no effect on gameplay. + * + * **Warning:** Remember that clients might switch off particle effects for + * performance reasons. Thus you should not use this for important visual + * input. + */ +static int effect_create(lua_State *s) +{ + const int id = luaL_checkint(s, 1); + + if (lua_isuserdata(s, 2)) + { + // being mode + Being *b = checkBeing(s, 2); + Effects::show(id, b->getMap(), b); + } + else + { + // positional mode + int x = luaL_checkint(s, 2); + int y = luaL_checkint(s, 3); + MapComposite *m = checkCurrentMap(s); + Effects::show(id, m, Point(x, y)); + } + + return 0; +} + +/** LUA drop_item (creation) + * drop_item(int x, int y, int id [, int number]) + * drop_item(int x, int y, string name[, int number]) + ** + * Creates an item stack on the floor. + */ +static int item_drop(lua_State *s) +{ + const int x = luaL_checkint(s, 1); + const int y = luaL_checkint(s, 2); + ItemClass *ic = checkItemClass(s, 3); + const int number = luaL_optint(s, 4, 1); + MapComposite *map = checkCurrentMap(s); + + Item *i = new Item(ic, number); + + i->setMap(map); + Point pos(x, y); + i->setPosition(pos); + GameState::enqueueInsert(i); + return 0; +} + +/** LUA_CATEGORY Input and output (input) + */ + +/** LUA npc_message (input) + * npc_message(handle npc, handle character, string message) + ** + * **Warning:** May only be called from an NPC talk function. + * + * Shows an NPC dialog box on the screen of character ''ch'' displaying the + * string ''msg''. Idles the current thread until the user click "OK". */ static int npc_message(lua_State *s) { @@ -232,9 +504,21 @@ static int npc_message(lua_State *s) return lua_yield(s, 0); } -/** - * npc_choice(NPC*, Character*, string...): void - * Callback for sending a NPC_CHOICE. +/** LUA npc_choice (input) + * npc_choice(handle npc, handle character, item1, item2, ... itemN) + ** + * **Return value:** Number of the option the player selected (starting with 1). + * + * **Warning:** May only be called from an NPC talk function. + * + * Shows an NPC dialog box on the users screen with a number of dialog options + * to choose from. Idles the current thread until the user selects one or + * aborts the current thread when the user clicks "cancel". + * + * Items are either strings or tables of strings (indices are ignored, + * but presumed to be taken in order). So, + * ''npc_choice(npc, ch, "A", {"B", "C", "D"}, "E")'' is the same as + * ''npc_choice(npc, ch, "A", "B", "C", "D", "E")''. */ static int npc_choice(lua_State *s) { @@ -281,9 +565,16 @@ static int npc_choice(lua_State *s) return lua_yield(s, 0); } -/** - * npc_integer(NPC*, Character*, int min, int max, int default = min): void - * Callback for sending a NPC_INTEGER. +/** LUA npc_ask_integer (input) + * npc_ask_integer(handle npc, handle character, min_num, max_num, [default_num]) + ** + * **Return value:** The number the player entered into the field. + * + * **Warning:** May only be called from an NPC talk function. + * + * Shows a dialog box to the user which allows him to choose a number between + * ''min_num'' and ''max_num''. If ''default_num'' is set this number will be + * uses as default. Otherwise ''min_num'' will be the default. */ static int npc_ask_integer(lua_State *s) { @@ -306,9 +597,14 @@ static int npc_ask_integer(lua_State *s) return lua_yield(s, 0); } -/** - * npc_ask_string(NPC*, Character*): void - * Callback for sending a NPC_STRING. +/** LUA npc_ask_string (input) + * npc_ask_string(handle npc, handle character) + ** + * **Return value:** The string the player entered. + * + * **Warning:** May only be called from an NPC talk function. + * + * Shows a dialog box to a user which allows him to enter a text. */ static int npc_ask_string(lua_State *s) { @@ -325,52 +621,10 @@ static int npc_ask_string(lua_State *s) return lua_yield(s, 0); } -/** - * npc_create(string name, int id, int gender, int x, int y, - * function talk, function update): NPC* - * - * Callback for creating a NPC on the current map. - */ -static int npc_create(lua_State *s) -{ - const char *name = luaL_checkstring(s, 1); - const int id = luaL_checkint(s, 2); - const int gender = luaL_checkint(s, 3); - const int x = luaL_checkint(s, 4); - const int y = luaL_checkint(s, 5); - - if (!lua_isnoneornil(s, 6)) - luaL_checktype(s, 6, LUA_TFUNCTION); - if (!lua_isnoneornil(s, 7)) - luaL_checktype(s, 7, LUA_TFUNCTION); - - MapComposite *m = checkCurrentMap(s); - - NPC *q = new NPC(name, id); - q->setGender(getGender(gender)); - q->setMap(m); - q->setPosition(Point(x, y)); - - if (lua_isfunction(s, 6)) - { - lua_pushvalue(s, 6); - q->setTalkCallback(luaL_ref(s, LUA_REGISTRYINDEX)); - } - - if (lua_isfunction(s, 7)) - { - lua_pushvalue(s, 7); - q->setUpdateCallback(luaL_ref(s, LUA_REGISTRYINDEX)); - } - - GameState::enqueueInsert(q); - lua_pushlightuserdata(s, q); - return 1; -} - -/** - * npc_post(NPC*, Character*): void - * Callback for sending a NPC_POST. +/** LUA npc_post (input) + * npc_post(handle npc, handle character) + ** + * Starts retrieving post. Better not try to use it so far. */ static int npc_post(lua_State *s) { @@ -384,92 +638,350 @@ static int npc_post(lua_State *s) return 0; } -/** - * npc_enable(NPC*): void - * Enable a NPC if it has previously disabled +/** LUA being_say (input) + * being_say(handle being, string message) + ** + * Makes ''being'', which can be a character, monster or NPC, speak the string + * ''message'' as if it was entered by a player in the chat bar. */ -static int npc_enable(lua_State *s) +static int being_say(lua_State *s) { - NPC *p = checkNPC(s, 1); - p->setEnabled(true); - GameState::enqueueInsert(p); + Being *being = checkBeing(s, 1); + const char *message = luaL_checkstring(s, 2); + GameState::sayAround(being, message); return 0; } -/** - * npc_disable(NPC*): void - * Disable a NPC. +/** LUA chat_message (input) + * chat_message(handle character, string message) + ** + * Outputs the string ''message'' in the chatlog of ''character'' which will + * appear as a private message from "Server". */ -static int npc_disable(lua_State *s) +static int chat_message(lua_State *s) { - NPC *p = checkNPC(s, 1); - p->setEnabled(false); - GameState::remove(p); + Being *being = checkBeing(s, 1); + const char *message = luaL_checkstring(s, 2); + + GameState::sayTo(being, NULL, message); return 0; } -/** - * chr_warp(Character*, nil/int map, int x, int y): void - * Callback for warping a player to another place. +/** LUA announce (input) + * announce(string message [, string sender]) + ** + * Sends a global announce with the given ''message'' and ''sender''. If no + * ''sender'' is passed "Server" will be used as sender. */ -static int chr_warp(lua_State *s) +static int announce(lua_State *s) { - Character *q = checkCharacter(s, 1); - int x = luaL_checkint(s, 3); - int y = luaL_checkint(s, 4); + const char *message = luaL_checkstring(s, 1); + const char *sender = luaL_optstring(s, 2, "Server"); - bool b = lua_isnil(s, 2); - if (!(b || lua_isnumber(s, 2) || lua_isstring(s, 2))) + MessageOut msg(GAMSG_ANNOUNCE); + msg.writeString(message); + msg.writeInt16(0); // Announce from server so id = 0 + msg.writeString(sender); + accountHandler->send(msg); + return 0; +} + + +/** LUA_CATEGORY Inventory interaction (inventory) + */ + +/** LUA npc_trade (inventory) + * npc_trade(handle npc, + * handle character, + * bool mode, + * {int item1id, int item1amount, int item1cost}, ..., + * {int itemNid, int itemNamount, int itemNcost}) + * npc_trade(handle npc, + * handle character, + * bool mode, + * {string item1name, int item1amount, int item1cost}, ..., + * {string itemNname, int itemNamount, int itemNcost}) + ** + * FIXME: Move into a seperate file + * Opens a trade window for ''character'' while talking with ''npc''. ''mode'' is true for selling and false for buying. You have to set each items the NPC is buying/selling, the cost and the maximum amount in {}. + * + * **Note:** If the fourth parameters (table type) is omitted or invalid, and the mode set to sell (true), + * the whole player inventory is then sellable. + * + * **N.B.:** Be sure to put a ''value'' (item cost) parameter in your items.xml to permit the player to sell it when using this option. + * + * **Return values:** + * * **0** when a trade has been started + * * **1** when there is no buy/sellable items + * * **2** in case of errors. + * + * **Examples:** + * <code lua npc_trade.lua> + * -- "A buy sample." + * local buycase = npc_trade(npc, ch, false, { {"Sword", 10, 20}, {"Bow", 10, 30}, {"Dagger", 10, 50} }) + * if buycase == 0 then + * npc_message(npc, ch, "What do you want to buy?") + * elseif buycase == 1 then + * npc_message(npc, ch, "I've got no items to sell.") + * else + * npc_message(npc, ch, "Hmm, something went wrong... Ask a scripter to fix the buying mode!") + * end + * + * -- ... + * + * -- "Example: Let the player sell only pre-determined items." + * local sellcase = npc_trade(npc, ch, true, { {"Sword", 10, 20}, {"Bow", 10, 30}, + * {"Dagger", 10, 200}, {"Knife", 10, 300}, {"Arrow", 10, 500}, {"Cactus Drink", 10, 25} }) + * if sellcase == 0 then + * npc_message(npc, ch, "Here we go:") + * elseif sellcase == 1 then + * npc_message(npc, ch, "I'm not interested by your items.") + * else + * npc_message(npc, ch, "Hmm, something went wrong... Ask a scripter to fix me!") + * end + * + * -- ... + * + * -- "Example: Let the player sell every item with a 'value' parameter in the server's items.xml file + * local sellcase = npc_trade(npc, ch, true) + * if sellcase == 0 then + * npc_message(npc, ch, "Ok, what do you want to sell:") + * elseif sellcase == 1 then + * npc_message(npc, ch, "I'm not interested by any of your items.") + * else + * npc_message(npc, ch, "Hmm, something went wrong... Ask a scripter to fix this!") + * end + * </code> + */ +static int npc_trade(lua_State *s) +{ + NPC *p = checkNPC(s, 1); + Character *q = checkCharacter(s, 2); + if (!lua_isboolean(s, 3)) { - luaL_error(s, "chr_warp called with incorrect parameters."); + luaL_error(s, "npc_trade called with incorrect parameters."); return 0; } - MapComposite *m; - if (b) + + bool sellMode = lua_toboolean(s, 3); + BuySell *t = new BuySell(q, sellMode); + if (!lua_istable(s, 4)) { - m = checkCurrentMap(s); + if (sellMode) + { + // Can sell everything + if (!t->registerPlayerItems()) + { + // No items to sell in player inventory + t->cancel(); + lua_pushinteger(s, 1); + return 1; + } + + if (t->start(p)) + { + lua_pushinteger(s, 0); + return 1; + } + else + { + lua_pushinteger(s, 1); + return 1; + } + } + else + { + raiseWarning(s, "npc_trade[Buy] called with invalid " + "or empty items table parameter."); + t->cancel(); + lua_pushinteger(s, 2); + return 1; + } } - else if (lua_isnumber(s, 2)) + + int nbItems = 0; + + lua_pushnil(s); + while (lua_next(s, 4)) { - m = MapManager::getMap(lua_tointeger(s, 2)); - luaL_argcheck(s, m, 2, "invalid map id"); + if (!lua_istable(s, -1)) + { + raiseWarning(s, "npc_trade called with invalid " + "or empty items table parameter."); + t->cancel(); + lua_pushinteger(s, 2); + return 1; + } + + int v[3]; + for (int i = 0; i < 3; ++i) + { + lua_rawgeti(s, -1, i + 1); + if (i == 0) // item id or name + { + ItemClass *it = getItemClass(s, -1); + + if (!it) + { + raiseWarning(s, "npc_trade called with incorrect " + "item id or name."); + t->cancel(); + lua_pushinteger(s, 2); + return 1; + } + v[0] = it->getDatabaseID(); + } + else if (!lua_isnumber(s, -1)) + { + raiseWarning(s, "npc_trade called with incorrect parameters " + "in item table."); + t->cancel(); + lua_pushinteger(s, 2); + return 1; + } + else + { + v[i] = lua_tointeger(s, -1); + } + lua_pop(s, 1); + } + if (t->registerItem(v[0], v[1], v[2])) + nbItems++; + lua_pop(s, 1); + } + + if (nbItems == 0) + { + t->cancel(); + lua_pushinteger(s, 1); + return 1; + } + if (t->start(p)) + { + lua_pushinteger(s, 0); + return 1; } else { - m = MapManager::getMap(lua_tostring(s, 2)); - luaL_argcheck(s, m, 2, "invalid map name"); + lua_pushinteger(s, 1); + return 1; } +} - Map *map = m->getMap(); +/** LUA chr_inv_count (inventory) + * chr_inv_count(handle character, bool inInventory, bool inEquipment, int id1, ..., int idN) + * chr_inv_count(handle character, bool inInventory, bool inEquipment, string name1, ..., string nameN) + ** + * The boolean values ''inInventory'' and ''inEquipment'' make possible to + * select whether equipped or carried items must be counted. + * + * **Return values:** A number of integers with the amount of items ''id'' or + * ''name'' carried or equipped by the ''character''. + */ +static int chr_inv_count(lua_State *s) +{ + Character *q = checkCharacter(s, 1); + if (!lua_isboolean(s, 2) || !lua_isboolean(s, 3)) + { + luaL_error(s, "chr_inv_count called with incorrect parameters."); + return 0; + } - // If the wanted warp place is unwalkable - if (!map->getWalk(x / map->getTileWidth(), y / map->getTileHeight())) + bool inInventory = lua_toboolean(s, 2); + bool inEquipment = lua_toboolean(s, 3); + + int nb_items = lua_gettop(s) - 3; + Inventory inv(q); + + int nb = 0; + for (int i = 4; i < nb_items + 4; ++i) { - int c = 50; - LOG_INFO("chr_warp called with a non-walkable place."); - do - { - x = rand() % map->getWidth(); - y = rand() % map->getHeight(); - } while (!map->getWalk(x, y) && --c); - x *= map->getTileWidth(); - y *= map->getTileHeight(); + ItemClass *it = checkItemClass(s, i); + nb = inv.count(it->getDatabaseID(), inInventory, inEquipment); + lua_pushinteger(s, nb); } - GameState::enqueueWarp(q, m, x, y); + return nb_items; +} - return 0; +/** LUA chr_inv_change (inventory) + * chr_inv_change(handle character, int id1, int number1, ..., int idN, numberN) + * chr_inv_change(handle character, string name1, int number1, ..., string nameN, numberN) + ** + * **Return value:** Boolean true on success, boolean false on failure. + * + * Changes the number of items with the item ID ''id'' or ''name'' owned by + * ''character'' by ''number''. You can change any number of items with this + * function by passing multiple ''id'' or ''name'' and ''number'' pairs. + * A failure can be caused by trying to take items the character doesn't possess. + * + * **Warning:** When one of the operations fails the following operations are + * ignored but these before are executed. For that reason you should always + * check if the character possesses items you are taking away using + * chr_inv_count. + */ +static int chr_inv_change(lua_State *s) +{ + Character *q = checkCharacter(s, 1); + int nb_items = (lua_gettop(s) - 1) / 2; + Inventory inv(q); + for (int i = 0; i < nb_items; ++i) + { + if (!lua_isnumber(s, i * 2 + 3)) + { + luaL_error(s, "chr_inv_change called with " + "incorrect parameters."); + return 0; + } + + int nb = lua_tointeger(s, i * 2 + 3); + ItemClass *ic = checkItemClass(s, i * 2 + 2); + int id = ic->getDatabaseID(); + if (nb < 0) + { + // Removing too much item is a success as for the scripter's + // point of view. We log it anyway. + nb = inv.remove(id, -nb); + if (nb) + { + LOG_WARN("chr_inv_change() removed more items than owned: " + << "character: " << q->getName() << " item id: " << id); + } + } + else + { + nb = inv.insert(id, nb); + if (nb) + { + Item *item = new Item(ic, nb); + item->setMap(q->getMap()); + item->setPosition(q->getPosition()); + GameState::enqueueInsert(item); + } + } + } + lua_pushboolean(s, 1); + return 1; } -/** - * Callback for gathering inventory information. +/** LUA chr_get_inventory (inventory) * chr_get_inventory(character): table[]{slot, item id, name, amount} - * Returns in the inventory slots order, the slot id, the item ids, - * name and amount. Only slots not empty are returned. - * @Example - * To get a piece of information, you can do something like this: - * -- This will print the 2nd non-empty slot id. - * local my_table = chr_get_inventory(character) - * print(my_table[2].slot) + ** + * used to get a full view of a character's inventory. + * This is not the preferred way to know whether an item is in the character's inventory: + * Use chr_inv_count for simple cases. + * + * **Return value:** A table containing all the info about the character's inventory. + * Empty slots are not listed. + * + * **Example of use:** + * <code lua> + * local inventory_table = chr_get_inventory(ch) + * for i = 1, #inventory_table do + * item_message = item_message.."\n"..inventory_table[i].slot..", " + * ..inventory_table[i].id..", "..inventory_table[i].name..", " + * ..inventory_table[i].amount + * end + * </code> */ static int chr_get_inventory(lua_State *s) { @@ -516,16 +1028,24 @@ static int chr_get_inventory(lua_State *s) return 1; } -/** - * Callback for gathering equipment information. - * chr_get_inventory(character): table[](slot, item id, name) - * Returns in the inventory slots order, the slot id, the item ids, and name. - * Only slots not empty are returned. - * @Example - * To get a piece of information, you can do something like this: - * -- This will print the 2nd non-empty slot id. - * local my_table = chr_get_equipment(character) - * print(my_table[2].slot) +/** LUA chr_get_equipment (inventory) + * chr_get_equipment(character): table[](slot, item id, name)} + ** + * Used to get a full view of a character's equipment. + * This is not the preferred way to know whether an item is equipped: + * Use chr_inv_count for simple cases. + * + * **Return value:** A table containing all the info about the character's equipment. + * Empty slots are not listed. + * + * **Example of use:** + * <code lua> + * local equipment_table = chr_get_equipment(ch) + * for i = 1, #equipment_table do + * item_message = item_message.."\n"..equipment_table[i].slot..", " + * ..equipment_table[i].id..", "..equipment_table[i].name + * end + * </code> */ static int chr_get_equipment(lua_State *s) { @@ -574,95 +1094,9 @@ static int chr_get_equipment(lua_State *s) return 1; } -/** - * chr_inv_change(Character*, (int id || string name || itemclass item, - * int nb)...): bool success - * Callback for inserting/removing items in inventory. - * The function can be called several times in a row, but it is better to - * perform all the changes at once, so as to reduce bandwidth. Removals - * (negative amount) should be passed first, then insertions (positive amount). - * If a removal fails, all the previous operations are canceled (except for - * items dropped on the floor, hence why removals should be passed first), and - * the function returns false. - * Note: If an insertion fails, extra items are dropped on the floor. - */ -static int chr_inv_change(lua_State *s) -{ - Character *q = checkCharacter(s, 1); - int nb_items = (lua_gettop(s) - 1) / 2; - Inventory inv(q); - for (int i = 0; i < nb_items; ++i) - { - if (!lua_isnumber(s, i * 2 + 3)) - { - luaL_error(s, "chr_inv_change called with " - "incorrect parameters."); - return 0; - } - - int nb = lua_tointeger(s, i * 2 + 3); - ItemClass *ic = checkItemClass(s, i * 2 + 2); - int id = ic->getDatabaseID(); - if (nb < 0) - { - // Removing too much item is a success as for the scripter's - // point of view. We log it anyway. - nb = inv.remove(id, -nb); - if (nb) - { - LOG_WARN("chr_inv_change() removed more items than owned: " - << "character: " << q->getName() << " item id: " << id); - } - } - else - { - nb = inv.insert(id, nb); - if (nb) - { - Item *item = new Item(ic, nb); - item->setMap(q->getMap()); - item->setPosition(q->getPosition()); - GameState::enqueueInsert(item); - } - } - } - lua_pushboolean(s, 1); - return 1; -} - -/** - * chr_inv_count(Character*, bool in inventory, bool in equipment, - * int item_id...): int count... - * Callback for counting items in inventory. - * The function can search in inventory and/or in the equipment. - */ -static int chr_inv_count(lua_State *s) -{ - Character *q = checkCharacter(s, 1); - if (!lua_isboolean(s, 2) || !lua_isboolean(s, 3)) - { - luaL_error(s, "chr_inv_count called with incorrect parameters."); - return 0; - } - - bool inInventory = lua_toboolean(s, 2); - bool inEquipment = lua_toboolean(s, 3); - - int nb_items = lua_gettop(s) - 3; - Inventory inv(q); - - int nb = 0; - for (int i = 4; i < nb_items + 4; ++i) - { - ItemClass *it = checkItemClass(s, i); - nb = inv.count(it->getDatabaseID(), inInventory, inEquipment); - lua_pushinteger(s, nb); - } - return nb_items; -} - -/** - * chr_equip_slot(Character*, int inventorySlot): bool success +/** LUA chr_equip_slot (inventory) + * chr_equip_slot(handle character, int slot) + ** * Makes the character equip the item in the given inventory slot. */ static int chr_equip_slot(lua_State *s) @@ -675,10 +1109,14 @@ static int chr_equip_slot(lua_State *s) return 1; } -/** - * chr_equip_item(Character*, int itemId || string itemName): bool success +/** LUA chr_equip_item (inventory) + * chr_equip_item(handle character, int item_id) + * chr_equip_item(handle character, string item_name) + ** * Makes the character equip the item id when it's existing * in the player's inventory. + * + * **Return value:** true if equipping suceeded. false otherwise. */ static int chr_equip_item(lua_State *s) { @@ -697,9 +1135,12 @@ static int chr_equip_item(lua_State *s) return 1; } -/** - * chr_unequip_slot(Character*, int inventorySlot): bool success +/** LUA chr_unequip_slot (inventory) + * chr_unequip_slot(handle character, int slot) + ** * Makes the character unequip the item in the given equipment slot. + * + * **Return value:** true upon success. false otherwise. */ static int chr_unequip_slot(lua_State *s) { @@ -712,11 +1153,14 @@ static int chr_unequip_slot(lua_State *s) return 1; } -/** - * chr_unequip_item(Character*, int itemId || string itemName): bool success +/** LUA chr_unequip_item (inventory) + * chr_unequip_item(handle character, int item_id) + * chr_unequip_item(handle character, string item_name) + ** * Makes the character unequip the item(s) corresponding to the id * when it's existing in the player's equipment. - * Returns true when every item were unequipped from equipment. + * + * **Return value:** true when every item were unequipped from equipment. */ static int chr_unequip_item(lua_State *s) { @@ -728,246 +1172,158 @@ static int chr_unequip_item(lua_State *s) return 1; } -/** - * chr_get_level(Character* [, skill]): int level - * Tells the character current level. If a skill is passed as 2nd argument it - * will return the skill level. +/** LUA_CATEGORY Character and being interaction (being) */ -static int chr_get_level(lua_State *s) -{ - Character *ch = checkCharacter(s, 1); - if (lua_gettop(s) > 1) - { - int skillId = checkSkill(s, 2); - lua_pushinteger(s, ch->levelForExp(ch->getExperience(skillId))); - } - else - { - lua_pushinteger(s, ch->getLevel()); - } - return 1; -} -/** - * chr_kick(Character*) - * Kicks the character. - */ -static int chr_kick(lua_State *s) -{ - Character *ch = checkCharacter(s, 1); - MessageOut kickmsg(GPMSG_CONNECT_RESPONSE); - kickmsg.writeInt8(ERRMSG_ADMINISTRATIVE_LOGOFF); - ch->getClient()->disconnect(kickmsg); - return 0; -} - -/** - * npc_trade(NPC*, Character*, bool sell, table items): int - * Callback for trading between a player and an NPC. - * Let the player buy or sell only a subset of predeterminded items. - * @param table items: a subset of buyable/sellable items. - * When selling, if the 4 parameter is omitted or invalid, - * everything in the player inventory can be sold. - * @return 0 if something to buy/sell, 1 if no items, 2 in case of errors. +/** LUA chr_get_quest (being) + * chr_get_quest(handle character, string name) + ** + * **Return value:** The quest variable named ''name'' for the given character. + * + * **Warning:** May only be called from an NPC talk function. + * */ -static int npc_trade(lua_State *s) +static int chr_get_quest(lua_State *s) { - NPC *p = checkNPC(s, 1); - Character *q = checkCharacter(s, 2); - if (!lua_isboolean(s, 3)) - { - luaL_error(s, "npc_trade called with incorrect parameters."); - return 0; - } - - bool sellMode = lua_toboolean(s, 3); - BuySell *t = new BuySell(q, sellMode); - if (!lua_istable(s, 4)) - { - if (sellMode) - { - // Can sell everything - if (!t->registerPlayerItems()) - { - // No items to sell in player inventory - t->cancel(); - lua_pushinteger(s, 1); - return 1; - } - - if (t->start(p)) - { - lua_pushinteger(s, 0); - return 1; - } - else - { - lua_pushinteger(s, 1); - return 1; - } - } - else - { - raiseWarning(s, "npc_trade[Buy] called with invalid " - "or empty items table parameter."); - t->cancel(); - lua_pushinteger(s, 2); - return 1; - } - } - - int nbItems = 0; - - lua_pushnil(s); - while (lua_next(s, 4)) - { - if (!lua_istable(s, -1)) - { - raiseWarning(s, "npc_trade called with invalid " - "or empty items table parameter."); - t->cancel(); - lua_pushinteger(s, 2); - return 1; - } - - int v[3]; - for (int i = 0; i < 3; ++i) - { - lua_rawgeti(s, -1, i + 1); - if (i == 0) // item id or name - { - ItemClass *it = getItemClass(s, -1); + Character *q = checkCharacter(s, 1); + const char *name = luaL_checkstring(s, 2); + luaL_argcheck(s, name[0] != 0, 2, "empty variable name"); - if (!it) - { - raiseWarning(s, "npc_trade called with incorrect " - "item id or name."); - t->cancel(); - lua_pushinteger(s, 2); - return 1; - } - v[0] = it->getDatabaseID(); - } - else if (!lua_isnumber(s, -1)) - { - raiseWarning(s, "npc_trade called with incorrect parameters " - "in item table."); - t->cancel(); - lua_pushinteger(s, 2); - return 1; - } - else - { - v[i] = lua_tointeger(s, -1); - } - lua_pop(s, 1); - } - if (t->registerItem(v[0], v[1], v[2])) - nbItems++; - lua_pop(s, 1); - } + Script::Thread *thread = checkCurrentThread(s); - if (nbItems == 0) - { - t->cancel(); - lua_pushinteger(s, 1); - return 1; - } - if (t->start(p)) - { - lua_pushinteger(s, 0); - return 1; - } - else + std::string value; + bool res = getQuestVar(q, name, value); + if (res) { - lua_pushinteger(s, 1); + push(s, value); return 1; } + QuestCallback *f = new QuestThreadCallback(&LuaScript::getQuestCallback, + getScript(s)); + recoverQuestVar(q, name, f); + + thread->mState = Script::ThreadExpectingString; + return lua_yield(s, 0); } -/** - * being_apply_status(Being*, int id, int time): void - * Applies a status effect with id to the being given for a amount of time. +/** LUA chr_set_quest (being) + * chr_set_quest(handle character, string name, string value) + ** + * Sets the quest variable named ''name'' for the given character to the value + * ''value''. */ -static int being_apply_status(lua_State *s) +static int chr_set_quest(lua_State *s) { - Being *being = checkBeing(s, 1); - const int id = luaL_checkint(s, 2); - const int time = luaL_checkint(s, 3); + Character *q = checkCharacter(s, 1); + const char *name = luaL_checkstring(s, 2); + const char *value = luaL_checkstring(s, 3); + luaL_argcheck(s, name[0] != 0, 2, "empty variable name"); - being->applyStatusEffect(id, time); + setQuestVar(q, name, value); return 0; } -/** - * being_remove_status(Being*, int id): void - * Removes the given status effect. +/** LUA chr_set_special_recharge_speed (being) + * chr_set_special_recharge_speed(handle ch, int specialid, int new_speed) + * chr_set_special_recharge_speed(handle ch, string specialname, int new_speed) + ** + * Sets the recharge speed of the special to a new value for the character. + * + * **Note:** When passing the ''specialname'' as parameter make sure that it is + * formatted in this way: <setname>_<specialname> (for eg. "Magic_Healingspell"). */ -static int being_remove_status(lua_State *s) +static int chr_set_special_recharge_speed(lua_State *s) { - Being *being = checkBeing(s, 1); - const int id = luaL_checkint(s, 2); + Character *c = checkCharacter(s, 1); + const int special = checkSpecial(s, 2); + const int speed = luaL_checkint(s, 3); - being->removeStatusEffect(id); + if (!c->setSpecialRechargeSpeed(special, speed)) + { + luaL_error(s, + "chr_set_special_recharge_speed called with special " + "that is not owned by character."); + } return 0; } -/** - * being_has_status(Being*, int id): bool - * Returns whether a being has the given status effect. +/** LUA chr_get_special_recharge_speed (being) + * chr_get_special_recharge_speed(handle ch, int specialid) + * chr_get_special_recharge_speed(handle ch, string specialname) + ** + * **Return value:** The current recharge speed of the special that is owned by + * the character ''ch''. + * + * **Note:** When passing the ''specialname'' as parameter make sure that it is + * formatted in this way: <setname>_<specialname> (for eg. "Magic_Healingspell"). */ -static int being_has_status(lua_State *s) +static int chr_get_special_recharge_speed(lua_State *s) { - Being *being = checkBeing(s, 1); - const int id = luaL_checkint(s, 2); + Character *c = checkCharacter(s, 1); + const int special = checkSpecial(s, 2); - lua_pushboolean(s, being->hasStatusEffect(id)); - return 1; -} + SpecialMap::iterator it = c->findSpecial(special); -/** - * being_get_status_time(Being*, int id): int - * Returns the time left on the given status effect. - */ -static int being_get_status_time(lua_State *s) -{ - Being *being = checkBeing(s, 1); - const int id = luaL_checkint(s, 2); + luaL_argcheck(s, it != c->getSpecialEnd(), 2, + "character does not have special"); - lua_pushinteger(s, being->getStatusEffectTime(id)); + lua_pushinteger(s, it->second.rechargeSpeed); return 1; } -/** - * being_set_status_time(Being*, int id, int time): void - * Sets the time left on the given status effect. +/** LUA chr_set_special_mana (being) + * chr_set_special_mana(handle ch, int specialid, int new_mana) + * chr_set_special_mana(handle ch, string specialname, int new_mana) + ** + * Sets the mana (recharge status) of the special to a new value for the + * character. + * + * **Note:** When passing the ''specialname'' as parameter make sure that it is + * formatted in this way: <setname>_<specialname> (for eg. "Magic_Healingspell"). */ -static int being_set_status_time(lua_State *s) +static int chr_set_special_mana(lua_State *s) { - Being *being = checkBeing(s, 1); - const int id = luaL_checkint(s, 2); - const int time = luaL_checkint(s, 3); - - being->setStatusEffectTime(id, time); + Character *c = checkCharacter(s, 1); + const int special = checkSpecial(s, 2); + const int mana = luaL_checkint(s, 3); + if (!c->setSpecialMana(special, mana)) + { + luaL_error(s, + "chr_set_special_mana called with special " + "that is not owned by character."); + } return 0; } -/** - * being_type(Being*): EntityType - * Returns the entity type of the given being. +/** LUA chr_get_special_mana (being) + * chr_get_special_mana(handle ch, int specialid) + * chr_get_special_mana(handle ch, string specialname) + ** + * **Return value:** The mana (recharge status) of the special that is owned by + * the character ''ch''. + * + * **Note:** When passing the ''specialname'' as parameter make sure that it is + * formatted in this way: <setname>_<specialname> (for eg. "Magic_Healingspell"). */ -static int being_type(lua_State *s) +static int chr_get_special_mana(lua_State *s) { - Being *being = checkBeing(s, 1); - lua_pushinteger(s, being->getType()); + Character *c = checkCharacter(s, 1); + const int special = checkSpecial(s, 2); + SpecialMap::iterator it = c->findSpecial(special); + luaL_argcheck(s, it != c->getSpecialEnd(), 2, + "character does not have special"); + lua_pushinteger(s, it->second.currentMana); return 1; } - -/** - * being_walk(Being *, int x, int y[, float speed]): void - * Function for making a being walk to a position. - * The speed is in tile per second. +/** LUA being_walk (being) + * being_walk(handle being, int pixelX, int pixelY [, int walkSpeed]) + ** + * Set the desired destination in pixels for the **'being'**. + * + * The optional **'WalkSpeed'** is to be given in tiles per second. The average + * speed is 6.0 tiles per second. If no speed is given the default speed of the + * being is used. */ static int being_walk(lua_State *s) { @@ -987,23 +1343,38 @@ static int being_walk(lua_State *s) return 0; } -/** - * being_say(Being* source, string message): void - * Makes the being say something. - */ -static int being_say(lua_State *s) -{ - Being *being = checkBeing(s, 1); - const char *message = luaL_checkstring(s, 2); - GameState::sayAround(being, message); - return 0; -} - - -/** - * being_damage(Being* victim, int value, int delta, int cth, int type, - * int element [, Being* source [, int skill]]): void - * Applies combat damage to a being. +/** LUA being_damage (being) + * being_damage(handle being, int damage, int delta, + * int accuracy, int type, int element) + * being_damage(handle being, int damage, int delta, int accuracy, + * int type, int element, handle source) + * being_damage(handle being, int damage, int delta, int accuracy, + * int type, int element, handle source, int skill) + * being_damage(handle being, int damage, int delta, int accuracy, + * int type, int element, handle source, string skillname) + ** + * Inflicts damage to ''being''. The severity of the attack is between + * ''damage'' and (''damage'' + ''delta'') and is calculated using the normal [[damage calculation]] rules. The being has a chance to [[hitting and dodging|dodge the attack]] with its [[attributes|agility attribute]]. The ''accuracy'' decides how hard this is. If ''source'' is provided the attack is handled as if the ''source'' triggered the damage. If ''skill'' is given the ''owner'' can also recieve xp for the attack. The ''skill'' should be defined in the [[skills.xml|skills.xml]]. If the skill is provided as string (''skillname'') you have to use this format: <setname>_<skillname>. So for example: "Weapons_Unarmed" + * + * ''type'' affects which kind of armor and character attributes reduce the + * damage. It can be one of the following values: + * | 0 | DAMAGE_PHYSICAL | + * | 1 | DAMAGE_MAGICAL | + * | 2 | DAMAGE_OTHER | + * + * ''element'' decides how the [[element system]] changes the damage. The + * following values are possible: + * | 0 | ELEMENT_NEUTRAL | + * | 1 | ELEMENT_FIRE | + * | 2 | ELEMENT_WATER | + * | 3 | ELEMENT_EARTH | + * | 4 | ELEMENT_AIR | + * | 5 | ELEMENT_LIGHTNING | + * | 6 | ELEMENT_METAL | + * | 7 | ELEMENT_WOOD | + * | 8 | ELEMENT_ICE | + * + * **Return Value**: Actual HP reduction resulting from the attack. */ static int being_damage(lua_State *s) { @@ -1041,10 +1412,14 @@ static int being_damage(lua_State *s) return 0; } -/** - * being_heal(Being* [, int value]): void - * Restores hit points of a being. - * Without a value the being is fully healed. +/** LUA being_heal (being) + * being_heal(handle being[, int value]) + ** + * Restores ''value'' lost hit points to ''being''. Value can be omitted to + * restore the being to full hit points. + * + * While you can (ab)use this function to hurt a being by using a negative + * value you should rather use being_damage for this purpose. */ static int being_heal(lua_State *s) { @@ -1062,97 +1437,51 @@ static int being_heal(lua_State *s) return 0; } -/** - * being_get_base_attribute(Being*, int attribute): int - * Gets the base attribute of a being. +/** LUA being_get_name (being) + * being_get_name(handle being) + ** + * **Return value:** Name of the being. */ -static int being_get_base_attribute(lua_State *s) -{ - Being *being = checkBeing(s, 1); - int attr = luaL_checkint(s, 2); - luaL_argcheck(s, attr > 0, 2, "invalid attribute id"); - - lua_pushinteger(s, being->getAttribute(attr)); - return 1; -} - -/** - * being_get_modified_attribute(Being*, int attribute): int - * Gets the modified attribute of a being. - */ -static int being_get_modified_attribute(lua_State *s) +static int being_get_name(lua_State *s) { Being *being = checkBeing(s, 1); - int attr = luaL_checkint(s, 2); - luaL_argcheck(s, attr > 0, 2, "invalid attribute id"); - - lua_pushinteger(s, being->getModifiedAttribute(attr)); + push(s, being->getName()); return 1; } -/** - * being_set_base_attribute(Being*, int attribute, double value): void - * Sets the base attribute of a being. - */ -static int being_set_base_attribute(lua_State *s) -{ - Being *being = checkBeing(s, 1); - int attr = luaL_checkint(s, 2); - double value = luaL_checknumber(s, 3); - - being->setAttribute(attr, value); - return 0; -} - -/** - * being_apply_attribute_modifier(Being*, int attribute, double value, - * int layer, int [duration, int [effect-id]]): void - * Applies an attribute modifier to a being. - */ -static int being_apply_attribute_modifier(lua_State *s) -{ - Being *being = checkBeing(s, 1); - int attr = luaL_checkint(s,2); - double value = luaL_checknumber(s, 3); - int layer = luaL_checkint(s, 4); - int duration = luaL_optint(s, 5, 0); - int effectId = luaL_optint(s, 6, 0); - - being->applyModifier(attr, value, layer, duration, effectId); - return 0; -} - -/** - * being_remove_attribute_modifier(Being*, int attribute, double value, - * int layer, int [effect-id]]): void - * Removes an attribute modifier to a being. - */ -static int being_remove_attribute_modifier(lua_State *s) -{ - Being *being = checkBeing(s, 1); - int attr = luaL_checkint(s, 2); - double value = luaL_checknumber(s, 3); - int layer = luaL_checkint(s, 4); - int effectId = luaL_optint(s, 5, 0); - - being->removeModifier(attr, value, layer, effectId); - return 0; -} - -/** - * being_get_name(Being*): string - * Gets the being's name. - */ -static int being_get_name(lua_State *s) +/** LUA being_type (being) + * being_type(handle being) + ** + * **Return value:** Type of the given being. These type constants are defined + * in libmana-constants.lua: + * + * | 0 | TYPE_ITEM | + * | 1 | TYPE_ACTOR | + * | 2 | TYPE_NPC | + * | 3 | TYPE_MONSTER | + * | 4 | TYPE_CHARACTER | + * | 5 | TYPE_EFFECT | + * | 6 | TYPE_OTHER | +*/ +static int being_type(lua_State *s) { Being *being = checkBeing(s, 1); - push(s, being->getName()); + lua_pushinteger(s, being->getType()); return 1; } -/** - * being_get_action(Being*): BeingAction - * Gets the being's current action. +/** LUA being_get_action (being) + * being_get_action(handle being) + ** + * **Return value:** Current action of the given being. These action constants + * are defined in libmana-constants.lua: + * + * | 0 | ACTION_STAND | + * | 1 | ACTION_WALK | + * | 2 | ACTION_ATTACK | + * | 3 | ACTION_SIT | + * | 4 | ACTION_DEAD | + * | 5 | ACTION_HURT | */ static int being_get_action(lua_State *s) { @@ -1161,9 +1490,10 @@ static int being_get_action(lua_State *s) return 1; } -/** - * being_set_action(Being*, BeingAction): void - * Sets the being's current action. +/** LUA being_set_action (being) + * being_set_action(handle being, int action) + ** + * Sets the current action for the being. */ static int being_set_action(lua_State *s) { @@ -1173,9 +1503,18 @@ static int being_set_action(lua_State *s) return 0; } -/** - * being_get_direction(Being*): BeingDirection - * Gets the being's current direction. +/** LUA being_get_direction (being) + * being_get_direction(handle being) + ** + * **Return value:** Current direction of the given being. These direction + * constants are defined in libmana-constants.lua: + * + * | 0 | DIRECTION_DEFAULT | + * | 1 | DIRECTION_UP | + * | 2 | DIRECTION_DOWN | + * | 3 | DIRECTION_LEFT | + * | 4 | DIRECTION_RIGHT | + * | 5 | DIRECTION_INVALID | */ static int being_get_direction(lua_State *s) { @@ -1184,9 +1523,11 @@ static int being_get_direction(lua_State *s) return 1; } -/** - * being_set_direction(Being*, BeingDirection): void - * Sets the being's current direction. +/** LUA being_set_direction (being) + * being_set_direction(handle being, int direction) + ** + * Sets the current direction of the given being. Directions are same as in + * ''being_get_direction''. */ static int being_set_direction(lua_State *s) { @@ -1196,9 +1537,18 @@ static int being_set_direction(lua_State *s) return 0; } -/** - * being_set_walkmask(Being*, string mask) - * Sets the walkmask of a being +/** LUA being_set_walkmask (being) + * being_set_walkmask(handle being, string mask) + ** + * Sets the walkmasks of a being. The mask is a set of characters which stand + * for different collision types. + * + * | w | Wall | + * | c | Character | + * | m | Monster | + * + * This means being_set_walkmask(being, "wm") will prevent the being from + * walking over walls and monsters. */ static int being_set_walkmask(lua_State *s) { @@ -1215,9 +1565,11 @@ static int being_set_walkmask(lua_State *s) return 0; } -/** - * being_get_walkmask(Being*): string - * Returns the walkmask of a being. +/** LUA being_get_walkmask (being) + * being_get_walkmask(handle being) + ** + * **Return value:** The walkmask of the being formatted as string. (See + * [[scripting#get_item_class|being_set_walkmask]]) */ static int being_get_walkmask(lua_State *s) { @@ -1235,24 +1587,68 @@ static int being_get_walkmask(lua_State *s) return 1; } -/** - * being_get_mapid(Being*): int - * Returns the id of the map where the being is located or nil if there is none. +/** LUA chr_warp (being) + * chr_warp(handle character, int mapID, int posX, int posY) + * chr_warp(handle character, string mapName, int posX, int posY) + ** + * Teleports the ''character'' to the position ''posX'':''posY'' on the map + * with the ID number ''mapID'' or name ''mapName''. The ''mapID'' can be + * substituted by ''nil'' to warp the ''character'' to a new position on the + * current map. */ -static int being_get_mapid(lua_State *s) +static int chr_warp(lua_State *s) { - Being *being = checkBeing(s, 1); - if (MapComposite *map = being->getMap()) - lua_pushinteger(s, map->getID()); + Character *q = checkCharacter(s, 1); + int x = luaL_checkint(s, 3); + int y = luaL_checkint(s, 4); + + bool b = lua_isnil(s, 2); + if (!(b || lua_isnumber(s, 2) || lua_isstring(s, 2))) + { + luaL_error(s, "chr_warp called with incorrect parameters."); + return 0; + } + MapComposite *m; + if (b) + { + m = checkCurrentMap(s); + } + else if (lua_isnumber(s, 2)) + { + m = MapManager::getMap(lua_tointeger(s, 2)); + luaL_argcheck(s, m, 2, "invalid map id"); + } else - lua_pushnil(s); + { + m = MapManager::getMap(lua_tostring(s, 2)); + luaL_argcheck(s, m, 2, "invalid map name"); + } - return 1; + Map *map = m->getMap(); + + // If the wanted warp place is unwalkable + if (!map->getWalk(x / map->getTileWidth(), y / map->getTileHeight())) + { + int c = 50; + LOG_INFO("chr_warp called with a non-walkable place."); + do + { + x = rand() % map->getWidth(); + y = rand() % map->getHeight(); + } while (!map->getWalk(x, y) && --c); + x *= map->getTileWidth(); + y *= map->getTileHeight(); + } + GameState::enqueueWarp(q, m, x, y); + + return 0; } -/** - * posX(Being*): int xcoord - * Function for getting the x-coordinate of the position of a being. +/** LUA posX (being) + * posX(handle being) + ** + * **Return value:** The horizontal position of the ''being'' in pixels + * measured from the left border of the map it is currently on. */ static int posX(lua_State *s) { @@ -1261,9 +1657,11 @@ static int posX(lua_State *s) return 1; } -/** - * posY(Being*): int ycoord - * Function for getting the y-coordinate of the position of a being. +/** LUA posY (being) + * posY(handle being) + ** + * **Return value:** The vertical position of the ''being'' in pixels measured + * from the upper border of the map it is currently on. */ static int posY(lua_State *s) { @@ -1272,421 +1670,415 @@ static int posY(lua_State *s) return 1; } -static int monster_class_on_update(lua_State *s) -{ - MonsterClass *monsterClass = LuaMonsterClass::check(s, 1); - luaL_checktype(s, 2, LUA_TFUNCTION); - monsterClass->setUpdateCallback(getScript(s)); - return 0; -} - -static int monster_class_on_damage(lua_State *s) +/** LUA being_get_base_attribute (being) + * being_get_base_attribute(handle being, int attribute_id) + ** + * Set the value of the being's ''base attribute'' to the 'new_value' parameter + * given. (It can be negative). + */ +static int being_get_base_attribute(lua_State *s) { - MonsterClass *monsterClass = LuaMonsterClass::check(s, 1); - luaL_checktype(s, 2, LUA_TFUNCTION); - monsterClass->setDamageCallback(getScript(s)); - return 0; -} + Being *being = checkBeing(s, 1); + int attr = luaL_checkint(s, 2); + luaL_argcheck(s, attr > 0, 2, "invalid attribute id"); -static int monster_class_attacks(lua_State *s) -{ - MonsterClass *monsterClass = LuaMonsterClass::check(s, 1); - pushSTLContainer(s, monsterClass->getAttackInfos()); + lua_pushinteger(s, being->getAttribute(attr)); return 1; } -/** - * monster_create(int id || string name, int x, int y): Monster* - * Callback for creating a monster on the current map. +/** LUA being_set_base_attribute (being) + * being_set_base_attribute(handle being, int attribute_id, double new_value) + ** + * **Return value:** Returns the double value of the being's ''base attribute''. */ -static int monster_create(lua_State *s) +static int being_set_base_attribute(lua_State *s) { - MonsterClass *monsterClass = checkMonsterClass(s, 1); - const int x = luaL_checkint(s, 2); - const int y = luaL_checkint(s, 3); - MapComposite *m = checkCurrentMap(s); - - Monster *q = new Monster(monsterClass); - q->setMap(m); - q->setPosition(Point(x, y)); - GameState::enqueueInsert(q); + Being *being = checkBeing(s, 1); + int attr = luaL_checkint(s, 2); + double value = luaL_checknumber(s, 3); - lua_pushlightuserdata(s, q); - return 1; + being->setAttribute(attr, value); + return 0; } -/** - * monster_get_name(int monster_id): string monster_name - * Returns the name of the monster with the given id. +/** being_get_modified_attribute (being) + * being_get_modified_attribute(handle being, int attribute_id) + ** + * *Return value:** Returns the double value of the being's + * ''modified attribute''. + * + * The modified attribute is equal to the base attribute + currently applied + * modifiers. + * + * To get to know how to configure and create modifiers, you can have a look at + * the [[attributes.xml]] file and at the [[#being_apply_attribute_modifier]]() + * and [[#being_remove_attribute_modifier]]() lua functions. + * + * Note also that items, equipment, and monsters attacks can cause attribute + * modifiers. + * + * FIXME: This functions about applying and removing modifiers are still WIP, + * because some simplifications and renaming could occur. */ -static int monster_get_name(lua_State *s) +static int being_get_modified_attribute(lua_State *s) { - const int id = luaL_checkint(s, 1); - MonsterClass *spec = monsterManager->getMonster(id); - if (!spec) - { - luaL_error(s, "monster_get_name called with unknown monster id."); - return 0; - } - push(s, spec->getName()); + Being *being = checkBeing(s, 1); + int attr = luaL_checkint(s, 2); + luaL_argcheck(s, attr > 0, 2, "invalid attribute id"); + + lua_pushinteger(s, being->getModifiedAttribute(attr)); return 1; } -/** - * monster_get_id(handle monster): int monsterid - * Returns the id of the monster handle +/** LUA being_apply_attribute_modifier (being) + * being_apply_attribute_modifier(handle being, int attribute_id, double value, + * unsigned int layer, [unsigned short duration, + * [unsigned int effect_id]]) + ** + * **Parameters description:** \\ + * * **value** (double): The modifier value (can be negative). + * * **layer** (unsigned int): The layer or level of the modifier. + * As modifiers are stacked on an attribute, the layer determines + * where the modifier will be inserted. Also, when adding a modifier, + * all the modifiers with an higher ayer value will also be recalculated. + * * **duration** (unsigned short): The modifier duration in ticks((A tick is + * equal to 100ms.)). If set to 0, the modifier is permanent. + * * **effect_id** (unsigned int): Set and keep that parameter when you want + * to retrieve the exact layer later. (FIXME: Check this.) */ -static int monster_get_id(lua_State *s) +static int being_apply_attribute_modifier(lua_State *s) { - Monster *monster = checkMonster(s, 1); - lua_pushinteger(s, monster->getSpecy()->getId()); - return 1; + Being *being = checkBeing(s, 1); + int attr = luaL_checkint(s,2); + double value = luaL_checknumber(s, 3); + int layer = luaL_checkint(s, 4); + int duration = luaL_optint(s, 5, 0); + int effectId = luaL_optint(s, 6, 0); + + being->applyModifier(attr, value, layer, duration, effectId); + return 0; } -/** - * monster_change_anger(Monster*, Being*, int anger) - * Makes a monster angry at a being +/** LUA being_remove_attribute_modifier (being) + * being_remove_attribute_modifier(handle being, int attribute_id, + * double value, unsigned int layer) + ** + * Permits to remove an attribute modifier by giving its value and its layer. */ -static int monster_change_anger(lua_State *s) +static int being_remove_attribute_modifier(lua_State *s) { - Monster *monster = checkMonster(s, 1); - Being *being = checkBeing(s, 2); - const int anger = luaL_checkint(s, 3); - monster->changeAnger(being, anger); + Being *being = checkBeing(s, 1); + int attr = luaL_checkint(s, 2); + double value = luaL_checknumber(s, 3); + int layer = luaL_checkint(s, 4); + int effectId = luaL_optint(s, 5, 0); + + being->removeModifier(attr, value, layer, effectId); return 0; } -static int monster_drop_anger(lua_State *s) +/** LUA being_get_gender (being) + * being_get_gender(handle being) + ** + * **Return value:** The gender of the being. These gender constants are + * defined in libmana-constants.lua: + * + * | 0 | GENDER_MALE | + * | 1 | GENDER_FEMALE | + * | 2 | GENDER_UNSPECIFIED | + */ +static int being_get_gender(lua_State *s) { - Monster *monster = checkMonster(s, 1); - Being *being = checkBeing(s, 2); - monster->forgetTarget(being); - return 0; + Being *b = checkBeing(s, 1); + lua_pushinteger(s, b->getGender()); + return 1; } -static int monster_get_angerlist(lua_State *s) +/** LUA being_set_gender (being) + * being_set_gender(handle being, int gender) + ** + * Sets the gender of a ''being''. + * + * The gender constants are defined in libmana-constants.lua: + * + * | 0 | GENDER_MALE | + * | 1 | GENDER_FEMALE | + * | 2 | GENDER_UNSPECIFIED | + */ +static int being_set_gender(lua_State *s) { - Monster *monster = checkMonster(s, 1); - pushSTLContainer(s, monster->getAngerList()); - return 1; + Being *b = checkBeing(s, 1); + const int gender = luaL_checkinteger(s, 2); + b->setGender(getGender(gender)); + return 0; } -/** - * monster_remove(Monster*): bool success - * Remove a monster object without kill event. - * return whether the monster was enqueued for removal. +/** LUA chr_get_level (being) + * chr_get_level(handle character) + * chr_get_level(handle character, int skill_id) + * chr_get_level(handle character, string skill_name) + ** + * **Return value:** Returns the level of the ''character''. If a skill is + * passed (either by name or id) the level of this skill is returned. + * + * **Note:** If the skill is provided as string (''skill_name'') you have to + * use this format: <setname>_<skillname>. So for example: "Weapons_Unarmed". */ -static int monster_remove(lua_State *s) +static int chr_get_level(lua_State *s) { - bool monsterRemoved = false; - if (Monster *m = getMonster(s, 1)) + Character *ch = checkCharacter(s, 1); + if (lua_gettop(s) > 1) { - GameState::remove(m); - monsterRemoved = true; + int skillId = checkSkill(s, 2); + lua_pushinteger(s, ch->levelForExp(ch->getExperience(skillId))); + } + else + { + lua_pushinteger(s, ch->getLevel()); } - lua_pushboolean(s, monsterRemoved); return 1; } -/** - * chr_get_quest(Character*, string): string - * Callback for getting a quest variable. Starts a recovery and returns - * immediatly, if the variable is not known yet. +/** LUA chr_get_exp (being) + * chr_get_exp(handle character, int skill) + * chr_get_exp(handle character, int skill) + ** + * **Return value:** The total experience collected by ''character'' in skill ''skill''. + * + * If the skill is provided as string (''skillname'') you have to use this + * format: <setname>_<skillname>. So for example: "Weapons_Unarmed". */ -static int chr_get_quest(lua_State *s) +static int chr_get_exp(lua_State *s) { - Character *q = checkCharacter(s, 1); - const char *name = luaL_checkstring(s, 2); - luaL_argcheck(s, name[0] != 0, 2, "empty variable name"); - - Script::Thread *thread = checkCurrentThread(s); - - std::string value; - bool res = getQuestVar(q, name, value); - if (res) - { - push(s, value); - return 1; - } - QuestCallback *f = new QuestThreadCallback(&LuaScript::getQuestCallback, - getScript(s)); - recoverQuestVar(q, name, f); + Character *c = checkCharacter(s, 1); + int skill = checkSkill(s, 2); + const int exp = c->getExperience(skill); - thread->mState = Script::ThreadExpectingString; - return lua_yield(s, 0); + lua_pushinteger(s, exp); + return 1; } -/** - * chr_request_quest(Character*, string, Ref function) - * Requests the questvar from the account server. This will make it available in - * the quest cache after some time. The passwed function will be called back as - * soon the quest var is available. +/** LUA chr_give_exp (being) + * chr_give_exp(handle character, int skill, int amount [, int optimalLevel]) + * chr_give_exp(handle character, string skillname, int amount [, int optimalLevel]) + ** + * Gives ''character'' ''amount'' experience in skill ''skill''. When an + * optimal level is set (over 0), the experience is reduced when the characters + * skill level is beyond this. If the skill is provided as string + * (''skillname'') you have to use this format: <setname>_<skillname>. + * So for example: "Weapons_Unarmed". */ -static int chr_request_quest(lua_State *s) +static int chr_give_exp(lua_State *s) { - Character *ch = checkCharacter(s, 1); - const char *name = luaL_checkstring(s, 2); - luaL_argcheck(s, name[0] != 0, 2, "empty variable name"); - luaL_checktype(s, 3, LUA_TFUNCTION); - - std::string value; - bool res = getQuestVar(ch, name, value); - if (res) - { - // Already cached, call passed callback immediately - Script *script = getScript(s); - Script::Ref callback; - script->assignCallback(callback); - - script->prepare(callback); - script->push(ch); - script->push(name); - script->push(value); - script->execute(ch->getMap()); - return 0; - } - - QuestCallback *f = new QuestRefCallback(getScript(s), name); - recoverQuestVar(ch, name, f); + Character *c = checkCharacter(s, 1); + int skill = checkSkill(s, 2); + const int exp = luaL_checkint(s, 3); + const int optimalLevel = luaL_optint(s, 4, 0); + c->receiveExperience(skill, exp, optimalLevel); return 0; } -/** - * chr_try_get_quest(Character*, string): nil or string - * Callback for checking if a quest variable is available in cache. It will - * return the variable if it is or nil if it is not in cache. +/** LUA exp_for_level (being) + * exp_for_level(int level) + ** + * **Return value:** Returns the total experience necessary (counted from + * level 0) for reaching ''level'' in any skill. */ -static int chr_try_get_quest(lua_State *s) +static int exp_for_level(lua_State *s) { - Character *q = checkCharacter(s, 1); - const char *name = luaL_checkstring(s, 2); - luaL_argcheck(s, name[0] != 0, 2, "empty variable name"); - - std::string value; - bool res = getQuestVar(q, name, value); - if (res) - push(s, value); - else - lua_pushnil(s); + const int level = luaL_checkint(s, 1); + lua_pushinteger(s, Character::expForLevel(level)); return 1; } -/** - * getvar_map(string): string - * Gets the value of a persistent map variable. +/** LUA chr_get_hair_color (being) + * chr_get_hair_color(handle character) + ** + * **Return value:** The hair color ID of ''character'' */ -static int getvar_map(lua_State *s) +static int chr_get_hair_color(lua_State *s) { - const char *name = luaL_checkstring(s, 1); - luaL_argcheck(s, name[0] != 0, 1, "empty variable name"); - - MapComposite *map = checkCurrentMap(s); + Character *c = checkCharacter(s, 1); - push(s, map->getVariable(name)); + lua_pushinteger(s, c->getHairColor()); return 1; } -/** - * setvar_map(string, string): void - * Sets the value of a persistent map variable. +/** LUA chr_set_hair_color (being) + * chr_set_hair_color(handle character, int color) + ** + * Sets the hair color ID of ''character'' to ''color'' */ -static int setvar_map(lua_State *s) +static int chr_set_hair_color(lua_State *s) { - const char *name = luaL_checkstring(s, 1); - const char *value = luaL_checkstring(s, 2); - luaL_argcheck(s, name[0] != 0, 1, "empty variable name"); + Character *c = checkCharacter(s, 1); + const int color = luaL_checkint(s, 2); + luaL_argcheck(s, color >= 0, 2, "invalid color id"); - MapComposite *map = checkCurrentMap(s); - map->setVariable(name, value); + c->setHairColor(color); + c->raiseUpdateFlags(UPDATEFLAG_LOOKSCHANGE); return 0; } -/** - * getvar_world(string): string - * Gets the value of a persistent global variable. +/** LUA chr_get_hair_style (being) + * chr_get_hair_style(handle character) + ** + * **Return value:** The hair style ID of ''character'' */ -static int getvar_world(lua_State *s) +static int chr_get_hair_style(lua_State *s) { - const char *name = luaL_checkstring(s, 1); - luaL_argcheck(s, name[0] != 0, 1, "empty variable name"); + Character *c = checkCharacter(s, 1); - push(s, GameState::getVariable(name)); + lua_pushinteger(s, c->getHairStyle()); return 1; } -/** - * setvar_world(string, string): void - * Sets the value of a persistent global variable. +/** LUA chr_set_hair_style (being) + * chr_set_hair_style(handle character, int style) + ** + * Sets the hair style ID of ''character'' to ''style'' */ -static int setvar_world(lua_State *s) +static int chr_set_hair_style(lua_State *s) { - const char *name = luaL_checkstring(s, 1); - const char *value = luaL_checkstring(s, 2); - luaL_argcheck(s, name[0] != 0, 1, "empty variable name"); + Character *c = checkCharacter(s, 1); + const int style = luaL_checkint(s, 2); + luaL_argcheck(s, style >= 0, 2, "invalid style id"); - GameState::setVariable(name, value); + c->setHairStyle(style); + c->raiseUpdateFlags(UPDATEFLAG_LOOKSCHANGE); return 0; } -/** - * chr_set_quest(Character*, string, string): void - * Callback for setting a quest variable. +/** LUA chr_get_kill_count (being) + * chr_get_kill_count(handle character, int monsterId) + * chr_get_kill_count(handle character, string monsterName) + * chr_get_kill_count(handle character, MonsterClass monsterClass) + ** + * **Return value:** The total number of monsters of the specy (passed either + * as monster id, monster name or monster class) the ''character'' has killed + * during its career. */ -static int chr_set_quest(lua_State *s) +static int chr_get_kill_count(lua_State *s) { - Character *q = checkCharacter(s, 1); - const char *name = luaL_checkstring(s, 2); - const char *value = luaL_checkstring(s, 3); - luaL_argcheck(s, name[0] != 0, 2, "empty variable name"); + Character *c = checkCharacter(s, 1); + MonsterClass *monster = checkMonsterClass(s, 2); - setQuestVar(q, name, value); - return 0; + lua_pushinteger(s, c->getKillCount(monster->getId())); + return 1; } -/** - * trigger_create(int x, int y, int width, int height, function, int id, - * boolean once) - * Creates a trigger area. Whenever an actor enters this area, the given Lua - * function is called. +/** LUA chr_get_rights (being) + * chr_get_rights(handle character) + ** + * **Return value:** The access level of the account of character. */ -static int trigger_create(lua_State *s) +static int chr_get_rights(lua_State *s) { - const int x = luaL_checkint(s, 1); - const int y = luaL_checkint(s, 2); - const int width = luaL_checkint(s, 3); - const int height = luaL_checkint(s, 4); - luaL_checktype(s, 5, LUA_TFUNCTION); - const int id = luaL_checkint(s, 6); - - if (!lua_isboolean(s, 7)) - { - luaL_error(s, "trigger_create called with incorrect parameters."); - return 0; - } - - Script *script = getScript(s); - MapComposite *m = checkCurrentMap(s, script); - - const bool once = lua_toboolean(s, 7); - - Script::Ref function; - lua_pushvalue(s, 5); - script->assignCallback(function); - lua_pop(s, 1); - - ScriptAction *action = new ScriptAction(script, function, id); - Rectangle r = { x, y, width, height }; - TriggerArea *area = new TriggerArea(m, r, action, once); - - LOG_INFO("Created script trigger at " << x << "," << y - << " (" << width << "x" << height << ") id: " << id); - - bool ret = GameState::insert(area); - lua_pushboolean(s, ret); + Character *c = checkCharacter(s, 1); + lua_pushinteger(s, c->getAccountLevel()); return 1; } -/** - * private message: chat_message(Being* recipent, string message): void - * Creates a chat message in the users chatlog(s). +/** LUA chr_kick (being) + * chr_kick(handle character) + ** + * Kicks the character. */ -static int chat_message(lua_State *s) +static int chr_kick(lua_State *s) { - Being *being = checkBeing(s, 1); - const char *message = luaL_checkstring(s, 2); - - GameState::sayTo(being, NULL, message); + Character *ch = checkCharacter(s, 1); + MessageOut kickmsg(GPMSG_CONNECT_RESPONSE); + kickmsg.writeInt8(ERRMSG_ADMINISTRATIVE_LOGOFF); + ch->getClient()->disconnect(kickmsg); return 0; } -/** - * get_beings_in_circle(int x, int y, int radius): table of Being* - * get_beings_in_circle(handle centerBeing, int radius): table of Being* - * Gets a LUA table with the Being* pointers of all beings - * inside of a circular area of the current map. +/** LUA being_get_mapid (being) + * being_get_mapid(handle Being) + ** + * **Return value:** the id of the map where the being is located + * or nil if there is none. */ -static int get_beings_in_circle(lua_State *s) +static int being_get_mapid(lua_State *s) { - int x, y, r; - if (lua_islightuserdata(s, 1)) - { - Being *b = checkBeing(s, 1); - const Point &pos = b->getPosition(); - x = pos.x; - y = pos.y; - r = luaL_checkint(s, 2); - } + Being *being = checkBeing(s, 1); + if (MapComposite *map = being->getMap()) + lua_pushinteger(s, map->getID()); else - { - x = luaL_checkint(s, 1); - y = luaL_checkint(s, 2); - r = luaL_checkint(s, 3); - } + lua_pushnil(s); - MapComposite *m = checkCurrentMap(s); + return 1; +} - //create a lua table with the beings in the given area. - lua_newtable(s); - int tableStackPosition = lua_gettop(s); - int tableIndex = 1; - for (BeingIterator i(m->getAroundPointIterator(Point(x, y), r)); i; ++i) +/** LUA chr_request_quest (being) + * chr_request_quest(handle character, string questvariable, Ref function) + ** + * Requests the questvar from the account server. This will make it available in + * the quest cache after some time. The passed function will be called back as + * soon the quest var is available. + */ +static int chr_request_quest(lua_State *s) +{ + Character *ch = checkCharacter(s, 1); + const char *name = luaL_checkstring(s, 2); + luaL_argcheck(s, name[0] != 0, 2, "empty variable name"); + luaL_checktype(s, 3, LUA_TFUNCTION); + + std::string value; + bool res = getQuestVar(ch, name, value); + if (res) { - Being *b = *i; - char t = b->getType(); - if (t == OBJECT_NPC || t == OBJECT_CHARACTER || t == OBJECT_MONSTER) - { - if (Collision::circleWithCircle(b->getPosition(), b->getSize(), - Point(x, y), r)) - { - lua_pushlightuserdata(s, b); - lua_rawseti(s, tableStackPosition, tableIndex); - tableIndex++; - } - } + // Already cached, call passed callback immediately + Script *script = getScript(s); + Script::Ref callback; + script->assignCallback(callback); + + script->prepare(callback); + script->push(ch); + script->push(name); + script->push(value); + script->execute(ch->getMap()); + + return 0; } - return 1; + QuestCallback *f = new QuestRefCallback(getScript(s), name); + recoverQuestVar(ch, name, f); + + return 0; } -/** - * get_beings_in_rectangle(int x, int y, int width, int height): table of Being* - * Gets a LUA table with the Being* pointers of all beings - * inside of a rectangular area of the current map. +/** LUA chr_try_get_quest (being) + * chr_try_get_quest(handle character, string questvariable) + ** + * Callback for checking if a quest variable is available in cache. + * + * **Return value:** It will return the variable if it is or nil + * if it is not in cache. */ -static int get_beings_in_rectangle(lua_State *s) +static int chr_try_get_quest(lua_State *s) { - const int x = luaL_checkint(s, 1); - const int y = luaL_checkint(s, 2); - const int w = luaL_checkint(s, 3); - const int h = luaL_checkint(s, 4); - - MapComposite *m = checkCurrentMap(s); + Character *q = checkCharacter(s, 1); + const char *name = luaL_checkstring(s, 2); + luaL_argcheck(s, name[0] != 0, 2, "empty variable name"); - //create a lua table with the beings in the given area. - lua_newtable(s); - int tableStackPosition = lua_gettop(s); - int tableIndex = 1; - Rectangle rect = {x, y ,w, h}; - for (BeingIterator i(m->getInsideRectangleIterator(rect)); i; ++i) - { - Being *b = *i; - char t = b->getType(); - if ((t == OBJECT_NPC || t == OBJECT_CHARACTER || t == OBJECT_MONSTER) && - rect.contains(b->getPosition())) - { - lua_pushlightuserdata(s, b); - lua_rawseti(s, tableStackPosition, tableIndex); - tableIndex++; - } - } - return 1; - } + std::string value; + bool res = getQuestVar(q, name, value); + if (res) + push(s, value); + else + lua_pushnil(s); + return 1; +} -/** - * get_character_by_name(string name): Character* - * Returns the character handle or NULL if there is none +/** LUA get_character_by_name (being) + * get_character_by_name(string name) + ** + * Tries to find an online character by name. + * + * **Return value** the character handle or nil if there is none */ static int get_character_by_name(lua_State *s) { @@ -1701,8 +2093,9 @@ static int get_character_by_name(lua_State *s) return 1; } -/** - * chr_get_post(Character*): void +/** LUA chr_get_post (being) + * chr_get_post(handle character) + ** * Gets the post for the character. */ static int chr_get_post(lua_State *s) @@ -1719,10 +2112,14 @@ static int chr_get_post(lua_State *s) return lua_yield(s, 0); } -/** - * being_register(Being*): void +/** LUA being_register (being) + * being_register(handle being) + ** * Makes the server call the on_being_death and on_being_remove callbacks * when the being dies or is removed from the map. + * + * **Note:** You should never need to call this in most situations. It is + * handeled by the libmana.lua */ static int being_register(lua_State *s) { @@ -1735,35 +2132,9 @@ static int being_register(lua_State *s) return 0; } -/** - * effect_create (int id, int x, int y): void - * effect_create (int id, Being*): void - * Triggers a special effect from the clients effects.xml. - */ -static int effect_create(lua_State *s) -{ - const int id = luaL_checkint(s, 1); - - if (lua_isuserdata(s, 2)) - { - // being mode - Being *b = checkBeing(s, 2); - Effects::show(id, b->getMap(), b); - } - else - { - // positional mode - int x = luaL_checkint(s, 2); - int y = luaL_checkint(s, 3); - MapComposite *m = checkCurrentMap(s); - Effects::show(id, m, Point(x, y)); - } - - return 0; -} - -/** - * chr_shake_screen(Character*, int x, int y[, float strength, int radius]): void +/** LUA chr_shake_screen (being) + * chr_shake_screen(handle character, int x, int y[, float strength, int radius]) + ** * Shake the screen for a given character. */ static int chr_shake_screen(lua_State *s) @@ -1786,6 +2157,12 @@ static int chr_shake_screen(lua_State *s) return 0; } +/** LUA chr_create_text_particle (being) + * chr_create_text_particle(handle character, string text) + ** + * Creates a text particle on a client. This effect is only visible for the + * ''character''. + */ static int chr_create_text_particle(lua_State *s) { Character *c = checkCharacter(s, 1); @@ -1798,329 +2175,196 @@ static int chr_create_text_particle(lua_State *s) return 0; } - -/** - * chr_get_exp(Character*, int skill): int - * chr_get_exp(Character*, string skillname): int - * Gets the exp total in a skill of a specific character. - * If called with skillname this name has to be in this format: - * "<setname>_<skillname>" - */ -static int chr_get_exp(lua_State *s) -{ - Character *c = checkCharacter(s, 1); - int skill = checkSkill(s, 2); - const int exp = c->getExperience(skill); - - lua_pushinteger(s, exp); - return 1; -} - -/** - * chr_give_exp(Character*, int skill, int amount[, int optimal_level]): void - * chr_give_exp(Character*, string skillname, int amount - * [, int optimal_level]): void - * Gives the character a certain amount of experience points - * in a skill. Can also be used to reduce the exp amount when - * desired. If called with skillname this name has to be in this format: - * "<setname>_<skillname>" - */ -static int chr_give_exp(lua_State *s) -{ - Character *c = checkCharacter(s, 1); - int skill = checkSkill(s, 2); - const int exp = luaL_checkint(s, 3); - const int optimalLevel = luaL_optint(s, 4, 0); - - c->receiveExperience(skill, exp, optimalLevel); - return 0; -} - -/** - * chr_set_hair_style(Character*, int style_id): void - * Sets the given character's hair style to the given style id. +/** LUA chr_give_special (being) + * chr_give_special(handle character, int special) + ** + * Enables a special for a character. */ -static int chr_set_hair_style(lua_State *s) +static int chr_give_special(lua_State *s) { + // cost_type is ignored until we have more than one cost type Character *c = checkCharacter(s, 1); - const int style = luaL_checkint(s, 2); - luaL_argcheck(s, style >= 0, 2, "invalid style id"); + const int special = checkSpecial(s, 2); + const int currentMana = luaL_optint(s, 3, 0); - c->setHairStyle(style); - c->raiseUpdateFlags(UPDATEFLAG_LOOKSCHANGE); + c->giveSpecial(special, currentMana); return 0; } -/** - * chr_get_hair_style(Character*): int hair_style - * Gets the hair style of the given character. +/** LUA chr_has_special (being) + * chr_has_special(handle character, int special) + ** + * **Return value:** True if the ''character'' has the special. False otherwise */ -static int chr_get_hair_style(lua_State *s) +static int chr_has_special(lua_State *s) { Character *c = checkCharacter(s, 1); + const int special = luaL_checkint(s, 2); - lua_pushinteger(s, c->getHairStyle()); + lua_pushboolean(s, c->hasSpecial(special)); return 1; } -/** - * chr_set_hair_color(Character*, int color_id): void - * Set the hair color of the given character to the given color id. - */ -static int chr_set_hair_color(lua_State *s) -{ - Character *c = checkCharacter(s, 1); - const int color = luaL_checkint(s, 2); - luaL_argcheck(s, color >= 0, 2, "invalid color id"); - - c->setHairColor(color); - c->raiseUpdateFlags(UPDATEFLAG_LOOKSCHANGE); - - return 0; -} - -/** - * chr_get_hair_color(Character*): int hair_color - * Get the hair color of the given character. +/** LUA chr_take_special (being) + * chr_take_special(handle character, int special) + ** + * Removes a special from a character. + * + * **Return value:** True if removal was successful. False otherwise + * (in case the ''character'' did not have the special) */ -static int chr_get_hair_color(lua_State *s) +static int chr_take_special(lua_State *s) { Character *c = checkCharacter(s, 1); + const int special = luaL_checkint(s, 2); - lua_pushinteger(s, c->getHairColor()); + lua_pushboolean(s, c->hasSpecial(special)); + c->takeSpecial(special); return 1; } -/** - * chr_get_kill_count(Character*, int monster_type): int - * Get the number of monsters the player killed of a type. - */ -static int chr_get_kill_count(lua_State *s) -{ - Character *c = checkCharacter(s, 1); - MonsterClass *monster = checkMonsterClass(s, 2); - lua_pushinteger(s, c->getKillCount(monster->getId())); - return 1; -} +/** LUA_CATEGORY Monster (monster) + */ -/** - * being_get_gender(Being*): int - * Get the gender of the being. +/** LUA monster_get_id (monster) + * monster_get_id(handle monster) + ** + * **Return value:** The id of the specy of the monster handle. */ -static int being_get_gender(lua_State *s) +static int monster_get_id(lua_State *s) { - Being *b = checkBeing(s, 1); - lua_pushinteger(s, b->getGender()); + Monster *monster = checkMonster(s, 1); + lua_pushinteger(s, monster->getSpecy()->getId()); return 1; } -/** - * being_set_gender(Being*, int gender): void - * Set the gender of the being. +/** LUA monster_change_anger (monster) + * monster_change_anger(handle monster, handle being, int anger) + ** + * Makes the ''monster'' more angry about the ''being'' by adding ''anger'' to + * the being. */ -static int being_set_gender(lua_State *s) +static int monster_change_anger(lua_State *s) { - Being *b = checkBeing(s, 1); - const int gender = luaL_checkinteger(s, 2); - b->setGender(getGender(gender)); + Monster *monster = checkMonster(s, 1); + Being *being = checkBeing(s, 2); + const int anger = luaL_checkint(s, 3); + monster->changeAnger(being, anger); return 0; } -/** - * chr_give_special(Character*, int special): void - * Enables a special for a character. +/** LUA monster_drop_anger (monster) + * monster_drop_anger(handle monster, handle target) + ** + * Will drop all anger against the ''target''. */ -static int chr_give_special(lua_State *s) +static int monster_drop_anger(lua_State *s) { - // cost_type is ignored until we have more than one cost type - Character *c = checkCharacter(s, 1); - const int special = checkSpecial(s, 2); - const int currentMana = luaL_optint(s, 3, 0); - - c->giveSpecial(special, currentMana); + Monster *monster = checkMonster(s, 1); + Being *being = checkBeing(s, 2); + monster->forgetTarget(being); return 0; } -/** - * chr_has_special(Character*, int special): bool - * Checks whether a character has a given special. +/** LUA monster_get_angerlist (monster) + * monster_get_angerlist(handle monster) + ** + * **Return value:** A table with the beings as key and the anger against them + * as values. */ -static int chr_has_special(lua_State *s) +static int monster_get_angerlist(lua_State *s) { - Character *c = checkCharacter(s, 1); - const int special = luaL_checkint(s, 2); - - lua_pushboolean(s, c->hasSpecial(special)); + Monster *monster = checkMonster(s, 1); + pushSTLContainer(s, monster->getAngerList()); return 1; } -/** - * chr_take_special(Character*, int special): bool success - * Removes a special from a character. - */ -static int chr_take_special(lua_State *s) -{ - Character *c = checkCharacter(s, 1); - const int special = luaL_checkint(s, 2); - lua_pushboolean(s, c->hasSpecial(special)); - c->takeSpecial(special); - return 1; -} +/** LUA_CATEGORY Status effects (statuseffects) + */ -/** - * chr_set_special_recharge_speed(Character*, int special, int speed) - * Sets recharge speed for a special. +/** LUA being_apply_status (statuseffects) + * being_apply_status(handle Being, int status_id, int time) + ** + * Gives a ''being'' a status effect ''status_id'', status effects don't work + * on NPCs. ''time'' is in game ticks. */ -static int chr_set_special_recharge_speed(lua_State *s) +static int being_apply_status(lua_State *s) { - Character *c = checkCharacter(s, 1); - const int special = checkSpecial(s, 2); - const int speed = luaL_checkint(s, 3); + Being *being = checkBeing(s, 1); + const int id = luaL_checkint(s, 2); + const int time = luaL_checkint(s, 3); - if (!c->setSpecialRechargeSpeed(special, speed)) - { - luaL_error(s, - "chr_set_special_recharge_speed called with special " - "that is not owned by character."); - } + being->applyStatusEffect(id, time); return 0; } -/** - * chr_get_special_recharge_speed(Character*, int special) - * Gets recharge speed of a special. +/** LUA being_remove_status (statuseffects) + * being_remove_status(handle Being, int status_id) + ** + * Removes a given status effect from a being. */ -static int chr_get_special_recharge_speed(lua_State *s) +static int being_remove_status(lua_State *s) { - Character *c = checkCharacter(s, 1); - const int special = checkSpecial(s, 2); - - SpecialMap::iterator it = c->findSpecial(special); - - luaL_argcheck(s, it != c->getSpecialEnd(), 2, - "character does not have special"); - - lua_pushinteger(s, it->second.rechargeSpeed); - return 1; -} + Being *being = checkBeing(s, 1); + const int id = luaL_checkint(s, 2); -/** - * chr_set_special_mana(Character*, int special, int mana) - * Sets the current charge of the special. - */ -static int chr_set_special_mana(lua_State *s) -{ - Character *c = checkCharacter(s, 1); - const int special = checkSpecial(s, 2); - const int mana = luaL_checkint(s, 3); - if (!c->setSpecialMana(special, mana)) - { - luaL_error(s, - "chr_set_special_mana called with special " - "that is not owned by character."); - } + being->removeStatusEffect(id); return 0; } -/** - * chr_get_special_mana(Character*, int special): int - * Gets the current charge of a special. +/** LUA being_has_status (statuseffects) + * being_has_status(handle Being, int status_id) + ** + * **Return value:** Bool if the being has a given status effect. */ -static int chr_get_special_mana(lua_State *s) +static int being_has_status(lua_State *s) { - Character *c = checkCharacter(s, 1); - const int special = checkSpecial(s, 2); - SpecialMap::iterator it = c->findSpecial(special); - luaL_argcheck(s, it != c->getSpecialEnd(), 2, - "character does not have special"); - lua_pushinteger(s, it->second.currentMana); - return 1; -} + Being *being = checkBeing(s, 1); + const int id = luaL_checkint(s, 2); -/** - * chr_get_rights(Character*): int - * Returns the rights level of a character. - */ -static int chr_get_rights(lua_State *s) -{ - Character *c = checkCharacter(s, 1); - lua_pushinteger(s, c->getAccountLevel()); + lua_pushboolean(s, being->hasStatusEffect(id)); return 1; } -/** - * exp_for_level(int level): int - * Returns the exp total necessary to reach a specific skill level. +/** LUA being_get_status_time (statuseffects) + * being_get_status_time(handle Being, int status_id) + ** + * **Return Value:** Number of ticks remaining on a status effect. */ -static int exp_for_level(lua_State *s) +static int being_get_status_time(lua_State *s) { - const int level = luaL_checkint(s, 1); - lua_pushinteger(s, Character::expForLevel(level)); + Being *being = checkBeing(s, 1); + const int id = luaL_checkint(s, 2); + + lua_pushinteger(s, being->getStatusEffectTime(id)); return 1; } -/** - * Returns four useless tables for testing the STL container push wrappers. - * This function can be removed when there are more useful functions which use - * them. +/** LUA being_set_status_time (statuseffects) + * being_set_status_time(handle Being, int status_id, int time) + ** + * Sets the time on a status effect a target being already has. */ -static int test_tableget(lua_State *s) +static int being_set_status_time(lua_State *s) { + Being *being = checkBeing(s, 1); + const int id = luaL_checkint(s, 2); + const int time = luaL_checkint(s, 3); - std::list<float> list; - std::vector<std::string> svector; - std::vector<int> ivector; - std::map<std::string, std::string> map; - std::set<int> set; - - LOG_INFO("Pushing Float List"); - list.push_back(12.636); - list.push_back(0.0000000045656); - list.push_back(185645445634566.346); - list.push_back(7835458.11); - pushSTLContainer<float>(s, list); - - LOG_INFO("Pushing String Vector"); - svector.push_back("All"); - svector.push_back("your"); - svector.push_back("base"); - svector.push_back("are"); - svector.push_back("belong"); - svector.push_back("to"); - svector.push_back("us!"); - pushSTLContainer<std::string>(s, svector); - - LOG_INFO("Pushing Integer Vector"); - ivector.resize(10); - for (int i = 1; i < 10; i++) - { - ivector[i-1] = i * i; - } - pushSTLContainer<int>(s, ivector); - - LOG_INFO("Pushing String/String Map"); - map["Apple"] = "red"; - map["Banana"] = "yellow"; - map["Lime"] = "green"; - map["Plum"] = "blue"; - pushSTLContainer<std::string, std::string>(s, map); - - LOG_INFO("Pushing Integer Set"); - set.insert(12); - set.insert(8); - set.insert(14); - set.insert(10); - pushSTLContainer<int>(s, set); + being->setStatusEffectTime(id, time); + return 0; +} - return 5; -} +/** LUA_CATEGORY Map information (mapinformation) + */ -/** - * get_map_id(): int - * Returns the id of the current map. +/** LUA get_map_id (mapinformation) + * get_map_id() + ** + * **Return value:** The ID number of the map the script runs on. */ static int get_map_id(lua_State *s) { @@ -2134,9 +2378,11 @@ static int get_map_id(lua_State *s) return 1; } -/** - * get_map_property(string property): string - * Returns the value of a map property. +/** LUA get_map_property (mapinformation) + * get_map_property(string key) + ** + * **Return value:** The value of the property ''key'' of the current map. The + * string is empty if the property ''key'' does not exist. */ static int get_map_property(lua_State *s) { @@ -2147,9 +2393,11 @@ static int get_map_property(lua_State *s) return 1; } -/** - * is_walkable(int x, int y): bool - * Returns whether the pixel on the map is walkable. +/** LUA is_walkable (mapinformation) + * is_walkable(int x, int y) + ** + * **Return value:** True if ''x'':''y'' is a walkable pixel + * on the current map. */ static int is_walkable(lua_State *s) { @@ -2166,6 +2414,16 @@ static int is_walkable(lua_State *s) return 1; } +/** LUA map_get_pvp (mapinformation) + * map_get_pvp() + ** + * **Return value:** The pvp situation of the map. + * + * There are constants for the different pvp situations in the libmana-constants.lua: + * + * | 0 | PVP_NONE | + * | 1 | PVP_FREE | + */ static int map_get_pvp(lua_State *s) { MapComposite *m = checkCurrentMap(s); @@ -2173,47 +2431,33 @@ static int map_get_pvp(lua_State *s) return 1; } -static int item_class_on(lua_State *s) -{ - ItemClass *itemClass = LuaItemClass::check(s, 1); - const char *event = luaL_checkstring(s, 2); - luaL_checktype(s, 3, LUA_TFUNCTION); - itemClass->setEventCallback(event, getScript(s)); - return 0; -} -static int item_class_attacks(lua_State *s) -{ - ItemClass *itemClass = LuaItemClass::check(s, 1); - std::vector<AttackInfo *> attacks = itemClass->getAttackInfos(); - pushSTLContainer<AttackInfo *>(s, attacks); - return 1; -} +/** LUA_CATEGORY General Information (information) + */ -/** - * drop_item(int x, int y, int id || string name[, int number]): bool - * Creates an item stack on the floor. +/** LUA monster_get_name (information) + * get_map_id() + ** + * **Return value:** The ID number of the map the script runs on. */ -static int item_drop(lua_State *s) +static int monster_get_name(lua_State *s) { - const int x = luaL_checkint(s, 1); - const int y = luaL_checkint(s, 2); - ItemClass *ic = checkItemClass(s, 3); - const int number = luaL_optint(s, 4, 1); - MapComposite *map = checkCurrentMap(s); - - Item *i = new Item(ic, number); - - i->setMap(map); - Point pos(x, y); - i->setPosition(pos); - GameState::enqueueInsert(i); - return 0; + const int id = luaL_checkint(s, 1); + MonsterClass *spec = monsterManager->getMonster(id); + if (!spec) + { + luaL_error(s, "monster_get_name called with unknown monster id."); + return 0; + } + push(s, spec->getName()); + return 1; } -/** - * item_get_name(int item_id): string item_name - * Returns the name of the item with the given id. +/** LUA item_get_name (information) + * get_map_property(string key) + ** + * **Return value:** The value of the property ''key'' of the current map. + * The string is empty if the property ''key'' does not exist. */ static int item_get_name(lua_State *s) { @@ -2228,9 +2472,134 @@ static int item_get_name(lua_State *s) return 1; } -/** - * log(int log_level, string log_message): void - * Logs the given message to the log. +/** LUA_CATEGORY Persistent variables (variables) + */ + +/** LUA on_mapvar_changed (variables) + * on_mapvar_changed(string key, function func) + ** + * Registers a callback to the key. This callback will be called with the key + * and value of the changed variable. + * + * **Example:** + * <code lua>on_mapvar_changed(key, function(key, value) + * log(LOG_DEBUG, "mapvar " .. key .. " has new value " .. value) + * end)</code> + */ +static int on_mapvar_changed(lua_State *s) +{ + const char *key = luaL_checkstring(s, 1); + luaL_checktype(s, 2, LUA_TFUNCTION); + luaL_argcheck(s, key[0] != 0, 2, "empty variable name"); + MapComposite *m = checkCurrentMap(s); + m->setMapVariableCallback(key, getScript(s)); + return 0; +} + +/** LUA on_worldvar_changed (variables) + * on_worldvar_changed(string key, function func) + ** + * Registers a callback to the key. This callback will be called with the key + * and value of the changed variable. + * + * **Example:** + * <code lua>on_worldvar_changed(key, function(key, value) + * log(LOG_DEBUG, "worldvar " .. key .. " has new value " .. value) + * end)</code> + */ +static int on_worldvar_changed(lua_State *s) +{ + const char *key = luaL_checkstring(s, 1); + luaL_checktype(s, 2, LUA_TFUNCTION); + luaL_argcheck(s, key[0] != 0, 2, "empty variable name"); + MapComposite *m = checkCurrentMap(s); + m->setWorldVariableCallback(key, getScript(s)); + return 0; +} + +/** LUA getvar_map (variables) + * getvar_map(string variablename) + ** + * **Return value:** the value of a persistent map variable. + * + * **See:** [[scripting#map|map[]]] for an easier way to get a map variable. + */ +static int getvar_map(lua_State *s) +{ + const char *name = luaL_checkstring(s, 1); + luaL_argcheck(s, name[0] != 0, 1, "empty variable name"); + + MapComposite *map = checkCurrentMap(s); + + push(s, map->getVariable(name)); + return 1; +} + +/** LUA setvar_map (variables) + * setvar_map(string variablename, string value) + ** + * Sets the value of a persistent map variable. + * + * **See:** [[scripting#map|map[]]] for an easier way to get a map variable. + */ +static int setvar_map(lua_State *s) +{ + const char *name = luaL_checkstring(s, 1); + const char *value = luaL_checkstring(s, 2); + luaL_argcheck(s, name[0] != 0, 1, "empty variable name"); + + MapComposite *map = checkCurrentMap(s); + map->setVariable(name, value); + + return 0; +} + +/** LUA getvar_world (variables) + * getvar_world(string variablename) + ** + * Gets the value of a persistent global variable. + * + * **See:** [[scripting#world|world[]]] for an easier way to get a map variable. + */ +static int getvar_world(lua_State *s) +{ + const char *name = luaL_checkstring(s, 1); + luaL_argcheck(s, name[0] != 0, 1, "empty variable name"); + + push(s, GameState::getVariable(name)); + return 1; +} + +/** LUA setvar_world (variables) + * setvar_world(string variablename, string value) + ** + * Sets the value of a persistent global variable. + * + * **See:** [[scripting#world|world[]]] for an easier way to get a map variable. + */ +static int setvar_world(lua_State *s) +{ + const char *name = luaL_checkstring(s, 1); + const char *value = luaL_checkstring(s, 2); + luaL_argcheck(s, name[0] != 0, 1, "empty variable name"); + + GameState::setVariable(name, value); + return 0; +} + + +/** LUA_CATEGORY Logging (logging) + */ + +/** LUA log (logging) + * log(int log_level, string message) + ** + * Log something at the specified log level. The available log levels are: + * | 0 | LOG_FATAL | + * | 1 | LOG_ERROR | + * | 2 | LOG_WARNING | + * | 3 | LOG_INFO | + * | 4 | LOG_DEBUG | */ static int log(lua_State *s) { @@ -2248,10 +2617,104 @@ static int log(lua_State *s) return 0; } -/** - * get_distance(Being*, Being*): int - * get_distance(int x1, int y1, int x2, int y2): int - * Gets the distance between two beings or two points. + +/** LUA_CATEGORY Area of Effect (area) + * In order to easily use area of effects in your items or in your scripts, + * the following functions are available: + */ + +/** LUA get_beings_in_circle (area) + * get_beings_in_circle(int x, int y, int radius) + * get_beings_in_circle(handle being, int radius) + ** + * **Return value:** This function returns a lua table of all beings in a + * circle of radius (in pixels) ''radius'' centered either at the pixel at + * (''x'', ''y'') or at the position of ''being''. + */ +static int get_beings_in_circle(lua_State *s) +{ + int x, y, r; + if (lua_islightuserdata(s, 1)) + { + Being *b = checkBeing(s, 1); + const Point &pos = b->getPosition(); + x = pos.x; + y = pos.y; + r = luaL_checkint(s, 2); + } + else + { + x = luaL_checkint(s, 1); + y = luaL_checkint(s, 2); + r = luaL_checkint(s, 3); + } + + MapComposite *m = checkCurrentMap(s); + + //create a lua table with the beings in the given area. + lua_newtable(s); + int tableStackPosition = lua_gettop(s); + int tableIndex = 1; + for (BeingIterator i(m->getAroundPointIterator(Point(x, y), r)); i; ++i) + { + Being *b = *i; + char t = b->getType(); + if (t == OBJECT_NPC || t == OBJECT_CHARACTER || t == OBJECT_MONSTER) + { + if (Collision::circleWithCircle(b->getPosition(), b->getSize(), + Point(x, y), r)) + { + lua_pushlightuserdata(s, b); + lua_rawseti(s, tableStackPosition, tableIndex); + tableIndex++; + } + } + } + + return 1; +} + +/** LUA get_beings_in_rectangle (area) + * get_beings_in_rectangle(int x, int y, int width, int height) + ** + * **Return value:** An table of being objects within the rectangle. + * All parameters have to be passed as pixels. + */ +static int get_beings_in_rectangle(lua_State *s) +{ + const int x = luaL_checkint(s, 1); + const int y = luaL_checkint(s, 2); + const int w = luaL_checkint(s, 3); + const int h = luaL_checkint(s, 4); + + MapComposite *m = checkCurrentMap(s); + + //create a lua table with the beings in the given area. + lua_newtable(s); + int tableStackPosition = lua_gettop(s); + int tableIndex = 1; + Rectangle rect = {x, y ,w, h}; + for (BeingIterator i(m->getInsideRectangleIterator(rect)); i; ++i) + { + Being *b = *i; + char t = b->getType(); + if ((t == OBJECT_NPC || t == OBJECT_CHARACTER || t == OBJECT_MONSTER) && + rect.contains(b->getPosition())) + { + lua_pushlightuserdata(s, b); + lua_rawseti(s, tableStackPosition, tableIndex); + tableIndex++; + } + } + return 1; + } + +/** LUA get_distance (area) + * get_distance(handle being1, handle being2) + * get_distance(int x1, int y1, int x2, int y2) + ** + * **Return value:** The distance between the two beings or the two points + * in pixels. */ static int get_distance(lua_State *s) { @@ -2281,180 +2744,254 @@ static int get_distance(lua_State *s) return 1; } -/** - * map_get_objects(): table of all objects - * map_get_objects(string type): table of all objects of type - * Gets the objects of a map. - */ -static int map_get_objects(lua_State *s) -{ - const bool filtered = (lua_gettop(s) == 1); - const char *filter; - if (filtered) - { - filter = luaL_checkstring(s, 1); - } - MapComposite *m = checkCurrentMap(s); - const std::vector<MapObject*> &objects = m->getMap()->getObjects(); - - if (!filtered) - pushSTLContainer<MapObject*>(s, objects); - else - { - std::vector<MapObject*> filteredObjects; - for (std::vector<MapObject*>::const_iterator it = objects.begin(); - it != objects.end(); ++it) - { - if (utils::compareStrI((*it)->getType(), filter) == 0) - { - filteredObjects.push_back(*it); - } - } - pushSTLContainer<MapObject*>(s, filteredObjects); - } - return 1; -} +/** LUA_CATEGORY Special info class (specialinfo) + * See the [[specials.xml#A script example|specials Documentation]] for a + * script example + */ -/** - * map_object_get_property(handle object, string key) - * Returns the value of the object property 'key'. +/** LUA get_special_info (specialinfo) + * get_special_info(int specialId) + * get_special_info(string specialName) + ** + * **Return value:** This function returns a object of the specialinfo class. + * See below for usage of that object. + * + * **Note:** When passing the ''specialName'' as parameter make sure that it is + * formatted in this way: <setname>_<specialname> (for eg. "Magic_Healingspell"). */ -static int map_object_get_property(lua_State *s) +static int get_special_info(lua_State *s) { - const char *key = luaL_checkstring(s, 2); - MapObject *obj = LuaMapObject::check(s, 1); - - std::string property = obj->getProperty(key); - if (!property.empty()) - { - push(s, property); - return 1; - } - else - { - // scripts can check for nil - return 0; - } + const int special = checkSpecial(s, 1); + SpecialManager::SpecialInfo *info = specialManager->getSpecialInfo(special); + luaL_argcheck(s, info, 1, "invalid special"); + LuaSpecialInfo::push(s, info); + return 1; } -/** - * map_object_get_bounds(object) - * Returns 4 int: x/y/width/height of object. +/** LUA specialinfo:name (specialinfo) + * specialinfo:name() + ** + * ** Return value:** The name of the specialinfo object. + * + * **Note:** See [[scripting#get_special_info|get_special_info]] for getting a + * specialinfo object. */ -static int map_object_get_bounds(lua_State *s) +static int specialinfo_get_name(lua_State *s) { - MapObject *obj = LuaMapObject::check(s, 1); - const Rectangle &bounds = obj->getBounds(); - lua_pushinteger(s, bounds.x); - lua_pushinteger(s, bounds.y); - lua_pushinteger(s, bounds.w); - lua_pushinteger(s, bounds.h); - return 4; + SpecialManager::SpecialInfo *info = LuaSpecialInfo::check(s, 1); + push(s, info->name); + return 1; } -/** - * map_object_get_name(object) - * Returns the name of the object. +/** LUA specialinfo:needed_mana (specialinfo) + * specialinfo:needed_mana() + ** + * ** Return value:** The mana that is needed to use the special + * + * **Note:** See [[scripting#get_special_info|get_special_info]] for getting a + * specialinfo object. */ -static int map_object_get_name(lua_State *s) +static int specialinfo_get_needed_mana(lua_State *s) { - MapObject *obj = LuaMapObject::check(s, 1); - push(s, obj->getName()); + SpecialManager::SpecialInfo *info = LuaSpecialInfo::check(s, 1); + lua_pushinteger(s, info->neededMana); return 1; } -/** - * map_object_get_type(object) - * Returns the type of the object. +/** LUA specialinfo:rechargeable (specialinfo) + * specialinfo:rechargeable() + ** + * ** Return value:** A boolean value that indicates whether the special is + * rechargeable or usuable without recharge. + * + * **Note:** See [[scripting#get_special_info|get_special_info]] for getting + * a specialinfo object. */ -static int map_object_get_type(lua_State *s) +static int specialinfo_is_rechargeable(lua_State *s) { - MapObject *obj = LuaMapObject::check(s, 1); - push(s, obj->getType()); + SpecialManager::SpecialInfo *info = LuaSpecialInfo::check(s, 1); + lua_pushboolean(s, info->rechargeable); return 1; } -static int status_effect_on_tick(lua_State *s) +/** LUA specialinfo:on_use (specialinfo) + * specialinfo:on_use(function callback) + ** + * Assigns the ''callback'' as callback for the use event. This function will + * be called everytime a character uses a special. + * + * **Note:** See [[scripting#get_special_info|get_special_info]] for getting + * a specialinfo object. + */ +static int specialinfo_on_use(lua_State *s) { - StatusEffect *statusEffect = LuaStatusEffect::check(s, 1); + SpecialManager::SpecialInfo *info = LuaSpecialInfo::check(s, 1); + Script *script = getScript(s); luaL_checktype(s, 2, LUA_TFUNCTION); - statusEffect->setTickCallback(getScript(s)); + script->assignCallback(info->useCallback); return 0; } -/** - * announce(text [, sender]) - * Does a global announce +/** LUA specialinfo:on_recharged (specialinfo) + * specialinfo:on_recharged(function callback) + ** + * Assigns the ''callback'' as callback for the recharged event. This function + * will be called everytime when the special is fully recharged. + * + * **Note:** See [[scripting#get_special_info|get_special_info]] for getting + * a specialinfo object. */ -static int announce(lua_State *s) +static int specialinfo_on_recharged(lua_State *s) { - const char *message = luaL_checkstring(s, 1); - const char *sender = luaL_optstring(s, 2, "Server"); - - MessageOut msg(GAMSG_ANNOUNCE); - msg.writeString(message); - msg.writeInt16(0); // Announce from server so id = 0 - msg.writeString(sender); - accountHandler->send(msg); + SpecialManager::SpecialInfo *info = LuaSpecialInfo::check(s, 1); + Script *script = getScript(s); + luaL_checktype(s, 2, LUA_TFUNCTION); + script->assignCallback(info->rechargedCallback); return 0; } -static int get_special_info(lua_State *s) -{ - const int special = checkSpecial(s, 1); - SpecialManager::SpecialInfo *info = specialManager->getSpecialInfo(special); - luaL_argcheck(s, info, 1, "invalid special"); - LuaSpecialInfo::push(s, info); - return 1; -} - -static int specialinfo_get_name(lua_State *s) +/** LUA specialinfo:category (specialinfo) + * specialinfo:category(function callback) + ** + * **Return value:** The set-name of the special as defined in the + * [[specials.xml]] + * + * **Note:** See [[scripting#get_special_info|get_special_info]] for getting + * a specialinfo object. + */ +static int specialinfo_get_category(lua_State *s) { SpecialManager::SpecialInfo *info = LuaSpecialInfo::check(s, 1); - push(s, info->name); + push(s, info->setName); return 1; } -static int specialinfo_get_needed_mana(lua_State *s) + +/** LUA_CATEGORY Status effect class (statuseffectclass) + */ + +/** LUA get_status_effect (statuseffectclass) + * get_status_effect(string name) + ** + * **Return value:** This function returns a object of the statuseffect class. + * See below for usage of that object. + */ +static int get_status_effect(lua_State *s) { - SpecialManager::SpecialInfo *info = LuaSpecialInfo::check(s, 1); - lua_pushinteger(s, info->neededMana); + const char *name = luaL_checkstring(s, 1); + LuaStatusEffect::push(s, StatusManager::getStatusByName(name)); return 1; } -static int specialinfo_is_rechargeable(lua_State *s) +/** LUA statuseffect:on_tick (statuseffectclass) + * statuseffect:on_tick(function callback) + ** + * Sets the callback that gets called for every tick when the status effect + * is active. + * + * **Note:** See [[scripting#get_status_effect|get_status_effect]] for getting + * a statuseffect object. + */ +static int status_effect_on_tick(lua_State *s) { - SpecialManager::SpecialInfo *info = LuaSpecialInfo::check(s, 1); - lua_pushboolean(s, info->rechargeable); - return 1; + StatusEffect *statusEffect = LuaStatusEffect::check(s, 1); + luaL_checktype(s, 2, LUA_TFUNCTION); + statusEffect->setTickCallback(getScript(s)); + return 0; } -static int specialinfo_get_category(lua_State *s) +/** LUA_CATEGORY Monster class (monsterclass) + */ + +/** LUA get_monster_class (monsterclass) + * get_monster_class(int monsterid) + * get_monster_class(string monstername) + ** + * **Return value:** This function returns a object of the monster class. + * See below for usage of that object. + */ +static int get_monster_class(lua_State *s) { - SpecialManager::SpecialInfo *info = LuaSpecialInfo::check(s, 1); - push(s, info->setName); + LuaMonsterClass::push(s, checkMonsterClass(s, 1)); return 1; } -static int specialinfo_on_recharged(lua_State *s) +/** LUA monsterclass:on_update (monsterclass) + * monsterclass:on_update(function callback) + ** + * Assigns the ''callback'' as callback for the monster update event. This + * callback will be called every tick for each monster of that class. + * + * **Note:** See [[scripting#get_monster_class|get_monster_class]] for getting + * a monsterclass object. + */ +static int monster_class_on_update(lua_State *s) { - SpecialManager::SpecialInfo *info = LuaSpecialInfo::check(s, 1); - Script *script = getScript(s); + MonsterClass *monsterClass = LuaMonsterClass::check(s, 1); luaL_checktype(s, 2, LUA_TFUNCTION); - script->assignCallback(info->rechargedCallback); + monsterClass->setUpdateCallback(getScript(s)); return 0; } -static int specialinfo_on_use(lua_State *s) +/** LUA monsterclass:on_damage (monsterclass) + * monsterclass:on_damage(function callback) + ** + * Assigns the ''callback'' as callback for the monster damage event. + * This callback will be called every time when a monster takes damage. + * The damage can be either invoked from scripts or from other beings such + * as players. The parameters of the callback are: the attacked monster, + * the being dealing the damage and the hp loss + * + * **Note:** See [[scripting#get_monster_class|get_monster_class]] for getting + * a monsterclass object. + * + * **Example:** <code lua> + * local function damage(mob, aggressor, hploss) + * being_say(mob, "I took damage -.- ".. hploss) + * if aggressor then + * being_say(mob, "Curse you, ".. being_get_name(aggressor)) + * end + * end + * local maggot = get_monster_class("maggot") + * maggot:on_damage(damage)</code> + */ +static int monster_class_on_damage(lua_State *s) { - SpecialManager::SpecialInfo *info = LuaSpecialInfo::check(s, 1); - Script *script = getScript(s); + MonsterClass *monsterClass = LuaMonsterClass::check(s, 1); luaL_checktype(s, 2, LUA_TFUNCTION); - script->assignCallback(info->useCallback); + monsterClass->setDamageCallback(getScript(s)); return 0; } +/** LUA monsterclass:attacks (monsterclass) + * monsterclass:attacks() + ** + * **Return value:** This function returns a table with all attacks of the + * monster. See the [[scripting#AttackInfo class|Attack Info]] section. + */ +static int monster_class_attacks(lua_State *s) +{ + MonsterClass *monsterClass = LuaMonsterClass::check(s, 1); + pushSTLContainer(s, monsterClass->getAttackInfos()); + return 1; +} + + +/** LUA_CATEGORY AttackInfo class (attackinfoclass) + * The AttackInfo class reveals info about attacks and provides functions to + * register callbacks on attacks. See the + * [[attackconfiguration|Attack Configuration]] for more info. + * To get an AttackInfo use + * [[scripting#monsterclass:attacks|monsterclass:attacks]] or + * [[scripting#itemclass:attacks|itemclass:attacks]] + */ + +/** LUA attackinfo:priority (attackinfoclass) + * attackinfo:priority() + ** + * **Return value:** This function returns the priority of the attack. + */ static int attack_get_priority(lua_State *s) { AttackInfo *attack = LuaAttackInfo::check(s, 1); @@ -2462,6 +2999,12 @@ static int attack_get_priority(lua_State *s) return 1; } +/** LUA attackinfo:cooldowntime (attackinfoclass) + * attackinfo:cooldowntime() + ** + * **Return value:** This function returns the cooldowntime (time after dealing + * damage after which a new attack can be used) of the attack. + */ static int attack_get_cooldowntime(lua_State *s) { AttackInfo *attack = LuaAttackInfo::check(s, 1); @@ -2469,6 +3012,12 @@ static int attack_get_cooldowntime(lua_State *s) return 1; } +/** LUA attackinfo:warmuptime (attackinfoclass) + * attackinfo:warmuptime() + ** + * **Return value:** This function returns the warmuptime (time before a attack + * triggers damage after being used) of the attack. + */ static int attack_get_warmuptime(lua_State *s) { AttackInfo *attack = LuaAttackInfo::check(s, 1); @@ -2476,6 +3025,12 @@ static int attack_get_warmuptime(lua_State *s) return 1; } +/** LUA attackinfo:reusetime (attackinfoclass) + * attackinfo:reusetime() + ** + * **Return value:** This function returns the reusetime (time after which the + * same attack can be used again) of the attack. + */ static int attack_get_reusetime(lua_State *s) { AttackInfo *attack = LuaAttackInfo::check(s, 1); @@ -2483,6 +3038,13 @@ static int attack_get_reusetime(lua_State *s) return 1; } +/** LUA attackinfo:damage (attackinfoclass) + * >attackinfo:damage() + ** + * **Return value:** This function returns the damage info of the attack. + * + * **See also:** [[scripting#Damage Class|Damage Class]] + */ static int attack_get_damage(lua_State *s) { AttackInfo *attack = LuaAttackInfo::check(s, 1); @@ -2490,6 +3052,13 @@ static int attack_get_damage(lua_State *s) return 1; } +/** LUA attackinfo:on_attack (attackinfoclass) + * attackinfo:on_attack(function callback) + ** + * Assigns a callback to the attack that will be called as soon the attack is + * used. The callback will get called with the following parameters: + * being user, being target, int damage_dealt. + */ static int attack_on_attack(lua_State *s) { AttackInfo *attack = LuaAttackInfo::check(s, 1); @@ -2498,6 +3067,16 @@ static int attack_on_attack(lua_State *s) return 0; } + +/** LUA_CATEGORY Damage Class (damageclass) + * The Damage class provides info about the kind of damage attack deals. + */ + +/** LUA damage:id (damageclass) + * damage:id() + ** + * **Return value:** This function returns the id of the attack. + */ static int damage_get_id(lua_State *s) { Damage *damage = LuaDamage::check(s, 1); @@ -2505,7 +3084,12 @@ static int damage_get_id(lua_State *s) return 1; } - +/** LUA damage:skill (damageclass) + * damage:skill() + ** + * **Return value:** This function returns the skill id of the attack. If the + * damage dealer is a character is a character this skill will recieve exp. + */ static int damage_get_skill(lua_State *s) { Damage *damage = LuaDamage::check(s, 1); @@ -2513,6 +3097,12 @@ static int damage_get_skill(lua_State *s) return 1; } +/** LUA damage:base (damageclass) + * damage:base() + ** + * **Return value:** This function returns the base damage of the attack. + * It is the minimum of damage dealt. + */ static int damage_get_base(lua_State *s) { Damage *damage = LuaDamage::check(s, 1); @@ -2520,6 +3110,13 @@ static int damage_get_base(lua_State *s) return 1; } +/** LUA damage:delta (damageclass) + * damage:delta() + ** + * **Return value:** This function returns the damage delta of the attack. + * base damage + delta damage is the maximum of damage the attack can cause. + * A number in between will be picked by random. + */ static int damage_get_delta(lua_State *s) { Damage *damage = LuaDamage::check(s, 1); @@ -2527,6 +3124,13 @@ static int damage_get_delta(lua_State *s) return 1; } +/** LUA damage:cth (damageclass) + * damage:cth() + ** + * **Return value:** This function returns the chance to hit of the attack. + * This number is not a percent value but some factor. Higher means a better + * chance to hit. FIXME: Add info about the factor. + */ static int damage_get_cth(lua_State *s) { Damage *damage = LuaDamage::check(s, 1); @@ -2534,6 +3138,13 @@ static int damage_get_cth(lua_State *s) return 1; } +/** LUA damage:element (damageclass) + * damage:element() + ** + * **Return value:** This function returns the element of the attack. + * + * **See:** [[scripting#being_damage|being_damage]] for possible values. + */ static int damage_get_element(lua_State *s) { Damage *damage = LuaDamage::check(s, 1); @@ -2541,6 +3152,13 @@ static int damage_get_element(lua_State *s) return 1; } +/** LUA damage:type (damageclass) + * damage:type() + ** + * **Return value:** This function returns the type of the attack. + * + * **See:** [[scripting#being_damage|being_damage]] for possible values. + */ static int damage_get_type(lua_State *s) { Damage *damage = LuaDamage::check(s, 1); @@ -2548,6 +3166,13 @@ static int damage_get_type(lua_State *s) return 1; } +/** LUA damage:is_truestrike (damageclass) + * damage:is_truestrike() + ** + * **Return value:** This function returns whether the attack is a true strike. + * A true strike is not effected by chance of hit or anything that could + * prevent the hit. + */ static int damage_is_truestrike(lua_State *s) { Damage *damage = LuaDamage::check(s, 1); @@ -2555,6 +3180,11 @@ static int damage_is_truestrike(lua_State *s) return 1; } +/** LUA damage:range (damageclass) + * damage:range() + ** + * **Return value:** This function returns the range of the attack in pixels. + */ static int damage_get_range(lua_State *s) { Damage *damage = LuaDamage::check(s, 1); @@ -2562,6 +3192,236 @@ static int damage_get_range(lua_State *s) return 1; } + +/** LUA_CATEGORY Map object class (mapobjectclass) + */ + +/** LUA map_get_objects (mapobjectclass) + * map_get_objects() + * map_get_objects(string type) + ** + * **Return value:** A table of all objects or a table of all objects of the + * given ''type''. See below for usage of these objects. + */ +static int map_get_objects(lua_State *s) +{ + const bool filtered = (lua_gettop(s) == 1); + const char *filter; + if (filtered) + { + filter = luaL_checkstring(s, 1); + } + + MapComposite *m = checkCurrentMap(s); + const std::vector<MapObject*> &objects = m->getMap()->getObjects(); + + if (!filtered) + pushSTLContainer<MapObject*>(s, objects); + else + { + std::vector<MapObject*> filteredObjects; + for (std::vector<MapObject*>::const_iterator it = objects.begin(); + it != objects.end(); ++it) + { + if (utils::compareStrI((*it)->getType(), filter) == 0) + { + filteredObjects.push_back(*it); + } + } + pushSTLContainer<MapObject*>(s, filteredObjects); + } + return 1; +} + +/** LUA mapobject:property (mapobjectclass) + * mapobject:property(string key) + ** + * **Return value:** The value of the property of the key ''key'' or nil if + * the property does not exists. + * + * **Note:** See [[scripting#map_get_objects|map_get_objects]] for getting a + * monsterclass object. + */ +static int map_object_get_property(lua_State *s) +{ + const char *key = luaL_checkstring(s, 2); + MapObject *obj = LuaMapObject::check(s, 1); + + std::string property = obj->getProperty(key); + if (!property.empty()) + { + push(s, property); + return 1; + } + else + { + // scripts can check for nil + return 0; + } +} + +/** LUA mapobject:bounds (mapobjectclass) + * mapobject:bounds() + ** + * **Return value:** x, y position and height, width of the ''mapobject''. + * + * **Example use:** + * <code lua>local x, y, width, height = my_mapobject:bounds()</code> + * + * **Note:** See [[scripting#map_get_objects|map_get_objects]] for getting a + * mapobject object. + */ +static int map_object_get_bounds(lua_State *s) +{ + MapObject *obj = LuaMapObject::check(s, 1); + const Rectangle &bounds = obj->getBounds(); + lua_pushinteger(s, bounds.x); + lua_pushinteger(s, bounds.y); + lua_pushinteger(s, bounds.w); + lua_pushinteger(s, bounds.h); + return 4; +} + +/** LUA mapobject:name (mapobjectclass) + * mapobject:name() + ** + * **Return value:** Name as set in the mapeditor of the ''mapobject''. + * + * **Note:** See [[scripting#map_get_objects|map_get_objects]] for getting + * a mapobject object. + */ +static int map_object_get_name(lua_State *s) +{ + MapObject *obj = LuaMapObject::check(s, 1); + push(s, obj->getName()); + return 1; +} + +/** LUA mapobject:type (mapobjectclass) + * mapobject:type() + ** + * **Return value:** Type as set in the mapeditor of the ''mapobject''. + * + * **Note:** See [[scripting#map_get_objects|map_get_objects]] for getting + * a mapobject object. + */ +static int map_object_get_type(lua_State *s) +{ + MapObject *obj = LuaMapObject::check(s, 1); + push(s, obj->getType()); + return 1; +} + + +/** LUA_CATEGORY Item class (itemclass) + */ + +/** LUA get_item_class (itemclass) + * get_item_class(int itemid) + * get_item_class(string itemname) + ** + * **Return value:** This function returns a object of the item class. + * See below for usage of that object. + */ +static int get_item_class(lua_State *s) +{ + LuaItemClass::push(s, checkItemClass(s, 1)); + return 1; +} + +/** LUA itemclass:on (itemclass) + * itemclass:on(string event, function callback) + ** + * Assigns ''callback'' as callback for the ''event'' event. + * + * **Note:** See [[scripting#get_item_class|get_item_class]] for getting + * a itemclass object. + */ +static int item_class_on(lua_State *s) +{ + ItemClass *itemClass = LuaItemClass::check(s, 1); + const char *event = luaL_checkstring(s, 2); + luaL_checktype(s, 3, LUA_TFUNCTION); + itemClass->setEventCallback(event, getScript(s)); + return 0; +} + +/** LUA itemclass:attacks (itemclass) + * itemclass:attacks() + ** + * **Return value:** Returns a list of all attacks the item offers. + * + * **See:** the [[scripting#AttackInfo Class|AttackInfo class]] for more info + * about how to use the values in the list. + */ +static int item_class_attacks(lua_State *s) +{ + ItemClass *itemClass = LuaItemClass::check(s, 1); + std::vector<AttackInfo *> attacks = itemClass->getAttackInfos(); + pushSTLContainer<AttackInfo *>(s, attacks); + return 1; +} + + +/** + * Returns four useless tables for testing the STL container push wrappers. + * This function can be removed when there are more useful functions which use + * them. + */ +static int test_tableget(lua_State *s) +{ + + std::list<float> list; + std::vector<std::string> svector; + std::vector<int> ivector; + std::map<std::string, std::string> map; + std::set<int> set; + + LOG_INFO("Pushing Float List"); + list.push_back(12.636); + list.push_back(0.0000000045656); + list.push_back(185645445634566.346); + list.push_back(7835458.11); + pushSTLContainer<float>(s, list); + + LOG_INFO("Pushing String Vector"); + svector.push_back("All"); + svector.push_back("your"); + svector.push_back("base"); + svector.push_back("are"); + svector.push_back("belong"); + svector.push_back("to"); + svector.push_back("us!"); + pushSTLContainer<std::string>(s, svector); + + LOG_INFO("Pushing Integer Vector"); + ivector.resize(10); + for (int i = 1; i < 10; i++) + { + ivector[i-1] = i * i; + } + pushSTLContainer<int>(s, ivector); + + LOG_INFO("Pushing String/String Map"); + map["Apple"] = "red"; + map["Banana"] = "yellow"; + map["Lime"] = "green"; + map["Plum"] = "blue"; + pushSTLContainer<std::string, std::string>(s, map); + + LOG_INFO("Pushing Integer Set"); + set.insert(12); + set.insert(8); + set.insert(14); + set.insert(10); + pushSTLContainer<int>(s, set); + + + return 5; +} + + + static int require_loader(lua_State *s) { // Add .lua extension (maybe only do this when it doesn't have it already) |