LuaAPI: Update SetVisualGearVaues
authorWuzzy
Tue, 21 Aug 2018 20:57:56 +0100
changeset 1510 b402473a77ba
parent 1509 9c51e2c8572c
child 1511 3c0c822ecdb9
LuaAPI: Update SetVisualGearVaues
LuaAPI.wiki
--- a/LuaAPI.wiki	Mon Aug 20 22:25:02 2018 +0100
+++ b/LuaAPI.wiki	Tue Aug 21 20:57:56 2018 +0100
@@ -715,7 +715,9 @@
 </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 of the visual gear `vgUid`. All visual gear values are numbers. Each visual gear may be using these parameters differently, but the *usual* meaning of these is the following:
+This allows manipulation of the internal state of the visual gear `vgUid`. If `vgUid` is invalid or the `vgUid` does not refer to an existing visual gear, the function does nothing- Thus, you can safely call this function even if you are not sure if the visual gear actually exists.
+
+All visual gear values are numbers. Each visual gear may be using these parameters differently, but the *usual* meaning of these is the following:
 
  * `X`, `Y`: Position
  * `dX`, `dY`: Speed along the X and Y axis
@@ -726,7 +728,7 @@
  * `Timer`: Time in milliseconds until it expires
  * `Tint`: RGBA color
 
-Some visual gears interpret these values differently, just like normal gears. See [VisualGearTypes] for details.  Also, most visual gears are not even using some of these values.
+Some visual gears interpret these values differently, just like normal gears. See [VisualGearTypes] for details.  Also, most visual gears are not using all possible values, while some values are just ignored.
 
 Note that most visual gears require little to no modification of their values.