LuaLibraries.wiki
author Wuzzy
Mon, 04 Apr 2016 12:59:54 +0100
changeset 833 ccc713bc70ad
parent 798 30c5f1ebd552
child 867 30cc2f85c5e7
permissions -rw-r--r--
Taunts: Fixed missed row
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
84
6fa418422e57 Created wiki page through web user interface.
henrik.rostedt@gmail.com
parents:
diff changeset
     1
#summary Libraries for writing Lua scripts in Hedgewars.
6fa418422e57 Created wiki page through web user interface.
henrik.rostedt@gmail.com
parents:
diff changeset
     2
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
     3
= Lua libraries documentation =
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
     4
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
     5
== Introduction ==
84
6fa418422e57 Created wiki page through web user interface.
henrik.rostedt@gmail.com
parents:
diff changeset
     6
6fa418422e57 Created wiki page through web user interface.
henrik.rostedt@gmail.com
parents:
diff changeset
     7
Libraries in scripts in Hedgewars are lua files that are used by many scripts to add a common function, as an example the Locale library that allows scripts to translate text. The variables in these files are not exposed to the script using it but all the functions can be called.
6fa418422e57 Created wiki page through web user interface.
henrik.rostedt@gmail.com
parents:
diff changeset
     8
6fa418422e57 Created wiki page through web user interface.
henrik.rostedt@gmail.com
parents:
diff changeset
     9
To use a library you only need to add one row at the top of the script:
501
04b4b463bf33 Add HedgewarsScriptLoad, warn about the old and rusty loadfile function.
almikes@aol.com
parents: 500
diff changeset
    10
<code language="lua">HedgewarsScriptLoad("Scripts/<Library Name>.lua")</code>
04b4b463bf33 Add HedgewarsScriptLoad, warn about the old and rusty loadfile function.
almikes@aol.com
parents: 500
diff changeset
    11
Where `<Library Name>` is replaced by the name.
84
6fa418422e57 Created wiki page through web user interface.
henrik.rostedt@gmail.com
parents:
diff changeset
    12
501
04b4b463bf33 Add HedgewarsScriptLoad, warn about the old and rusty loadfile function.
almikes@aol.com
parents: 500
diff changeset
    13
*Note*: In old scripts, you will find this line instead:
04b4b463bf33 Add HedgewarsScriptLoad, warn about the old and rusty loadfile function.
almikes@aol.com
parents: 500
diff changeset
    14
<code language="lua">loadfile(GetDataPath() .. "Scripts/<Library Name>.lua")()</code>
525
b051cfd45c23 Edited wiki page LuaLibraries through web user interface.
almikes@aol.com
parents: 501
diff changeset
    15
This does not work with new Hedgewars versions anymore and causes the script to break. You have to replace it with `HedgewarsScriptLoad`. *Calls to `loadfile` are one of the most common reasons why old scripts do not work in recent Hedgewars versions.*
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    16
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
    17
== Table of Contents ==
527
908428bf4a03 Add TOC
almikes@aol.com
parents: 526
diff changeset
    18
908428bf4a03 Add TOC
almikes@aol.com
parents: 526
diff changeset
    19
<wiki:toc max_depth="2" />
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
    20
== Locale ==
84
6fa418422e57 Created wiki page through web user interface.
henrik.rostedt@gmail.com
parents:
diff changeset
    21
6fa418422e57 Created wiki page through web user interface.
henrik.rostedt@gmail.com
parents:
diff changeset
    22
This library allows you to translate string and should be used whenever a script has text. It loads the appropriate locale file and check automatically.
6fa418422e57 Created wiki page through web user interface.
henrik.rostedt@gmail.com
parents:
diff changeset
    23
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
    24
==== `loc(text)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    25
529
f3e3229af8bf Replaced old lang function with loc.
almikes@aol.com
parents: 528
diff changeset
    26
Returns the localised string of `text` or, if it is not found, it returns `text`.
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    27
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    28
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    29
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
    30
== Utils ==
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    31
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    32
This library includes miscellaneous functions to use, they are all independent of each other and can be used everywhere.
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    33
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
    34
==== `gearIsInBox(gear, x, y, w, h)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    35
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    36
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.
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    37
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    38
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
    39
==== `gearIsInCircle(gear, x, y, r, useRadius)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    40
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    41
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.
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    42
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    43
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    44
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
    45
== Tracker ==
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    46
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    47
This library is intended to be used if you need to keep track of gears. It can also keep track of teams and clans and as an extra functionality it can also store variables for a gear, team or clan.
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    48
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    49
To set it up you need to add some hooks in different events. The hooks `trackGear` and `trackDeletion` to `onGearAdd` and `onGearDelete` respectively. It is strongly recommended to only track the gears you are interested in as, especially with snow on, the amount of gears can go up high and that will slow down the script. To keep track of teams you need to keep track of `gtHedgehog` and `gtResurrector` (if resurrection might be used) and add `trackTeams` to `onGameStart`.
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    50
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    51
If you want to call a function on a couple of gears you will have to call the “`runOn`” functions. To these you will pass the function you want to be run as a variable to the function. The function must take a gear as a parameter, nothing else, for example:
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    52
<code language="lua">function killall(gear)
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    53
    SetHealth(gear, 0)
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    54
end
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    55
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    56
function onGearDelete(gear)
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    57
    if GetGearType(gear) == gtTarget then
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    58
        runOnHogs(killall)
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    59
    end
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    60
end</code>
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    61
This will kill all hogs if a target is destroyed.
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    62
103
023ff3c709ac Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 86
diff changeset
    63
To see a commented example of the tracker in use by a script you can look at
798
30c5f1ebd552 global replace of http with https for hedgewars.org wiki links
nemo
parents: 742
diff changeset
    64
[https://hg.hedgewars.org/hedgewars/file/default/share/hedgewars/Data/Scripts/Multiplayer/Random_Weapon.lua Random Weapons].
103
023ff3c709ac Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 86
diff changeset
    65
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
    66
=== Tracking functions ===
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    67
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
    68
==== `trackGear(gear)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    69
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    70
Will keep track of the gear.
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    71
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    72
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
    73
==== `trackDeletion(gear)` ====
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    74
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    75
Will stop keeping track of the gear (gears not tracked will be ignored).
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    76
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    77
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
    78
==== `trackTeams()` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    79
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    80
Will start the tracking of teams, clans and hedgehogs (hogs can be tracked without this).
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    81
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    82
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
    83
=== “`runOn`” functions ===
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    84
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
    85
==== `runOnGears(func)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    86
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    87
Runs the function `func` on all gears.
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    88
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    89
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
    90
==== `runOnHogs(func)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    91
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    92
Runs the function `func` on all hedgehogs.
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    93
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    94
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
    95
==== `runOnHogsInTeam(func, team)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    96
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    97
Runs the function `func` on all hedgehogs in the specified team.
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
    98
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
    99
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   100
==== runOnHogsInOtherTeams(func, team) ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   101
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   102
Runs the function `func` on all hedgehogs but those in the specified team.
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   103
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   104
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   105
==== `runOnHogsInClan(func, clan)` ====
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
   106
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   107
Runs the function `func` on all hedgehogs in the specified clan.
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   108
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
   109
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   110
==== `runOnHogsInOtherClans(func, clan)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   111
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   112
Runs the function `func` on all hedgehogs but those in the specified clan.
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   113
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
   114
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   115
=== Variable functions ===
85
9f1d2d3db844 Edited wiki page LuaLibraries through web user interface.
henrik.rostedt@gmail.com
parents: 84
diff changeset
   116
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   117
_To be continued …_
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   118
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   119
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   120
== Animate ==
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   121
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   122
This library provides functions that aid cinematic/cut-scene creation and functions for handling events. 
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   123
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   124
In order to use its full potential, the following lines need to be at the beginning of `onGameTick`.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   125
500
dc66ea78b36d Use correct syntax highlighting.
almikes@aol.com
parents: 246
diff changeset
   126
<code language="lua">function onGameTick()
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   127
    AnimUnWait()
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   128
    if ShowAnimation() == false then
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   129
        return
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   130
    end
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   131
    ExecuteAfterAnimations()
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   132
    CheckEvents()
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   133
end</code>
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   134
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   135
Also, `AnimInit()` needs to be called in `onGameInit()`.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   136
Each of these functions will be explained below.
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   137
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   138
=== Cinematic handling ===
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   139
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   140
==== `ShowAnimation()` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   141
Performs the current action in the cinematic and returns `true` if finished, otherwise `false`. It needs to be used in `onGameTick`. Cut-scenes need to be added with `AddAnim(steps)`.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   142
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   143
==== `AddAnim(steps)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   144
Adds `steps` to the array of animations, where `steps` is a table with numbers as keys and elements of the following form. Each step is a table having the following keys: `func`, `args`, `swh`.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   145
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   146
  * `func` is the function to be executed. It can be any function that returns false when it needs to be called again in following game ticks (e.g. `AnimMove`). It can be one of the cinematic functions. 
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   147
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   148
  * `args` is a table containing the arguments that need to be passed to the function given
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   149
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   150
  * `swh` is an optional boolean value that defaults to `true` and denotes whether the current hedgehog should be switched to the hog given as argument.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   151
Example:
500
dc66ea78b36d Use correct syntax highlighting.
almikes@aol.com
parents: 246
diff changeset
   152
<code language="lua">cinem = {
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   153
    {func = AnimSay, args = {myHog, "Snails! SNAILS!", SAY_SAY, 3000}},
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   154
    {func = AnimMove, args = {myhog, "Left", 2000, 0}},
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   155
    {func = AddCaption, swh = false, args = {"But he found no more snails..."}}
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   156
    }
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   157
AddAnim(cinem)</code>
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   158
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   159
==== `RemoveAnim(steps)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   160
Removes `steps` from the animations array.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   161
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   162
=== `AddSkipFunction(anim, func, args)` ===
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   163
Adds `func` to the array of functions used to skip animations, associating it with `anim`. When the animation is skipped (see below), the function is called with `args` as arguments.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   164
Example:
500
dc66ea78b36d Use correct syntax highlighting.
almikes@aol.com
parents: 246
diff changeset
   165
<code language="lua">AddSkipFunc(cinem, SkipCinem, {})</code>
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   166
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   167
==== `RemoveSkipFunction(anim)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   168
Removes the skip function associated with `anim`.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   169
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   170
==== `SetAnimSkip(bool)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   171
Sets the state of animation skipping to `bool`. It is useful in case the player is allowed to skip the animation.
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   172
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   173
Example:
500
dc66ea78b36d Use correct syntax highlighting.
almikes@aol.com
parents: 246
diff changeset
   174
<code language="lua">function onPrecise()
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   175
    if AnimInProgress() then
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   176
        SetAnimSkip(true)
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   177
    end
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   178
end</code>
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   179
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   180
==== `AnimInProgress()` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   181
Returns `true` if a cinematic is currently taking place, `false` otherwise.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   182
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   183
==== `ExecuteAfterAnimations()` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   184
Calls the functions (added with `AddFunction`) that need to be executed after the cinematic. The best location for this function call is in `onGameTick`.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   185
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   186
==== `AddFunction(element)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   187
Adds `element` to the functions array that are to be called after the cinematic. `element` is a table with the keys: `func`, `args`.
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   188
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   189
Example:
500
dc66ea78b36d Use correct syntax highlighting.
almikes@aol.com
parents: 246
diff changeset
   190
<code language="lua">AddFunction({func = AfterCinem, args = {2}})</code>
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   191
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   192
==== `RemoveFunction()` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   193
Removes the first function from the aforementioned list.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   194
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   195
==== `AnimInit()` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   196
Initializes variables used by the other functions. Needs to be called in `onGameInit`.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   197
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   198
==== !AnimUnWait() ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   199
Decreases the wait time used by cinematics. It is best called in `onGameTick`.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   200
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   201
=== Cinematic functions ===
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   202
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   203
==== `AnimSwitchHog(gear)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   204
Switches to `gear` and follows it.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   205
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   206
==== `AnimWait(gear, time)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   207
Increases the wait time by `time`. `gear` is just for compatibility with `ShowAnimation`.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   208
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   209
==== `AnimSay(gear, text, manner, time` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   210
Calls `HogSay` with the first three arguments and increses the wait time by `time`.
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   211
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   212
Example:
500
dc66ea78b36d Use correct syntax highlighting.
almikes@aol.com
parents: 246
diff changeset
   213
<code language="lua">cinem = {
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   214
    {func = AnimSay, args = {gear1, "You're so defensive!", SAY_SAY, 2500}},
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   215
    {func = AnimSay, args = {gear2, "No, I'm not!", SAY_SAY, 2000}}
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   216
   }</code>
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   217
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   218
==== `AnimSound(gear, sound, time)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   219
Plays the sound `sound` and increases the wait time by `time`.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   220
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   221
==== `AnimTurn(hog, dir)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   222
Makes `hog` face in direction `dir`, where `dir` equals either `"Right"` or `"Left"`.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   223
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   224
==== `AnimMove(hog, dir, x, y)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   225
Makes `hog` move in direction `dir` until either his horizontal coordinate is `x` or his vertical coordinate is `y`.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   226
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   227
==== `AnimJump(hog, jumpType)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   228
Makes `hog` perform a jump of type `jumpType`, where `jumpType` equals either `"long"`, `"high"` or `"back"`.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   229
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   230
==== `AnimSetGearPosition(gear, x, y, fall)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   231
Sets the position of `gear` to (`x`, `y`). If the optional argument `fall` does not equal `false` then the gear is given a small falling velocity in order to get around exact positioning.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   232
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   233
==== `AnimDisappear(gear, x, y)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   234
Teleports the gear to (`x`, `y`), adding some effects at the previous position and sounds. Doesn’t follow the gear.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   235
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   236
==== `AnimOutOfNowhere(gear, x, y)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   237
Teleports the gear to (`x`, `y`), adding effects and sounds at the final position. Follows gear.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   238
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   239
==== `AnimTeleportGear(gear, x, y)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   240
Teleports the gear to (`x`, `y`), adding effects and sounds both at the starting position and the final position. Follows gear.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   241
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   242
==== `AnimVisualGear(gear, x, y, vgType, state, critical, follow)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   243
Calls `AddVisualGear` with arguments second to sixth. If the optional argument `follow` equals `true` then the gear is followed. `gear` is for compatibility only.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   244
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   245
==== `AnimCaption(gear, text, time)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   246
Adds `text` as caption and increases wait time by `time`.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   247
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   248
==== `AnimCustomFunction(gear, func, args)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   249
Calls the function `func` with `args` as arguments. This function is useful, for instance, when the cinematic uses the position of a gear at the moment of execution. If `func` needs to be called in following game ticks then it should return false.
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   250
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   251
Example:
500
dc66ea78b36d Use correct syntax highlighting.
almikes@aol.com
parents: 246
diff changeset
   252
<code language="lua">function NeedToTurn(hog1, hog2)
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   253
   if GetX(hog1) < GetX(hog2) then
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   254
      HogTurnLeft(hog1, false)
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   255
      HogTurnLeft(hog2, true)
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   256
   else
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   257
      HogTurnLeft(hog2, false)
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   258
      HogTurnLeft(hog1, true)
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   259
   end
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   260
end
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   261
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   262
cinem = {{func = AnimCustomFunction, args = {hog1, NeedToTurn, {hog1, hg2}}}}</code>
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   263
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   264
==== `AnimInsertStepNext(step)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   265
Inserts `step` after the current step (read: action) in the cinematic array. Useful when an action depends on variables (e.g. positoins). It can be used mostly with `AnimCustomFunction`. Note: In case of multiple consecutive calls, steps need to be added in reverse order.
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   266
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   267
Example:
500
dc66ea78b36d Use correct syntax highlighting.
almikes@aol.com
parents: 246
diff changeset
   268
<code language="lua">function BlowHog(deadHog)
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   269
  AnimInsertStepNext({func = DeleteGear, args = {deadHog}, swh = false}) 
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   270
  AnimInsertStepNext({func = AnimVisualGear, args = {deadHog, GetX(deadHog), GetY(deadHog), vgtBigExplosion, 0, true}, swh = false})
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   271
  AnimInsertStepNext({func = AnimWait, args = {deadHog, 1200}})
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   272
  AnimInsertStepNext({func = AnimVisualGear, args = {deadHog, GetX(deadHog) + 20, GetY(deadHog), vgtExplosion, 0, true}, swh = false})
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   273
  AnimInsertStepNext({func = AnimWait, args = {deadHog, 100}})
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   274
  AnimInsertStepNext({func = AnimVisualGear, args = {deadHog, GetX(deadHog) + 10, GetY(deadHog), vgtExplosion, 0, true}, swh = false})
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   275
  AnimInsertStepNext({func = AnimWait, args = {deadHog, 100}})
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   276
  AnimInsertStepNext({func = AnimVisualGear, args = {deadHog, GetX(deadHog) - 10, GetY(deadHog), vgtExplosion, 0, true}, swh = false})
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   277
  AnimInsertStepNext({func = AnimWait, args = {deadHog, 100}})
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   278
  AnimInsertStepNext({func = AnimVisualGear, args = {deadHog, GetX(deadHog) - 20, GetY(deadHog), vgtExplosion, 0, true}, swh = false})
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   279
end
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   280
cinem = {{func = AnimCustomFunction, args = {liveHog, BlowHog, {deadHog}}}}</code>
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   281
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   282
=== Event handling ===
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   283
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   284
Events are pairs of functions that are used to check for various conditions. One of them is for verification and, if it returns `true`, the second function is called.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   285
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   286
==== `AddEvent(condFunc, condArgs, doFunc, doArgs, evType)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   287
Adds the functions `condFunc` and `doFunc` to the events list. They get called with the respective args (`condArgs` and `doArgs`). `condFunc` will get called in every game tick until it returns `true` or is removed. Once it returns `true`, `doFunc` is called and they are or are not removed from the list, depending on `evType` (`0` for removal, `1` for keeping). An `evType` of `1` is useful for repeating actions (e.g. every time a hog gets damaged, do something).
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   288
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   289
Example:
500
dc66ea78b36d Use correct syntax highlighting.
almikes@aol.com
parents: 246
diff changeset
   290
<code language="lua">function CheckPos()
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   291
   return GetX(myHog) > 1500
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   292
end
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   293
function CheckAmmo()
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   294
   return GetAmmoCount(myHog, amGrenade) == 0
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   295
end
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   296
function DoPos()
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   297
   ShowMission("Scooter", "Mover", "Nice Work", 0, 0)
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   298
end
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   299
function DoAmmo()
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   300
   AddAmmo(myHog, amGrenade, 5)
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   301
end
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   302
AddEvent(CheckPos, {}, DoPos, {}, 0) -- Add event that gets removed on completion
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   303
AddEvent(CheckAmmo, {}, DoAmmo, {}, 1) -- Add repeating event</code>
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   304
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   305
==== `AddNewEvent(condFunc, condArgs, doFunc, doArgs, evType)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   306
Does the same as `AddEvent`, but first checks if the event is already in the list so that it isn’t added twice.
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   307
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   308
==== `RemoveEventFunc(cFunc, cArgs)` ====
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   309
Removes the event or events that have `cFunc` as the condition checking function. If `cArgs` does not equal `nil` then only those events get removed that have `cArgs` as arguments for `cFunc`, too.
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   310
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   311
Example:
500
dc66ea78b36d Use correct syntax highlighting.
almikes@aol.com
parents: 246
diff changeset
   312
<code language="lua">AddEvent(condFunc1, condArgs1, doFunc, doArgs)
246
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   313
AddEvent(condFunc1, condArgs2, doFunc, doArgs)
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   314
AddEvent(condFunc1, condArgs2, doFunc, doArgs)
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   315
AddEvent(condFunc2, condArgs1, doFunc, doArgs)
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   316
AddEvent(condFunc2, condArgs2, doFunc, doArgs)
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   317
RemoveEventFunc(condFunc1) --Removes all three events that have condFunc1
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   318
RemoveEventFunc(condFunc2, condArgs1) --Removes a single event</code>
7b1a6c46c3b5 Edited wiki page LuaLibraries through web user interface.
szabibibi@gmail.com
parents: 103
diff changeset
   319
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   320
==== `CheckEvents` ====
530
9d1b7bddb6d2 Remove bad blockquoute element.
almikes@aol.com
parents: 529
diff changeset
   321
Verifies all the condition functions in the events list and calls the respective ‘action’ functions if the conditions are met. If the `evType` of a completed event equals `0` then it is removed from the list. This function is best placed in `onGameTick`.
526
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   322
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   323
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   324
== Params ==
526
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   325
The Params library is a small library introduced in 0.9.21. It provides a function to parse the parameter string `ScriptParam` and it is intended to simplify using this string.
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   326
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   327
This library requires the parameter string to be in a certain format. It must be a comma-seperated list of kev-value pairs in the `key=value` format. Examples:
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   328
531
5628b472ab0d Copy-edit Params section
almikes@aol.com
parents: 530
diff changeset
   329
<code>speed=1</code>
5628b472ab0d Copy-edit Params section
almikes@aol.com
parents: 530
diff changeset
   330
<code>health=100, ammo=5</code>
5628b472ab0d Copy-edit Params section
almikes@aol.com
parents: 530
diff changeset
   331
<code>param1=hello, param2=whatever, param3=5325.4</code>
5628b472ab0d Copy-edit Params section
almikes@aol.com
parents: 530
diff changeset
   332
5628b472ab0d Copy-edit Params section
almikes@aol.com
parents: 530
diff changeset
   333
Using this library is by no means neccessary, you could use practically whatever syntax you wish if you write your own code for parsing.
526
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   334
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   335
==== `parseParams()` ====
526
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   336
Parses `ScriptParam` and writes the result into the global table `params`. The table will follow the `key=value` pattern. Both keys and pairs are stored as string.
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   337
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   338
===== Example  =====
526
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   339
<code language="lua">
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   340
function onParameters()
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   341
    parseParams()
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   342
    if params["myparam1"] == "hello" then
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   343
        WriteLnToConsole("Hello World!")
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   344
    end
528
88cc64932e78 Copy-editing on the entire page.
almikes@aol.com
parents: 527
diff changeset
   345
end</code>
526
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   346
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   347
If the key-value pair `myparam1=hello` is present, this script writes “Hello World!” in the console. All these inputs would trigger the event:
f910cf3241fc Add Params.
almikes@aol.com
parents: 525
diff changeset
   348
531
5628b472ab0d Copy-edit Params section
almikes@aol.com
parents: 530
diff changeset
   349
<code>myparam1=hello</code>
5628b472ab0d Copy-edit Params section
almikes@aol.com
parents: 530
diff changeset
   350
<code>myparam2=whatever, myparam1=hello</code>
532
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   351
<code>g=4, f=56, m=56, myparam1=hello</code>
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   352
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   353
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   354
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   355
== !TargetPractice ==
532
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   356
Starting with 0.9.21, this library provides a function to create an entire target practice mission which follows some basic properties.
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   357
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   358
Here is a brief description of the generated missions:
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   359
 * The player will get a team with a single hedgehog.
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   360
 * The team gets a single predefined weapon infinitely times.
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   361
 * A fixed sequence of targets will spawn at predefined positions.
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   362
 * When a target has been destroyed, the next target of the target sequence appears
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   363
 * The mission ends successfully when all targets have been destroyed
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   364
 * The mission ends unsuccessfully when the time runs out or the hedgehog dies
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   365
 * When the mission ends, a score is awarded, based on the performance (hit targets, accuracy and remaining time) of the hedgehog. When not all targets are hit, there will be no accuracy and time bonuses.
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   366
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   367
If you want to create a more sophisticated training mission, use your own code instead. The main motivation to write this library was to reduce redundancy in existing target practice missions.
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   368
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   369
Thos library also loads the Locale library for its own purposes. If you use !TargetPractice, you do not have to explicitly load Locale anymore.
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   370
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   371
=== `TargetPracticeMission(params)` ===
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   372
This function sets up the *entire* training mission and needs one argument: `params`.
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   373
`params` is a table containing fields which describe the training mission.
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   374
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   375
There are mandatory and optional fields. The optional fields have default values.
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   376
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   377
Mandatory fields:
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   378
|| *Field name* || *Description* ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   379
|| `missionTitle` || The name of the mission ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   380
|| `map` || The name of the image map to be used ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   381
|| `theme` || The name of the theme (can be background theme, too) ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   382
|| `time` || The time limit in milliseconds ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   383
|| `ammoType` || The [AmmoTypes ammo type] of the weapon to be used ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   384
|| `gearType` || The [GearTypes gear type] of the gear which is fired by the weapon (used to count shots) ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   385
|| `targets` || The coordinates of where the targets will be spawned. It is a table containing tables containing coordinates of format `{ x=value, y=value }`. The targets will be spawned in the same order as specified the coordinate tables appear. There must be at least 1 target. ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   386
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   387
Optional fields:
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   388
|| *Field name* || *Description * ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   389
|| `wind` || The initial wind (`-100` to `100`) (default: `0` (no wind)) ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   390
|| `solidLand` || Weather the terrain is indestructible (default: `false`) ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   391
|| `artillery` || If `true`, the hog can’t move (default: `false`) ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   392
|| `hogHat` || Hat of the hedgehog (default: `"NoHat"`) ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   393
|| `hogName` || Name of the hedgehog (default: `"Trainee"`) ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   394
|| `teamName` || Name of the hedgehog’s team (default: `"Training Team"`) ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   395
|| `teamGrave` || Name of the hedgehog’s grave ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   396
|| `clanColor` || Color of the (only) clan (default: `0xFF0204`, which is a red tone) ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   397
|| `goalText` || A short string explaining the goal of the mission (default: `"Destroy all targets within the time!"`) ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   398
|| `shootText`: || A string which says how many times the player shot, “`%d`” is replaced by the number of shots. (default: `"You have shot %d times."`) ||
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   399
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   400
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   401
==== Example ====
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   402
Below is the complete source code of the mission “Target Practice: Cluster Bomb”:
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   403
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   404
<code language="lua">HedgewarsScriptLoad("/Scripts/TargetPractice.lua")
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   405
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   406
local params = {
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   407
	ammoType = amClusterBomb,
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   408
	gearType = gtClusterBomb,
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   409
	missionTitle = "Cluster Bomb Training",
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   410
	solidLand = false,
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   411
	map = "Trash",
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   412
	theme = "Golf",
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   413
	hog_x = 756,
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   414
	hog_y = 370,
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   415
	hogName = loc("Private Nolak"),
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   416
	hogHat = "war_desertgrenadier1",
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   417
	teamName = loc("The Hogies"),
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   418
	targets = {
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   419
		{ x = 628, y = 0 },
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   420
		{ x = 891, y = 0 },
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   421
		{ x = 1309, y = 0 },
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   422
		{ x = 1128, y = 0 },
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   423
		{ x = 410, y = 0 },
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   424
		{ x = 1564, y = 0 },
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   425
		{ x = 1248, y = 476 },
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   426
		{ x = 169, y = 0 },
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   427
		{ x = 1720, y = 0 },
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   428
		{ x = 1441, y = 0 },
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   429
		{ x = 599, y = 0 },
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   430
		{ x = 1638, y = 0 },
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   431
	},
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   432
	time = 180000,
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   433
	shootText = loc("You have thrown %d cluster bombs."),
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   434
}
8b7a9c032722 Add TargetPractice library
almikes@aol.com
parents: 531
diff changeset
   435
683
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   436
TargetPracticeMission(params)</code>
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   437
742
1ece82f7b547 LuaLibraries: Add title
Wuzzy
parents: 684
diff changeset
   438
== !SpeedShoppa ==
683
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   439
Starting with 0.9.22, this library provides a function to create a simple shoppa-style mission.
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   440
684
5488179eb2d2 Minor copy-editing
Wuzzy
parents: 683
diff changeset
   441
In !SpeedShoppa missions, the player starts with infinite ropes and has to collect all crates as fast as possible and compete for the fastest time.
683
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   442
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   443
This library also loads the Locale library for its own purposes. If you use !SpeedShoppa, you do not have to explicitly load Locale anymore.
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   444
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   445
=== `SpeedShoppaMission(params)` ===
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   446
This function sets up the *entire* mission and needs one argument: `params`.
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   447
The argument “`params`” is a table containing fields which describe the training mission.
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   448
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   449
Mandatory fields:
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   450
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   451
|| *Field name* || *Description* ||
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   452
|| `map` || The name of the map to be used ||
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   453
|| `theme` || The name of the theme (does not need to be a standalone theme) ||
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   454
|| `time` || The time limit in milliseconds ||
684
5488179eb2d2 Minor copy-editing
Wuzzy
parents: 683
diff changeset
   455
|| `crates` || The coordinates of where the crates will be spawned. It is a table containing tables containing coordinates of format `{ x=value, y=value }`. There must be at least 1 crate. ||
683
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   456
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   457
Optional fields:
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   458
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   459
|| *Field name* || *Description* ||
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   460
|| `missionTitle` || The name of the mission (optional but highly recommended) (default: `"Speed Shoppa"`) ||
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   461
|| `hogHat` || Hat of the hedgehog (default: `"NoHat"`) ||
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   462
|| `hogName` || Name of the hedgehog (default: `"Roper"`) ||
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   463
|| `teamName` || Name of the hedgehog’s team (default: `"Shoppers"`) ||
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   464
|| `teamGrave` || Name of the hedgehog’s grave (default: `"Statue"`) ||
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   465
|| `teamFlag` || Name of the team’s flag (default: `"cm_shoppa"`) ||
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   466
|| `clanColor` || Color of the (only) clan (default: `0xFF0204`, which is a red tone) ||
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   467
|| `goalText` || A short string explaining the goal of the mission (default: `"Use your rope to collect all crates as fast as possible."`) ||
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   468
|| `faceLeft` || If `true`, the hog faces to the left initially, if false, it faces to the right. (default: `false` (=right)) ||
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   469
|| `crateType` || Specify the type of crate (this has no gameplay effect), pick one of `"ammo"`, `"utility"`, `"health"`. Default: `"ammo"` ||
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   470
|| `extra_onGameStart` || A function which is called at the end of this script's `onGameStart`. It takes no parameters. You could use this to spawn additional gears like girders or mines ||
6e31eaf0b22d Add SpeedShoppa documentation
Wuzzy
parents: 587
diff changeset
   471
|| `extra_onGameInit` || A function which is called at the end of this script's `onGameInit` ||