LuaAPI: Clarify description of onGearResurrect
authorWuzzy
Sun, 27 Nov 2016 17:10:45 +0000
changeset 942 cca9e43e9d72
parent 941 6100c2308a82
child 943 8151ecbc40a3
LuaAPI: Clarify description of onGearResurrect
LuaAPI.wiki
--- a/LuaAPI.wiki	Sun Nov 27 13:26:45 2016 +0000
+++ b/LuaAPI.wiki	Sun Nov 27 17:10:45 2016 +0000
@@ -244,7 +244,7 @@
         end
     end</code>
 === <tt>onGearResurrect(gearUid) </tt> ===
-This function is called when a gear is resurrected. CPU Hogs will resurrect if the !GameFlag `gfAISurvival` is enabled. Alternatively, specific gears can have `heResurrectable` set to true via `SetEffect`.
+This function is called when a gear is resurrected due to the hog effect `heResurrectable` being set (see `SetEffect`) and/or being an AI hog when the game modifier “AI Survival” (`gfAISurvival`) is active. It is *not* called when a hog was resurrected by the resurrector tool you can use in the game.
 
 === <tt>onAmmoStoreInit()</tt> ===
 This function is called when the game is initialized to request the available ammo and ammo probabilities. Use `SetAmmo` here.