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

Eluna documentation changes

Browse Source
This commit is contained in:
Rochet2
2014-08-10 18:52:40 +03:00
parent 25f3c4e6bb
commit 8e92558eac
7 changed files with 88 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
CorpseMethods.h
View File

@@ -10,10 +10,10 @@
namespace LuaCorpse
{
/**
* Returns the &Corpse Owner GUID.
*
* @return uint64 ownerGUID
*/
* Returns the &Corpse Owner GUID.
*
* @return uint64 ownerGUID
*/
int GetOwnerGUID(lua_State* L, Corpse* corpse)
{
#ifndef TRINITY
@@ -25,10 +25,10 @@ namespace LuaCorpse
}
/**
* Returns the ghost time of a &Corpse.
*
* @return uint32 ghostTime
*/
* Returns the ghost time of a &Corpse.
*
* @return uint32 ghostTime
*/
int GetGhostTime(lua_State* L, Corpse* corpse)
{
Eluna::Push(L, uint32(corpse->GetGhostTime()));
@@ -36,19 +36,19 @@ namespace LuaCorpse
}
/**
* Returns the CorpseType of a &Corpse.
*
* <pre>
* enum CorpseType
* {
* CORPSE_BONES = 0,
* CORPSE_RESURRECTABLE_PVE = 1,
* CORPSE_RESURRECTABLE_PVP = 2
* };
* </pre>
*
* @return uint8 corpseType
*/
* Returns the CorpseType of a &Corpse.
*
* <pre>
* enum CorpseType
* {
* CORPSE_BONES = 0,
* CORPSE_RESURRECTABLE_PVE = 1,
* CORPSE_RESURRECTABLE_PVP = 2
* };
* </pre>
*
* @return uint8 corpseType
*/
int GetType(lua_State* L, Corpse* corpse)
{
Eluna::Push(L, corpse->GetType());
@@ -56,9 +56,9 @@ namespace LuaCorpse
}
/**
* Resets the &Corpse ghost time.
*
*/
* Resets the &Corpse ghost time.
*
*/
int ResetGhostTime(lua_State* /*L*/, Corpse* corpse)
{
corpse->ResetGhostTime();
@@ -66,9 +66,9 @@ namespace LuaCorpse
}
/**
* Saves the &Corpse to the database.
*
*/
* Saves the &Corpse to the database.
*
*/
int SaveToDB(lua_State* /*L*/, Corpse* corpse)
{
corpse->SaveToDB();
@@ -76,9 +76,9 @@ namespace LuaCorpse
}
/**
* Deletes the &Corpse from the world.
*
*/
* Deletes the &Corpse from the world.
*
*/
int DeleteBonesFromWorld(lua_State* /*L*/, Corpse* corpse)
{
corpse->DeleteBonesFromWorld();

14
QuestMethods.h
View File

@@ -11,7 +11,6 @@ namespace LuaQuest
{
/**
* Returns 'true' if the &Quest has the specified flag, false otherwise.
*
* Below flags are based off of 3.3.5a. Subject to change.
*
* <pre>
@@ -45,8 +44,7 @@ namespace LuaQuest
* </pre>
*
* @param uint32 flag : all available flags can be seen above
*
* @return bool
* @return bool hasFlag
*/
int HasFlag(lua_State* L, Quest* quest)
{
@@ -63,7 +61,7 @@ namespace LuaQuest
/**
* Returns 'true' if the &Quest is a daily quest, false otherwise.
*
* @return bool
* @return bool isDaily
*/
int IsDaily(lua_State* L, Quest* quest)
{
@@ -75,7 +73,7 @@ namespace LuaQuest
/**
* Returns 'true' if the &Quest is repeatable, false otherwise.
*
* @return bool
* @return bool isRepeatable
*/
int IsRepeatable(lua_State* L, Quest* quest)
{
@@ -84,7 +82,7 @@ namespace LuaQuest
}
/**
* Returns entry ID of the &Quest.
* Returns entry id of the &Quest.
*
* @return uint32 entryId
*/
@@ -106,7 +104,7 @@ namespace LuaQuest
}
/**
* Returns the minimum &Quest level required to pick up the &Quest.
* Returns the minimum level required to pick up the &Quest.
*
* @return uint32 minLevel
*/
@@ -117,7 +115,7 @@ namespace LuaQuest
}
/**
* Returns the next &Quest entry ID.
* Returns the next &Quest entry id.
*
* @return int32 entryId
*/

13
SpellMethods.h
View File

@@ -12,7 +12,7 @@ namespace LuaSpell
/**
* Returns 'true' if the &Spell is automatically repeating, false otherwise.
*
* @return boolean isRepeatable
* @return boolean isAutoRepeating
*/
int IsAutoRepeat(lua_State* L, Spell* spell)
{
@@ -23,7 +23,7 @@ namespace LuaSpell
/**
* Returns the &Unit that casted the &Spell.
*
* @return &Unit
* @return &Unit caster
*/
int GetCaster(lua_State* L, Spell* spell)
{
@@ -82,9 +82,9 @@ namespace LuaSpell
/**
* Returns the target destination coordinates of the &Spell.
*
* @return float x : X Coordinate of the &Spell
* @return float y : Y Coordinate of the &Spell
* @return float z : Z Coordinate of the &Spell
* @return float x : x coordinate of the &Spell
* @return float y : y coordinate of the &Spell
* @return float z : z coordinate of the &Spell
*/
int GetTargetDest(lua_State* L, Spell* spell)
{
@@ -107,7 +107,6 @@ namespace LuaSpell
/**
* Returns the target &Object of the &Spell.
*
* Target can be any of the following &Object types: &Player, &Creature, &GameObject, &Item, &Corpse
*
* @return &Object target
@@ -141,7 +140,7 @@ namespace LuaSpell
/**
* Sets the &Spell to automatically repeat:
*
* @param bool repeat : Set variable to 'true' for spell to automatically repeat
* @param bool repeat : set variable to 'true' for spell to automatically repeat
*/
int SetAutoRepeat(lua_State* L, Spell* spell)
{

9
UnitMethods.h
View File

@@ -1363,13 +1363,14 @@ namespace LuaUnit
/**
* Casts the spell at target with modified basepoints or casters.
* See also &Unit:CastSpell
*
* @param &Unit target
* @param uint32 spell
* @param bool triggered = false
* @param int32 bp0 = nil : modifier for the base points of the spell.
* @param int32 bp1 = nil : modifier for the base points of the spell.
* @param int32 bp2 = nil : modifier for the base points of the spell.
* @param int32 bp0 = nil : modifier for the base points of the spell. If left as nil, no change is made
* @param int32 bp1 = nil : modifier for the base points of the spell. If left as nil, no change is made
* @param int32 bp2 = nil : modifier for the base points of the spell. If left as nil, no change is made
* @param &Item castItem = nil
* @param uint64 originalCaster = 0
*/
@@ -1637,7 +1638,7 @@ namespace LuaUnit
*
* @param &Unit victim : &Unit that caused the threat
* @param float threat : threat amount
* @param uint32 SpellSchoolMask = 0 : school mask of the threat causer
* @param SpellSchoolMask schoolMask = 0 : spell school mask of the threat causer
* @param uint32 spell = 0 : spell entry used for threat
*/
int AddThreat(lua_State* L, Unit* unit)

23
WeatherMethods.h
View File

@@ -10,9 +10,9 @@
namespace LuaWeather
{
/**
* Returns the Zone ID of the &Weather as an uint32.
* Returns the zone id of the &Weather
*
* @return uint32 ZoneID
* @return uint32 zoneId
*/
int GetZoneId(lua_State* L, Weather* weather)
{
@@ -21,7 +21,7 @@ namespace LuaWeather
}
/**
* Sets the &Weather type based on &Weather type and grade supplied.
* Sets the &Weather type based on &WeatherType and grade supplied.
*
* <pre>
* enum WeatherType
@@ -35,7 +35,7 @@ namespace LuaWeather
* };
* </pre>
*
* @param uint32 type : the &Weather type, see above available weather types
* @param WeatherType type : the &WeatherType, see above available weather types
* @param float grade : the intensity/grade of the &Weather, ranges from 0 to 1
*/
int SetWeather(lua_State* L, Weather* weather)
@@ -50,7 +50,7 @@ namespace LuaWeather
/**
* Sends a &Weather update to the &Player supplied.
*
* @param &Player
* @param &Player player
*/
int SendWeatherUpdateToPlayer(lua_State* L, Weather* weather)
{
@@ -62,13 +62,12 @@ namespace LuaWeather
/**
* Regenerates the &Weather, causing it to change based on the below statistics.
* - 30% chance of no change
* - 30% chance of &Weather getting better (if not fine) or changing &Weather type
* - 30% chance of &Weather getting worse (if not fine)
* - 10% chance of radical change (if not fine)
*
* 30% - No change
* 30% - &Weather gets better (if not fine) or change &Weather type
* 30% - &Weather worsens (if not fine)
* 10% - Radical change (if not fine)
*
* @return bool Changed : returns 'true' if &Weather changed
* @return bool changed : returns 'true' if &Weather changed
*/
int Regenerate(lua_State* L, Weather* weather)
{
@@ -79,7 +78,7 @@ namespace LuaWeather
/**
* Sends a &Weather update to the all &Player in the zone.
*
* @param bool : Returns 'true' if weather changed for any &Player in the zone, 'false' if no &Player is within the zone
* @param bool changed : returns 'true' if weather changed for any &Player in the zone, 'false' if no &Player is within the zone
*/
int UpdateWeather(lua_State* L, Weather* weather)
{

10
WorldObjectMethods.h
View File

@@ -79,12 +79,12 @@ namespace LuaWorldObject
}
/**
* Returns the coordinates and orientation of the &WorldObject
* Returns the coordinates and orientation / facing of the &WorldObject
*
* @return float x
* @return float y
* @return float z
* @return float o
* @return float x : x coordinate of the &WorldObject
* @return float y : y coordinate of the &WorldObject
* @return float z : z coordinate (height) of the &WorldObject
* @return float o : facing / orientation of the &WorldObject
*/
int GetLocation(lua_State* L, WorldObject* obj)
{

50
WorldPacketMethods.h
View File

@@ -23,7 +23,7 @@ namespace LuaPacket
/**
* Returns the size of the &WorldPacket.
*
* @return uint32 : size of &WorldPacket
* @return uint32 size : size of &WorldPacket
*/
int GetSize(lua_State* L, WorldPacket* packet)
{
@@ -34,7 +34,7 @@ namespace LuaPacket
/**
* Sets the opcode of the &WorldPacket by specifying an opcode.
*
* @param uint32 packet : the packet specified to be set for the &WorldPacket
* @param uint32 opcode : the opcode specified to be set for the &WorldPacket
*/
int SetOpcode(lua_State* L, WorldPacket* packet)
{
@@ -48,33 +48,33 @@ namespace LuaPacket
/**
* Reads an int8 value of the &WorldPacket specified.
*
* @return int8
* @return int8 value
*/
int ReadByte(lua_State* L, WorldPacket* packet)
{
int8 byte;
(*packet) >> byte;
Eluna::Push(L, byte);
int8 _byte;
(*packet) >> _byte;
Eluna::Push(L, _byte);
return 1;
}
/**
* Reads a uint8 value of the &WorldPacket specified.
*
* @return uint8
* @return uint8 value
*/
int ReadUByte(lua_State* L, WorldPacket* packet)
{
uint8 byte;
(*packet) >> byte;
Eluna::Push(L, byte);
uint8 _ubyte;
(*packet) >> _ubyte;
Eluna::Push(L, _ubyte);
return 1;
}
/**
* Reads an int16 value of the &WorldPacket specified.
*
* @return int16
* @return int16 value
*/
int ReadShort(lua_State* L, WorldPacket* packet)
{
@@ -87,7 +87,7 @@ namespace LuaPacket
/**
* Reads a uint16 value of the &WorldPacket specified.
*
* @return uint16
* @return uint16 value
*/
int ReadUShort(lua_State* L, WorldPacket* packet)
{
@@ -100,7 +100,7 @@ namespace LuaPacket
/**
* Reads an int32 value of the &WorldPacket specified.
*
* @return int32
* @return int32 value
*/
int ReadLong(lua_State* L, WorldPacket* packet)
{
@@ -113,7 +113,7 @@ namespace LuaPacket
/**
* Reads a uint32 value of the &WorldPacket specified.
*
* @return uint32
* @return uint32 value
*/
int ReadULong(lua_State* L, WorldPacket* packet)
{
@@ -126,7 +126,7 @@ namespace LuaPacket
/**
* Reads a float value of the &WorldPacket specified.
*
* @return float
* @return float value
*/
int ReadFloat(lua_State* L, WorldPacket* packet)
{
@@ -139,7 +139,7 @@ namespace LuaPacket
/**
* Reads a double value of the &WorldPacket specified.
*
* @return double
* @return double value
*/
int ReadDouble(lua_State* L, WorldPacket* packet)
{
@@ -150,9 +150,9 @@ namespace LuaPacket
}
/**
* Reads a uint64 GUID value of the &WorldPacket specified.
* Reads a uint64 value of the &WorldPacket specified.
*
* @return uint64 : GUID returned as uint64
* @return uint64 value : value returned as string
*/
int ReadGUID(lua_State* L, WorldPacket* packet)
{
@@ -165,7 +165,7 @@ namespace LuaPacket
/**
* Reads a string value of the &WorldPacket specified.
*
* @return string
* @return string value
*/
int ReadString(lua_State* L, WorldPacket* packet)
{
@@ -176,9 +176,9 @@ namespace LuaPacket
}
/**
* Writes a uint64 GUID to the &WorldPacket.
* Writes an uint64 value to the &WorldPacket.
*
* @param uint64 GUID : the GUID to be written to the &WorldPacket
* @param uint64 value : the value to be written to the &WorldPacket
*/
int WriteGUID(lua_State* L, WorldPacket* packet)
{
@@ -190,7 +190,7 @@ namespace LuaPacket
/**
* Writes a string to the &WorldPacket.
*
* @param string : the string to be written to the &WorldPacket
* @param string value : the string to be written to the &WorldPacket
*/
int WriteString(lua_State* L, WorldPacket* packet)
{
@@ -212,7 +212,7 @@ namespace LuaPacket
}
/**
* Writes a uint8 value to the &WorldPacket.
* Writes an uint8 value to the &WorldPacket.
*
* @param uint8 value : the uint8 value to be written to the &WorldPacket
*/
@@ -236,7 +236,7 @@ namespace LuaPacket
}
/**
* Writes a uint16 value to the &WorldPacket.
* Writes an uint16 value to the &WorldPacket.
*
* @param uint16 value : the uint16 value to be written to the &WorldPacket
*/
@@ -260,7 +260,7 @@ namespace LuaPacket
}
/**
* Writes a uint32 value to the &WorldPacket.
* Writes an uint32 value to the &WorldPacket.
*
* @param uint32 value : the uint32 value to be written to the &WorldPacket
*/