LuaGuide.wiki
author Wuzzy
Thu, 21 Sep 2017 00:57:30 +0100
changeset 1033 ea42a17739d0
parent 901 8e65ab2cd36d
child 1414 a76bfb278ad9
permissions -rw-r--r--
LuaAPI: fix spawnammocrate mistakes
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
29
19a3182cac9d Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
     1
#summary Guide to writing Lua scripts in Hedgewars.
19a3182cac9d Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
     2
895
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
     3
= Lua guide =
31
e713a5d2a7f9 Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 30
diff changeset
     4
895
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
     5
This is both a simplistic introduction to Lua scripting in Hedgewars and a guide for more advanced control over the game. With Lua scripting, one can define own missions (both in training and campaign menu), [PresetMaps mission maps] (like Knockball) and styles (like Highlander).
30
43e5101de029 Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 29
diff changeset
     6
43e5101de029 Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 29
diff changeset
     7
== What is a Lua script ==
29
19a3182cac9d Created wiki page through web user interface.
henrik.rostedt
parents:
diff changeset
     8
895
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
     9
A Lua script is used to make the game behave different by giving the Hedgewars engine different commands. The script gets called by the engine on different events and the script tells the engine what to do.
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
    10
Lua is a programming language, and you must first learn some basics about the Lua programming language to get started. See [http://www.lua.org/] to learn more.
32
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    11
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    12
== The basic structure ==
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    13
896
ff2bb096e079 LuaGuide: campaign fix
Wuzzy
parents: 895
diff changeset
    14
Dependent on what type of script you want to write the requirements are a bit different, but before we go into that we must first create the `.lua` file. The location of the file depends on the script type.
895
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
    15
897
c3ce54152c05 LuaGuide: fix bad bullets
Wuzzy
parents: 896
diff changeset
    16
   * If you want to make a mission for multi player you create a map and create a new file `map.lua` in the map's folder.
c3ce54152c05 LuaGuide: fix bad bullets
Wuzzy
parents: 896
diff changeset
    17
   * If you want to make a training mission then you create a new `.lua` file under `Data/Missions/Training` folder.
c3ce54152c05 LuaGuide: fix bad bullets
Wuzzy
parents: 896
diff changeset
    18
   * Campaign missions go into `Data/Missions/Campaign/<CAMPAIGN NAME>`.
c3ce54152c05 LuaGuide: fix bad bullets
Wuzzy
parents: 896
diff changeset
    19
   * If you want to make a custom game style like Highlander, create a new `.lua` file in `Data/Scripts/Multiplayer`.
32
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    20
896
ff2bb096e079 LuaGuide: campaign fix
Wuzzy
parents: 895
diff changeset
    21
To get started, a `.lua` file should generally be structured like this:
32
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    22
{{{
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    23
function onGameInit()
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    24
end
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    25
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    26
function onAmmoStoreInit()
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    27
end
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    28
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    29
function onGameStart()
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    30
end
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    31
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    32
function onGameTick()
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    33
end
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    34
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    35
function onGearAdd(gear)
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    36
end
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    37
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    38
function onGearDelete(gear)
5f66adfa478c Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 31
diff changeset
    39
end
35
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    40
}}}
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    41
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    42
These are event handlers and are called on different events by the engine. Now lets look at the initiation events.
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    43
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    44
== The initiation events ==
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    45
681
ce0819a5ec57 Some copy-editing
Wuzzy
parents: 592
diff changeset
    46
The two most important event handlers are `onGameInit` and `onAmmoStoreInit`. They are used instead of loading a game scheme and weapon scheme and in campaign missions or standalone missions `onGameInit` is also used to add teams and hogs.
35
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    47
681
ce0819a5ec57 Some copy-editing
Wuzzy
parents: 592
diff changeset
    48
First we have `onGameInit`. On this event we should add all game modifiers and team setup. If you are making a mission you only need to specify the things you want to change on this event, everything not changed will be set to default. The available game modifiers can be found here: [LuaAPI#onGameInit()]
35
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    49
895
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
    50
An example of setting up Barrel Mayhem in a style:
35
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    51
{{{
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    52
function onGameInit()
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    53
    GameFlags = gfRandomOrder + gfSharedAmmo
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    54
    TurnTime = 30000
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    55
    CaseFreq = 0
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    56
    MinesNum = 0
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    57
    MinesTime = 0
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    58
    Explosives = 40
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    59
end
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    60
}}}
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    61
681
ce0819a5ec57 Some copy-editing
Wuzzy
parents: 592
diff changeset
    62
If you are doing a training or campaign mission you should also set `Seed`, `Map` and `Theme`. But you must also add teams and hogs on this event. This is done by using `AddTeam` and `AddHog`. An example of adding one team with one hog (these functions may only be used here):
35
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    63
{{{
895
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
    64
AddTeam("Team", 0xFF0002, "Simple", "Island", "Default", "hedgewars")
35
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    65
AddHog("Hedgehog", 0, 1, "NoHat")
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    66
}}}
895
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
    67
To be able to play you must add another team and hog that should have another team color (this team has `0xFF0002`) or if you only want one team add the game flag `gfOneClanMode`. Look into [LuaAPI] to see what the other parameters of `AddTeam` and `AddHog` are.
35
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    68
681
ce0819a5ec57 Some copy-editing
Wuzzy
parents: 592
diff changeset
    69
In `onAmmoStoreInit` you set what weapons is available in the game. For every weapon run [LuaAPI#SetAmmo_(ammoType,_count,_probability,_delay,_numberInCrate) SetAmmo].
36
f66efe81d8c0 Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 35
diff changeset
    70
This is used to set both starting weapons and weapons found in crates.
35
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    71
895
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
    72
Here is an example of the initiation of a training mission:
35
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    73
{{{
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    74
function onGameInit()
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    75
    Seed = 0
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    76
    GameFlags = gfMultiWeapon + gfOneClanMode
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    77
    TurnTime = 25000
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    78
    CaseFreq = 0
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    79
    MinesNum = 0
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    80
    Explosives = 0
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    81
    Delay = 0
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    82
    Map = "Mushrooms"
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    83
    Theme = "Nature"
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    84
895
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
    85
    AddTeam("Team", 0xFF00002, "Simple", "Island", "Default", "hedgewars")
35
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    86
    AddHog("Hedgehog", 0, 1, "NoHat")
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    87
end
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    88
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    89
function onAmmoStoreInit()
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    90
    SetAmmo(amShotgun, 9, 0, 0, 0)
532bb2509f0b Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 32
diff changeset
    91
end
37
acd631a56390 Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 36
diff changeset
    92
}}}
acd631a56390 Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 36
diff changeset
    93
acd631a56390 Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 36
diff changeset
    94
== Gears everywhere ==
acd631a56390 Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 36
diff changeset
    95
895
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
    96
Mostly everything in Hedgewars are made out of gears: grenades, bazooka shells, and cakes just to name a few. But these are just the visible gears, the whip's effect and rising water are also gears. But for now we will focus on the more visible ones.
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
    97
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
    98
The hogs are gears, too and when you shoot with bazooka the bazooka shell will be created and explode when it hits the ground. When the shell is created the `onGearAdd` event is called and the `gear` parameter will be the bazooka.
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
    99
And when it hits the ground, before the gear has been deleted, `onGearDelete` is invoked with the shell as parameter, after that it is removed.
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
   100
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
   101
Each gear has a [GearTypes gear type], for instance, a bazooka shell has the gear type of `gtShell`, a grenade has a gear type of `gtGrenade`, and so on. You will almost always need to check for the gear type with `GetGearType` in the `onGearAdd` function in order to do anything meaningful.
899
011ca6031678 LuaGuide: better Gears section
Wuzzy
parents: 898
diff changeset
   102
011ca6031678 LuaGuide: better Gears section
Wuzzy
parents: 898
diff changeset
   103
Gears also have a lot of various values to track their position, state, etc. These can be accessed and written to with several “getter” and “setter” functions like `GetPos`, `GetHealth`, `SetTag`, etc. See [LuaAPI] for a full list. In Hedgewars, the gear values and some variable names do not always really mean what they seem to be, their concrete meaning often depends on the actual gear type. For instance, using `GetHealth(h)` on a hedgehog gear (gear type: `gtHedgehog`) will return its health (obviously). Less obviously, using `GetHealth` on a flying saucer gear (gear type: `gtJetpack`) will return its amount of fuel.
011ca6031678 LuaGuide: better Gears section
Wuzzy
parents: 898
diff changeset
   104
011ca6031678 LuaGuide: better Gears section
Wuzzy
parents: 898
diff changeset
   105
To learn all the gory detaily about gears, see [GearTypes].
895
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
   106
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
   107
== Other important event handlers ==
37
acd631a56390 Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 36
diff changeset
   108
898
159bbbd0ab0a LuaGuide: better paragraphicing of gametick funcs
Wuzzy
parents: 897
diff changeset
   109
The last important event handlers are `onGameTick` and `onGameTick20`. `onGameTick` is called every game tick, that is every millisecond which is a thousand times a second. `onGameTick20` is called every 20 game ticks, that is, every 20 milliseconds.
159bbbd0ab0a LuaGuide: better paragraphicing of gametick funcs
Wuzzy
parents: 897
diff changeset
   110
159bbbd0ab0a LuaGuide: better paragraphicing of gametick funcs
Wuzzy
parents: 897
diff changeset
   111
These functions are very important for specifying actions which need to happen regularily. It is important to know when to use `onGameTick`, and when to use `onGameTick20`. You can usually get away with just using `onGameTick` but must make sure any code inserted here must be efficient and fast, as this function is called very often. Complex code which takes more time to execute should go into `onGameTick20` instead.
159bbbd0ab0a LuaGuide: better paragraphicing of gametick funcs
Wuzzy
parents: 897
diff changeset
   112
895
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
   113
If you need a different interval other than 1 or 20 milliseconds, you can use modulo on the `GameTicks` variable which holds the total number of game ticks since the beginning of the game.
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
   114
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
   115
== Getting started … for real ==
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
   116
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
   117
This was just a simplistic introduction which didn't cover everything. If you want to l
37
acd631a56390 Edited wiki page LuaGuide through web user interface.
henrik.rostedt
parents: 36
diff changeset
   118
895
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
   119
A good way to learn Lua scripting in Hedgewars is to read existing scripts. We recommend to take a look into `Data/Missions/Training/Basic_Training_-_Sniper_Rifle.lua` which is the Lua script for the Sniper Rifle target practice training mission. It should give you a rough “feeling” of how a script is supposed to look and is heavily commented.
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
   120
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
   121
Continue with the following pages to learn more:
9db173fcf26e LuaGuide: Make the Lua guide more complete
Wuzzy
parents: 681
diff changeset
   122
900
f8887a49ad91 LuaGuide: fix bad bullets
Wuzzy
parents: 899
diff changeset
   123
   * [LuaAPI] contains a reference of most available functions and global variables
901
8e65ab2cd36d LuaGuide: add link to missions
Wuzzy
parents: 900
diff changeset
   124
   * [Missions] for a more in-depth guide on how to create missions
900
f8887a49ad91 LuaGuide: fix bad bullets
Wuzzy
parents: 899
diff changeset
   125
   * [LuaLibraries] contains information about “libraries”, that is, extra scripts you can include for even more functions. One common library is `Locale` for making a mission translatable
f8887a49ad91 LuaGuide: fix bad bullets
Wuzzy
parents: 899
diff changeset
   126
   * [GearTypes] contains the list of all gear types, along with an explanation of how the gears and their values work