GearTypes: Add more rope parameters
authorWuzzy
Wed, 06 Apr 2016 16:25:56 +0100
changeset 856 9740fae28189
parent 855 0878a8e37afb
child 857 ca7261b5c679
GearTypes: Add more rope parameters
GearTypes.wiki
--- a/GearTypes.wiki	Mon Apr 04 14:27:03 2016 +0100
+++ b/GearTypes.wiki	Wed Apr 06 16:25:56 2016 +0100
@@ -194,11 +194,17 @@
  * `Radius`: Effect range of resurrection in pixels (default: 100). Note that this does not change the drawn circle
 
 ==== `gtRope` ====
-A rope.
+A rope. There can only be one rope gear at once.
+
+The gear state flag `gstCollision` is set when the previous rope shot has hit something and is reset each time a new hook it fired.
 
+ * `X` and `Y`: Position of the nearest “bending point” of the rope (nearest to the rope gun), or the rope hook if rope does not touch anything
+ * `dX`: sine of rope angle, number between -1000000 and 1000000 (correspond to -180° to 180°)
+ * `dY`: negative cosine of rope angle, expressed as number between 0 and 10000000
+ * `Elasticity`: If the hog is attached to a rope, or is busy firing one, the elasticity of the rope will be non-rezo. A non-zero number holds the current retracted length of the rope from the nearest “bending point” or the hook, times 10000
+ * `Friction`: Holds the maximum remaning length of the rope measured from the nearest “bending point” or the hook, times 10000. Set this after rope creation to manually set the rope length individually. Note you can set `RopePercent` in `onGameInit` to set the rope length for all ropes at once
  * `Tag` Rope style: `0`=classic white segments (default), `1`=simple line which can be colored with `Tint`.
  * `Tint`: Rope color as RGBA. This only works if `Tag` equals `1`
- * `Elasticity`: If a hog is attached to a rope, or is busy firing one, the elasticity of the rope will be non-rezo
 
 ==== `gtSwitcher` ====
 Switch hedgehog.