GearTypes: Extend gtTardis info
authorWuzzy
Sun, 26 Jul 2020 18:47:01 +0200
changeset 2181 3da12997c5e7
parent 2180 ce320d08ddf7
child 2182 0e10f5421f6d
GearTypes: Extend gtTardis info
GearTypes.wiki
--- a/GearTypes.wiki	Wed Jul 22 14:02:04 2020 +0200
+++ b/GearTypes.wiki	Sun Jul 26 18:47:01 2020 +0200
@@ -250,11 +250,23 @@
 ==== `gtTardis` ====
 A !TimeBox. It works in several phases and an internal timer.
 
- * `Pos`: Current phase. The value `4` is used when the !TimeBox is currently time-travelling (has completely turned invisible).
- * `Timer`: Has several meanings, depending on `Pos`. Here's the most imporant one, for `Pos` of `4`: A timer (in milliseconds) containing the remaining time until the !TimeBox returns. The !TimeBox returns when `Timer` reaches 0. Hedgewars decreases the timer only while the same team is playing
+ * `Pos`: Current phase.
+     * `1`: Appearing
+     * `2`: Pause (phase in which hedgehog walks in or out)
+     * `3`: Disappearing
+     * `4`: Time-travelling/away (has completely turned invisible)
+ * `Timer`: Has several meanings, depending on the value of `Pos`:
+     * `1`: `Timer` is unused
+     * `2`: `Timer` increases each tick until `Timer > 2000` (plus a small delay), after which `Pos` advances to `3`
+     * `3`: `Timer` is unused
+     * `4`: `Timer` contains remaining time until the !TimeBox returns. The !TimeBox returns when `Timer` reaches 0. Hedgewars decreases the timer only while the same team is playing
+ * `Power`: Used to store the fade-in/fade-out animation state, depending on current value of `Pos`:
+     * `1`: `Power` increases by 1 every 32 ticks, until it reaches 255, at which `Pos` advances to `2`
+     * `2`: `Power` is unused
+     * `3`: `Power` decreases by 1 every 32 ticks, until it reaches 0, at which `Pos` advances to `4`. If the timebox is starting the time-travel, `Timer` is set to a random value (for the return time). It the timebox was returning, the timebox gear is deleted after this
+     * `4`: `Power` is unused
  * `Tint`: RGBA color (default: clan color)
-
-Note: This section is incomplete, not all phases are documented yet.
+ * `Tag`: Will be set to 1 if the hog dies, took damage or moved before it could enter the !TimeBox. If this happens, using the timebox will fail and the hedgehog won't go into time-travel
 
 ==== `gtTeleport` ====
 Teleportation.