From 2622a8622ae94500cfab59ec8599e9348891c8f8 Mon Sep 17 00:00:00 2001 From: Mattes D Date: Mon, 12 Sep 2016 23:21:15 +0200 Subject: APIDump: Reformatted the docs to include type information. Also fixed a bit of documentation in the CPP source. --- src/Item.h | 4 ++-- src/Mobs/Monster.h | 2 +- src/World.h | 3 ++- 3 files changed, 5 insertions(+), 4 deletions(-) (limited to 'src') diff --git a/src/Item.h b/src/Item.h index fb52c75fa..8d0e9d9a0 100644 --- a/src/Item.h +++ b/src/Item.h @@ -197,8 +197,8 @@ public: /** Returns the enchantability of the item. When the item hasn't a enchantability, it will returns 0 */ int GetEnchantability(); // tolua_export - /** Enchants the item using the specified number of XP levels. - Returns true if item enchanted, false if not. */ + /** Randomly enchants the item using the specified number of XP levels. + Returns true if the item was enchanted, false if not (not enchantable / too many enchantments already). */ bool EnchantByXPLevels(int a_NumXPLevels); // tolua_export // tolua_begin diff --git a/src/Mobs/Monster.h b/src/Mobs/Monster.h index 2155a4a7c..03382e28e 100644 --- a/src/Mobs/Monster.h +++ b/src/Mobs/Monster.h @@ -62,7 +62,7 @@ public: virtual void HandleFalling(void) override; - /** Engage pathfinder and tell it to calculate a path to a given position, and move the mobile accordingly + /** Engage pathfinder and tell it to calculate a path to a given position, and move the mob accordingly Currently, the mob will only start moving to a new position after the position it is currently going to is reached. */ virtual void MoveToPosition(const Vector3d & a_Position); // tolua_export diff --git a/src/World.h b/src/World.h index a33831eb9..de34af1d2 100644 --- a/src/World.h +++ b/src/World.h @@ -477,7 +477,8 @@ public: bool DigBlock (int a_X, int a_Y, int a_Z); virtual void SendBlockTo(int a_X, int a_Y, int a_Z, cPlayer * a_Player) override; - /** Set default spawn at the given coordinates. */ + /** Set default spawn at the given coordinates. + Returns false if the new spawn couldn't be stored in the INI file. */ bool SetSpawn(double a_X, double a_Y, double a_Z); double GetSpawnX(void) const { return m_SpawnX; } -- cgit v1.2.3