Unified the lua.cpp documentation.

I also changed the chatmessage function to chat_message
to follow the coding standard.

3 files changed, 208 insertions, 170 deletions

diff --git a/example/serverdata/scripts/crafting.lua b/example/serverdata/scripts/crafting.lua
index ea306289..eae26a41 100644
--- a/example/serverdata/scripts/crafting.lua
+++ b/example/serverdata/scripts/crafting.lua
@@ -27,7 +27,7 @@ function on_craft(ch, recipe)
     -- uncomment one (but not both!) of the following three lines to enable the

     -- example crafting systems

     

-    mana.chatmessage(ch, "There is no crafting in this game world.")

+    mana.chat_message(ch, "There is no crafting in this game world.")

     --craft_strict(ch, recipe)

     --craft_lax(ch, recipe)

 end

@@ -42,10 +42,10 @@ function craft_strict(ch, recipe)
             8, -2, --take away the iron

             9, -1, --take away the wood

             5, 1 ) -- give a sword

-        mana.chatmessage(ch, "You've crafted a sword")

+        mana.chat_message(ch, "You've crafted a sword")

         return

     end

-    mana.chatmessage(ch, "This wouldn't create anything useful")

+    mana.chat_message(ch, "This wouldn't create anything useful")

 end

 

 -- a primitive example crafting system which doesn't care about item order

@@ -60,10 +60,10 @@ function craft_lax(ch, recipe)
             8, -2, --take away the iron

             9, -1, --take away the wood

             5, 1 ) -- give a sword

-        mana.chatmessage(ch, "You've crafted a sword")

+        mana.chat_message(ch, "You've crafted a sword")

         return

     end

-    mana.chatmessage(ch, "This wouldn't create anything useful")

+    mana.chat_message(ch, "This wouldn't create anything useful")

 end

 

 -- this turns multiple occurences of the same item into one by adding up

diff --git a/example/serverdata/scripts/global_events.lua b/example/serverdata/scripts/global_events.lua
index 5655dc8c..548351a8 100644
--- a/example/serverdata/scripts/global_events.lua
+++ b/example/serverdata/scripts/global_events.lua
@@ -50,14 +50,14 @@ end
 -- to the character and/or initialize a tutorial quest.
 function on_chr_birth(ch)
 	-- this message is shown on first login.
-	mana.chatmessage(0, ch, "And so your adventure begins...")
+	mana.chat_message(0, ch, "And so your adventure begins...")
 end
 
 -- This function is called when a character logs into the game. This can,
 -- for example, be utilized for a message-of-the-day or for various
 -- handlings of offline processing mechanics.
 function on_chr_login(ch)
-	mana.chatmessage(0, ch, "Welcome to Manasource")
+	mana.chat_message(0, ch, "Welcome to Manasource")
 end
 
 
@@ -72,7 +72,7 @@ function on_chr_logout(ch)
 	local msg = mana.being_get_name(ch).." left the game."
 	for b in pairs(around) do
 		if mana.being_type(b) == TYPE_CHARACTER then
-			mana.chatmessage(0, b, msg)
+			mana.chat_message(0, b, msg)
 		end
 	end
 end
diff --git a/src/scripting/lua.cpp b/src/scripting/lua.cpp
index 9a67c7c7..69c84311 100644
--- a/src/scripting/lua.cpp
+++ b/src/scripting/lua.cpp
@@ -63,8 +63,8 @@ extern "C" {
  */
 
 /**
+ * mana.npc_message(NPC*, Character*, string): void
  * Callback for sending a NPC_MESSAGE.
- * mana.npc_message(npc, character, string)
  */
 static int npc_message(lua_State *s)
 {
@@ -85,8 +85,8 @@ static int npc_message(lua_State *s)
 }
 
 /**
+ * mana.npc_choice(NPC*, Character*, string...): void
  * Callback for sending a NPC_CHOICE.
- * mana.npc_choice(npc, character, string...)
  */
 static int npc_choice(lua_State *s)
 {
@@ -115,7 +115,8 @@ static int npc_choice(lua_State *s)
                 }
                 else
                 {
-                    raiseScriptError(s, "npc_choice called with incorrect parameters.");
+                    raiseScriptError(s, "npc_choice called "
+                                     "with incorrect parameters.");
                     return 0;
                 }
                 lua_pop(s, 1);
@@ -132,8 +133,8 @@ static int npc_choice(lua_State *s)
 }
 
 /**
+ * mana.npc_integer(NPC*, Character*, int min, int max, int defaut = min): void
  * Callback for sending a NPC_INTEGER.
- * mana.npc_integer(npc, character, min, max, defaut)
  */
 static int npc_ask_integer(lua_State *s)
 {
@@ -141,7 +142,8 @@ static int npc_ask_integer(lua_State *s)
     Character *q = getCharacter(s, 2);
     if (!p || !q)
     {
-        raiseScriptError(s, "npc_integer called with incorrect parameters.");
+        raiseScriptError(s, "npc_ask_integer called "
+                         "with incorrect parameters.");
         return 0;
     }
     MessageOut msg(GPMSG_NPC_NUMBER);
@@ -162,8 +164,8 @@ static int npc_ask_integer(lua_State *s)
 }
 
 /**
+ * mana.npc_ask_string(NPC*, Character*): void
  * Callback for sending a NPC_STRING.
- * mana.npc_ask_string(npc, character)
  */
 static int npc_ask_string(lua_State *s)
 {
@@ -171,7 +173,7 @@ static int npc_ask_string(lua_State *s)
     Character *q = getCharacter(s, 2);
     if (!p || !q)
     {
-        raiseScriptError(s, "npc_string called with incorrect parameters.");
+        raiseScriptError(s, "npc_ask_string called with incorrect parameters.");
         return 0;
     }
     MessageOut msg(GPMSG_NPC_STRING);
@@ -182,8 +184,8 @@ static int npc_ask_string(lua_State *s)
 }
 
 /**
+ * mana.npc_create(string name, int id, int x, int y): NPC*
  * Callback for creating a NPC on the current map with the current script.
- * mana.npc_create(string name, int id, int x, int y): npc
  */
 static int npc_create(lua_State *s)
 {
@@ -212,6 +214,10 @@ static int npc_create(lua_State *s)
     return 1;
 }
 
+/**
+ * mana.npc_end(NPC*, Character*): void
+ * Callback for ending a NPC conversation with the given character.
+ */
 static int npc_end(lua_State *s)
 {
     NPC *p = getNPC(s, 1);
@@ -229,8 +235,8 @@ static int npc_end(lua_State *s)
 }
 
 /**
+ * mana.npc_post(NPC*, Character*): void
  * Callback for sending a NPC_POST.
- * mana.npc_post(npc, character)
  */
 static int npc_post(lua_State *s)
 {
@@ -239,7 +245,7 @@ static int npc_post(lua_State *s)
 
     if (!p || !q)
     {
-        raiseScriptError(s, "npc_Choice called with incorrect parameters.");
+        raiseScriptError(s, "npc_post called with incorrect parameters.");
         return 0;
     }
 
@@ -251,8 +257,8 @@ static int npc_post(lua_State *s)
 }
 
 /**
+ * mana.npc_enable(NPC*): void
  * Enable a NPC if it has previously disabled
- * mana.npc_enable(npc)
  */
 static int npc_enable(lua_State *s)
 {
@@ -267,8 +273,8 @@ static int npc_enable(lua_State *s)
 }
 
 /**
- * Disable a NPC
- * mana.npc_disable(npc)
+ * mana.npc_disable(NPC*): void
+ * Disable a NPC.
  */
 static int npc_disable(lua_State *s)
 {
@@ -283,8 +289,8 @@ static int npc_disable(lua_State *s)
 }
 
 /**
+ * mana.chr_warp(Character*, nil/int map, int x, int y): void
  * Callback for warping a player to another place.
- * mana.chr_warp(character, nil/int map, int x, int y)
  */
 static int chr_warp(lua_State *s)
 {
@@ -337,6 +343,7 @@ static int chr_warp(lua_State *s)
 }
 
 /**
+ * mana.chr_inv_change(Character*, (int id, 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
@@ -348,7 +355,6 @@ static int chr_warp(lua_State *s)
  * however currency is now handled through attributes. This breaks backwards
  * compatibility with old scripts, and so logs a warning.
  * Note: If an insertion fails, extra items are dropped on the floor.
- * mana.chr_inv_change(character, (int id, int nb)...): bool success
  */
 static int chr_inv_change(lua_State *s)
 {
@@ -364,7 +370,8 @@ static int chr_inv_change(lua_State *s)
     {
         if (!lua_isnumber(s, i * 2 + 2) || !lua_isnumber(s, i * 2 + 3))
         {
-            raiseScriptError(s, "chr_inv_change called with incorrect parameters.");
+            raiseScriptError(s, "chr_inv_change called "
+                             "with incorrect parameters.");
             return 0;
         }
 
@@ -372,7 +379,7 @@ static int chr_inv_change(lua_State *s)
         int nb = lua_tointeger(s, i * 2 + 3);
         if (id == 0)
         {
-            LOG_WARN("mana.chr_inv_change() called with id 0! "
+            LOG_WARN("chr_inv_change called with id 0! "
                      "Currency is now handled through attributes!");
         }
         else if (nb < 0)
@@ -390,7 +397,8 @@ static int chr_inv_change(lua_State *s)
             ItemClass *ic = itemManager->getItem(id);
             if (!ic)
             {
-                raiseScriptError(s, "chr_inv_change called with an unknown item.");
+                raiseScriptError(s, "chr_inv_change called "
+                                 "with an unknown item.");
                 continue;
             }
             nb = inv.insert(id, nb);
@@ -408,8 +416,8 @@ static int chr_inv_change(lua_State *s)
 }
 
 /**
+ * mana.chr_inv_count(Character*, int item_id...): int count...
  * Callback for counting items in inventory.
- * mana.chr_inv_count(character, int id...): int count...
  */
 static int chr_inv_count(lua_State *s)
 {
@@ -429,7 +437,7 @@ static int chr_inv_count(lua_State *s)
         id = luaL_checkint(s, i);
         if (id == 0)
         {
-            LOG_WARN("mana.chr_inv_count() called with id 0! "
+            LOG_WARN("chr_inv_count called with id 0! "
                      "Currency is now handled through attributes!");
         }
         else
@@ -442,8 +450,8 @@ static int chr_inv_count(lua_State *s)
 }
 
 /**
+ * mana.npc_trade(NPC*, Character*, bool sell, table items): int
  * Callback for trading between a player and an NPC.
- * mana.npc_trade(npc, character, bool sell, table items)
  * 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,
@@ -489,7 +497,8 @@ static int npc_trade(lua_State *s)
         }
         else
         {
-            raiseWarning(s, "npc_trade[Buy] called with invalid or empty items table parameter.");
+            raiseWarning(s, "npc_trade[Buy] called with invalid "
+                         "or empty items table parameter.");
             t->cancel();
             lua_pushinteger(s, 2);
             return 1;
@@ -503,7 +512,8 @@ static int npc_trade(lua_State *s)
     {
         if (!lua_istable(s, -1))
         {
-            raiseWarning(s, "npc_trade called with invalid or empty items table parameter.");
+            raiseWarning(s, "npc_trade called with invalid "
+                         "or empty items table parameter.");
             t->cancel();
             lua_pushinteger(s, 2);
             return 1;
@@ -515,7 +525,8 @@ static int npc_trade(lua_State *s)
             lua_rawgeti(s, -1, i + 1);
             if (!lua_isnumber(s, -1))
             {
-                raiseWarning(s, "npc_trade called with incorrect parameters in item table.");
+                raiseWarning(s, "npc_trade called with incorrect parameters "
+                             "in item table.");
                 t->cancel();
                 lua_pushinteger(s, 2);
                 return 1;
@@ -547,10 +558,9 @@ static int npc_trade(lua_State *s)
 }
 
 /**
- * Applies a status effect with id to the being given for a amount of time
- * mana.being_apply_status(Being *being, int id, int time)
+ * mana.being_apply_status(Being*, int id, int time): void
+ * Applies a status effect with id to the being given for a amount of time.
  */
-
 static int being_apply_status(lua_State *s)
 {
     const int id = luaL_checkint(s, 2);
@@ -558,7 +568,8 @@ static int being_apply_status(lua_State *s)
 
     if (!lua_isuserdata(s, 1))
     {
-        raiseScriptError(s, "being_apply_status called with incorrect parameters.");
+        raiseScriptError(s, "being_apply_status called "
+                         "with incorrect parameters.");
         return 0;
     }
     Being *being = getBeing(s, 1);
@@ -567,8 +578,8 @@ static int being_apply_status(lua_State *s)
 }
 
 /**
- * Removes the given status effect
- * mana.being_remove_status(Being *being, int id)
+ * mana.being_remove_status(Being*, int id): void
+ * Removes the given status effect.
  */
 static int being_remove_status(lua_State *s)
 {
@@ -576,7 +587,8 @@ static int being_remove_status(lua_State *s)
 
     if (!lua_isuserdata(s, 1))
     {
-        raiseScriptError(s, "being_remove_status called with incorrect parameters.");
+        raiseScriptError(s, "being_remove_status called "
+                         "with incorrect parameters.");
         return 0;
     }
     Being *being = getBeing(s, 1);
@@ -585,8 +597,8 @@ static int being_remove_status(lua_State *s)
 }
 
 /**
- * Returns true if a being has the given status effect
- * mana.being_has_status(Being *being, int id)
+ * mana.being_has_status(Being*, int id): bool
+ * Returns whether a being has the given status effect.
  */
 static int being_has_status(lua_State *s)
 {
@@ -594,7 +606,8 @@ static int being_has_status(lua_State *s)
 
     if (!lua_isuserdata(s, 1))
     {
-        raiseScriptError(s, "being_has_status called with incorrect parameters.");
+        raiseScriptError(s, "being_has_status called "
+                         "with incorrect parameters.");
         return 0;
     }
     Being *being = getBeing(s, 1);
@@ -603,8 +616,8 @@ static int being_has_status(lua_State *s)
 }
 
 /**
- * Returns the time left on the given status effect
- * mana.being_get_status_time(Being *being, int id)
+ * mana.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)
 {
@@ -612,7 +625,8 @@ static int being_get_status_time(lua_State *s)
 
     if (!lua_isuserdata(s, 1))
     {
-        raiseScriptError(s, "being_time_status called with incorrect parameters.");
+        raiseScriptError(s, "being_get_status_time called "
+                         "with incorrect parameters.");
         return 0;
     }
     Being *being = getBeing(s, 1);
@@ -621,8 +635,8 @@ static int being_get_status_time(lua_State *s)
 }
 
 /**
- * Sets the time left on the given status effect
- * mana.being_set_status_time(Being *being, int id, int time)
+ * mana.being_set_status_time(Being*, int id, int time): void
+ * Sets the time left on the given status effect.
  */
 static int being_set_status_time(lua_State *s)
 {
@@ -631,7 +645,8 @@ static int being_set_status_time(lua_State *s)
 
     if (!lua_isuserdata(s, 1))
     {
-        raiseScriptError(s, "being_time_status called with incorrect parameters.");
+        raiseScriptError(s, "being_set_status_time called "
+                         "with incorrect parameters.");
         return 0;
     }
     Being *being = getBeing(s, 1);
@@ -640,8 +655,8 @@ static int being_set_status_time(lua_State *s)
 }
 
 /**
- * Returns the Thing type of the given Being
- * mana.being_type(Being *being)
+ * mana.being_type(Being*): ThingType
+ * Returns the Thing type of the given being.
  */
 static int being_type(lua_State *s)
 {
@@ -660,9 +675,9 @@ static int being_type(lua_State *s)
 
 
 /**
- * Function for making a being walk to a position
- * being_walk(Being *being, int x, int y[, float speed])
- * The speed is in tile per second
+ * 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.
  */
 static int being_walk(lua_State *s)
 {
@@ -683,8 +698,8 @@ static int being_walk(lua_State *s)
 }
 
 /**
- * Makes the being say something
- * mana.being_say(source, message)
+ * mana.being_say(Being* source, string message): void
+ * Makes the being say something.
  */
 static int being_say(lua_State *s)
 {
@@ -713,8 +728,9 @@ static int being_say(lua_State *s)
 
 
 /**
- * Applies combat damage to a being
- * mana.being_damage(victim, value, delta, cth, type, element)
+ * mana.being_damage(Being* victim, int value, int delta, int cth, int type,
+ *                   int element): void
+ * Applies combat damage to a being.
  */
 static int being_damage(lua_State *s)
 {
@@ -723,20 +739,20 @@ static int being_damage(lua_State *s)
     if (!being->canFight())
         return 0;
 
-    Damage dmg((unsigned short)    lua_tointeger(s, 2), /* base */
-               (unsigned short) lua_tointeger(s, 3),    /* delta */
-               (unsigned short) lua_tointeger(s, 4),    /* cth */
-               (unsigned char)  lua_tointeger(s, 6),    /* element */
-               DAMAGE_PHYSICAL);                        /* type */
+    Damage dmg((unsigned short) lua_tointeger(s, 2), /* base */
+               (unsigned short) lua_tointeger(s, 3), /* delta */
+               (unsigned short) lua_tointeger(s, 4), /* cth */
+               (unsigned char)  lua_tointeger(s, 6), /* element */
+               DAMAGE_PHYSICAL);                     /* type */
     being->damage(NULL, dmg);
 
     return 0;
 }
 
 /**
- * Restores hit points of a being
- * mana.being_heal(being[, value])
- * Without a value it heals fully.
+ * mana.being_heal(Being* [, int value]): void
+ * Restores hit points of a being.
+ * Without a value the being is fully healed.
  */
 static int being_heal(lua_State *s)
 {
@@ -766,8 +782,8 @@ static int being_heal(lua_State *s)
 }
 
 /**
- * Gets the base attribute of a being
- * mana.being_get_base_attribute(being, attribute)
+ * mana.being_get_base_attribute(Being*, int attribute): int
+ * Gets the base attribute of a being.
  */
 static int being_get_base_attribute(lua_State *s)
 {
@@ -789,8 +805,8 @@ static int being_get_base_attribute(lua_State *s)
 }
 
 /**
- * Gets the modified attribute of a being
- * mana.being_get_modified_attribute(being, attribute)
+ * mana.being_get_modified_attribute(Being*, int attribute): int
+ * Gets the modified attribute of a being.
  */
 static int being_get_modified_attribute(lua_State *s)
 {
@@ -812,8 +828,8 @@ static int being_get_modified_attribute(lua_State *s)
 }
 
 /**
- * Sets the base attribute of a being
- * mana.being_set_base_attribute(being, attribute, value)
+ * mana.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)
 {
@@ -830,9 +846,9 @@ static int being_set_base_attribute(lua_State *s)
 }
 
 /**
+ * mana.being_apply_attribute_modifier(Being*, int attribute, double value,
+ *     int layer, int [duration, int [effect-id]]): void
  * Applies an attribute modifier to a being.
- * mana.being_apply_attribute_modifier(
- *     attribute, value, layer, [duration, [effect-id]])
  */
 static int being_apply_attribute_modifier(lua_State *s)
 {
@@ -857,6 +873,11 @@ static int being_apply_attribute_modifier(lua_State *s)
     return 0;
 }
 
+/**
+ * mana.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 = getBeing(s, 1);
@@ -876,8 +897,8 @@ static int being_remove_attribute_modifier(lua_State *s)
 }
 
 /**
- * Gets the being's name
- * mana.being_get_name(being)
+ * mana.being_get_name(Being*): string
+ * Gets the being's name.
  */
 static int being_get_name(lua_State *s)
 {
@@ -892,8 +913,8 @@ static int being_get_name(lua_State *s)
 }
 
 /**
- * Gets the being's current action
- * mana.being_get_action(being)
+ * mana.being_get_action(Being*): BeingAction
+ * Gets the being's current action.
  */
 static int being_get_action(lua_State *s)
 {
@@ -908,8 +929,8 @@ static int being_get_action(lua_State *s)
 }
 
 /**
- * Sets the being's current action
- * mana.being_set_action(being, action)
+ * mana.being_set_action(Being*, BeingAction): void
+ * Sets the being's current action.
  */
 static int being_set_action(lua_State *s)
 {
@@ -926,8 +947,8 @@ static int being_set_action(lua_State *s)
 }
 
 /**
- * Gets the being's current direction
- * mana.being_get_direction(being)
+ * mana.being_get_direction(Being*): BeingDirection
+ * Gets the being's current direction.
  */
 static int being_get_direction(lua_State *s)
 {
@@ -942,8 +963,8 @@ static int being_get_direction(lua_State *s)
 }
 
 /**
- * Sets the being's current direction
- * mana.being_set_direction(being, direction)
+ * mana.being_set_direction(Being*, BeingDirection): void
+ * Sets the being's current direction.
  */
 static int being_set_direction(lua_State *s)
 {
@@ -960,7 +981,8 @@ static int being_set_direction(lua_State *s)
 }
 
 /**
- * Function for getting the x-coordinate of the position of a being
+ * mana.posX(Being*): int xcoord
+ * Function for getting the x-coordinate of the position of a being.
  */
 static int posX(lua_State *s)
 {
@@ -971,7 +993,8 @@ static int posX(lua_State *s)
 }
 
 /**
- * Function for getting the y-coordinate of the position of a being
+ * mana.posY(Being*): int ycoord
+ * Function for getting the y-coordinate of the position of a being.
  */
 static int posY(lua_State *s)
 {
@@ -982,8 +1005,8 @@ static int posY(lua_State *s)
 }
 
 /**
+ * mana.monster_create(int type, int x, int y): Monster*
  * Callback for creating a monster on the current map.
- * mana.monster_create(int type, int x, int y)
  */
 static int monster_create(lua_State *s)
 {
@@ -1004,8 +1027,8 @@ static int monster_create(lua_State *s)
     MonsterClass *spec = monsterManager->getMonster(monsterId);
     if (!spec)
     {
-        raiseScriptError(s, "monster_create called with invalid monster ID: %d", monsterId);
-        //LOG_WARN("LuaMonster_Create invalid monster ID: " << monsterId);
+        raiseScriptError(s, "monster_create called "
+                         "with invalid monster Id: %d", monsterId);
         return 0;
     }
 
@@ -1019,7 +1042,7 @@ static int monster_create(lua_State *s)
 }
 
 /**
- * mana.monster_remove(mob)
+ * mana.monster_remove(Monster*): bool success
  * Remove a monster object without kill event.
  * return whether the monster was enqueued for removal.
  */
@@ -1043,22 +1066,24 @@ static int monster_remove(lua_State *s)
 }
 
 /**
- * mana.monster_load_script(mob, scriptfilename)
- * loads a LUA script given for mob
+ * mana.monster_load_script(Monster*, string script_filename): void
+ * loads a LUA script for the given monster.
  */
 static int monster_load_script(lua_State *s)
 {
     Monster *m = static_cast< Monster* >(getBeing(s, 1));
     if (!m)
     {
-         raiseScriptError(s, "monster_load_script called for a nonexistance monster.");
+         raiseScriptError(s, "monster_load_script called "
+                          "for a nonexistent monster.");
          return 0;
     }
 
     const char *scriptName = luaL_checkstring(s, 2);
     if (scriptName[0] == 0)
     {
-        raiseScriptError(s, "monster_load_script called with empty script file name.");
+        raiseScriptError(s, "monster_load_script called "
+                         "with empty script file name.");
         return 0;
     }
 
@@ -1066,18 +1091,18 @@ static int monster_load_script(lua_State *s)
     return 0;
 }
 
-
 /**
+ * mana.chr_get_chest(Character*, string): nil or string
  * Callback for getting a quest variable. Starts a recovery and returns
  * immediatly, if the variable is not known yet.
- * mana.chr_get_chest(character, string): nil or string
  */
 static int chr_get_quest(lua_State *s)
 {
     Character *q = getCharacter(s, 1);
     if (!q)
     {
-        raiseScriptError(s, "chr_get_quest called for nonexistent character.");
+        raiseScriptError(s, "chr_get_quest "
+                         "called for nonexistent character.");
     }
 
     const char *m = luaL_checkstring(s, 2);
@@ -1101,10 +1126,9 @@ static int chr_get_quest(lua_State *s)
     return 0;
 }
 
-
 /**
- * gets the value of a persistent map variable.
  * mana.getvar_map(string): string
+ * Gets the value of a persistent map variable.
  */
 static int getvar_map(lua_State *s)
 {
@@ -1125,15 +1149,15 @@ static int getvar_map(lua_State *s)
 }
 
 /**
- * sets the value of a persistent map variable.
- * mana.setvar_map(string, string)
+ * mana.setvar_map(string, string): void
+ * Sets the value of a persistent map variable.
  */
 static int setvar_map(lua_State *s)
 {
     const char *m = luaL_checkstring(s, 1);
     if (m[0] == 0)
     {
-        raiseScriptError(s, "getvar_map called for unnamed variable.");
+        raiseScriptError(s, "setvar_map called for unnamed variable.");
         return 0;
     }
 
@@ -1148,8 +1172,8 @@ static int setvar_map(lua_State *s)
 }
 
 /**
- * gets the value of a persistent global variable.
  * mana.getvar_world(string): string
+ * Gets the value of a persistent global variable.
  */
 static int getvar_world(lua_State *s)
 {
@@ -1167,8 +1191,8 @@ static int getvar_world(lua_State *s)
 }
 
 /**
- * sets the value of a persistent global variable.
- * mana.setvar_world(string, string)
+ * mana.setvar_world(string, string): void
+ * Sets the value of a persistent global variable.
  */
 static int setvar_world(lua_State *s)
 {
@@ -1186,10 +1210,9 @@ static int setvar_world(lua_State *s)
     return 0;
 }
 
-
 /**
+ * mana.chr_set_chest(Character*, string, string): void
  * Callback for setting a quest variable.
- * mana.chr_set_chest(character, string, string)
  */
 static int chr_set_quest(lua_State *s)
 {
@@ -1211,9 +1234,10 @@ static int chr_set_quest(lua_State *s)
 }
 
 /**
+ * mana.trigger_create(int x, int y, int width, int height,
+ *                     string function, int id)
  * Creates a trigger area. Whenever an actor enters this area, a Lua function
  * is called.
- * mana.trigger_create (x, y, width, height, function, id)
  */
 static int trigger_create(lua_State *s)
 {
@@ -1221,6 +1245,7 @@ static int trigger_create(lua_State *s)
     const int y = luaL_checkint(s, 2);
     const int width = luaL_checkint(s, 3);
     const int height = luaL_checkint(s, 4);
+    //TODO: Turn the function string to a lua function pointer
     const char *function = luaL_checkstring(s, 5);
     const int id = luaL_checkint(s, 6);
 
@@ -1257,11 +1282,11 @@ static int trigger_create(lua_State *s)
 }
 
 /**
- * Creates a chat message in the users chatlog(s)
- * global message: mana.chatmessage (message)
- * private massage: mana.chatmessage (recipent, message)
+ * private message: mana.chat_message(Being* recipent, string message): void
+ * @todo global message: mana.chat_message(string message): void
+ * Creates a chat message in the users chatlog(s).
  */
-static int chatmessage(lua_State *s)
+static int chat_message(lua_State *s)
 {
     if (lua_gettop(s) == 2 && lua_isuserdata(s, 1) && lua_isstring(s, 2) )
     {
@@ -1279,7 +1304,7 @@ static int chatmessage(lua_State *s)
     }
     else
     {
-        raiseScriptError(s, "being_say called with incorrect parameters.");
+        raiseScriptError(s, "chat_message called with incorrect parameters.");
         return 0;
     }
 
@@ -1287,9 +1312,9 @@ static int chatmessage(lua_State *s)
 }
 
 /**
- * Gets a LUA table with the being IDs of all beings
+ * mana.get_beings_in_circle(int x, int y, 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.
- * mana.get_beings_in_circle (x, y, radius)
  */
 static int get_beings_in_circle(lua_State *s)
 {
@@ -1327,9 +1352,10 @@ static int get_beings_in_circle(lua_State *s)
 }
 
 /**
- * Gets a LUA table with the being IDs of all beings
- * inside of a recangular area of the current map.
- * mana.get_beings_in_rectangle (x, y, width, height)
+ * mana.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.
  */
 static int get_beings_in_rectangle(lua_State *s)
 {
@@ -1365,7 +1391,8 @@ static int get_beings_in_rectangle(lua_State *s)
  }
 
 /**
- * Gets the post for the character
+ * mana.chr_get_post(Character*): void
+ * Gets the post for the character.
  */
 static int chr_get_post(lua_State *s)
 {
@@ -1387,10 +1414,10 @@ static int chr_get_post(lua_State *s)
 }
 
 /**
+ * mana.being_register(Being*): void
  * Makes the server call the lua functions deathEvent
  * and removeEvent when the being dies or is removed
  * from the map.
- * mana.being_register (being)
  */
 static int being_register(lua_State *s)
 {
@@ -1414,11 +1441,10 @@ static int being_register(lua_State *s)
     return 0;
 }
 
-
 /**
- * Triggers a special effect from the clients effects.xml
- * mana.effect_create (id, x, y)
- * mana.effect_create (id, being)
+ * mana.effect_create (int id, int x, int y): void
+ * mana.effect_create (int id, Being*): void
+ * Triggers a special effect from the clients effects.xml.
  */
 static int effect_create(lua_State *s)
 {
@@ -1458,17 +1484,18 @@ static int effect_create(lua_State *s)
     return 0;
 }
 
-
 /**
- *
- * mana.chr_shake_screen(
+ * mana.chr_shake_screen(Character*, int x, int y[, float strength,
+ *                       int radius]): void
+ * Shake the screen for a given character.
  */
 static int chr_shake_screen(lua_State *s)
 {
     Character *c = getCharacter(s, 1);
     if (!c)
     {
-        raiseScriptError(s, "lua chr_shake_screen called for nonexistent character.");
+        raiseScriptError(s, "chr_shake_screen called "
+                         "for nonexistent character.");
         return 0;
     }
 
@@ -1491,15 +1518,15 @@ static int chr_shake_screen(lua_State *s)
 
 
 /**
+ * mana.chr_get_exp(Character*, int skill): int
  * Gets the exp total in a skill of a specific character
- * mana.chr_get_exp (being, skill)
  */
 static int chr_get_exp(lua_State *s)
 {
     Character *c = getCharacter(s, 1);
     if (!c)
     {
-        raiseScriptError(s, "luaChr_GetExp called for nonexistent character.");
+        raiseScriptError(s, "chr_get_exp called for nonexistent character.");
         return 0;
     }
 
@@ -1510,19 +1537,19 @@ static int chr_get_exp(lua_State *s)
     return 1;
 }
 
-
 /**
+ * mana.chr_give_exp(Character*, int skill,
+ *                   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.
- * mana.chr_give_exp (being, skill, amount)
  */
 static int chr_give_exp(lua_State *s)
 {
     Character *c = getCharacter(s, 1);
     if (!c)
     {
-        raiseScriptError(s, "luaChr_GiveExp called for nonexistent character.");
+        raiseScriptError(s, "chr_give_exp called for nonexistent character.");
         return 0;
     }
 
@@ -1536,22 +1563,24 @@ static int chr_give_exp(lua_State *s)
 }
 
 /**
- * Sets the given character's hair style to the given style id
- * mana.chr_set_hair_style (character, styleid)
+ * mana.chr_set_hair_style(Character*, int style_id): void
+ * Sets the given character's hair style to the given style id.
  */
 static int chr_set_hair_style(lua_State *s)
 {
     Character *c = getCharacter(s, 1);
     if (!c)
     {
-        raiseScriptError(s, "chr_set_hair_style called for nonexistent character.");
+        raiseScriptError(s, "chr_set_hair_style called "
+                         "for nonexistent character.");
         return 0;
     }
 
     const int style = luaL_checkint(s, 2);
     if (style < 0)
     {
-        raiseScriptError(s, "chr_set_hair_style called for nonexistent style id %d.", style);
+        raiseScriptError(s, "chr_set_hair_style called "
+                         "for nonexistent style id %d.", style);
         return 0;
     }
 
@@ -1562,15 +1591,16 @@ static int chr_set_hair_style(lua_State *s)
 }
 
 /**
- * Gets the hair style of the given character
- * mana.chr_get_hair_style (character)
+ * mana.chr_get_hair_style(Character*): int hair_style
+ * Gets the hair style of the given character.
  */
 static int chr_get_hair_style(lua_State *s)
 {
     Character *c = getCharacter(s, 1);
     if (!c)
     {
-        raiseScriptError(s, "chr_get_hair_style called for nonexistent character.");
+        raiseScriptError(s, "chr_get_hair_style called "
+                         "for nonexistent character.");
         return 0;
     }
 
@@ -1579,22 +1609,24 @@ static int chr_get_hair_style(lua_State *s)
 }
 
 /**
- * Set the hair color of the given character to the given color id
- * mana.chr_set_hair_color (character, colorid)
+ * mana.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 = getCharacter(s, 1);
     if (!c)
     {
-        raiseScriptError(s, "chr_set_hair_color called for nonexistent character.");
+        raiseScriptError(s, "chr_set_hair_color called "
+                         "for nonexistent character.");
         return 0;
     }
 
     const int color = luaL_checkint(s, 2);
     if (color < 0)
     {
-        raiseScriptError(s, "chr_set_hair_color called for nonexistent style id %d.", color);
+        raiseScriptError(s, "chr_set_hair_color called "
+                         "for nonexistent style id %d.", color);
         return 0;
     }
 
@@ -1605,15 +1637,16 @@ static int chr_set_hair_color(lua_State *s)
 }
 
 /**
- * Get the hair color of the given character
- * mana.chr_get_hair_color (character)
+ * mana.chr_get_hair_color(Character*): int hair_color
+ * Get the hair color of the given character.
  */
 static int chr_get_hair_color(lua_State *s)
 {
     Character *c = getCharacter(s, 1);
     if (!c)
     {
-        raiseScriptError(s, "chr_get_hair_color called for nonexistent character.");
+        raiseScriptError(s, "chr_get_hair_color called "
+                         "for nonexistent character.");
         return 0;
     }
 
@@ -1622,15 +1655,16 @@ static int chr_get_hair_color(lua_State *s)
 }
 
 /**
- * Get the number of monsters the player killed of a type
- * mana.chr_get_kill_count (character, monsterType)
+ * mana.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 = getCharacter(s, 1);
     if (!c)
     {
-        raiseScriptError(s, "chr_get_kill_count called for nonexistent character.");
+        raiseScriptError(s, "chr_get_kill_count called "
+                         "for nonexistent character.");
         return 0;
     }
 
@@ -1641,8 +1675,8 @@ static int chr_get_kill_count(lua_State *s)
 }
 
 /**
- * Get the gender of the character
- * mana.chr_get_gender (character)
+ * mana.chr_get_gender(Character*): int
+ * Get the gender of the character.
  */
 static int chr_get_gender(lua_State *s)
 {
@@ -1658,8 +1692,8 @@ static int chr_get_gender(lua_State *s)
 }
 
 /**
- * Enables a special for a character
- * mana.chr_give_special (character, special)
+ * mana.chr_give_special(Character*, int special): void
+ * Enables a special for a character.
  */
 static int chr_give_special(lua_State *s)
 {
@@ -1667,7 +1701,8 @@ static int chr_give_special(lua_State *s)
     Character *c = getCharacter(s, 1);
     if (!c)
     {
-        raiseScriptError(s, "chr_give_special called for nonexistent character.");
+        raiseScriptError(s, "chr_give_special called "
+                         "for nonexistent character.");
         return 0;
     }
     const int special = luaL_checkint(s, 2);
@@ -1677,8 +1712,8 @@ static int chr_give_special(lua_State *s)
 }
 
 /**
- * Checks if a character has a special and returns true or false
- * mana.chr_has_special (character, special)
+ * mana.chr_has_special(Character*, int special): bool
+ * Checks whether a character has a given special.
  */
 static int chr_has_special(lua_State *s)
 {
@@ -1695,8 +1730,8 @@ static int chr_has_special(lua_State *s)
 }
 
 /**
- * Removes a special from a character
- * mana.chr_take_special (character, special)
+ * mana.chr_take_special(Character*, int special): bool success
+ * Removes a special from a character.
  */
 static int chr_take_special(lua_State *s)
 {
@@ -1713,11 +1748,9 @@ static int chr_take_special(lua_State *s)
     return 1;
 }
 
-
-
 /**
+ * mana.chr_get_rights(Character*): int
  * Returns the rights level of a character.
- * mana.chr_get_rights (being)
  */
 static int chr_get_rights(lua_State *s)
 {
@@ -1732,8 +1765,8 @@ static int chr_get_rights(lua_State *s)
 }
 
 /**
+ * mana.exp_for_level(int level): int
  * Returns the exp total necessary to reach a specific skill level.
- * mana.exp_for_level (level)
  */
 static int exp_for_level(lua_State *s)
 {
@@ -1800,7 +1833,8 @@ static int test_tableget(lua_State *s)
 }
 
 /**
- * Returns the ID of the current map
+ * mana.get_map_id(): int
+ * Returns the id of the current map.
  */
 static int get_map_id(lua_State *s)
 {
@@ -1813,7 +1847,8 @@ static int get_map_id(lua_State *s)
 }
 
 /**
- * Returns the value of a map property
+ * mana.get_map_property(string property): string
+ * Returns the value of a map property.
  */
 static int get_map_property(lua_State *s)
 {
@@ -1836,7 +1871,7 @@ static int get_map_property(lua_State *s)
 }
 
 /**
- * bool mana.is_walkable(int x, int y)
+ * mana.is_walkable(int x, int y): bool
  * Returns whether the pixel on the map is walkable.
  */
 static int is_walkable(lua_State *s)
@@ -1865,8 +1900,8 @@ static int is_walkable(lua_State *s)
 }
 
 /**
- * Creates an item stack on the floor
- * mana.drop_item(x, y, id[, number])
+ * mana.drop_item(int x, int y, int id[, int number]): void
+ * Creates an item stack on the floor.
  */
 static int item_drop(lua_State *s)
 {
@@ -1896,7 +1931,8 @@ static int item_drop(lua_State *s)
 }
 
 /**
- * Logs the given message to the log
+ * mana.log(int log_level, string log_message): void
+ * Logs the given message to the log.
  */
 static int log(lua_State *s)
 {
@@ -1912,7 +1948,9 @@ static int log(lua_State *s)
 }
 
 /**
- * Gets the distance between two beings or two points
+ * mana.get_distance(Being*, Being*): int
+ * mana.get_distance(int x1, int y1, int x2, int y2): int
+ * Gets the distance between two beings or two points.
  */
 static int get_distance(lua_State *s)
 {
@@ -2029,7 +2067,7 @@ LuaScript::LuaScript():
         { "posX",                            &posX                            },
         { "posY",                            &posY                            },
         { "trigger_create",                  &trigger_create                  },
-        { "chatmessage",                     &chatmessage                     },
+        { "chat_message",                    &chat_message                    },
         { "get_beings_in_circle",            &get_beings_in_circle            },
         { "get_beings_in_rectangle",         &get_beings_in_rectangle         },
         { "being_register",                  &being_register                  },