LuaLibraryUtils.wiki
author Wuzzy
Wed, 17 Apr 2019 13:33:23 +0100
changeset 1781 2d057448d499
parent 1652 ff0512443f75
child 1826 24b348e89a57
permissions -rw-r--r--
LuaGears: Mention visual gears, too
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1373
2eedf1c53951 LuaLibraryUtils: Edited via web interface
Wuzzy
parents: 1359
diff changeset
     1
#summary Lua library documentation of Utils; contains assorted helper functions
1345
673321313201 LuaLibraryUtils: labels
Wuzzy
parents: 1336
diff changeset
     2
#labels !LuaLibrary
1331
fef74f26cab9 LuaLibraryUtils: headings
Wuzzy
parents: 1329
diff changeset
     3
= Lua library: `Utils` =
1329
bd781e19a52d Split Lua libraries into several sub-pages
Wuzzy <almikes@aol.com>
parents:
diff changeset
     4
bd781e19a52d Split Lua libraries into several sub-pages
Wuzzy <almikes@aol.com>
parents:
diff changeset
     5
This library includes miscellaneous functions to use, they are all independent of each other and can be used everywhere.
bd781e19a52d Split Lua libraries into several sub-pages
Wuzzy <almikes@aol.com>
parents:
diff changeset
     6
1331
fef74f26cab9 LuaLibraryUtils: headings
Wuzzy
parents: 1329
diff changeset
     7
== `gearIsInBox(gear, x, y, w, h)` ==
1329
bd781e19a52d Split Lua libraries into several sub-pages
Wuzzy <almikes@aol.com>
parents:
diff changeset
     8
bd781e19a52d Split Lua libraries into several sub-pages
Wuzzy <almikes@aol.com>
parents:
diff changeset
     9
Returns whether the gear is inside (centre point of the gear) a box with x and y as the top left corner and having the width and height of w and h respectively.
bd781e19a52d Split Lua libraries into several sub-pages
Wuzzy <almikes@aol.com>
parents:
diff changeset
    10
bd781e19a52d Split Lua libraries into several sub-pages
Wuzzy <almikes@aol.com>
parents:
diff changeset
    11
1331
fef74f26cab9 LuaLibraryUtils: headings
Wuzzy
parents: 1329
diff changeset
    12
== `gearIsInCircle(gear, x, y, r, useRadius)` ==
1329
bd781e19a52d Split Lua libraries into several sub-pages
Wuzzy <almikes@aol.com>
parents:
diff changeset
    13
1358
a09a11ea67b4 LuaLibraryUtils: add fillMap and eraseMap
Wuzzy
parents: 1345
diff changeset
    14
Returns whether the gear is inside a circle with x and y being the centre point and r being the radius of the circle. The boolean useRadius determine whether only the centre point of the gear will be used or the radius of the gear will be checked too.
a09a11ea67b4 LuaLibraryUtils: add fillMap and eraseMap
Wuzzy
parents: 1345
diff changeset
    15
1394
607ff7beea3d LuaLibraryUtils: optional flush
Wuzzy
parents: 1373
diff changeset
    16
== `fillMap([flush])` ==
1358
a09a11ea67b4 LuaLibraryUtils: add fillMap and eraseMap
Wuzzy
parents: 1345
diff changeset
    17
Completely fill the current map with land. Requires `MapGen` to be set to `mgDrawn`. `FlushPoints()` will be called at the end, unless `flush` is set to `false`.
a09a11ea67b4 LuaLibraryUtils: add fillMap and eraseMap
Wuzzy
parents: 1345
diff changeset
    18
1394
607ff7beea3d LuaLibraryUtils: optional flush
Wuzzy
parents: 1373
diff changeset
    19
== `eraseMap([flush])` ==
1651
c1a5d8894bd0 LuaLibraryUtils: Add U_LAND_TINT_*
Wuzzy
parents: 1394
diff changeset
    20
Completely erase all land from current map. Requires `MapGen` to be set to `mgDrawn`. `FlushPoints()` will be called at the end, unless `flush` is set to `false`.
c1a5d8894bd0 LuaLibraryUtils: Add U_LAND_TINT_*
Wuzzy
parents: 1394
diff changeset
    21
c1a5d8894bd0 LuaLibraryUtils: Add U_LAND_TINT_*
Wuzzy
parents: 1394
diff changeset
    22
== Standardized land tint colors ==
c1a5d8894bd0 LuaLibraryUtils: Add U_LAND_TINT_*
Wuzzy
parents: 1394
diff changeset
    23
There are some “standard” tint colors for placed girders and other sprites which are defined to allow more consistency, if it is desired. These values are used in !TechRacer, !HedgeEditor and the basic movement training to colorize girders consistently:
c1a5d8894bd0 LuaLibraryUtils: Add U_LAND_TINT_*
Wuzzy
parents: 1394
diff changeset
    24
1652
ff0512443f75 LuaLibraryUtils: missing space added
Wuzzy
parents: 1651
diff changeset
    25
 * `U_LAND_TINT_NORMAL`: Normal land
ff0512443f75 LuaLibraryUtils: missing space added
Wuzzy
parents: 1651
diff changeset
    26
 * `U_LAND_TINT_ICE`: Icy land
ff0512443f75 LuaLibraryUtils: missing space added
Wuzzy
parents: 1651
diff changeset
    27
 * `U_LAND_TINT_INDESTRUCTIBLE`: Indestructible land
ff0512443f75 LuaLibraryUtils: missing space added
Wuzzy
parents: 1651
diff changeset
    28
 * `U_LAND_TINT_BOUNCY`: Bouncy land