LuaLibraryTracker.wiki
changeset 1360 3ea63f51e092
parent 1346 1886a29a6bce
child 1361 367b835ac926
equal deleted inserted replaced
1359:d886660be4d0 1360:3ea63f51e092
     1 #summary Lua library documentation: Tracker
     1 #summary Lua library documentation: Tracker
     2 #labels !LuaLibrary
     2 #labels !LuaLibrary
     3 = Lua library: `Tracker` =
     3 = Lua library: `Tracker` =
     4 
     4 
     5 **NOTE: Documentation of this library is incomplete, some functions are still undocumented.**
     5 *NOTE: Documentation of this library is incomplete, some functions are still undocumented.*
     6 
     6 
     7 This Lua library is intended to be used if you need to keep track of gears. It can also keep track of teams and clans and as an extra functionality it can also store variables for a gear, team or clan.
     7 This Lua library is intended to be used if you need to keep track of gears. It can also keep track of teams and clans and as an extra functionality it can also store variables for a gear, team or clan.
     8 
     8 
     9 To set it up you need to add some hooks in different events. The hooks `trackGear` and `trackDeletion` to `onGearAdd` and `onGearDelete` respectively. It is strongly recommended to only track the gears you are interested in as, especially with snow on, the amount of gears can go up high and that will slow down the script. To keep track of teams you need to keep track of `gtHedgehog` and `gtResurrector` (if resurrection might be used) and add `trackTeams` to `onGameStart`.
     9 To set it up you need to add some hooks in different events. The hooks `trackGear` and `trackDeletion` to `onGearAdd` and `onGearDelete` respectively. It is strongly recommended to only track the gears you are interested in as, especially with snow on, the amount of gears can go up high and that will slow down the script. To keep track of teams you need to keep track of `gtHedgehog` and `gtResurrector` (if resurrection might be used) and add `trackTeams` to `onGameStart`.
    10 
    10