LuaAPI: proper description of GetGearRadius
authorWuzzy
Thu, 09 Jun 2016 13:53:17 +0100
changeset 892 05bb5a116783
parent 891 d991247c5c05
child 893 e8664c10f69b
LuaAPI: proper description of GetGearRadius
LuaAPI.wiki
--- a/LuaAPI.wiki	Thu Jun 09 13:47:05 2016 +0100
+++ b/LuaAPI.wiki	Thu Jun 09 13:53:17 2016 +0100
@@ -445,7 +445,9 @@
 Returns x,y coordinates for the specified gear. Not to be confused with `GetGearPos`.
 
 === <tt>!GetGearRadius(gearUid)</tt> ===
-Returns radius for the specified gear.
+Returns the `Radius` value for the specified gear. For most [GearTypes gear types] for “projectile” gears (like `gtShell` or `gtGrenade`), the radius refers to the gear's collision radius. This is an invisible circle around the center of the gear which is used for the collision checks. For a few gear types, its radius means something different, see [Gear Types] for a full list.
+
+To set the `Radius` value, use `SetGearValues`.
 
 === <tt>!GetGearVelocity(gearUid)</tt> ===
 Returns a tuple of dx,dy values for the specified gear.