yolinlin/mod-ale
1
0
Fork 0
mirror of https://github.com/azerothcore/mod-ale synced 2025-11-29 15:38:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of https://github.com/elunaluaengine/eluna

Browse Source
This commit is contained in:
Foereaper
2014-12-22 04:55:08 +01:00
parent 7ce8db73b9 bce49b99e2
commit 8238ac05ca
10 changed files with 594 additions and 444 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
BattleGroundMethods.h
View File

@@ -7,10 +7,13 @@
#ifndef BATTLEGROUNDMETHODS_H
#define BATTLEGROUNDMETHODS_H
/***
* Contains the state of a battleground, e.g. Warsong Gulch, Arathi Basin, etc.
*/
namespace LuaBattleGround
{
/**
* Returns the name of the [Battleground]
* Returns the name of the [BattleGround].
*
* @return string name
*/
@@ -21,7 +24,7 @@ namespace LuaBattleGround
}
/**
* Returns the amount of alive players in the [Battleground] by the team ID.
* Returns the amount of alive players in the [BattleGround] by the team ID.
*
* @param uint32 team : team ID
* @return uint32 count
@@ -35,7 +38,7 @@ namespace LuaBattleGround
}
/**
* Returns the [Map] of the [Battleground].
* Returns the [Map] of the [BattleGround].
*
* @return [Map] map
*/
@@ -46,7 +49,7 @@ namespace LuaBattleGround
}
/**
* Returns the bonus honor given by amount of kills in the specific [Battleground].
* Returns the bonus honor given by amount of kills in the specific [BattleGround].
*
* @param uint32 kills : amount of kills
* @return uint32 bonusHonor
@@ -60,7 +63,7 @@ namespace LuaBattleGround
}
/**
* Returns the bracket ID of the specific [Battleground].
* Returns the bracket ID of the specific [BattleGround].
*
* @return BattleGroundBracketId bracketId
*/
@@ -71,7 +74,7 @@ namespace LuaBattleGround
}
/**
* Returns the end time of the [Battleground].
* Returns the end time of the [BattleGround].
*
* @return uint32 endTime
*/
@@ -86,7 +89,7 @@ namespace LuaBattleGround
}
/**
* Returns the amount of free slots for the selected team in the specific [Battleground].
* Returns the amount of free slots for the selected team in the specific [BattleGround].
*
* @param uint32 team : team ID
* @return uint32 freeSlots
@@ -100,7 +103,7 @@ namespace LuaBattleGround
}
/**
* Returns the instance ID of the [Battleground].
* Returns the instance ID of the [BattleGround].
*
* @return uint32 instanceId
*/
@@ -111,7 +114,7 @@ namespace LuaBattleGround
}
/**
* Returns the map ID of the [Battleground].
* Returns the map ID of the [BattleGround].
*
* @return uint32 mapId
*/
@@ -122,7 +125,7 @@ namespace LuaBattleGround
}
/**
* Returns the type ID of the [Battleground].
* Returns the type ID of the [BattleGround].
*
* @return BattleGroundTypeId typeId
*/
@@ -133,7 +136,7 @@ namespace LuaBattleGround
}
/**
* Returns the max allowed [Player] level of the specific [Battleground].
* Returns the max allowed [Player] level of the specific [BattleGround].
*
* @return uint32 maxLevel
*/
@@ -144,7 +147,7 @@ namespace LuaBattleGround
}
/**
* Returns the minimum allowed [Player] level of the specific [Battleground].
* Returns the minimum allowed [Player] level of the specific [BattleGround].
*
* @return uint32 minLevel
*/
@@ -155,7 +158,7 @@ namespace LuaBattleGround
}
/**
* Returns the maximum allowed [Player] count of the specific [Battleground].
* Returns the maximum allowed [Player] count of the specific [BattleGround].
*
* @return uint32 maxPlayerCount
*/
@@ -166,7 +169,7 @@ namespace LuaBattleGround
}
/**
* Returns the minimum allowed [Player] count of the specific [Battleground].
* Returns the minimum allowed [Player] count of the specific [BattleGround].
*
* @return uint32 minPlayerCount
*/
@@ -177,7 +180,7 @@ namespace LuaBattleGround
}
/**
* Returns the maximum allowed [Player] count per team of the specific [Battleground].
* Returns the maximum allowed [Player] count per team of the specific [BattleGround].
*
* @return uint32 maxTeamPlayerCount
*/
@@ -188,7 +191,7 @@ namespace LuaBattleGround
}
/**
* Returns the minimum allowed [Player] count per team of the specific [Battleground].
* Returns the minimum allowed [Player] count per team of the specific [BattleGround].
*
* @return uint32 minTeamPlayerCount
*/
@@ -199,7 +202,7 @@ namespace LuaBattleGround
}
/**
* Returns the winning team of the specific [Battleground].
* Returns the winning team of the specific [BattleGround].
*
* @return Team team
*/
@@ -210,7 +213,7 @@ namespace LuaBattleGround
}
/**
* Returns the status of the specific [Battleground].
* Returns the status of the specific [BattleGround].
*
* @return BattleGroundStatus status
*/

19
CorpseMethods.h
View File

@@ -7,10 +7,13 @@
#ifndef CORPSEMETHODS_H
#define CORPSEMETHODS_H
/***
* The remains of a [Player] that has died.
*/
namespace LuaCorpse
{
/**
* Returns the [Corpse] Owner GUID.
* Returns the GUID of the [Player] that left the [Corpse] behind.
*
* @return uint64 ownerGUID
*/
@@ -25,7 +28,7 @@ namespace LuaCorpse
}
/**
* Returns the ghost time of a [Corpse].
* Returns the time when the [Player] became a ghost and spawned this [Corpse].
*
* @return uint32 ghostTime
*/
@@ -38,14 +41,12 @@ namespace LuaCorpse
/**
* Returns the [CorpseType] of a [Corpse].
*
* <pre>
* enum CorpseType
* {
* CORPSE_BONES = 0,
* CORPSE_RESURRECTABLE_PVE = 1,
* CORPSE_RESURRECTABLE_PVP = 2
* };
* </pre>
*
* @return [CorpseType] corpseType
*/
@@ -56,8 +57,9 @@ namespace LuaCorpse
}
/**
* Resets the [Corpse] ghost time.
* Sets the "ghost time" to the current time.
*
* See [Corpse:GetGhostTime].
*/
int ResetGhostTime(Eluna* /*E*/, lua_State* /*L*/, Corpse* corpse)
{
@@ -67,7 +69,6 @@ namespace LuaCorpse
/**
* Saves the [Corpse] to the database.
*
*/
int SaveToDB(Eluna* /*E*/, lua_State* /*L*/, Corpse* corpse)
{
@@ -78,9 +79,15 @@ namespace LuaCorpse
/**
* Deletes the [Corpse] from the world.
*
* If the [Corpse]'s type is not BONES then this does nothing.
*/
int DeleteBonesFromWorld(Eluna* /*E*/, lua_State* /*L*/, Corpse* corpse)
{
// Prevent a failed assertion.
if (corpse->GetType() != CORPSE_BONES)
{
return 0;
}
corpse->DeleteBonesFromWorld();
return 0;
}

4
CreatureMethods.h
View File

@@ -8,9 +8,9 @@
#define CREATUREMETHODS_H
/***
* Non-[Player] controlled [Unit]s.
* Non-[Player] controlled [Unit]s (i.e. NPCs).
*
* Inherits [Object], [WorldObject], [Unit]
* Inherits all [Object], [WorldObject], and [Unit] methods.
*/
namespace LuaCreature
{

4
ElunaIncludes.h
View File

@@ -61,6 +61,10 @@
typedef Opcodes OpcodesList;
#endif
/*
* Note: if you add or change a CORE_NAME #define,
* please update LuaGlobalFunctions::GetCoreName docstring.
*/
#ifdef MANGOS
#define CORE_NAME "MaNGOS"
#define CORE_VERSION REVISION_NR

183
ElunaQueryMethods.h
View File

@@ -12,19 +12,31 @@
#else
#define RESULT (*result)
#endif
/***
* The result of a database query.
*
* E.g. the return value of [Global:WorldDBQuery].
*/
namespace LuaQuery
{
void CheckFields(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
static void CheckFields(lua_State* L, ElunaQuery* result)
{
if (Eluna::CHECKVAL<uint32>(L, 2) >= RESULT->GetFieldCount())
luaL_argerror(L, 2, "invalid field index");
}
/* BOOLEAN */
int IsNull(Eluna* E, lua_State* L, ElunaQuery* result)
/**
* Returns `true` if the specified column of the current row is `NULL`, otherwise `false`.
*
* @param uint32 column
* @return bool isNull
*/
int IsNull(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
{
uint32 col = Eluna::CHECKVAL<uint32>(L, 2);
CheckFields(E, L, result);
CheckFields(L, result);
#ifndef TRINITY
Eluna::Push(L, RESULT->Fetch()[col].IsNULL());
@@ -35,126 +47,195 @@ namespace LuaQuery
}
/* GETTERS */
/**
* Returns the number of columns in the result set.
*
* @return uint32 columnCount
*/
int GetColumnCount(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
{
Eluna::Push(L, RESULT->GetFieldCount());
return 1;
}
/**
* Returns the number of rows in the result set.
*
* @return uint32 rowCount
*/
int GetRowCount(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
{
if (RESULT->GetRowCount() > (uint32)-1)
Eluna::Push(L, (uint32)-1);
else
Eluna::Push(L, RESULT->GetRowCount());
Eluna::Push(L, (uint32)(RESULT->GetRowCount()));
return 1;
}
int GetBool(Eluna* E, lua_State* L, ElunaQuery* result)
/**
* Returns the data in the specified column of the current row, casted to a boolean.
*
* @param uint32 column
* @return bool data
*/
int GetBool(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
{
uint32 col = Eluna::CHECKVAL<uint32>(L, 2);
CheckFields(E, L, result);
CheckFields(L, result);
Eluna::Push(L, RESULT->Fetch()[col].GetBool());
return 1;
}
int GetUInt8(Eluna* E, lua_State* L, ElunaQuery* result)
/**
* Returns the data in the specified column of the current row, casted to an unsigned 8-bit integer.
*
* @param uint32 column
* @return uint8 data
*/
int GetUInt8(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
{
uint32 col = Eluna::CHECKVAL<uint32>(L, 2);
CheckFields(E, L, result);
CheckFields(L, result);
Eluna::Push(L, RESULT->Fetch()[col].GetUInt8());
return 1;
}
int GetUInt16(Eluna* E, lua_State* L, ElunaQuery* result)
/**
* Returns the data in the specified column of the current row, casted to an unsigned 16-bit integer.
*
* @param uint32 column
* @return uint16 data
*/
int GetUInt16(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
{
uint32 col = Eluna::CHECKVAL<uint32>(L, 2);
CheckFields(E, L, result);
CheckFields(L, result);
Eluna::Push(L, RESULT->Fetch()[col].GetUInt16());
return 1;
}
int GetUInt32(Eluna* E, lua_State* L, ElunaQuery* result)
/**
* Returns the data in the specified column of the current row, casted to an unsigned 32-bit integer.
*
* @param uint32 column
* @return uint32 data
*/
int GetUInt32(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
{
uint32 col = Eluna::CHECKVAL<uint32>(L, 2);
CheckFields(E, L, result);
CheckFields(L, result);
Eluna::Push(L, RESULT->Fetch()[col].GetUInt32());
return 1;
}
int GetUInt64(Eluna* E, lua_State* L, ElunaQuery* result)
/**
* Returns the data in the specified column of the current row, casted to an unsigned 64-bit integer.
*
* @param uint32 column
* @return uint64 data
*/
int GetUInt64(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
{
uint32 col = Eluna::CHECKVAL<uint32>(L, 2);
CheckFields(E, L, result);
CheckFields(L, result);
Eluna::Push(L, RESULT->Fetch()[col].GetUInt64());
return 1;
}
int GetInt8(Eluna* E, lua_State* L, ElunaQuery* result)
/**
* Returns the data in the specified column of the current row, casted to a signed 8-bit integer.
*
* @param uint32 column
* @return int8 data
*/
int GetInt8(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
{
uint32 col = Eluna::CHECKVAL<uint32>(L, 2);
CheckFields(E, L, result);
CheckFields(L, result);
Eluna::Push(L, RESULT->Fetch()[col].GetInt8());
return 1;
}
int GetInt16(Eluna* E, lua_State* L, ElunaQuery* result)
/**
* Returns the data in the specified column of the current row, casted to a signed 16-bit integer.
*
* @param uint32 column
* @return int16 data
*/
int GetInt16(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
{
uint32 col = Eluna::CHECKVAL<uint32>(L, 2);
CheckFields(E, L, result);
CheckFields(L, result);
Eluna::Push(L, RESULT->Fetch()[col].GetInt16());
return 1;
}
int GetInt32(Eluna* E, lua_State* L, ElunaQuery* result)
/**
* Returns the data in the specified column of the current row, casted to a signed 32-bit integer.
*
* @param uint32 column
* @return int32 data
*/
int GetInt32(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
{
uint32 col = Eluna::CHECKVAL<uint32>(L, 2);
CheckFields(E, L, result);
CheckFields(L, result);
Eluna::Push(L, RESULT->Fetch()[col].GetInt32());
return 1;
}
int GetInt64(Eluna* E, lua_State* L, ElunaQuery* result)
/**
* Returns the data in the specified column of the current row, casted to a signed 64-bit integer.
*
* @param uint32 column
* @return int64 data
*/
int GetInt64(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
{
uint32 col = Eluna::CHECKVAL<uint32>(L, 2);
CheckFields(E, L, result);
CheckFields(L, result);
Eluna::Push(L, RESULT->Fetch()[col].GetInt64());
return 1;
}
int GetFloat(Eluna* E, lua_State* L, ElunaQuery* result)
/**
* Returns the data in the specified column of the current row, casted to a 32-bit floating point value.
*
* @param uint32 column
* @return float data
*/
int GetFloat(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
{
uint32 col = Eluna::CHECKVAL<uint32>(L, 2);
CheckFields(E, L, result);
CheckFields(L, result);
Eluna::Push(L, RESULT->Fetch()[col].GetFloat());
return 1;
}
int GetDouble(Eluna* E, lua_State* L, ElunaQuery* result)
/**
* Returns the data in the specified column of the current row, casted to a 64-bit floating point value.
*
* @param uint32 column
* @return double data
*/
int GetDouble(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
{
uint32 col = Eluna::CHECKVAL<uint32>(L, 2);
CheckFields(E, L, result);
CheckFields(L, result);
Eluna::Push(L, RESULT->Fetch()[col].GetDouble());
return 1;
}
int GetString(Eluna* E, lua_State* L, ElunaQuery* result)
/**
* Returns the data in the specified column of the current row, casted to a string.
*
* @param uint32 column
* @return string data
*/
int GetString(Eluna* /*E*/, lua_State* L, ElunaQuery* result)
{
uint32 col = Eluna::CHECKVAL<uint32>(L, 2);
CheckFields(E, L, result);
#ifndef TRINITY
Eluna::Push(L, RESULT->Fetch()[col].GetCppString());
#else
Eluna::Push(L, RESULT->Fetch()[col].GetString());
#endif
return 1;
}
int GetCString(Eluna* E, lua_State* L, ElunaQuery* result)
{
uint32 col = Eluna::CHECKVAL<uint32>(L, 2);
CheckFields(E, L, result);
CheckFields(L, result);
#ifndef TRINITY
Eluna::Push(L, RESULT->Fetch()[col].GetString());
@@ -167,8 +248,11 @@ namespace LuaQuery
/* OTHER */
/**
* Advances the ElunaQuery to the next row in the result returned.
* Returns false if there was no new row, otherwise true.
* Advances the [ElunaQuery] to the next row in the result set.
*
* *Do not* call this immediately after a query, or you'll skip the first row.
*
* Returns `false` if there was no new row, otherwise `true`.
*
* @return bool hadNextRow
*/
@@ -180,9 +264,18 @@ namespace LuaQuery
/**
* Returns a table from the current row where keys are field names and values are the row's values.
*
* All numerical values will be numbers and everything else is returned as a string.
* For example `SELECT entry, name FROM creature_template` would result in a table of `{ entry = 123, name = "some creature name" }`
* To move to next row see [ElunaQuery:NextRow]
*
* **For example,** the query:
*
* SELECT entry, name FROM creature_template
*
* would result in a table like:
*
* { entry = 123, name = "some creature name" }
*
* To move to next row use [ElunaQuery:NextRow].
*
* @return table rowData : table filled with row columns and data where `T[column] = data`
*/

416
GlobalMethods.h
View File

@@ -7,10 +7,15 @@
#ifndef GLOBALMETHODS_H
#define GLOBALMETHODS_H
/***
* These functions can be used anywhere at any time, including at start-up.
*/
namespace LuaGlobalFunctions
{
/**
* Returns lua engine name. Currently `ElunaEngine`
* Returns Lua engine's name.
*
* Always returns "ElunaEngine" on Eluna.
*
* @return string engineName
*/
@@ -21,8 +26,9 @@ namespace LuaGlobalFunctions
}
/**
* Returns emulator / core name.
* For example `MaNGOS`, `cMaNGOS` or `TrinityCore`
* Returns emulator's name.
*
* The result will be either `MaNGOS`, `cMaNGOS`, or `TrinityCore`.
*
* @return string coreName
*/
@@ -35,9 +41,8 @@ namespace LuaGlobalFunctions
/**
* Returns emulator version
*
* * For TrinityCore returns for example `2014-08-13 17:27:22 +0300`
* * For cMaNGOS returns for example `12708`
* * For MaNGOS returns for example `20002`
* - For TrinityCore returns the date of the last revision, e.g. `2014-08-13 17:27:22 +0300`
* - For cMaNGOS/MaNGOS returns the revision number, e.g. `12708`
*
* @return string version
*/
@@ -48,9 +53,11 @@ namespace LuaGlobalFunctions
}
/**
* Returns emulator expansion. Expansion is 0 for classic, 1 for TBC, 2 for WOTLK and 3 for cataclysm
* Returns emulator's supported expansion.
*
* @return int32 version : emulator expansion ID
* Expansion is 0 for pre-TBC, 1 for TBC, 2 for WotLK, and 3 for Cataclysm.
*
* @return int32 expansion
*/
int GetCoreExpansion(Eluna* /*E*/, lua_State* L)
{
@@ -120,14 +127,12 @@ namespace LuaGlobalFunctions
/**
* Returns a table with all the current [Player]s in the world
*
* <pre>
* enum TeamId
* {
* TEAM_ALLIANCE = 0,
* TEAM_HORDE = 1,
* TEAM_NEUTRAL = 2
* };
* </pre>
*
* @param [TeamId] team = TEAM_NEUTRAL : optional check team of the [Player], Alliance, Horde or Neutral (All)
* @param bool onlyGM = false : optional check if GM only
@@ -168,14 +173,12 @@ namespace LuaGlobalFunctions
/**
* Returns a table with all the current [Player]s in a map
*
* <pre>
* enum TeamId
* {
* TEAM_ALLIANCE = 0,
* TEAM_HORDE = 1,
* TEAM_NEUTRAL = 2
* };
* </pre>
*
* @param uint32 mapId : the [Map] entry ID
* @param uint32 instanceId : the instance ID to search in the map
@@ -220,10 +223,10 @@ namespace LuaGlobalFunctions
}
/**
* Returns [Guild] by name
* Returns a [Guild] by name.
*
* @param string name : the name of a guild
* @return [Guild] guild
* @param string name
* @return [Guild] guild : the Guild, or `nil` if it doesn't exist
*/
int GetGuildByName(Eluna* /*E*/, lua_State* L)
{
@@ -233,16 +236,16 @@ namespace LuaGlobalFunctions
}
/**
* Returns [Map] by ID
* Returns a [Map] by ID.
*
* @param uint32 mapId : the [Map] ID
* @param uint32 instanceId : instance ID to search, use 0 if not instance
* @return [Map] map
* @param uint32 mapId : see [Map.dbc](https://github.com/cmangos/issues/wiki/Map.dbc)
* @param uint32 instanceId = 0 : required if the map is an instance, otherwise don't pass anything
* @return [Map] map : the Map, or `nil` if it doesn't exist
*/
int GetMapById(Eluna* /*E*/, lua_State* L)
{
uint32 mapid = Eluna::CHECKVAL<uint32>(L, 1);
uint32 instance = Eluna::CHECKVAL<uint32>(L, 2);
uint32 instance = Eluna::CHECKVAL<uint32>(L, 2, 0);
Eluna::Push(L, eMapMgr->FindMap(mapid, instance));
return 1;
@@ -252,7 +255,7 @@ namespace LuaGlobalFunctions
* Returns [Guild] by the leader's GUID
*
* @param uint64 guid : the guid of a [Guild] leader
* @return [Guild] guild
* @return [Guild] guild, or `nil` if it doesn't exist
*/
int GetGuildByLeaderGUID(Eluna* /*E*/, lua_State* L)
{
@@ -263,7 +266,7 @@ namespace LuaGlobalFunctions
}
/**
* Returns the amount of [Player]s in the world
* Returns the amount of [Player]s in the world.
*
* @return uint32 count
*/
@@ -274,8 +277,10 @@ namespace LuaGlobalFunctions
}
/**
* Returns a [Player]'s GUID
* Builds a [Player]'s GUID
*
* [Player] GUID consist of low GUID and type ID
*
* [Player] and [Creature] for example can have the same low GUID but not GUID.
*
* @param uint32 lowguid : low GUID of the [Player]
@@ -289,7 +294,8 @@ namespace LuaGlobalFunctions
}
/**
* Returns an [Item]'s GUID
* Builds an [Item]'s GUID.
*
* [Item] GUID consist of low GUID and type ID
* [Player] and [Item] for example can have the same low GUID but not GUID.
*
@@ -304,9 +310,11 @@ namespace LuaGlobalFunctions
}
/**
* Returns a [GameObject]'s GUID
* [GameObject] GUID consist of entry ID, low GUID and type ID
* [Player] and [GameObject] for example can have the same low GUID but not GUID.
* Builds a [GameObject]'s GUID.
*
* A GameObject's GUID consist of entry ID, low GUID and type ID
*
* A [Player] and GameObject for example can have the same low GUID but not GUID.
*
* @param uint32 lowguid : low GUID of the [GameObject]
* @param uint32 entry : entry ID of the [GameObject]
@@ -321,8 +329,10 @@ namespace LuaGlobalFunctions
}
/**
* Returns a [Creature]'s GUID.
* Builds a [Creature]'s GUID.
*
* [Creature] GUID consist of entry ID, low GUID and type ID
*
* [Player] and [Creature] for example can have the same low GUID but not GUID.
*
* @param uint32 lowguid : low GUID of the [Creature]
@@ -339,9 +349,13 @@ namespace LuaGlobalFunctions
/**
* Returns the low GUID from a GUID.
*
* Low GUID is an ID to distinct the objects of the same type.
* Creatures in instances are also assigned new GUIDs when the Map is created.
*
* [Player] and [Creature] for example can have the same low GUID but not GUID.
* GUID consist of entry ID, low GUID and type ID
*
* A GUID consists of a low GUID, type ID, and possibly an entry ID depending on the type ID.
*
* @param uint64 guid : GUID of an [Object]
* @return uint32 lowguid : low GUID of the [Object]
@@ -355,9 +369,8 @@ namespace LuaGlobalFunctions
}
/**
* Returns an item chat link for given entry
* Returns an chat link for an [Item].
*
* <pre>
* enum LocaleConstant
* {
* LOCALE_enUS = 0,
@@ -370,7 +383,6 @@ namespace LuaGlobalFunctions
* LOCALE_esMX = 7,
* LOCALE_ruRU = 8
* };
* </pre>
*
* @param uint32 entry : entry ID of an [Item]
* @param [LocaleConstant] locale = DEFAULT_LOCALE : locale to return the [Item] name in
@@ -405,8 +417,10 @@ namespace LuaGlobalFunctions
/**
* Returns the type ID from a GUID.
* Type ID is different for each type ([Player], [Creature], [GameObject]...)
* GUID consist of entry ID, low GUID and type ID
*
* Type ID is different for each type ([Player], [Creature], [GameObject], etc.).
*
* GUID consist of entry ID, low GUID, and type ID.
*
* @param uint64 guid : GUID of an [Object]
* @return uint32 typeId : type ID of the [Object]
@@ -420,12 +434,11 @@ namespace LuaGlobalFunctions
/**
* Returns the entry ID from a GUID.
* Entry ID is different for each [Creature] and [GameObject].
* [Item] GUIDs dont include the entry
* GUID consist of entry ID, low GUID and type ID
*
* @param uint64 guid : GUID of an [Creature] or [GameObject], otherwise returns 0
* @return uint32 entry : entry ID of the [Creature] or [GameObject]
* GUID consist of entry ID, low GUID, and type ID.
*
* @param uint64 guid : GUID of an [Creature] or [GameObject]
* @return uint32 entry : entry ID, or `0` if `guid` is not a [Creature] or [GameObject]
*/
int GetGUIDEntry(Eluna* /*E*/, lua_State* L)
{
@@ -435,9 +448,8 @@ namespace LuaGlobalFunctions
}
/**
* Returns the area's or zone's name
* Returns the area or zone's name.
*
* <pre>
* enum LocaleConstant
* {
* LOCALE_enUS = 0,
@@ -450,7 +462,6 @@ namespace LuaGlobalFunctions
* LOCALE_esMX = 7,
* LOCALE_ruRU = 8
* };
* </pre>
*
* @param uint32 areaOrZoneId : area ID or zone ID
* @param [LocaleConstant] locale = DEFAULT_LOCALE : locale to return the name in
@@ -471,7 +482,7 @@ namespace LuaGlobalFunctions
return 1;
}
void RegisterEntryHelper(Eluna* E, lua_State* L, int regtype)
static void RegisterEntryHelper(Eluna* E, lua_State* L, int regtype)
{
uint32 entry = Eluna::CHECKVAL<uint32>(L, 1);
uint32 ev = Eluna::CHECKVAL<uint32>(L, 2);
@@ -486,7 +497,7 @@ namespace LuaGlobalFunctions
luaL_argerror(L, 3, "unable to make a ref to function");
}
void RegisterEventHelper(Eluna* E, lua_State* L, int regtype)
static void RegisterEventHelper(Eluna* E, lua_State* L, int regtype)
{
uint32 ev = Eluna::CHECKVAL<uint32>(L, 1);
luaL_checktype(L, 2, LUA_TFUNCTION);
@@ -501,9 +512,8 @@ namespace LuaGlobalFunctions
}
/**
* Registers a server event
* Registers a server event handler.
*
* <pre>
* enum ServerEvents
* {
* // Server
@@ -558,10 +568,9 @@ namespace LuaGlobalFunctions
*
* SERVER_EVENT_COUNT
* };
* </pre>
*
* @param uint32 event : server event Id, refer to ServerEvents above
* @param function function : function to register
* @param uint32 event : server event ID, refer to ServerEvents above
* @param function function : function that will be called when the event occurs
* @param uint32 shots = 0 : the number of times the function will be called, 0 means "always call this function"
*/
int RegisterServerEvent(Eluna* E, lua_State* L)
@@ -571,7 +580,7 @@ namespace LuaGlobalFunctions
}
/**
* Registers a [Player] event
* Registers a [Player] event handler.
*
* <pre>
* enum PlayerEvents
@@ -636,7 +645,7 @@ namespace LuaGlobalFunctions
}
/**
* Registers a [Guild] event
* Registers a [Guild] event handler.
*
* <pre>
* enum GuildEvents
@@ -669,7 +678,7 @@ namespace LuaGlobalFunctions
}
/**
* Registers a [Group] event
* Registers a [Group] event handler.
*
* <pre>
* enum GroupEvents
@@ -697,7 +706,7 @@ namespace LuaGlobalFunctions
}
/**
* Registers a [Battleground] event
* Registers a [BattleGround] event handler.
*
* <pre>
* enum BGEvents
@@ -721,7 +730,7 @@ namespace LuaGlobalFunctions
}
/**
* Registers a packet event
* Registers a [WorldPacket] event handler.
*
* <pre>
* enum PacketEvents
@@ -746,7 +755,7 @@ namespace LuaGlobalFunctions
}
/**
* Registers a [Creature] gossip event
* Registers a [Creature] gossip event handler.
*
* <pre>
* enum GossipEvents
@@ -769,7 +778,7 @@ namespace LuaGlobalFunctions
}
/**
* Registers a [GameObject] gossip event
* Registers a [GameObject] gossip event handler.
*
* <pre>
* enum GossipEvents
@@ -792,7 +801,7 @@ namespace LuaGlobalFunctions
}
/**
* Registers an [Item] event
* Registers an [Item] event handler.
*
* <pre>
* enum ItemEvents
@@ -818,7 +827,7 @@ namespace LuaGlobalFunctions
}
/**
* Registers an [Item] gossip event
* Registers an [Item] gossip event handler.
*
* <pre>
* enum GossipEvents
@@ -841,7 +850,7 @@ namespace LuaGlobalFunctions
}
/**
* Registers a [Player] gossip event
* Registers a [Player] gossip event handler.
*
* <pre>
* enum GossipEvents
@@ -864,7 +873,7 @@ namespace LuaGlobalFunctions
}
/**
* Registers a [Creature] event
* Registers a [Creature] event handler.
*
* <pre>
* enum CreatureEvents
@@ -922,7 +931,7 @@ namespace LuaGlobalFunctions
}
/**
* Registers a [GameObject] event
* Registers a [GameObject] event handler.
*
* <pre>
* enum GameObjectEvents
@@ -956,8 +965,7 @@ namespace LuaGlobalFunctions
}
/**
* Reloads the Lua Engine
*
* Reloads the Lua engine.
*/
int ReloadEluna(Eluna* /*E*/, lua_State* /*L*/)
{
@@ -966,7 +974,7 @@ namespace LuaGlobalFunctions
}
/**
* Sends a message to the world
* Sends a message to all [Player]s online.
*
* @param string message : message to send
*/
@@ -978,10 +986,13 @@ namespace LuaGlobalFunctions
}
/**
* Executes an sql to your world database instantly and returns [ElunaQuery]
* Executes a SQL query on the world database and returns an [ElunaQuery].
*
* @param string sql : sql to run
* @return [ElunaQuery] result
* The query is always executed synchronously
* (i.e. when this function returns the query has already been executed).
*
* @param string sql : query to execute
* @return [ElunaQuery] results
*/
int WorldDBQuery(Eluna* /*E*/, lua_State* L)
{
@@ -1004,9 +1015,15 @@ namespace LuaGlobalFunctions
}
/**
* Executes an sql to your character database. The SQL is not ran instantly.
* Executes a SQL query on the world database.
*
* @param string sql : sql [ElunaQuery] to execute
* The query may be executed *asynchronously* (at a later, unpredictable time).
* If you need to execute the query synchronously, use [Global:WorldDBQuery] instead.
*
* Any results produced are ignored.
* If you need results from the query, use [Global:WorldDBQuery] instead.
*
* @param string sql : query to execute
*/
int WorldDBExecute(Eluna* /*E*/, lua_State* L)
{
@@ -1016,10 +1033,13 @@ namespace LuaGlobalFunctions
}
/**
* Executes an sql to your character database instantly and returns [ElunaQuery]
* Executes a SQL query on the character database and returns an [ElunaQuery].
*
* @param string sql : sql to run
* @return [ElunaQuery] result
* The query is always executed synchronously
* (i.e. when this function returns the query has already been executed).
*
* @param string sql : query to execute
* @return [ElunaQuery] results
*/
int CharDBQuery(Eluna* /*E*/, lua_State* L)
{
@@ -1042,9 +1062,15 @@ namespace LuaGlobalFunctions
}
/**
* Executes an sql to your character database. The SQL is not ran instantly.
* Executes a SQL query on the character database.
*
* @param string sql : sql to run
* The query may be executed *asynchronously* (at a later, unpredictable time).
* If you need to execute the query synchronously, use [Global:WorldDBQuery] instead.
*
* Any results produced are ignored.
* If you need results from the query, use [Global:WorldDBQuery] instead.
*
* @param string sql : query to execute
*/
int CharDBExecute(Eluna* /*E*/, lua_State* L)
{
@@ -1054,10 +1080,13 @@ namespace LuaGlobalFunctions
}
/**
* Executes an sql to your auth database instantly and returns [ElunaQuery]
* Executes a SQL query on the login database and returns an [ElunaQuery].
*
* @param string sql : sql to run
* @return [ElunaQuery] result
* The query is always executed synchronously
* (i.e. when this function returns the query has already been executed).
*
* @param string sql : query to execute
* @return [ElunaQuery] results
*/
int AuthDBQuery(Eluna* /*E*/, lua_State* L)
{
@@ -1080,9 +1109,15 @@ namespace LuaGlobalFunctions
}
/**
* Executes an sql to your auth database. The SQL is not ran instantly.
* Executes a SQL query on the login database.
*
* @param string sql : sql to run
* The query may be executed *asynchronously* (at a later, unpredictable time).
* If you need to execute the query synchronously, use [Global:WorldDBQuery] instead.
*
* Any results produced are ignored.
* If you need results from the query, use [Global:WorldDBQuery] instead.
*
* @param string sql : query to execute
*/
int AuthDBExecute(Eluna* /*E*/, lua_State* L)
{
@@ -1092,8 +1127,10 @@ namespace LuaGlobalFunctions
}
/**
* Registers a global timed event
* Registers a global timed event.
*
* When the passed function is called, the parameters `(eventId, delay, repeats)` are passed to it.
*
* Repeats will decrease on each call if the event does not repeat indefinitely
*
* @param function function : function to trigger when the time has passed
@@ -1118,7 +1155,7 @@ namespace LuaGlobalFunctions
}
/**
* Removes a global timed event specified by the event ID
* Removes a global timed event specified by ID.
*
* @param int eventId : event Id to remove
* @param bool all_Events = false : remove from all events, not just global
@@ -1137,7 +1174,7 @@ namespace LuaGlobalFunctions
}
/**
* Removes all global timed events
* Removes all global timed events.
*
* @param bool all_Events = false : remove all events, not just global
*/
@@ -1154,7 +1191,7 @@ namespace LuaGlobalFunctions
}
/**
* Performs an ingame spawn and returns [Creature] or [GameObject] dependent on spawnType
* Performs an in-game spawn and returns the [Creature] or [GameObject] spawned.
*
* @param int32 spawnType : type of object to spawn, 1 = [Creature], 2 = [GameObject]
* @param uint32 entry : entry ID of the [Creature] or [GameObject]
@@ -1484,10 +1521,10 @@ namespace LuaGlobalFunctions
}
/**
* Creates a [WorldPacket]
* Creates a [WorldPacket].
*
* @param uint32 opcode : opcode to create
* @param uint32 size : size of opcode
* @param uint32 opcode : the opcode of the packet
* @param uint32 size : the size of the packet
* @return [WorldPacket] packet
*/
int CreatePacket(Eluna* /*E*/, lua_State* L)
@@ -1502,7 +1539,7 @@ namespace LuaGlobalFunctions
}
/**
* Adds an [Item] to a vendor
* Adds an [Item] to a vendor and updates the world database.
*
* @param uint32 entry : [Creature] entry Id
* @param uint32 item : [Item] entry Id
@@ -1541,7 +1578,7 @@ namespace LuaGlobalFunctions
}
/**
* Removes an [Item] from a vendor
* Removes an [Item] from a vendor and updates the database.
*
* @param uint32 entry : [Creature] entry Id
* @param uint32 item : [Item] entry Id
@@ -1562,7 +1599,7 @@ namespace LuaGlobalFunctions
}
/**
* Removes all [Item]s from a vendor
* Removes all [Item]s from a vendor and updates the database.
*
* @param uint32 entry : [Creature] entry Id
*/
@@ -1585,7 +1622,7 @@ namespace LuaGlobalFunctions
}
/**
* Kicks a [Player] from the server
* Kicks a [Player] from the server.
*
* @param [Player] player : [Player] to kick
*/
@@ -1599,14 +1636,12 @@ namespace LuaGlobalFunctions
/**
* Ban's a [Player]'s account, character or IP
*
* <pre>
* enum BanMode
* {
* BAN_ACCOUNT,
* BAN_CHARACTER,
* BAN_IP
* };
* </pre>
*
* @param int32 banMode : method of ban, refer to BanMode above
* @param string nameOrIP : name of the [Player] or IP of the [Player]
@@ -1650,8 +1685,7 @@ namespace LuaGlobalFunctions
}
/**
* Saves all [Player]s
*
* Saves all [Player]s.
*/
int SaveAllPlayers(Eluna* /*E*/, lua_State* /*L*/)
{
@@ -1660,10 +1694,11 @@ namespace LuaGlobalFunctions
}
/**
* Sends mail to a [Player]
* There can be several item entry-amount pairs at the end of the function. There can be maximum of 12 different items.
* Sends mail to a [Player].
*
* There can be several item entry-amount pairs at the end of the function.
* There can be maximum of 12 different items.
*
* <pre>
* enum MailStationery
* {
* MAIL_STATIONERY_TEST = 1,
@@ -1674,7 +1709,6 @@ namespace LuaGlobalFunctions
* MAIL_STATIONERY_CHR = 65, // Christmas
* MAIL_STATIONERY_ORP = 67 // Orphan
* };
* </pre>
*
* @param string subject : title (subject) of the mail
* @param string text : contents of the mail
@@ -1761,7 +1795,7 @@ namespace LuaGlobalFunctions
}
/**
* Returns the result of bitwise and: a & b
* Performs a bitwise AND (a & b).
*
* @param uint32 a
* @param uint32 b
@@ -1776,7 +1810,7 @@ namespace LuaGlobalFunctions
}
/**
* Returns the result of bitwise or: a | b
* Performs a bitwise OR (a | b).
*
* @param uint32 a
* @param uint32 b
@@ -1791,7 +1825,7 @@ namespace LuaGlobalFunctions
}
/**
* Returns the result of bitwise left shift: a << b
* Performs a bitwise left-shift (a << b).
*
* @param uint32 a
* @param uint32 b
@@ -1806,7 +1840,7 @@ namespace LuaGlobalFunctions
}
/**
* Returns the result of bitwise right shift: a >> b
* Performs a bitwise right-shift (a >> b).
*
* @param uint32 a
* @param uint32 b
@@ -1821,7 +1855,7 @@ namespace LuaGlobalFunctions
}
/**
* Returns the result of bitwise xor: a ^ b
* Performs a bitwise XOR (a ^ b).
*
* @param uint32 a
* @param uint32 b
@@ -1836,7 +1870,7 @@ namespace LuaGlobalFunctions
}
/**
* Returns the result of bitwise not: ~a
* Performs a bitwise NOT (~a).
*
* @param uint32 a
* @return uint32 result
@@ -1849,16 +1883,16 @@ namespace LuaGlobalFunctions
}
/**
* Adds a taxi path to a specified map, returns the used pathId
* Adds a taxi path to a specified map, returns the used pathId.
*
* Related function: [Player:StartTaxi]
*
* <pre>
* -- Execute on startup
* local pathTable = {{mapid, x, y, z}, {mapid, x, y, z}}
* local path = AddTaxiPath(pathTable, 28135, 28135)
*
* -- Execute when the player should fly
* player:StartTaxi(path)
* </pre>
*
* @param table waypoints : table containing waypoints: {map, x, y, z[, actionFlag, delay]}
* @param uint32 mountA : alliance [Creature] entry
@@ -1965,7 +1999,7 @@ namespace LuaGlobalFunctions
}
/**
* Adds a [Corpse] to the world
* Adds a [Corpse] to the world.
*
* @param [Corpse] corpse : [Corpse] to add
*/
@@ -1978,7 +2012,7 @@ namespace LuaGlobalFunctions
}
/**
* Removes a [Corpse] from the world
* Removes a [Corpse] from the world.
*
* @param [Corpse] corpse : [Corpse] to remove
*/
@@ -1991,10 +2025,10 @@ namespace LuaGlobalFunctions
}
/**
* Converts a [Corpse] by guid, also allows for insignia to be looted
* Converts a [Corpse] by GUID, and optionally allows for insignia to be looted.
*
* @param uint64 playerGUID : guid of the [Player]
* @param bool insignia = false : if true, it allows insignia to be looted
* @param uint64 playerGUID : GUID of the [Player]
* @param bool insignia = false : if `true`, allow an insignia to be looted
* @return [Corpse] corpse : returns converted [Corpse]
*/
int ConvertCorpseForPlayer(Eluna* /*E*/, lua_State* L)
@@ -2007,8 +2041,7 @@ namespace LuaGlobalFunctions
}
/**
* Removes old [Corpse]s from the world
*
* Removes old [Corpse]s from the world.
*/
int RemoveOldCorpses(Eluna* /*E*/, lua_State* /*L*/)
{
@@ -2017,7 +2050,7 @@ namespace LuaGlobalFunctions
}
/**
* Finds [Weather] in a zone, also returns [Weather]
* Gets the [Weather] for a zone.
*
* @param uint32 zoneId : zone Id to check for [Weather]
* @return [Weather] weather
@@ -2035,7 +2068,7 @@ namespace LuaGlobalFunctions
}
/**
* Adds [Weather] to a zone, also returns [Weather]
* Adds weather to a zone and returns the new [Weather] object.
*
* @param uint32 zoneId : zone Id to add [Weather]
* @return [Weather] weather
@@ -2053,7 +2086,7 @@ namespace LuaGlobalFunctions
}
/**
* Removes [Weather] from a zone
* Removes [Weather] from a zone.
*
* @param uint32 zoneId : zone Id to remove [Weather]
*/
@@ -2069,7 +2102,9 @@ namespace LuaGlobalFunctions
}
/**
* Sends normal [Weather] to a [Player]
* Sends a clear weather packet to a [Player].
*
* Does not affect other [Player]s in the same zone, or affect the zone.
*
* @param [Player] player : [Player] to send the normal weather to
*/
@@ -2085,25 +2120,26 @@ namespace LuaGlobalFunctions
}
/**
* Returns true if the bag and slot is a valid inventory position, otherwise false
* Returns `true` if the bag and slot is a valid inventory position, otherwise `false`.
*
* <pre>
* Possible and most commonly used combinations:
* Some commonly used combinations:
*
* bag = 255
* slots 0-18 equipment
* slots 19-22 equipped bag slots
* slots 23-38 backpack
* slots 39-66 bank main slots
* slots 67-74 bank bag slots
* slots 86-117 keyring
* *Bag 255 (common character inventory)*
*
* bag = 19-22
* slots 0-35 for equipped bags
* - Slots 0-18: equipment
* - Slots 19-22: bag slots
* - Slots 23-38: backpack
* - Slots 39-66: bank main slots
* - Slots 67-74: bank bag slots
* - Slots 86-117: keyring
*
* bag = 67-74
* slots 0-35 for bank bags
* </pre>
* *Bags 19-22 (equipped bags)*
*
* - Slots 0-35
*
* *Bags 67-74 (bank bags)*
*
* - Slots 0-35
*
* @param uint8 bag : the bag the [Item] is in, you can get this with [Item:GetBagSlot]
* @param uint8 slot : the slot the [Item] is in within the bag, you can get this with [Item:GetSlot]
@@ -2119,25 +2155,9 @@ namespace LuaGlobalFunctions
}
/**
* Returns true if the bag and slot is a valid equipment position, otherwise false
* Returns `true` if the bag and slot is a valid equipment position, otherwise `false`.
*
* <pre>
* Possible and most commonly used combinations:
*
* bag = 255
* slots 0-18 equipment
* slots 19-22 equipped bag slots
* slots 23-38 backpack
* slots 39-66 bank main slots
* slots 67-74 bank bag slots
* slots 86-117 keyring
*
* bag = 19-22
* slots 0-35 for equipped bags
*
* bag = 67-74
* slots 0-35 for bank bags
* </pre>
* See [Global:IsInventoryPos] for bag/slot combination examples.
*
* @param uint8 bag : the bag the [Item] is in, you can get this with [Item:GetBagSlot]
* @param uint8 slot : the slot the [Item] is in within the bag, you can get this with [Item:GetSlot]
@@ -2153,25 +2173,9 @@ namespace LuaGlobalFunctions
}
/**
* Returns true if the bag and slot is a valid bank position, otherwise false
* Returns `true` if the bag and slot is a valid bank position, otherwise `false`.
*
* <pre>
* Possible and most commonly used combinations:
*
* bag = 255
* slots 0-18 equipment
* slots 19-22 equipped bag slots
* slots 23-38 backpack
* slots 39-66 bank main slots
* slots 67-74 bank bag slots
* slots 86-117 keyring
*
* bag = 19-22
* slots 0-35 for equipped bags
*
* bag = 67-74
* slots 0-35 for bank bags
* </pre>
* See [Global:IsInventoryPos] for bag/slot combination examples.
*
* @param uint8 bag : the bag the [Item] is in, you can get this with [Item:GetBagSlot]
* @param uint8 slot : the slot the [Item] is in within the bag, you can get this with [Item:GetSlot]
@@ -2187,25 +2191,9 @@ namespace LuaGlobalFunctions
}
/**
* Returns true if the bag and slot is a valid bag position, otherwise false
* Returns `true` if the bag and slot is a valid bag position, otherwise `false`.
*
* <pre>
* Possible and most commonly used combinations:
*
* bag = 255
* slots 0-18 equipment
* slots 19-22 equipped bag slots
* slots 23-38 backpack
* slots 39-66 bank main slots
* slots 67-74 bank bag slots
* slots 86-117 keyring
*
* bag = 19-22
* slots 0-35 for equipped bags
*
* bag = 67-74
* slots 0-35 for bank bags
* </pre>
* See [Global:IsInventoryPos] for bag/slot combination examples.
*
* @param uint8 bag : the bag the [Item] is in, you can get this with [Item:GetBagSlot]
* @param uint8 slot : the slot the [Item] is in within the bag, you can get this with [Item:GetSlot]
@@ -2221,9 +2209,9 @@ namespace LuaGlobalFunctions
}
/**
* Returns current time in ms
* Returns the server's current time.
*
* @return uint32 currTime
* @return uint32 currTime : the current time, in milliseconds
*/
int GetCurrTime(Eluna* /*E*/, lua_State* L)
{
@@ -2232,10 +2220,10 @@ namespace LuaGlobalFunctions
}
/**
* Returns difference from a [Global:GetCurrTime] time to now
* Returns the difference between an old timestamp and the current time.
*
* @param uint32 oldTime
* @return uint32 timeDiff
* @param uint32 oldTime : an old timestamp, in milliseconds
* @return uint32 timeDiff : the difference, in milliseconds
*/
int GetTimeDiff(Eluna* /*E*/, lua_State* L)
{
@@ -2245,7 +2233,7 @@ namespace LuaGlobalFunctions
return 1;
}
std::string GetStackAsString(lua_State* L)
static std::string GetStackAsString(lua_State* L)
{
std::ostringstream oss;
int top = lua_gettop(L);
@@ -2258,9 +2246,9 @@ namespace LuaGlobalFunctions
}
/**
* Prints given parameters to the info log
* Prints given parameters to the info log.
*
* @param ... variableArguments
* @param ...
*/
int PrintInfo(Eluna* /*E*/, lua_State* L)
{
@@ -2269,9 +2257,9 @@ namespace LuaGlobalFunctions
}
/**
* Prints given parameters to the error log
* Prints given parameters to the error log.
*
* @param ... variableArguments
* @param ...
*/
int PrintError(Eluna* /*E*/, lua_State* L)
{
@@ -2280,9 +2268,9 @@ namespace LuaGlobalFunctions
}
/**
* Prints given parameters to the debug log
* Prints given parameters to the debug log.
*
* @param ... variableArguments
* @param ...
*/
int PrintDebug(Eluna* /*E*/, lua_State* L)
{
@@ -2291,16 +2279,17 @@ namespace LuaGlobalFunctions
}
/**
* Returns an object represeting long long.
* Returns an object representing a `long long` (64-bit) value.
*
* The value by default is 0, but can be initialized to a value by passing a number or long long as a string.
*
* @proto value = ()
* @proto value = (number)
* @proto value = (longlong)
* @proto value = (longlongstr)
* @param int32 number : regular lua number
* @param int64 longlong : a long long object
* @param string longlongstr : a long long as a string
* @proto value = (n)
* @proto value = (n_ll)
* @proto value = (n_str)
* @param int32 n
* @param int64 n_ll
* @param string n_str
* @return int64 value
*/
int CreateLongLong(Eluna* /*E*/, lua_State* L)
@@ -2320,16 +2309,17 @@ namespace LuaGlobalFunctions
}
/**
* Returns an object represeting unsigned long long.
* Returns an object representing an `unsigned long long` (64-bit) value.
*
* The value by default is 0, but can be initialized to a value by passing a number or unsigned long long as a string.
*
* @proto value = ()
* @proto value = (number)
* @proto value = (ulonglong)
* @proto value = (ulonglongstr)
* @param uint32 number : regular lua number
* @param uint64 ulonglong : an unsigned long long object
* @param string ulonglongstr : an unsigned long long as a string
* @proto value = (n)
* @proto value = (n_ull)
* @proto value = (n_str)
* @param uint32 n
* @param uint64 n_ull
* @param string n_str
* @return uint64 value
*/
int CreateULongLong(Eluna* /*E*/, lua_State* L)

1
LuaFunctions.cpp
View File

@@ -1123,7 +1123,6 @@ ElunaRegister<ElunaQuery> QueryMethods[] =
{ "GetFloat", &LuaQuery::GetFloat }, // :GetFloat(column) - returns the value of a float column
{ "GetDouble", &LuaQuery::GetDouble }, // :GetDouble(column) - returns the value of a double column
{ "GetString", &LuaQuery::GetString }, // :GetString(column) - returns the value of a string column, always returns a string
{ "GetCString", &LuaQuery::GetCString }, // :GetCString(column) - returns the value of a string column, can return nil
{ "IsNull", &LuaQuery::IsNull }, // :IsNull(column) - returns true if the column is null
{ NULL, NULL },

72
docs/DOC_GEN.md
View File

@@ -15,21 +15,23 @@
- Run in cmd `python -m ElunaDoc` when at `\LuaEngine\docs\`
## Documenting
You can document functions in the Eluna source code. For examples, simply open a method header file.
You can document functions in the Eluna source code. For examples, simply open a method header file with docs.
### Template
Here are basic templates for a function. When defining a parameter or a return value, the type and value name are mandatory.
Here are basic templates for a function. When defining a parameter or a return value, the type and value name are mandatory, unless the parameter type is ... (for variable arguments; don't include a name in this case).
```c++
/**
* Description.
* Short description (about 80 characters long).
*
* @param Type paramName
* @return Type returnName
*/
```
```c++
/**
* Description.
* Short description (about 80 characters long).
*
* @param Type paramName = defaultValue : parameter description
* @return Type returnName : return value description
@@ -37,9 +39,10 @@ Here are basic templates for a function. When defining a parameter or a return v
```
This is a template for a function that takes in different parameters. When defining a parameter or a return value, the type and value name are mandatory.
```c++
/**
* Description.
* Short description (about 80 characters long).
*
* @proto returnValue = (object)
* @proto returnValue = (x, y, z)
@@ -55,42 +58,55 @@ This is a template for a function that takes in different parameters. When defin
A documentation comment block will always start with `/**` and end with `*/`.
All lines start with `*` character followed by one space before any content.
The main description will start with uppercase letter and end with a dot. All paragraphs should end with a dot as well.
The parameter and return value descriptions should start with a lowercase letter and at the end there should be no dot.
The first paragrph is used as a short description of the function/class, so it should be kept to about 80 characters. The other paragraphs can be as long as desired.
All paragraphs in the description (including the first) should start with a capital letter and end with a period.
**Paragraphs must be separated by an empty line**, e.g.:
```c++
/**
* This is a short description (about 80 characters).
*
* Here's another paragraph with more info. NOTE THE EMPTY LINE BETWEEN THE PARAGRAPHS.
* This does need to be short, and this line is still part of the same paragraph because
* there is no empty line.
*/
```
The parameter and return value descriptions should start with a lowercase letter and not end with a period. If more than one sentence is needed, start the *first* without a capital letter and end the *last* without a period.
Any class, enum or function can be referenced (made a link to) with square brackets.
`[Player]` will reference a player. `[WeatherType]` will reference an enum. `[Player:GetName]` will reference a function.
Use correct indentation with documentation comments
Use correct indentation with documentation comments.
```c++
/**
* Correct indentation.
* @param Type paramName = defaultValue : parameter description
* @return Type returnName : return value description
*/
```
```c++
/**
* Invalid indentation.
* @param Type paramName = defaultValue : parameter description
* @return Type returnName : return value description
*/
```
### Markdown
You can use [markdown](http://pythonhosted.org//Markdown/) in your descriptions.
For syntax see http://daringfireball.net/projects/markdown/syntax and http://pythonhosted.org//Markdown/#differences
```
/**
* Description.
*
* * list item
* * list item
* * list item
* - list item
* - list item
* - list item
*
* <pre>
* codeblock
* </pre>
* // Codeblock
* // Code goes here.
* // Note the 4-space indent.
*
* `code line`
*
@@ -98,16 +114,18 @@ For syntax see http://daringfireball.net/projects/markdown/syntax and http://pyt
* **bold**
*/
```
Produces<br/>
**Produces:**
Description.
* list item
* list item
* list item
- list item
- list item
- list item
<pre>
codeblock
</pre>
// Codeblock
// Code goes here.
// Note the 4-space indent.
`code line`
@@ -115,7 +133,8 @@ codeblock
**bold**
### Types
Here are some examples of possible types and most commonly used ones
Here are some examples of possible types and most commonly used ones:
```
string
uint32
@@ -126,6 +145,7 @@ int16
int8
double
float
...
[EnumName]
[Player]
[Creature]

52
docs/ElunaDoc/parser.py
View File

@@ -22,13 +22,18 @@ class ParameterDoc(object):
'uint64': ('0', '18,446,744,073,709,551,615'),
}
@params(self=object, name=unicode, data_type=str, description=unicode, default_value=Nullable(unicode))
@params(self=object, name=Nullable(unicode), data_type=str, description=unicode, default_value=Nullable(unicode))
def __init__(self, name, data_type, description, default_value=None):
"""If `name` is not provided, the Parameter is a returned value instead of a parameter."""
self.name = name
self.data_type = data_type
self.default_value = default_value
if self.data_type == '...':
self.name = '...'
else:
assert(self.name is not None)
if description:
# Capitalize the first letter, add a period, and parse as Markdown.
self.description = '{}{}. '.format(description[0].capitalize(), description[1:])
@@ -114,7 +119,7 @@ class ClassParser(object):
# An extra optional space (\s?) was thrown in to make it different from `class_body_regex`.
param_regex = re.compile(r"""\s*\*\s@param\s # The @param tag starts with opt. whitespace followed by "* @param ".
([^\s]+)\s(\w+) # The data type, a space, and the name of the param.
([^\s]+)\s(\w+)? # The data type, a space, and the name of the param.
(?:\s=\s(\w+))? # The default value: a = surrounded by spaces, followed by text.
(?:\s:\s(.+))? # The description: a colon surrounded by spaces, followed by text.
""", re.X)
@@ -172,16 +177,15 @@ class ClassParser(object):
def handle_proto(self, match):
return_values, parameters = match.group(1), match.group(2)
prototype = '{0}= {1}:{{0}}( {2} )'.format(return_values, self.class_name, parameters)
parameters = ' '+parameters+' ' if parameters else ''
return_values = return_values + '= ' if return_values else ''
prototype = '{0}{1}:{{0}}({2})'.format(return_values, self.class_name, parameters)
self.prototypes.append(prototype)
def handle_end(self, match):
self.method_name = match.group(1)
# If there's no prototype, make one with all params and returns.
if not self.prototypes:
parameters = ', '.join([param.name for param in self.params])
# Only pad with spaces when there are no parameters.
def make_prototype(parameters):
if parameters != '':
parameters = ' ' + parameters + ' '
@@ -198,7 +202,37 @@ class ClassParser(object):
else:
prototype = '{0}:{1}({2})'.format(self.class_name, self.method_name, parameters)
self.prototypes.append(prototype)
return prototype
# If there's no prototype, make one with all params and returns.
if not self.prototypes:
# A list of all parameters with default values.
params_with_default = []
# The index of the last non-default parameter.
last_non_default_i = 0
# If False, a parameter WITHOUT a default value follows one WITH a default value.
# In this case, don't bother generating prototypes.
simple_order = True
for i, param in enumerate(self.params):
if param.default_value:
params_with_default.append(param)
else:
last_non_default_i = i
if params_with_default:
simple_order = False
if not params_with_default or not simple_order:
# Just generate one prototype with all the parameters.
parameters = ', '.join([param.name for param in self.params])
self.prototypes.append(make_prototype(parameters))
else:
# Generate a prototype for all the non-default parameters,
# then one for each default parameter with all the previous parameters.
for i in range(last_non_default_i, len(self.params)):
parameters = ', '.join([param.name for param in self.params[:i+1]])
self.prototypes.append(make_prototype(parameters))
else:
# Format the method name into each prototype.
self.prototypes = [proto.format(self.method_name) for proto in self.prototypes]
@@ -220,7 +254,7 @@ class ClassParser(object):
}
# Table of which regular expressions can follow the last handled regex.
# `doc_body_regex` must always come LAST when used, since it also matches param, return, and comment_end.
# `body_regex` must always come LAST when used, since it also matches param, return, and comment_end.
next_regexes = {
None: [class_start_regex, start_regex, end_regex],
class_start_regex: [class_end_regex, class_body_regex],

2
docs/ElunaDoc/templates/method.html
View File

@@ -53,7 +53,7 @@
{%- if current_method.parameters|length > 0 %}
{%- for param in current_method.parameters %}
<dl>
<dt><code>{{ param.data_type|escape|parse_data_type }} {{ param.name }} {{- ' (' + param.default_value + ')' if param.default_value }}</code></dt>
<dt><code>{{ param.data_type|escape|parse_data_type }} {{ param.name if param.data_type != '...' }} {{- ' (' + param.default_value + ')' if param.default_value }}</code></dt>
<dd class="docblock">{{ param.description|parse_links if param.description else '<em>See method description.</em>' }}</dd>
</dl>
{%- endfor %}