diff -r 14fa1f3ec020 -r 0599403a78ad DrawnMapFormat.wiki --- a/DrawnMapFormat.wiki Thu Dec 05 17:38:11 2019 +0000 +++ b/DrawnMapFormat.wiki Thu Dec 05 17:39:54 2019 +0000 @@ -34,23 +34,6 @@ When Hedgewars loads a drawn map with special points inside, `onSpecialPoint` is called for each special point. -==== Usage in scripts ==== -This section explains how the special points are used in various official scripts. - -===== !HedgeEditor ===== -!HedgeEditor uses special points to spawn various gears and other things such as mines, crates or waypoints. Consult the script file to find out how they work. - -===== Racer ===== -The special points are used to store coordinates of waypoints. This is utilized by the Official Racer Challenge on the official server. - -If `flags` is set to exactly 99, it's a coordinate for the “best racer ghost” or smoke trace. This is also used for Official Racer Challenge. - -===== !TechRacer ===== - -* `flags == 0`: Waypoint -* `flags == 99`: A position of the best racer ghost (like in Racer) -* Otherwise: Place a gear or girder (see script source code for reference) - === Compression === Above description describes the raw data, but the final file will be changed. The raw data is first base64-encoded and then compressed with [https://doc.qt.io/qt-5/qbytearray.html#qCompress Qt's `qCompress` function]. @@ -59,3 +42,24 @@ Hand-drawn maps will be automatically transferred when playing online. But if you wish you can still share your creations in the [https://www.hedgewars.org/node/2849 Hand-Drawn Maps Submission Thread]. + +--- + +== Appendix: Usage of special points in scripts == +This section explains how the special points are used in various official scripts. + +=== !HedgeEditor === +!HedgeEditor uses special points to spawn various gears and other things such as mines, crates or waypoints. Consult the script file to find out how they work. + +=== Racer === +The special points are used to store coordinates of waypoints. This is utilized by the Official Racer Challenge on the official server. + +If `flags` is set to exactly 99, it's a coordinate for the “best racer ghost” or smoke trace. This is also used for Official Racer Challenge. + +=== !TechRacer === + +Depending on the value of `flags`, a special point means … + + * `flags == 0`: Waypoint + * `flags == 99`: A position of the best racer ghost (like in Racer) + * Otherwise: Place a gear or girder (see script source code for reference)