LuaAPI.wiki
changeset 1004 94d046b03855
parent 1003 a4f8e22e15c6
child 1006 160112dc2fcf
equal deleted inserted replaced
1003:a4f8e22e15c6 1004:94d046b03855
   626 </code>
   626 </code>
   627 
   627 
   628 == Functions to modify gears ==
   628 == Functions to modify gears ==
   629 
   629 
   630 === <tt>!HideHog(gearUid)</tt> ===
   630 === <tt>!HideHog(gearUid)</tt> ===
   631 Removes a hedgehog from the map. The hidden hedgehog can be restored with `RestoreHog(gearUid)`.
   631 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).
   632 
   632 
   633 Example: 
   633 Example: 
   634 
   634 
   635 <code language="lua">    gear = AddGear(...)
   635 <code language="lua">    gear = AddGear(...)
   636      HideHog(gear) -- Hide the newly created gear.</code>
   636      HideHog(gear) -- Hide the newly created gear.</code>