mirror of
https://github.com/azerothcore/mod-ale
synced 2025-11-29 15:38:17 +08:00
Correct and add documentation
This commit is contained in:
@@ -10,7 +10,7 @@
|
||||
namespace LuaGameObject
|
||||
{
|
||||
/**
|
||||
* Returns 'true' if the &GameObject has the specified quest
|
||||
* Returns 'true' if the &GameObject can give the specified &Quest
|
||||
*
|
||||
* @param uint32 questId : quest entry Id to check
|
||||
* @return bool hasQuest
|
||||
@@ -52,7 +52,7 @@ namespace LuaGameObject
|
||||
/**
|
||||
* Returns 'true' if the &GameObject is active
|
||||
*
|
||||
* @return bool isActiveObject
|
||||
* @return bool isActive
|
||||
*/
|
||||
int IsActive(lua_State* L, GameObject* go)
|
||||
{
|
||||
@@ -67,7 +67,7 @@ namespace LuaGameObject
|
||||
}*/
|
||||
|
||||
/**
|
||||
* Returns display Id of the &GameObject
|
||||
* Returns display ID of the &GameObject
|
||||
*
|
||||
* @return uint32 displayId
|
||||
*/
|
||||
@@ -193,7 +193,7 @@ namespace LuaGameObject
|
||||
/**
|
||||
* Removes &GameObject from the world
|
||||
*
|
||||
* @param bool deleteFromDB : if true, it will delete the go from the database
|
||||
* @param bool deleteFromDB : if true, it will delete the &GameObject from the database
|
||||
*/
|
||||
int RemoveFromWorld(lua_State* L, GameObject* go)
|
||||
{
|
||||
@@ -205,12 +205,12 @@ namespace LuaGameObject
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a event to the &GameObject
|
||||
* Registers a timed event to the &GameObject
|
||||
*
|
||||
* @param function function : function to register the event with
|
||||
* @param function function : function to trigger when the time has passed
|
||||
* @param uint32 delay : set time in milliseconds for the event to trigger
|
||||
* @param uint32 repeats : how many times for the event to repeat, 0 is infinite
|
||||
* @return int32 functionReference
|
||||
* @return int32 eventId : unique ID for the timed event used to cancel it
|
||||
*/
|
||||
int RegisterEvent(lua_State* L, GameObject* go)
|
||||
{
|
||||
@@ -227,7 +227,7 @@ namespace LuaGameObject
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes event from a &GameObject by the specified event Id
|
||||
* Removes the timed event from a &GameObject by the specified event ID
|
||||
*
|
||||
* @param int32 eventId : event Id to remove
|
||||
*/
|
||||
@@ -239,7 +239,7 @@ namespace LuaGameObject
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes all events from a &GameObject
|
||||
* Removes all timed events from a &GameObject
|
||||
*
|
||||
*/
|
||||
int RemoveEvents(lua_State* /*L*/, GameObject* go)
|
||||
@@ -249,9 +249,9 @@ namespace LuaGameObject
|
||||
}
|
||||
|
||||
/**
|
||||
* Changes the state of a &GameObject to a door or button
|
||||
* Changes uses a door or a button type &GameObject
|
||||
*
|
||||
* @param uint32 delay : cooldown time to restore the go
|
||||
* @param uint32 delay : cooldown time in seconds to restore the &GameObject back to normal
|
||||
*/
|
||||
int UseDoorOrButton(lua_State* L, GameObject* go)
|
||||
{
|
||||
@@ -264,7 +264,7 @@ namespace LuaGameObject
|
||||
/**
|
||||
* Despawns a &GameObject
|
||||
*
|
||||
* @param uint32 delay : time of despawn
|
||||
* @param uint32 delay : time in seconds to despawn
|
||||
*/
|
||||
int Despawn(lua_State* L, GameObject* go)
|
||||
{
|
||||
@@ -280,7 +280,7 @@ namespace LuaGameObject
|
||||
/**
|
||||
* Respawns a &GameObject
|
||||
*
|
||||
* @param uint32 delay : time of respawn
|
||||
* @param uint32 delay : time of respawn in seconds
|
||||
*/
|
||||
int Respawn(lua_State* L, GameObject* go)
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user