LuaLibraryTracker.wiki
changeset 1366 680a173ead44
parent 1365 f7ca5312d2ff
child 1367 831b860f835d
equal deleted inserted replaced
1365:f7ca5312d2ff 1366:680a173ead44
     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 <wiki:toc max_depth="3" />
     4 <wiki:toc max_depth="2" />
     5 
     5 
     6 == Introduction ==
     6 == Introduction ==
     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`.