LuaAPI: update IsHogLocal
authorWuzzy
Sun, 11 Feb 2018 19:11:06 +0000
changeset 1190 0d33477246bc
parent 1189 e69155e475c8
child 1191 40698f589acb
LuaAPI: update IsHogLocal
LuaAPI.wiki
--- a/LuaAPI.wiki	Sun Feb 11 17:10:56 2018 +0000
+++ b/LuaAPI.wiki	Sun Feb 11 19:11:06 2018 +0000
@@ -521,7 +521,9 @@
 Returns the ammo count of the specified ammo type for the specified hedgehog gear.
 
 === <tt>!IsHogLocal(gearUid)</tt> (0.9.23) ===
-Returns `true` if the specified hedgehog gear is controlled by a human player on the computer on which Hedgewars runs on (i.e. not over a computer over the network). Returns `false` otherwise. Returns `nil` if `gearUid` is invalid.
+Returns `true` if the specified hedgehog gear is controlled by a human player on the computer on which Hedgewars runs on (i.e. not over a computer over the network). Also returns `true` if the hog is a member of any of the local clans. Returns `false` otherwise. Returns `nil` if `gearUid` is invalid.
+
+This is perfect to hide certain captions like weapon messages from enemy eyes.
 
 === <tt>!GetGearTarget(gearUid, x, y)  (0.9.16)</tt> ===
 Returns the x and y coordinate of target-based weapons/utilities.