Added Guild method documentation

Todo: Move a couple methods to player methods
This commit is contained in:
Foereaper
2014-12-21 01:24:43 +01:00
parent 809a0ac2bc
commit 6d0c50977f

View File

@@ -10,6 +10,11 @@
namespace LuaGuild namespace LuaGuild
{ {
/* GETTERS */ /* GETTERS */
/**
* Returns a table with the [Player]s in this [Guild]
*
* @return table guildPlayers : table of [Player]s
*/
int GetMembers(Eluna* /*E*/, lua_State* L, Guild* guild) int GetMembers(Eluna* /*E*/, lua_State* L, Guild* guild)
{ {
lua_newtable(L); lua_newtable(L);
@@ -35,12 +40,22 @@ namespace LuaGuild
return 1; return 1;
} }
/**
* Returns the member count of this [Guild]
*
* @return uint32 memberCount
*/
int GetMemberCount(Eluna* /*E*/, lua_State* L, Guild* guild) int GetMemberCount(Eluna* /*E*/, lua_State* L, Guild* guild)
{ {
Eluna::Push(L, guild->GetMemberSize()); Eluna::Push(L, guild->GetMemberSize());
return 1; return 1;
} }
/**
* Finds and returns the [Guild] leader by their GUID if logged in
*
* @return [Player] leader
*/
int GetLeader(Eluna* /*E*/, lua_State* L, Guild* guild) int GetLeader(Eluna* /*E*/, lua_State* L, Guild* guild)
{ {
#ifndef TRINITY #ifndef TRINITY
@@ -51,6 +66,11 @@ namespace LuaGuild
return 1; return 1;
} }
/**
* Returns [Guild] leader GUID
*
* @return uint64 leaderGUID
*/
int GetLeaderGUID(Eluna* /*E*/, lua_State* L, Guild* guild) int GetLeaderGUID(Eluna* /*E*/, lua_State* L, Guild* guild)
{ {
#ifndef TRINITY #ifndef TRINITY
@@ -61,24 +81,44 @@ namespace LuaGuild
return 1; return 1;
} }
/**
* Returns the [Guild]s entry ID
*
* @return uint32 entryId
*/
int GetId(Eluna* /*E*/, lua_State* L, Guild* guild) int GetId(Eluna* /*E*/, lua_State* L, Guild* guild)
{ {
Eluna::Push(L, guild->GetId()); Eluna::Push(L, guild->GetId());
return 1; return 1;
} }
/**
* Returns the [Guild]s name
*
* @return string guildName
*/
int GetName(Eluna* /*E*/, lua_State* L, Guild* guild) int GetName(Eluna* /*E*/, lua_State* L, Guild* guild)
{ {
Eluna::Push(L, guild->GetName()); Eluna::Push(L, guild->GetName());
return 1; return 1;
} }
/**
* Returns the [Guild]s current Message Of The Day
*
* @return string guildMOTD
*/
int GetMOTD(Eluna* /*E*/, lua_State* L, Guild* guild) int GetMOTD(Eluna* /*E*/, lua_State* L, Guild* guild)
{ {
Eluna::Push(L, guild->GetMOTD()); Eluna::Push(L, guild->GetMOTD());
return 1; return 1;
} }
/**
* Returns the [Guild]s current info
*
* @return string guildInfo
*/
int GetInfo(Eluna* /*E*/, lua_State* L, Guild* guild) int GetInfo(Eluna* /*E*/, lua_State* L, Guild* guild)
{ {
#ifndef TRINITY #ifndef TRINITY
@@ -91,6 +131,11 @@ namespace LuaGuild
/* SETTERS */ /* SETTERS */
#ifndef CATA #ifndef CATA
/**
* Sets the leader of this [Guild]
*
* @param [Player] leader : the [Player] leader to change
*/
int SetLeader(Eluna* /*E*/, lua_State* L, Guild* guild) int SetLeader(Eluna* /*E*/, lua_State* L, Guild* guild)
{ {
Player* player = Eluna::CHECKOBJ<Player>(L, 2); Player* player = Eluna::CHECKOBJ<Player>(L, 2);
@@ -105,6 +150,12 @@ namespace LuaGuild
#endif #endif
#ifndef CLASSIC #ifndef CLASSIC
/**
* Sets the information of the bank tab specified
*
* @param uint8 tabId : the ID of the tab specified
* @param string info : the information to be set to the bank tab
*/
int SetBankTabText(Eluna* /*E*/, lua_State* L, Guild* guild) int SetBankTabText(Eluna* /*E*/, lua_State* L, Guild* guild)
{ {
uint8 tabId = Eluna::CHECKVAL<uint8>(L, 2); uint8 tabId = Eluna::CHECKVAL<uint8>(L, 2);
@@ -120,6 +171,11 @@ namespace LuaGuild
/* OTHER */ /* OTHER */
// SendPacketToGuild(packet) // SendPacketToGuild(packet)
/**
* Sends a [WorldPacket] to all the [Player]s in the [Guild]
*
* @param [WorldPacket] packet : the [WorldPacket] to be sent to the [Player]s
*/
int SendPacket(Eluna* /*E*/, lua_State* L, Guild* guild) int SendPacket(Eluna* /*E*/, lua_State* L, Guild* guild)
{ {
WorldPacket* data = Eluna::CHECKOBJ<WorldPacket>(L, 2); WorldPacket* data = Eluna::CHECKOBJ<WorldPacket>(L, 2);
@@ -129,6 +185,12 @@ namespace LuaGuild
} }
// SendPacketToRankedInGuild(packet, rankId) // SendPacketToRankedInGuild(packet, rankId)
/**
* Sends a [WorldPacket] to all the [Player]s at the specified rank in the [Guild]
*
* @param [WorldPacket] packet : the [WorldPacket] to be sent to the [Player]s
* @param uint8 rankId : the rank ID
*/
int SendPacketToRanked(Eluna* /*E*/, lua_State* L, Guild* guild) int SendPacketToRanked(Eluna* /*E*/, lua_State* L, Guild* guild)
{ {
WorldPacket* data = Eluna::CHECKOBJ<WorldPacket>(L, 2); WorldPacket* data = Eluna::CHECKOBJ<WorldPacket>(L, 2);
@@ -138,12 +200,23 @@ namespace LuaGuild
return 0; return 0;
} }
/**
* Disbands the [Guild]
*/
int Disband(Eluna* /*E*/, lua_State* /*L*/, Guild* guild) int Disband(Eluna* /*E*/, lua_State* /*L*/, Guild* guild)
{ {
guild->Disband(); guild->Disband();
return 0; return 0;
} }
/**
* Adds the specified [Player] to the [Guild] at the specified rank.
*
* If no rank is specified, defaults to none.
*
* @param [Player] player : the [Player] to be added to the guild
* @param uint8 rankId : the rank ID
*/
int AddMember(Eluna* /*E*/, lua_State* L, Guild* guild) int AddMember(Eluna* /*E*/, lua_State* L, Guild* guild)
{ {
Player* player = Eluna::CHECKOBJ<Player>(L, 2); Player* player = Eluna::CHECKOBJ<Player>(L, 2);
@@ -153,6 +226,12 @@ namespace LuaGuild
return 0; return 0;
} }
/**
* Removes the specified [Player] from the [Guild].
*
* @param [Player] player : the [Player] to be removed from the guild
* @param bool isDisbanding : default 'false', should only be set to 'true' if the guild is triggered to disband
*/
int DeleteMember(Eluna* /*E*/, lua_State* L, Guild* guild) int DeleteMember(Eluna* /*E*/, lua_State* L, Guild* guild)
{ {
Player* player = Eluna::CHECKOBJ<Player>(L, 2); Player* player = Eluna::CHECKOBJ<Player>(L, 2);
@@ -166,6 +245,12 @@ namespace LuaGuild
return 0; return 0;
} }
/**
* Promotes/demotes the [Player] to the specified rank.
*
* @param [Player] player : the [Player] to be promoted/demoted
* @param uint8 rankId : the rank ID
*/
int SetMemberRank(Eluna* /*E*/, lua_State* L, Guild* guild) int SetMemberRank(Eluna* /*E*/, lua_State* L, Guild* guild)
{ {
Player* player = Eluna::CHECKOBJ<Player>(L, 2); Player* player = Eluna::CHECKOBJ<Player>(L, 2);