Prettify GetVisualGearValues documentation
authorWuzzy
Thu, 10 Sep 2015 00:49:20 +0000
changeset 614 64c94ad363c8
parent 613 50ad270cfcfb
child 615 632e4dcc8b52
Prettify GetVisualGearValues documentation
LuaAPI.wiki
--- a/LuaAPI.wiki	Thu Sep 10 00:44:39 2015 +0000
+++ b/LuaAPI.wiki	Thu Sep 10 00:49:20 2015 +0000
@@ -547,8 +547,18 @@
 
 === <tt>!GetVisualGearValues(vgUid)</tt> ===
 This returns the typically set visual gear values, useful if manipulating things like smoke or bubbles or circles. It returns the following values:
-X, Y, dX, dY, Angle, Frame, !FrameTicks, State, Timer, Tint 
-X, Y typically position, dX, dY typically speed, Angle is usually the rotation angle, Frame is typically the animation frame, !FrameTicks is usually an animation counter.  State can have a variety of values, but is typically bit packed, Timer is usually the gear lifetime and Tint is the colour.
+
+`X, Y, dX, dY, Angle, Frame, FrameTicks, State, Timer, Tint`
+
+* `X`, `Y`: typically position
+* `dX`, `dY`: typically speed
+* `Angle` is usually the rotation angle
+* `Frame` is typically the animation frame
+* `FrameTicks` is usually an animation counter
+* `State` can have a variety of values, but is typically bit packed
+* `Timer` is usually the gear lifetime
+* `Tint` is the RGBA color
+
 Most visual gears require little to no modification of parameters.
 
 Example: