# HG changeset patch # User Wuzzy # Date 1525301254 -3600 # Node ID 831b860f835d4566e2aa10a31cde3591db89c0a8 # Parent 680a173ead4405d37b8ad6e523bb69cfa514249f LuaLibraryTracker: hidden restored diff -r 680a173ead44 -r 831b860f835d LuaLibraryTracker.wiki --- a/LuaLibraryTracker.wiki Wed May 02 23:44:01 2018 +0100 +++ b/LuaLibraryTracker.wiki Wed May 02 23:47:34 2018 +0100 @@ -33,34 +33,34 @@ Will stop keeping track of the gear (gears not tracked will be ignored). === `trackTeams()` === -Will start the tracking of teams, clans and hedgehogs (hogs can be tracked without this). +Will start the tracking of teams, clans and hedgehogs (hogs can be tracked without this). You *must* call this function in `onGameStart` when you want to use any of the team or clan-related functions below. === `trackHiding(gear)` === -Will keep track of the given hedgehog gear when it is hidden. +Will keep track of the given hedgehog gear when it becomes hidden (e.g. with `HideHog`). === `trackRestoring(gear)` === -Will keep track of the given hedgehog gear when it is un-hidden. +Will keep track of the given hedgehog gear when it becomes restored, i.e. no longer hidden (e.g. with `RestoreHog`). == “`runOn`” functions == -These functions are used to run a function on tracked gears, teams and clans. +These functions are used to run a function on _tracked_ gears, teams and clans. === `runOnGears(func)` === -Runs the function `func` on all gears. +Runs the function `func` on all tracked gears. === `runOnHogs(func)` === -Runs the function `func` on all hedgehogs. +Runs the function `func` on all tracked hedgehogs. === `runOnHogsInTeam(func, team)` === -Runs the function `func` on all hedgehogs in the specified team (`team` = team name). +Runs the function `func` on all tracked hedgehogs in the specified team (`team` = team name). === `runOnHogsInOtherTeams(func, team)` === -Runs the function `func` on all hedgehogs but those in the specified team (`team` = team name). +Runs the function `func` on all tracked hedgehogs but those in the specified team (`team` = team name). === `runOnHogsInClan(func, clan)` === -Runs the function `func` on all hedgehogs in the specified clan (`clan` = clan ID). +Runs the function `func` on all tracked hedgehogs in the specified clan (`clan` = clan ID). === `runOnHogsInOtherClans(func, clan)` === -Runs the function `func` on all hedgehogs but those in the specified clan (`clan` = clan ID). +Runs the function `func` on all tracked hedgehogs but those in the specified clan (`clan` = clan ID). == Helper functions == === `getFirstHogOfClan(clan)` ===