LuaGears: Add usage warning for HideHog
authorWuzzy
Fri, 19 Apr 2019 15:16:14 +0100
changeset 1825 1d2aeacbdd8e
parent 1824 a5a87fba78fa
child 1826 24b348e89a57
LuaGears: Add usage warning for HideHog
LuaGears.wiki
--- a/LuaGears.wiki	Fri Apr 19 14:56:28 2019 +0100
+++ b/LuaGears.wiki	Fri Apr 19 15:16:14 2019 +0100
@@ -567,11 +567,11 @@
 Returns true if hedgehog gear is hidden (e.g. via `HideHog` or the !TimeBox), false if it isn't, nil if that hedgehog never existed.
 
 === `HideHog(gearUid)` ===
-Removes a hedgehog from the map. The hidden hedgehog can be restored with `RestoreHog(gearUid)`. Since 0.9.23, returns `true` on success and `false` on failure (if gear does not exist / hog is already hidden).
+Removes a hedgehog from the map. The hidden hedgehog can be restored with `RestoreHog(gearUid)`. Since 0.9.23, returns `true` on success and `false` on failure (if gear does not exist / hog is already hidden). You must not hide all hogs at once.
 
 Example: 
 
-<code language="lua">    gear = AddGear(...)
+<code language="lua">    local gear = AddHog(...)
      HideHog(gear) -- Hide the newly created gear.</code>
 
 === `RestoreHog(gearUid)` ===
@@ -579,7 +579,7 @@
 
 Example: 
 
-<code language="lua">    gear = AddGear(...)
+<code language="lua">    local gear = AddHog(...)
      HideHog(gear) -- Hide the newly created gear.
      RestoreHog(gear) -- Restore the newly hidden gear.</code>