Prettify SetVisualGearValues documentation
authorWuzzy
Thu, 10 Sep 2015 00:44:39 +0000
changeset 613 50ad270cfcfb
parent 612 376d1dcb3114
child 614 64c94ad363c8
Prettify SetVisualGearValues documentation
LuaAPI.wiki
--- a/LuaAPI.wiki	Thu Sep 10 00:40:55 2015 +0000
+++ b/LuaAPI.wiki	Thu Sep 10 00:44:39 2015 +0000
@@ -607,17 +607,25 @@
 </code>
 
 === <tt>!SetVisualGearValues(vgUid, X, Y, dX, dY, Angle, Frame, !FrameTicks, State, Timer, Tint)</tt> ===
-This allows manipulation of many of the visual gear values. Calling `GetVisualGearValues` first is recommended on most visual gears unless you are controlling all the key values. In the case of `vgtCircle`, the visual gear values are mapped as follows.  X, Y: position.  State: radius. Timer: Thickness.  !FrameTicks: pulsation speed (0 to disable).  dX, dY: min/max pulsation opacity (0-255). Tint: colour, RGBA.
+This allows manipulation of many of the visual gear values. In the case of `vgtCircle`, the visual gear values are mapped as follows:
+
+* `X`, `Y`: Position
+* `State`: Radius.
+* `Timer`: Thickness
+* `FrameTicks`: Pulsation speed (`0` to disable)
+* `dX`, `dY`: min/max pulsation opacity (`0`-`255`)
+* `Tint`: Color in RGBA
+
 Most visual gears require little to no modification of parameters.
 
-Example:
+Example 1:
 
 <code language="lua">  -- set a circle to position 1000,1000 pulsing from opacity 20 to 200 (8%-78%), radius of 50, 3px thickness, bright red.
     SetVisualGearValues(circleUid, 1000,1000, 20, 200, 0, 0, 100, 50, 3, 0xff0000ff)</code>
 
 Beginning from 0.9.21-dev, the 2nd to 11th arguments are optional. Any such argument which is declared as `nil` will not overwrite the corresponding value of the visual gear. With this change, it is not required anymore to call `GetVisualGearValues` beforehand.
 
-Examples:
+Example 2:
 
 <code language="lua">  -- set a circle to position 1000,1000
     SetVisualGearValues(circleUid, 1000, 1000)</code>