author | Wuzzy |
Tue, 21 Aug 2018 21:30:15 +0100 | |
changeset 1516 | 4b3e233e5ac0 |
parent 1515 | ca760c9fcca4 |
child 1518 | 1840cbe874bb |
permissions | -rw-r--r-- |
67
eecbb1c261bb
Edited wiki page LuaAPI through web user interface.
henrik.rostedt
parents:
66
diff
changeset
|
1 |
#summary API for writing Lua scripts in Hedgewars. |
284
365362b51148
This is cool stuff, let's put it on the project frontpage (adding "featured" tag)
sheepyluva@gmail.com
parents:
244
diff
changeset
|
2 |
#labels Featured |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
3 |
|
741 | 4 |
= Core Lua API documentation = |
5 |
||
312
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
6 |
== Introduction == |
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
7 |
|
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
8 |
Version 0.9.13 of Hedgewars introduced the ability to use Lua scripts to modify Hedgewars behaviour for different maps without having to recompile the whole game. The till then used triggers (only appeared in training maps) were removed. |
1426 | 9 |
|
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
10 |
Lua is an easy to learn scripting language that’s implemented using open source libraries. If you’d like to learn more about Lua, have a look at [http://www.lua.org Lua's official homepage]. Even though its easy to learn syntax this wiki page won't explain all basics of using Lua, e.g. declaring variables or using control structures. There are tons of step-by-step tutorials and documentation available on the internet. Just throw “Lua” into your favourite search engine and give it a try. |
312
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
11 |
|
519 | 12 |
=== About this wiki page === |
1240 | 13 |
This page might become outdated. For a list of undocumented functions, see [http://hw.ercatec.net/docs/lua_wiki_check.php]. |
312
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
14 |
|
519 | 15 |
<wiki:toc max_depth="4" /> |
16 |
||
859 | 17 |
== Overview == |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
18 |
=== How Hedgewars handles Lua scripts === |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
19 |
As of Version 0.9.20, Hedgewars supports Lua scripts for two similar tasks: Define tutorial missions, campaign missions or provide special map behaviour for precreated maps. It is also used for multiplayer scripts to create new game styles. |
312
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
20 |
|
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
21 |
=== Tutorial missions === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
22 |
Tutorial missions are located within text files inside `share/hedgewars/Data/Missions/Training`. The game will list all files with the lua extension inside this directory in the Training selection screen. You’ll find some premade example scripts within this directory that contain several comments on the script lines and what they do. |
312
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
23 |
|
567 | 24 |
See [Missions] for details. |
25 |
||
312
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
26 |
=== Special maps === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
27 |
In addition to tutorial missions predrawn maps (maps not created using the random map creator) may contain a single lua script file named `map.lua`. If it’s there, it will be used once the map is played. This way it’s possible to play maps alone or over the internet using custom goals. Mission maps can be found in singleplayer mode under the “training” button and in multiplayer mode, it is selectable as a map type. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
28 |
|
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
29 |
See also [PresetMaps] for more information about such maps. |
312
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
30 |
|
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
31 |
=== How Lua scripts are used === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
32 |
Several parts of script files are executed multiple times. In general, the whole script file is read while loading the map. Declarations as well as function calls outside functions are executed at once. Later on the game will call special predefined function names at special occassions such as the creation of new game objects (called “gears”). |
312
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
33 |
|
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
34 |
|
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
35 |
=== Important things to know === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
36 |
It is possible to play missions in multiplayer. However this requires all participating players to have the exact same version of the map files, including the `map.lua` script file. If this isn’t the case the game will probably desync and “kick” at least the one player using a different version of the map files. To avoid problems when running prepackaged maps, you should never modify any maps provided with the Hedgewars default package. Instead, create a copy of the existing map and modify this one. Feel free to share your work on the forums. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
37 |
|
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
38 |
Another thing to note is the current status of our scripting implementation. Similar to the whole game, this is still work in progress and we can’t guarantee that scripts working in this version will run in future revisions of the game as we might extend, change or rename parts of the scripting engine. |
312
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
39 |
|
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
40 |
=== Global variables/constants === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
41 |
Global variables are used by the game to interact with the scripts by passing and retrieving their values. While some of the variables are never read by the engine some allow you to modify the engine’s behaviour, e.g. the theme to be used for the current map. |
312
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
42 |
|
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
43 |
|
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
44 |
=== Functions called by the game: Event handlers === |
312
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
45 |
After successfully loading the Lua script the game will call the following functions on different occasions. To be used, they have to use the exact same name as defined below. |
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
46 |
|
478 | 47 |
== Data types == |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
48 |
This section defines some commonly used non-primitive parameter types which are used in multiple functions. This section is a bit incomplete at the moment. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
49 |
|
478 | 50 |
=== Color === |
477
8c326a00ead3
Add information about the “color” parameter found in some functions.
almikes@aol.com
parents:
476
diff
changeset
|
51 |
Some functions take a `color` parameter. |
8c326a00ead3
Add information about the “color” parameter found in some functions.
almikes@aol.com
parents:
476
diff
changeset
|
52 |
|
583
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
53 |
Colors are stored in RGB or RGBA format and are specified as a three- or four-byte number, respecively. |
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
54 |
In 3-byte (RGB) colors, each byte represents a color component. The value 0 means no intensity and 255 is largest intensity of the component. |
477
8c326a00ead3
Add information about the “color” parameter found in some functions.
almikes@aol.com
parents:
476
diff
changeset
|
55 |
The first byte is for the red component, the second byte for the green component and the third byte for the blue component. |
583
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
56 |
Four-byte (RGBA) colors use the first 3 bytes for the color components (like for the 3-byte colors) and the fourth byte is used for opacity, where 255 means maximum opacity and 0 means fully transparent (also called the “alpha channel”). |
477
8c326a00ead3
Add information about the “color” parameter found in some functions.
almikes@aol.com
parents:
476
diff
changeset
|
57 |
|
8c326a00ead3
Add information about the “color” parameter found in some functions.
almikes@aol.com
parents:
476
diff
changeset
|
58 |
Specifying the color number becomes much easier if you write it in hexadecimal notation. |
8c326a00ead3
Add information about the “color” parameter found in some functions.
almikes@aol.com
parents:
476
diff
changeset
|
59 |
|
583
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
60 |
Examples for RGB (3-byte) colors: |
477
8c326a00ead3
Add information about the “color” parameter found in some functions.
almikes@aol.com
parents:
476
diff
changeset
|
61 |
<code language="lua"> |
8c326a00ead3
Add information about the “color” parameter found in some functions.
almikes@aol.com
parents:
476
diff
changeset
|
62 |
c = 0x000000 -- black (R, G, B are all 0) |
8c326a00ead3
Add information about the “color” parameter found in some functions.
almikes@aol.com
parents:
476
diff
changeset
|
63 |
c = 0xFF0000 -- red |
8c326a00ead3
Add information about the “color” parameter found in some functions.
almikes@aol.com
parents:
476
diff
changeset
|
64 |
c = 0x00FF00 -- green |
8c326a00ead3
Add information about the “color” parameter found in some functions.
almikes@aol.com
parents:
476
diff
changeset
|
65 |
c = 0x0000FF -- blue |
8c326a00ead3
Add information about the “color” parameter found in some functions.
almikes@aol.com
parents:
476
diff
changeset
|
66 |
c = 0xFFFFFF -- white |
8c326a00ead3
Add information about the “color” parameter found in some functions.
almikes@aol.com
parents:
476
diff
changeset
|
67 |
c = 0x808080 -- gray (50%)</code> |
8c326a00ead3
Add information about the “color” parameter found in some functions.
almikes@aol.com
parents:
476
diff
changeset
|
68 |
|
885 | 69 |
Hint: On [http://www.colorpicker.com/] you find a color-picking tool for getting RGB colors easily. |
70 |
||
312
6c0397400a9b
Add Smaxx' nice lua API introduction from the hedgewars.org wiki
sheepyluva@gmail.com
parents:
295
diff
changeset
|
71 |
|
491
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
72 |
== Globally available variables and constants == |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
73 |
The following variables are made available by Hedgewars in Lua and can be used to quickly query a value. Lua scripts schould normally *not* write to these variables, only read from them. |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
74 |
|
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
75 |
=== General variables and constants === |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
76 |
Here are some unsorted variables or constants which are available in Lua. You shouldn’t write to most of them. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
77 |
|
491
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
78 |
|| *Identifier* || *Description* || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
79 |
|| `LAND_WIDTH` || The width of the landscape in pixels || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
80 |
|| `LAND_HEIGHT` || The height of the landscape in pixels || |
1301 | 81 |
|| `LOCALE` || Current locale identifier (e.g. “de” for German) || |
1074 | 82 |
|| `LeftX` || X coordinate of the leftmost point of the landscape || |
83 |
|| `RightX` || X coordinate of the rightmost point of the landscape || |
|
84 |
|| `TopY` || Y coordinate of the topmost point of the landscape || |
|
819 | 85 |
|| `CursorX` || The X position of the cursor if the player is choosing a target. Otherwise, this is `-2147483648` || |
86 |
|| `CursorY` || The Y position of the cursor if the player is choosing a target. Otherwise, this is `-2147483648` || |
|
491
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
87 |
|| `WaterLine` || The y position of the water, used to determine at which position stuff drowns. Use `SetWaterLine` to change. || |
1157 | 88 |
|| `ClansCount` || Number of clans, including defeated ones (a clan is a group of teams with same color) || |
89 |
|| `TeamsCount` || Number of teams, including defeated ones || |
|
491
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
90 |
|| `TurnTimeLeft` || Number of game ticks (milliseconds) left until the current turn ends. You can change this variable directly. || |
1112 | 91 |
|| `ReadyTimeLeft` || Remaining ready time in millseconds, 0 if turn in progress. Can be set in onNewTurn. In other places, it should only be read, not written. || |
491
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
92 |
|| `GameTime` || Number of total game ticks || |
1158 | 93 |
|| `TotalRounds` || Number of rounds that have passed. Equals `-1` if game has not started yet or hogs are still being placed. This variable is buggy in 0.9.23 and earlier! || |
491
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
94 |
|| `CurrentHedgehog` || The hedgehog gear that is currently in play || |
1155 | 95 |
|| `AmmoTypeMax` || Maximum ammo type ID (useful to iterate through all ammo types, starting by 0) || |
125
b0b7654c6de6
Edited wiki page LuaAPI through web user interface.
RedGrinner@gmail.com
parents:
123
diff
changeset
|
96 |
|
491
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
97 |
=== !GameFlags === |
557 | 98 |
The !GameFlags are used to store simple boolean settings of the game. |
99 |
You can read/modify them using the [LuaAPI#GameFlags_functions GameFlags-Functions]. |
|
102
86cf695636c6
Added gfResetHealth to Gameflags section along with a note.
RedGrinner@gmail.com
parents:
101
diff
changeset
|
100 |
|
491
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
101 |
|| *Identifier* || *Description (active state)* || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
102 |
|| `gfOneClanMode` || Used when only one clan is in the game. This game flag is primarily used for training missions. || |
1504 | 103 |
|| `gfMultiWeapon` || Shooting any weapon enters multi-shot mode with infinite shots. The remaining shots counter for weaoons like shotgun is suppressed. For target practice missions, not recommended for anything else. || |
1300 | 104 |
|| `gfSwitchHog` || Free hog switching at turn start || |
1505 | 105 |
|| `gfDivideTeams` || Each clan will start in its own side of the terrain || |
626 | 106 |
|| `gfBorder` || An indestructible border is active around the map. || |
491
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
107 |
|| `gfBottomBorder` || There is an indestructable border at the bottom of the map. || |
626 | 108 |
|| `gfShoppaBorder` || The terrain edge will be replaced by a decorative black/yellow “danger stripe”. This has no gameplay effect. || |
491
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
109 |
|| `gfSolidLand` || The terrain is indestructible. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
110 |
|| `gfLowGravity` || The gravity is low. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
111 |
|| `gfLaserSight` || A laser sight is almost always active. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
112 |
|| `gfInvulnerable` || All hedgehogs are invulnerable. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
113 |
|| `gfVampiric` || All hedgehogs become vampires and get 80% of the damage they deal as health. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
114 |
|| `gfKarma` || Attackers share the damage they deal to enemies. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
115 |
|| `gfArtillery` || Hedgehogs can’t walk. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
116 |
|| `gfRandomOrder` || The game is played in random order. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
117 |
|| `gfPlaceHog` || Placement mode: At the beginning of the round, all hedgehogs are placed manually first. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
118 |
|| `gfKing` || King Mode: One hedgehog per team becomes their king, if the king dies, the team loses. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
119 |
|| `gfSharedAmmo` || Teams in the same clan share their ammo. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
120 |
|| `gfDisableGirders` || No girders will be created in random maps || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
121 |
|| `gfDisableLandObjects` || No land objects will be created in random maps || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
122 |
|| `gfAISurvival` || Computer-controlled hedgehogs will be revived after they die. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
123 |
|| `gfInfAttack` || Attacks don’t end the turn. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
124 |
|| `gfResetWeps` || The weapons will be reset to the initial state each turn. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
125 |
|| `gfPerHogAmmo` || Each hedgehog has its own weapon stash. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
126 |
|| `gfDisableWind` || There is no wind. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
127 |
|| `gfMoreWind` || There is always strong wind. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
128 |
|| `gfTagTeam` || Tag Team: Teams in the same clan share their turn time. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
129 |
|| `gfResetHealth` || The health of all living hedgehogs is reset at the end of each turn. || |
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
130 |
|
540 | 131 |
=== Land flags === |
132 |
The land flags denote several types of terrain. Like all flags, they can be combined at will. |
|
133 |
||
134 |
|| *Identifier* || *Meaning* || |
|
135 |
|| `lfIce` || Slippery terrain, hogs will slide on it. || |
|
136 |
|| `lfBouncy` || Bouncy terrain, hogs and some other gears will bounce off when they collide with it. || |
|
137 |
|| `lfIndestructible` || Almost indestructible terrain, most weapons will not destroy it. || |
|
1228 | 138 |
|| `0` || Normal destroyable terrain. Note that this is the case when no other land flag is set. || |
540 | 139 |
|
491
9079444264ae
Update section “Global available constants”: Use tables, fix gameflags section (was outdated, some gameflags were missing).
almikes@aol.com
parents:
478
diff
changeset
|
140 |
=== More constants === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
141 |
More constants are at at [GearTypes Gear Types] , [AmmoTypes Ammo Types], [Sounds], [States], [Sprites], [VisualGearTypes Visual Gear Types]. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
142 |
|
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
143 |
== Event handlers == |
890 | 144 |
Lua scripts are supposed to _define_ these functions to do something. The functions are then _called_ by Hedgewars when a certain event has occoured. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
145 |
|
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
146 |
=== <tt>onGameInit()</tt> === |
860 | 147 |
This function is called before the game loads its resources. One can read and modify various game variables here. These variables will become globally available after `onGameInit` has been invoked, but changing them has only an effect in `onGameInit`. |
148 |
Most variables are optional, but for missions, `Theme` must be set by the scripter if you want to use a random map, rather than an image map. All other variables do not need to be set by the scripter and have default values. |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
149 |
|
860 | 150 |
List of game variables: |
863 | 151 |
|| *Identifier* || *Default* || *Description* || |
860 | 152 |
|| `Theme` || _depends_ || The theme to be used. When `Map` is set, a default value is used. For missions which don't use an image map, `Theme` *must* be set explicitly || |
153 |
|| `Map` || `""` || The image map being played or `""` if no image map is used || |
|
154 |
|| `Seed` || `0` || Seed of the random number generator || |
|
155 |
|| `MapGen` || `mgRandom` || Type of map generator. One of `mgRandom`, `mgMaze`, `mgPerlin`, `mgDrawn`. || |
|
156 |
|| `TemplateFilter` || `0` || _unknown meaning_ || |
|
157 |
|| `TemplateNumber` || `0` || _unknown meaning_ || |
|
864 | 158 |
|| `MapFeatureSize` || `50` || Used by random maps to determine its “curvyness” or complexity. This value can be set by the user with the slider under the random map preview in the game setup screen. The user-set value ranges from 1 (leftmost position) to 25 (rightmost position). A good starting value is `12`. || |
1251 | 159 |
|| `GameFlags` || `0` || All `GameFlags` combined as a bitmask. Setting `GameFlags` directly is discouraged, use the [LuaAPI#GameFlags_functions] instead || |
860 | 160 |
|| `Ready` || `5000` || Ready timer at the start of the turn (in milliseconds) || |
161 |
|| `Delay` || `100` || Delay between each turn in milliseconds || |
|
162 |
|| `TurnTime` || `45000` || Turn time in milliseconds || |
|
163 |
|| `GetAwayTime` || `100` || Retreat time in percent || |
|
164 |
|| `CaseFreq` || `5` || Probability that a crate drops in a turn. 0: never, >0: probability = `1/CaseFreq` || |
|
165 |
|| `HealthCaseProb` || `35` || Chance that a crate drop is a health crate, in percent (other crates are ammo or utility crates) || |
|
166 |
|| `HealthCaseAmount` || `25` || Amount of health in a health crate || |
|
167 |
|| `DamagePercent` || `100` || Global damage in percent, affects damage and knockback || |
|
168 |
|| `RopePercent` || `100` || Rope length in percent || |
|
169 |
|| `MinesNum` || `4` || Number of mines being placed on a medium-sized map || |
|
170 |
|| `MinesTime` || `3000` || Time for a mine to explode from activated (in milliseconds), `-1000` for random || |
|
171 |
|| `MineDudPercent` || `0` || Chance of mine being a dud, in percent || |
|
1111 | 172 |
|| `AirMinesNum` || `0` || Number of air mines being placed on a medium-sized map || |
860 | 173 |
|| `Explosives` || `2` || Number of barrels being placed on a medium-sized map || |
1503 | 174 |
|| `SuddenDeathTurns` || `15` || Number of rounds until Sudden Death begins (ignoring the first round) || |
862 | 175 |
|| `WaterRise` || `47` || Height of water rise in pixels for each Sudden Death turn || |
861 | 176 |
|| `HealthDecrease` || `5` || Amount of health decreased on each turn in Sudden Death || |
860 | 177 |
|| `Goals` || `""` || Use this to add additional text to the goal text popup shown at the beginning and when using the quit or pause keys. The text is added to the default text which usually explains the game modifiers and does not replace it. Use `|` for line breaks. Also, all text before and including a `:` in a line will be highlighted. See also `ShowMission`. || |
1111 | 178 |
|| `WorldEdge` || `weNone` || Type edges being used at the left and right sides of the terrain (see below). || |
860 | 179 |
|| `ScreenWidth` || _N/A_ || Width of the Hedgewars window or screen || |
890 | 180 |
|| `ScreenHeight` || _N/A_ || Height of the Hedgewars window or screen || |
860 | 181 |
|
862 | 182 |
The proper way to disable Sudden Death is by setting both `WaterRise` and `HealthDecrease` to `0`. |
183 |
||
860 | 184 |
If you want to add teams or hogs manually, you have to do it here. If you want to draw your own map using `AddPoint` and `FlushPoints`, you have to do this within this function as well. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
185 |
|
917 | 186 |
==== `WorldEdge` ==== |
187 |
The value of `WorldEdge` can have the following values: |
|
188 |
||
189 |
|| *Identifier* || *Meaning* || |
|
190 |
|| `weNone` || No world edges || |
|
191 |
|| `weBounce` || Bouncy world edges || |
|
192 |
|| `weWrap` || World wraps around at the edges || |
|
193 |
|| `weSea` || Ocean world edges || |
|
194 |
||
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
195 |
=== <tt>onGameStart()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
196 |
This function is called when the first round starts. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
197 |
|
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
198 |
Can be used to show the mission and for more setup, for example initial target spawning. |
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
199 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
200 |
=== <tt>onPreviewInit()</tt> === |
461 | 201 |
This function is called when the map preview in the frontend is initialized. This happens when the script is selected or you change a map generator parameter. |
202 |
||
203 |
It is useful for scripts which create their own maps (see `AddPoint` and `FlushPoints`). If you create a map in this function, a preview will be generated from this map and is exposed to the frontend. |
|
204 |
||
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
205 |
=== <tt>onParameters()</tt> === |
505 | 206 |
This function is called when the script parameters (as specified in the game scheme) become available. The script parameter string is stored in the global variable `ScriptParam`. |
207 |
||
208 |
Please note that it is normally not safe to call many of the other functions inside this function, this function is called very early in the game, only use this to initialize variables and other internal stuff like that. |
|
209 |
||
210 |
*Tip*: If you use the Params library (`/Scripts/Params.lua`), you can make the task of dissecting the string into useful values a bit easier, but it’s not required. (The Params library is not documented yet, however). |
|
211 |
||
212 |
*Tip*: If you use this callback, make sure to document the interpretation of the parameters so others know how to set the parameters properly. |
|
213 |
||
64
a651a8ab85d5
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
63
diff
changeset
|
214 |
=== <tt>onGameTick()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
215 |
This function is called on every game tick, i.e. 1000 times a second. If you just need to check on something periodically, consider `onGameTick20`. |
346
5f322c85c0e0
toss in onGameTick20 - this page needs more updating tho
kyberneticist@gmail.com
parents:
328
diff
changeset
|
216 |
|
5f322c85c0e0
toss in onGameTick20 - this page needs more updating tho
kyberneticist@gmail.com
parents:
328
diff
changeset
|
217 |
=== <tt>onGameTick20()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
218 |
This function is called every 20 game ticks, which equals 50 times a second. It reduces Lua overhead for simple monitoring that doesn’t need to happen every single tick. |
64
a651a8ab85d5
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
63
diff
changeset
|
219 |
|
181 | 220 |
=== <tt>onNewTurn()</tt> === |
1112 | 221 |
This function calls at the start of every turn. You can set `ReadyTimeLeft` here to change the ready time for this turn. (See also: `Ready`) |
63
24004a9003ec
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
62
diff
changeset
|
222 |
|
1189 | 223 |
=== <tt>onEndTurn()</tt> (0.9.24) === |
224 |
This function calls at the end of every turn. The end of a turn is defined as the point of time after the current hedgehog lost control and all the important gears are either gone or have settled. |
|
225 |
||
226 |
`CurrentHedgehog` holds the gear ID of the hedgehog whose turn just ended. |
|
227 |
||
228 |
This function is called at one of the earliest possible moment after the end of a turn. After this callback, Hedgewars then performs all the other stuff between turns. This includes things like: Applying poison or Sudden Death damage, calculating total hog damage, rising the water in Sudden Death, dropping a crate, checking victory, giving control to the next hog. |
|
229 |
||
230 |
Because this function is called *before* victories are checked, this is useful to set up your victory conditions here. |
|
231 |
||
1269 | 232 |
=== <tt>onSkipTurn()</tt> (0.9.24) === |
233 |
This function calls when a hog skips its turn. |
|
234 |
||
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
235 |
=== <tt>onSuddenDeath()</tt> === |
649 | 236 |
This function is called on the start of Sudden Death. |
237 |
||
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
238 |
=== <tt>onGearAdd(gearUid)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
239 |
This function is called when a new gear is added. Useful in combination with `GetGearType(gearUid)`. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
240 |
|
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
241 |
=== <tt>onGearDelete(gearUid)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
242 |
This function is called when a new gear is deleted. Useful in combination with `GetGearType(gearUid)`. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
243 |
|
916
a01743eb08f1
LuaAPI: onVisualGearAdd, onVisualGearDelete, GetVisualGearType
Wuzzy
parents:
913
diff
changeset
|
244 |
=== <tt>onVisualGearAdd(vgUid)</tt> (0.9.23) === |
a01743eb08f1
LuaAPI: onVisualGearAdd, onVisualGearDelete, GetVisualGearType
Wuzzy
parents:
913
diff
changeset
|
245 |
This function is called when a new visual gear is added. Useful in combination with `GetVisualGearType(vgUid)`. |
a01743eb08f1
LuaAPI: onVisualGearAdd, onVisualGearDelete, GetVisualGearType
Wuzzy
parents:
913
diff
changeset
|
246 |
|
a01743eb08f1
LuaAPI: onVisualGearAdd, onVisualGearDelete, GetVisualGearType
Wuzzy
parents:
913
diff
changeset
|
247 |
=== <tt>onVisualGearDelete(vgUid)</tt> (0.9.23) === |
a01743eb08f1
LuaAPI: onVisualGearAdd, onVisualGearDelete, GetVisualGearType
Wuzzy
parents:
913
diff
changeset
|
248 |
This function is called when a new visual gear is deleted. Useful in combination with `GetVisualGearType(vgUid)`. |
a01743eb08f1
LuaAPI: onVisualGearAdd, onVisualGearDelete, GetVisualGearType
Wuzzy
parents:
913
diff
changeset
|
249 |
|
181 | 250 |
=== <tt>onGearDamage(gearUid, damage)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
251 |
This function is called when a gear is damaged. |
55
ef26ff619aea
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
54
diff
changeset
|
252 |
|
ef26ff619aea
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
54
diff
changeset
|
253 |
Example: |
ef26ff619aea
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
54
diff
changeset
|
254 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
255 |
<code language="lua"> function onGearDamage(gear, damage) |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
256 |
if (GetGearType(gear) == gtHedgehog) then |
55
ef26ff619aea
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
54
diff
changeset
|
257 |
-- adds a message saying, e.g. "Hoggy H took 25 points of damage" |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
258 |
AddCaption(GetHogName(gear) .. ' took ' .. damage .. ' points of damage') |
55
ef26ff619aea
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
54
diff
changeset
|
259 |
end |
ef26ff619aea
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
54
diff
changeset
|
260 |
end</code> |
181 | 261 |
=== <tt>onGearResurrect(gearUid) </tt> === |
942 | 262 |
This function is called when a gear is resurrected due to the hog effect `heResurrectable` being set (see `SetEffect`) and/or being an AI hog when the game modifier “AI Survival” (`gfAISurvival`) is active. It is *not* called when a hog was resurrected by the resurrector tool you can use in the game. |
44
bf53e635a2ac
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
43
diff
changeset
|
263 |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
264 |
=== <tt>onAmmoStoreInit()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
265 |
This function is called when the game is initialized to request the available ammo and ammo probabilities. Use `SetAmmo` here. |
98
54e178bb6986
Added basic (not entirely accurate) entries for the event handlers relating to actions taken by Hedgehogs / user input.
RedGrinner@gmail.com
parents:
95
diff
changeset
|
266 |
|
203
08cc35ba4d34
Edited wiki page LuaAPI through web user interface.
kyberneticist@gmail.com
parents:
202
diff
changeset
|
267 |
=== <tt>onNewAmmoStore(team/clan index, hog index)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
268 |
This function is identical to `onAmmoStoreInit` in function, but is called once per ammo store. This allows different ammo sets for each clan, team or hedgehog depending on the mode. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
269 |
If `gfSharedAmmo` is set, the parameters passed are the clan index, and `-1`, and the function will be called once for each clan. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
270 |
If `gfPerHogAmmo` is set, the parameters passed are the team index and the hog index in that team, and the function will be called once for each hedgehog. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
271 |
If neither is set, the parameters passed are the team index and `-1`, and the function will be called once for each team. |
202
47363108b6b6
Edited wiki page LuaAPI through web user interface.
kyberneticist@gmail.com
parents:
184
diff
changeset
|
272 |
|
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
273 |
These indexes can be used to look up details of the clan/team/hedgehog prior to gear creation. Routines to do these lookups will be created as needed. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
274 |
If you add this hook, the expectation is that you will call SetAmmo appropriately. Any values from `onAmmoStoreInit` are ignored. |
202
47363108b6b6
Edited wiki page LuaAPI through web user interface.
kyberneticist@gmail.com
parents:
184
diff
changeset
|
275 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
276 |
=== <tt>onGearWaterSkip(gear)</tt> === |
502 | 277 |
This function is called when the gear `gear` skips over water. |
278 |
||
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
279 |
=== <tt>onScreenResize()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
280 |
This function is called when you resize the screen. Useful place to put a redraw function for any `vgtHealthTags` you're using. |
145
547ac6a1d14e
Edited wiki page LuaAPI through web user interface.
RedGrinner@gmail.com
parents:
144
diff
changeset
|
281 |
|
98
54e178bb6986
Added basic (not entirely accurate) entries for the event handlers relating to actions taken by Hedgehogs / user input.
RedGrinner@gmail.com
parents:
95
diff
changeset
|
282 |
=== <tt>onAttack()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
283 |
This function is called when your Hedgehog attacks. |
98
54e178bb6986
Added basic (not entirely accurate) entries for the event handlers relating to actions taken by Hedgehogs / user input.
RedGrinner@gmail.com
parents:
95
diff
changeset
|
284 |
|
107 | 285 |
=== <tt>onHJump()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
286 |
This function is called when you press the high jump key. |
98
54e178bb6986
Added basic (not entirely accurate) entries for the event handlers relating to actions taken by Hedgehogs / user input.
RedGrinner@gmail.com
parents:
95
diff
changeset
|
287 |
|
107 | 288 |
=== <tt>onLJump()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
289 |
This function is called when you press the long jump key. |
98
54e178bb6986
Added basic (not entirely accurate) entries for the event handlers relating to actions taken by Hedgehogs / user input.
RedGrinner@gmail.com
parents:
95
diff
changeset
|
290 |
|
54e178bb6986
Added basic (not entirely accurate) entries for the event handlers relating to actions taken by Hedgehogs / user input.
RedGrinner@gmail.com
parents:
95
diff
changeset
|
291 |
=== <tt>onPrecise()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
292 |
This function is called when you press the precise key. |
98
54e178bb6986
Added basic (not entirely accurate) entries for the event handlers relating to actions taken by Hedgehogs / user input.
RedGrinner@gmail.com
parents:
95
diff
changeset
|
293 |
|
54e178bb6986
Added basic (not entirely accurate) entries for the event handlers relating to actions taken by Hedgehogs / user input.
RedGrinner@gmail.com
parents:
95
diff
changeset
|
294 |
=== <tt>onLeft()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
295 |
This function is called when you press the left key. |
98
54e178bb6986
Added basic (not entirely accurate) entries for the event handlers relating to actions taken by Hedgehogs / user input.
RedGrinner@gmail.com
parents:
95
diff
changeset
|
296 |
|
54e178bb6986
Added basic (not entirely accurate) entries for the event handlers relating to actions taken by Hedgehogs / user input.
RedGrinner@gmail.com
parents:
95
diff
changeset
|
297 |
=== <tt>onRight()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
298 |
This function is called when you press the right key. |
98
54e178bb6986
Added basic (not entirely accurate) entries for the event handlers relating to actions taken by Hedgehogs / user input.
RedGrinner@gmail.com
parents:
95
diff
changeset
|
299 |
|
54e178bb6986
Added basic (not entirely accurate) entries for the event handlers relating to actions taken by Hedgehogs / user input.
RedGrinner@gmail.com
parents:
95
diff
changeset
|
300 |
=== <tt>onUp()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
301 |
This function is called when you press the up key. |
98
54e178bb6986
Added basic (not entirely accurate) entries for the event handlers relating to actions taken by Hedgehogs / user input.
RedGrinner@gmail.com
parents:
95
diff
changeset
|
302 |
|
54e178bb6986
Added basic (not entirely accurate) entries for the event handlers relating to actions taken by Hedgehogs / user input.
RedGrinner@gmail.com
parents:
95
diff
changeset
|
303 |
=== <tt>onDown()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
304 |
This function is called when you press the down key. |
98
54e178bb6986
Added basic (not entirely accurate) entries for the event handlers relating to actions taken by Hedgehogs / user input.
RedGrinner@gmail.com
parents:
95
diff
changeset
|
305 |
|
181 | 306 |
=== <tt>onAttackUp()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
307 |
This function is called when you release the attack key. |
175
2455fbbab5e8
Edited wiki page LuaAPI through web user interface.
azizi.054@gmail.com
parents:
174
diff
changeset
|
308 |
|
181 | 309 |
=== <tt>onDownUp()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
310 |
This function is called when you release the down key. |
175
2455fbbab5e8
Edited wiki page LuaAPI through web user interface.
azizi.054@gmail.com
parents:
174
diff
changeset
|
311 |
|
535 | 312 |
=== <tt>onHogAttack(ammoType)</tt> === |
313 |
This function is called when you press the attack key. Beginning with 0.9.21, the parameter `ammoType` is provided. It contains the ammo type of the weapon used for the attack. |
|
175
2455fbbab5e8
Edited wiki page LuaAPI through web user interface.
azizi.054@gmail.com
parents:
174
diff
changeset
|
314 |
|
181 | 315 |
=== <tt>onLeftUp()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
316 |
This function is called when you release the left key. |
175
2455fbbab5e8
Edited wiki page LuaAPI through web user interface.
azizi.054@gmail.com
parents:
174
diff
changeset
|
317 |
|
181 | 318 |
=== <tt>onPreciseUp()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
319 |
This function is called when you release the precise key. |
175
2455fbbab5e8
Edited wiki page LuaAPI through web user interface.
azizi.054@gmail.com
parents:
174
diff
changeset
|
320 |
|
181 | 321 |
=== <tt>onRightUp()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
322 |
This function is called when you release the right key. |
175
2455fbbab5e8
Edited wiki page LuaAPI through web user interface.
azizi.054@gmail.com
parents:
174
diff
changeset
|
323 |
|
622
d7c2a5db19a4
Add msgParam for onSlot, onTaunt, onTimer and onSetWeapon
Wuzzy
parents:
616
diff
changeset
|
324 |
=== <tt>onSetWeapon(msgParam)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
325 |
It is get called when a weapon is selected or switched. |
175
2455fbbab5e8
Edited wiki page LuaAPI through web user interface.
azizi.054@gmail.com
parents:
174
diff
changeset
|
326 |
|
622
d7c2a5db19a4
Add msgParam for onSlot, onTaunt, onTimer and onSetWeapon
Wuzzy
parents:
616
diff
changeset
|
327 |
`msgParam` tells you which ammo type was selected. |
d7c2a5db19a4
Add msgParam for onSlot, onTaunt, onTimer and onSetWeapon
Wuzzy
parents:
616
diff
changeset
|
328 |
|
d7c2a5db19a4
Add msgParam for onSlot, onTaunt, onTimer and onSetWeapon
Wuzzy
parents:
616
diff
changeset
|
329 |
=== <tt>onSlot(msgParam)</tt> === |
d7c2a5db19a4
Add msgParam for onSlot, onTaunt, onTimer and onSetWeapon
Wuzzy
parents:
616
diff
changeset
|
330 |
This function is called when one of the weapon slot keys has been pressed. |
d7c2a5db19a4
Add msgParam for onSlot, onTaunt, onTimer and onSetWeapon
Wuzzy
parents:
616
diff
changeset
|
331 |
|
d7c2a5db19a4
Add msgParam for onSlot, onTaunt, onTimer and onSetWeapon
Wuzzy
parents:
616
diff
changeset
|
332 |
`msgParam` tells the slot number minus 1 (i.e. `0` is for slot number 1, `1` is for slot number 2, etc.). |
175
2455fbbab5e8
Edited wiki page LuaAPI through web user interface.
azizi.054@gmail.com
parents:
174
diff
changeset
|
333 |
|
181 | 334 |
=== <tt>onSwitch()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
335 |
This function is called when a hog is switched to another. |
175
2455fbbab5e8
Edited wiki page LuaAPI through web user interface.
azizi.054@gmail.com
parents:
174
diff
changeset
|
336 |
|
622
d7c2a5db19a4
Add msgParam for onSlot, onTaunt, onTimer and onSetWeapon
Wuzzy
parents:
616
diff
changeset
|
337 |
=== <tt>onTaunt(msgParam)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
338 |
This function is called when the player uses an animated emote for example by using the chat commands `/wave`, `/juggle`, etc. |
175
2455fbbab5e8
Edited wiki page LuaAPI through web user interface.
azizi.054@gmail.com
parents:
174
diff
changeset
|
339 |
|
622
d7c2a5db19a4
Add msgParam for onSlot, onTaunt, onTimer and onSetWeapon
Wuzzy
parents:
616
diff
changeset
|
340 |
`msgParam` tells you which animation was played: |
d7c2a5db19a4
Add msgParam for onSlot, onTaunt, onTimer and onSetWeapon
Wuzzy
parents:
616
diff
changeset
|
341 |
|
623 | 342 |
|| *`msgParam`* || *Animation* || *Associated chat command* || |
343 |
|| 0 || Rolling up || `/rollup` || |
|
344 |
|| 1 || Sad face || `/sad` || |
|
345 |
|| 2 || Waving hand || `/wave` || |
|
346 |
|| 3 || Stupid winner's grin / “Awesome” face || `/hurrah` || |
|
347 |
|| 4 || Peeing || `/ilovelotsoflemonade` || |
|
348 |
|| 5 || Shrug || `/shrug` || |
|
349 |
|| 6 || Juggling || `/juggle` || |
|
622
d7c2a5db19a4
Add msgParam for onSlot, onTaunt, onTimer and onSetWeapon
Wuzzy
parents:
616
diff
changeset
|
350 |
|
d7c2a5db19a4
Add msgParam for onSlot, onTaunt, onTimer and onSetWeapon
Wuzzy
parents:
616
diff
changeset
|
351 |
=== <tt>onTimer(msgParam)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
352 |
This function is called when one of the timer keys is pressed. |
175
2455fbbab5e8
Edited wiki page LuaAPI through web user interface.
azizi.054@gmail.com
parents:
174
diff
changeset
|
353 |
|
622
d7c2a5db19a4
Add msgParam for onSlot, onTaunt, onTimer and onSetWeapon
Wuzzy
parents:
616
diff
changeset
|
354 |
`msgParams` tells the set timer in seconds (i.e. `3` for the 3 seconds timer key). |
d7c2a5db19a4
Add msgParam for onSlot, onTaunt, onTimer and onSetWeapon
Wuzzy
parents:
616
diff
changeset
|
355 |
|
181 | 356 |
=== <tt>onUpUp()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
357 |
This function is called when you release the up key. |
178
dde460404412
Edited wiki page LuaAPI through web user interface.
azizi.054@gmail.com
parents:
177
diff
changeset
|
358 |
|
946 | 359 |
=== <tt>onUsedAmmo(ammoType)</tt> (0.9.23) === |
360 |
Called after a weapon has been used completely, with `ammoType` as the used ammo type. |
|
361 |
||
947 | 362 |
For example, it is called right after a bazooka is fired, when both shots of a shotgun have been fired, when extra time is used, or when all 4 shots of a portable portal device have been fired. It is also called when using a multi-shot ammo has been aborted by changing the weapon selection mid-way, because this still uses up the ammo. |
946 | 363 |
|
1491 | 364 |
*Warning:* In 0.9.24 or earlier, you must not manipulate any ammo within this callback, e.g. by using `AddAmmo`. The ammo storage might become garbled otherwise. |
365 |
||
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
366 |
=== <tt>onHogHide(gearUid)</tt> === |
689 | 367 |
This function is called when a hedgehog with the gear ID `gearUid` is hidden (removed from the map). |
179
156e5fba2e2c
Edited wiki page LuaAPI through web user interface.
azizi.054@gmail.com
parents:
178
diff
changeset
|
368 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
369 |
=== <tt>onHogRestore(gearUid)</tt> === |
689 | 370 |
This function is called when a hedgehog with the specified gear ID `gearUid` is restored (unhidden). |
173
ef246592a16e
Edited wiki page LuaAPI through web user interface.
azizi.054@gmail.com
parents:
172
diff
changeset
|
371 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
372 |
=== <tt>onSpritePlacement(spriteId, centerX, centerY)</tt> === |
411 | 373 |
This function is called when a [Sprites Sprite] has been placed. |
374 |
||
375 |
`spriteID` is the type of the sprite, you find a list at [Sprites Sprites]. `centerX` and `centerY` are the coordinates of the center of the sprite. |
|
376 |
||
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
377 |
=== <tt>onGirderPlacement(frameIdx, centerX, centerY)</tt> === |
402
1e7586c110f6
Documented 0.9.21 functions onGirderPlacement and onRubberPlacement.
almikes@aol.com
parents:
401
diff
changeset
|
378 |
This function is called when a girder has been placed. |
1e7586c110f6
Documented 0.9.21 functions onGirderPlacement and onRubberPlacement.
almikes@aol.com
parents:
401
diff
changeset
|
379 |
|
940 | 380 |
`frameIdx` is used for the length and orientation of the girder. The possible values are explained in `PlaceGirder`. `centerX` and `centerY` are the coordinates of the girder’s center. |
402
1e7586c110f6
Documented 0.9.21 functions onGirderPlacement and onRubberPlacement.
almikes@aol.com
parents:
401
diff
changeset
|
381 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
382 |
=== <tt>onRubberPlacement(frameIdx, centerX, centerY)</tt> === |
402
1e7586c110f6
Documented 0.9.21 functions onGirderPlacement and onRubberPlacement.
almikes@aol.com
parents:
401
diff
changeset
|
383 |
This function is called when a rubber has been placed. |
1e7586c110f6
Documented 0.9.21 functions onGirderPlacement and onRubberPlacement.
almikes@aol.com
parents:
401
diff
changeset
|
384 |
|
940 | 385 |
`frameIdx` is used for the rubber orientation. The possible values are explained in `PlaceRubber`. `centerX` and `centerY` are the coordinates of the rubber’s center. |
402
1e7586c110f6
Documented 0.9.21 functions onGirderPlacement and onRubberPlacement.
almikes@aol.com
parents:
401
diff
changeset
|
386 |
|
1223
868b783afc88
LuaAPI: Add onSpecialPoints. I hope it's more or less correct
Wuzzy
parents:
1221
diff
changeset
|
387 |
=== `onSpecialPoint(x, y, flags)` === |
868b783afc88
LuaAPI: Add onSpecialPoints. I hope it's more or less correct
Wuzzy
parents:
1221
diff
changeset
|
388 |
This is used while a special hand-drawn map is loaded. The engine is building these hand-drawn maps by reading points from the map definition. Optionally, some of these points may be “special”. These are not actually drawn on the map, but are used to store additional information for a position on the map. Special points currently need to be added manually in the map, the in-game editor is not able to add those yet (as of 0.9.23). |
868b783afc88
LuaAPI: Add onSpecialPoints. I hope it's more or less correct
Wuzzy
parents:
1221
diff
changeset
|
389 |
Now, when such a special point at the coordinates `x` and `y` with an assigned value of `flags` is added, this function is called. `flags` is a whole number between `0` and `255` inclusive. |
868b783afc88
LuaAPI: Add onSpecialPoints. I hope it's more or less correct
Wuzzy
parents:
1221
diff
changeset
|
390 |
|
868b783afc88
LuaAPI: Add onSpecialPoints. I hope it's more or less correct
Wuzzy
parents:
1221
diff
changeset
|
391 |
This function is used in Racer and !TechRacer to define waypoints. |
868b783afc88
LuaAPI: Add onSpecialPoints. I hope it's more or less correct
Wuzzy
parents:
1221
diff
changeset
|
392 |
|
1225
64b95a681971
LuaAPI: Add onAchievementsDeclaration and DeclareAchievement
Wuzzy
parents:
1224
diff
changeset
|
393 |
=== `onAchievementsDeclaration()` === |
1229 | 394 |
This function is called after the stats for the stats screen (after the game) have been generated. You are supposed to call `DeclareAchievement` here. |
1225
64b95a681971
LuaAPI: Add onAchievementsDeclaration and DeclareAchievement
Wuzzy
parents:
1224
diff
changeset
|
395 |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
396 |
== Functions for creating gears == |
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
397 |
|
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
398 |
=== <tt>!AddGear(x, y, gearType, state, dx, dy, timer)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
399 |
This creates a new gear at position x,y (measured from top left) of kind `gearType` (see [GearTypes Gear Types]). The initial velocities are `dx` and `dy`. All arguments are numbers. The function returns the `uid` of the gear created. Gears can have multple states at once: `state` is a bitmask, the flag variables can be found in [States]. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
400 |
|
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
401 |
Example: |
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
402 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
403 |
<code language="lua"> local gear = AddGear(0, 0, gtTarget, 0, 0, 0, 0) |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
404 |
FindPlace(gear, true, 0, LAND_WIDTH)</code> |
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
405 |
|
1165 | 406 |
=== <tt>!AddVisualGear(x, y, visualGearType, state, critical [, layer])</tt> === |
1511 | 407 |
This attempts to create a new visual gear at position x,y (measured from top left) of kind `visualGearType` (see [VisualGearTypes Visual Gear Types]). Visual gears are decorational objects which are usually used for purely decorational graphical effects. They have no effect on gameplay. |
408 |
||
409 |
The function returns the `uid` of the visual gear created or `nil` if creation failed. There is no guarantee the visual gear will actually spawn. **IMPORTANT: Do not rely on visual gears to spawn**. |
|
410 |
||
411 |
Set `critical` to `true` if the visual gear is crucial to gameplay and must always be displayed in-game. Use `false` if it is just an effect, and its creation be skipped when in fast-forward mode (such as when joining a room). Most visual gears delete themselves. You can set an optional `layer` to specify which visual gears get drawn on top. |
|
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
412 |
|
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
413 |
Example: |
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
414 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
415 |
<code language="lua"> -- adds an non-critical explosion at position 1000,1000. Returns 0 if it was not created. |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
416 |
vgear = AddVisualGear(1000, 1000, vgtExplosion, 0, false) |
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
417 |
</code> |
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
418 |
|
871
3222b4cfef8a
LuaAPI: Additional parameter for SpawnHealthCrate, SpawnAmmoCrate, SpawnUtilityCrate
Wuzzy
parents:
869
diff
changeset
|
419 |
=== <tt>!SpawnHealthCrate(x, y, [, health])</tt> === |
1235
dae4580eca94
LuaAPI: Discourage negative health for health crates
Wuzzy
parents:
1232
diff
changeset
|
420 |
Spawns a health crate at the specified position. If `x` and `y` are set to 0, the crate will spawn on a random position (but always on land). Set `health` for the initial health contained in the health crate. If not set, the default health (`HealthCaseAmount`) is used. Do not use a negative value for `health`. |
417
f4b7962d39cd
Better documentation about the special coordinates x=0, y=0 for the crate spawn functions.
almikes@aol.com
parents:
416
diff
changeset
|
421 |
|
1189 | 422 |
=== <tt>!SpawnSupplyCrate(x, y, ammoType [, amount])</tt> (0.9.24) === |
423 |
Spawns an ammo or utility crate at the specified position with the given ammo type and an optional amount (default: 1). The crate type is chosen automatically based on the ammo type. |
|
424 |
Otherwise, this function behaves like `SpawnAmmoCrate`. |
|
425 |
||
871
3222b4cfef8a
LuaAPI: Additional parameter for SpawnHealthCrate, SpawnAmmoCrate, SpawnUtilityCrate
Wuzzy
parents:
869
diff
changeset
|
426 |
=== <tt>!SpawnAmmoCrate(x, y, ammoType [, amount])</tt> === |
1189 | 427 |
Spawns an ammo crate at the specified position with content of `ammoType` (see [AmmoTypes Ammo Types]). Any `ammoType` is permitted, an ammo crate is spawned even if the ammo is normally defined as an utility. |
428 |
If `ammoType` is set to `amNothing`, a random weapon (out of the available weapons from the weapon scheme) will be selected. If `x` and `y` are set to 0, the crate will spawn on a random position (but always on land). The `amount` parameter specifies the amount of ammo contained in the crate. If `amount` is `nil` or `0`, the value set by `SetAmmo` is used, or if `SetAmmo` has not been used, it falls back to the weapon scheme's value. If ´amount` is equal to or greater than `100` or greater, the amount is infinite. |
|
1031
637ad254daf9
LuaAPI: Explain the initial ammo setting in missions
Wuzzy
parents:
1030
diff
changeset
|
429 |
|
637ad254daf9
LuaAPI: Explain the initial ammo setting in missions
Wuzzy
parents:
1030
diff
changeset
|
430 |
Note that in Lua missions, the default number of ammo in crates is 0, so it has to be set to at least 1 with `SetAmmo` first, see the example: |
417
f4b7962d39cd
Better documentation about the special coordinates x=0, y=0 for the crate spawn functions.
almikes@aol.com
parents:
416
diff
changeset
|
431 |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
432 |
Example: |
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
433 |
|
1033 | 434 |
<code language="lua"> SetAmmo(amGrenade, 0, 0, 0, 1) -- grenade ammo crates now contain 1 grenade each |
435 |
SpawnAmmoCrate(0, 0, amGrenade) -- spawn grenade ammo crate at random position</code> |
|
417
f4b7962d39cd
Better documentation about the special coordinates x=0, y=0 for the crate spawn functions.
almikes@aol.com
parents:
416
diff
changeset
|
436 |
|
871
3222b4cfef8a
LuaAPI: Additional parameter for SpawnHealthCrate, SpawnAmmoCrate, SpawnUtilityCrate
Wuzzy
parents:
869
diff
changeset
|
437 |
=== <tt>!SpawnUtilityCrate(x, y, ammoType [, amount])</tt> === |
881
ab6bd4812ca4
LuaAPI: special amNothing for SpawnAmmoCrate / SpawnUtilityCrate
Wuzzy
parents:
871
diff
changeset
|
438 |
Spawns an utility crate with some ammo at the specified position. The function behaves almost like `SpawnAmmoCrate`, the differences are 1) the crate looks different and 2) if `ammoType` is set to `amNothing`, a random utility out of the set of available utilities from the weapon scheme is chosen as content. |
417
f4b7962d39cd
Better documentation about the special coordinates x=0, y=0 for the crate spawn functions.
almikes@aol.com
parents:
416
diff
changeset
|
439 |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
440 |
Example: |
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
441 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
442 |
<code language="lua"> SetAmmo(amLaserSight, 0, 0, 0, 1) |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
443 |
SpawnUtilityCrate(0, 0, amLaserSight)</code> |
400 | 444 |
|
445 |
=== <tt>!SpawnFakeAmmoCrate(x, y, explode, poison) </tt> === |
|
417
f4b7962d39cd
Better documentation about the special coordinates x=0, y=0 for the crate spawn functions.
almikes@aol.com
parents:
416
diff
changeset
|
446 |
Spawns a crate at the specified coordinates which looks exactly like a real ammo crate but contains not any ammo. It can be use useful for scripted events or to create a trap. If `x` and `y` are set to 0, the crate will spawn on a random position (but always on land). |
400 | 447 |
`explode` and `poison` are booleans. |
448 |
If `explode` is `true`, the crate will explode when collected. |
|
449 |
If `poison` is `true`, the collector will be poisoned. |
|
450 |
||
451 |
Example: |
|
452 |
||
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
453 |
<code language="lua">SpawnFakeAmmoCrate(500, 432, false, false) -- Spawns a fake ammo crate at the coordinates (500, 434) without explosion and poison. |
400 | 454 |
</code> |
455 |
||
456 |
=== <tt>!SpawnFakeHealthCrate(x, y, explode, poison) </tt> === |
|
1241
50cb37fde767
LuaAPI: Simplify SpawnFakeHealthCrate and SpawnFakeUtilityCrate
Wuzzy
parents:
1240
diff
changeset
|
457 |
Same as `SpawnFakeAmmoCrate`, except the crate will look like a health crate. |
400 | 458 |
|
459 |
=== <tt>!SpawnFakeUtilityCrate(x, y, explode, poison) </tt> === |
|
1241
50cb37fde767
LuaAPI: Simplify SpawnFakeHealthCrate and SpawnFakeUtilityCrate
Wuzzy
parents:
1240
diff
changeset
|
460 |
Same as `SpawnFakeAmmoCrate`, except the crate will look like an utility crate. |
400 | 461 |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
462 |
=== <tt>!AddHog(hogname, botlevel, health, hat)</tt> === |
413
6d90d6994e95
Add DismissTeam, move AddTeam to new “Clans and teams” section.
almikes@aol.com
parents:
412
diff
changeset
|
463 |
Adds a new hedgehog for current team (last created one with the `AddTeam` function), with bot level and specified health, also hat. |
556
e57188e7bc3b
Better explanation of botlevel (AddHog argument).
almikes@aol.com
parents:
555
diff
changeset
|
464 |
`botlevel` ranges from `0` to `5`, where `0` denotes a human player and `1` to `5` denote the skill level of a bot, where `1` is strongest and `5` is the weakest. Note that this is the reverse order of how the bot level is displayed in the game. |
413
6d90d6994e95
Add DismissTeam, move AddTeam to new “Clans and teams” section.
almikes@aol.com
parents:
412
diff
changeset
|
465 |
|
1159 | 466 |
*Warning*: This only works in singleplayer mode (e.g. missions). Also, Hedgewars only supports up to 48 hedgehogs in a game. If you add more hedgehogs or call this function in multiplayer mode, Hedgewars might fail. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
467 |
|
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
468 |
Example: |
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
469 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
470 |
<code language="lua"> local player = AddHog("HH 1", 0, 100, "NoHat") -- botlevel 0 means human player |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
471 |
SetGearPosition(player, 1500, 1000)</code> |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
472 |
== Functions to get gear properties == |
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
473 |
|
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
474 |
=== <tt>!GetGearType(gearUid)</tt> === |
1513 | 475 |
This function returns the [GearTypes gear type] for the specified gear, if it exists. If it doesn't exist, `nil` is returned. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
476 |
|
916
a01743eb08f1
LuaAPI: onVisualGearAdd, onVisualGearDelete, GetVisualGearType
Wuzzy
parents:
913
diff
changeset
|
477 |
=== <tt>!GetVisualGearType(vgUid)</tt> (0.9.23) === |
1513 | 478 |
This function returns the [VisualGearTypes visual gear type] for the specified visual gear, if it exists. If it doesn't exist, `nil` is returned. |
916
a01743eb08f1
LuaAPI: onVisualGearAdd, onVisualGearDelete, GetVisualGearType
Wuzzy
parents:
913
diff
changeset
|
479 |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
480 |
=== <tt>!GetGearPosition(gearUid)</tt> === |
891 | 481 |
Returns x,y coordinates for the specified gear. Not to be confused with `GetGearPos`. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
482 |
|
1244 | 483 |
=== `GetGearCollisionMask(gearUid)` === |
484 |
Returns the current collision mask of the given gear. See `SetGearCollisionMask` for an explanation of the mask. |
|
485 |
||
181 | 486 |
=== <tt>!GetGearRadius(gearUid)</tt> === |
1409 | 487 |
Returns the `Radius` value for the specified gear. For most [GearTypes gear types] for “projectile” gears (like `gtShell` or `gtGrenade`), the radius refers to the gear's collision radius. This is an invisible circle around the center of the gear which is used for the collision checks. For a few gear types, its radius means something different, see [GearTypes] for a full list. |
892 | 488 |
|
489 |
To set the `Radius` value, use `SetGearValues`. |
|
148
f343b50d5619
Edited wiki page LuaAPI through web user interface.
RedGrinner@gmail.com
parents:
147
diff
changeset
|
490 |
|
181 | 491 |
=== <tt>!GetGearVelocity(gearUid)</tt> === |
555 | 492 |
Returns a tuple of dx,dy values for the specified gear. |
493 |
||
494 |
=== <tt>!GetFlightTime(gearUid)</tt> === |
|
495 |
Returns the `FlightTime` of the specified gear. The `FlightTime` is a gear varialbe used to store a general time interval. The precise meaning of the `FlightTime` depends on the gear type. |
|
496 |
||
497 |
For example: The `FlightTime` of a hedgehog (`gtHedgehog`) is the time since they last have stood on solid ground. For most projectile gear types (i.e. `gtShell`), it stores the time after it has been launched. |
|
71
2dcbebb06088
Edited wiki page LuaAPI through web user interface.
henrik.rostedt
parents:
70
diff
changeset
|
498 |
|
181 | 499 |
=== <tt>!GetGearElasticity(gearUid) </tt> === |
611 | 500 |
Returns the elasticity of the specified gear. The elasticity normally determines how strong the gear will bounce after collisions, where higher elasticity is for stronger bounces. |
501 |
||
1514 | 502 |
This is also useful for determining if a hog is on a rope or not. If a hog is attached to a rope, or is busy firing one, the elasticity of the rope will be a non-zero number. |
611 | 503 |
|
504 |
=== <tt>!GetGearFriction(gearUid) </tt> === |
|
505 |
Returns the friction of the specified gear. The friction normally determines how well the gear will slide on terrain. Higher values are for increased sliding properties. |
|
74 | 506 |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
507 |
=== <tt>!GetHogClan(gearUid)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
508 |
Returns the clan ID of the specified hedgehog gear. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
509 |
|
28
026591d95ac6
Edited wiki page LuaAPI through web user interface.
henrik.rostedt
parents:
24
diff
changeset
|
510 |
=== <tt>!GetHogTeamName(gearUid)</tt> === |
1039 | 511 |
Returns the name of the specified gear’s team. `gearUid` can be a hedgehog or a grave. |
28
026591d95ac6
Edited wiki page LuaAPI through web user interface.
henrik.rostedt
parents:
24
diff
changeset
|
512 |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
513 |
=== <tt>!GetHogName(gearUid)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
514 |
Returns the name of the specified hedgehog gear. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
515 |
|
1498 | 516 |
=== <tt>!IsHogHidden(gearUid)</tt> (0.9.25) === |
1499 | 517 |
Returns true if hedgehog gear is hidden (e.g. via `HideHog` or the !TimeBox), false if it isn't, nil if that hedgehog never existed. |
1498 | 518 |
|
140
04d82b673bc4
Edited wiki page LuaAPI through web user interface.
RedGrinner@gmail.com
parents:
139
diff
changeset
|
519 |
=== <tt>!GetEffect(gearUid, effect)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
520 |
Returns the state of given effect for the given hedgehog gear. |
140
04d82b673bc4
Edited wiki page LuaAPI through web user interface.
RedGrinner@gmail.com
parents:
139
diff
changeset
|
521 |
|
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
522 |
See `SetEffect` for further details. |
373 | 523 |
|
133
b737ccb5b49a
Edited wiki page LuaAPI through web user interface.
RedGrinner@gmail.com
parents:
132
diff
changeset
|
524 |
=== <tt>!GetHogHat(gearUid)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
525 |
Returns the hat of the specified hedgehog gear. |
133
b737ccb5b49a
Edited wiki page LuaAPI through web user interface.
RedGrinner@gmail.com
parents:
132
diff
changeset
|
526 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
527 |
=== <tt>!GetHogFlag(gearUid)</tt> === |
610 | 528 |
Returns the name of the flag of the team of the specified hedgehog gear. |
529 |
||
932 | 530 |
=== <tt>!GetHogFort(gearUid)</tt> (0.9.23) === |
531 |
Returns the name of the fort of the team of the specified hedgehog gear. |
|
532 |
||
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
533 |
=== <tt>!GetHogGrave(gearUid)</tt> === |
610 | 534 |
Returns the name of the grave of the team of the specified hedgehog gear. |
535 |
||
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
536 |
=== <tt>!GetHogVoicepack(gearUid)</tt> === |
610 | 537 |
Returns the name of the voicepack of the team of the specified hedgehog gear. |
538 |
||
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
539 |
=== <tt>!GetAmmoCount(gearUid, ammoType)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
540 |
Returns the ammo count of the specified ammo type for the specified hedgehog gear. |
133
b737ccb5b49a
Edited wiki page LuaAPI through web user interface.
RedGrinner@gmail.com
parents:
132
diff
changeset
|
541 |
|
1410 | 542 |
=== <tt>!GetAmmoTimer(gearUid, ammoType)</tt> (0.9.25) === |
543 |
Returns the currently configured ammo timer (in milliseconds) for the given hedgehog gear and specified ammo type. This is the timer which is set by the player by using the timer keys (1-5). For ammo types for which the timer cannot be changed, `nil` is returned. |
|
544 |
||
545 |
Example: |
|
546 |
<code lang="lua">GetAmmoTimer(CurrentHedgehog, amGrenade) |
|
547 |
-- May return 1000, 2000, 3000, 4000 or 5000</code> |
|
548 |
||
913 | 549 |
=== <tt>!IsHogLocal(gearUid)</tt> (0.9.23) === |
1190 | 550 |
Returns `true` if the specified hedgehog gear is controlled by a human player on the computer on which Hedgewars runs on (i.e. not over a computer over the network). Also returns `true` if the hog is a member of any of the local clans. Returns `false` otherwise. Returns `nil` if `gearUid` is invalid. |
551 |
||
552 |
This is perfect to hide certain captions like weapon messages from enemy eyes. |
|
913 | 553 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
554 |
=== <tt>!GetGearTarget(gearUid, x, y) </tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
555 |
Returns the x and y coordinate of target-based weapons/utilities. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
556 |
<b>Note:</b>: This can’t be used in `onGearAdd()` but must be called after gear creation. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
557 |
|
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
558 |
=== <tt>GetX(gearUid)</tt> === |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
559 |
Returns x coordinate of the gear. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
560 |
|
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
561 |
=== <tt>GetY(gearUid)</tt> === |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
562 |
Returns y coordinate of the gear. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
563 |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
564 |
=== <tt>!GetState(gearUid)</tt> === |
415
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
565 |
Returns the state of the gear. The gear state is a bitmask which is built out of the variables as shown in [States]. |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
566 |
|
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
567 |
This function is usually used in combination with `band` to extract the truth value of a single flag. It is also used together with `SetState` and `bor` in order to activate a single flag. |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
568 |
|
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
569 |
Examples: |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
570 |
<code language="lua"> |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
571 |
local state = GetState(gear) |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
572 |
--[[ Stores the full raw bitmask of gear in state. Usually |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
573 |
useless on its own. ]] |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
574 |
</code> |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
575 |
|
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
576 |
<code language="lua"> |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
577 |
isDrowning = band(GetState(CurrentHedgehog),gstDrowning) ~= 0 |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
578 |
--[[ GetState(CurrentHedgehog) returns the state bitmask of |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
579 |
CurrentHedgehog, gstDrowning is a bitmask where only the |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
580 |
“drowning” bit is set. band does a bitwise AND on both, if |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
581 |
it returns a non-zero value, the hedgehog is drowning.]] |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
582 |
</code> |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
583 |
|
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
584 |
<code language="lua"> |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
585 |
SetState(CurrentHedgehog, bor(GetState(CurrentHedgehog), gstInvisible)) |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
586 |
--[[ first the state bitmask of CurrentHedgehog is bitwise ORed with |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
587 |
the gstInvisible flag, thus making the bit responsible for |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
588 |
invisiblity to become 1. Then the new bitmask is applied to |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
589 |
CurrentHedgehog, thus making it invisible.]] |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
590 |
</code> |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
591 |
|
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
592 |
|
114
e311af715b57
Edited wiki page LuaAPI through web user interface.
henrik.rostedt@gmail.com
parents:
107
diff
changeset
|
593 |
=== <tt>!GetGearMessage(gearUid)</tt> === |
625 | 594 |
Returns the message of the gear. This is a bitmask built out of flags seen in [GearMessages]. |
419 | 595 |
|
596 |
=== <tt>!GetTag(gearUid)</tt> === |
|
597 |
Returns the tag of the specified gear (by `gearUid`). |
|
598 |
||
891 | 599 |
The `Tag` of a gear is just another arbitrary variable to hold the gear's state. The meaning of a tag depends on the gear type. For example, for `gtBall` gears, it specifies the ball color, for `gtAirAttack` gears (airplane) it specifies the direction of the plane, etc. See [GearTypes] for a full list. The returned value will be an integer. |
419 | 600 |
|
601 |
Note that the word “tag” here does _not_ refer to the name and health tags you see above hedgehogs, this is something different. |
|
602 |
||
603 |
<code language="lua"> |
|
604 |
-- This adds a ball (the one from the ballgun) at (123, 456): |
|
605 |
ball = AddGear(123, 456, gtBall, 0, 0, 0, 0) |
|
606 |
-- The tag of a ball defines its color. It will automatically chosen at random when created. |
|
607 |
colorTag = GetTag(ball) |
|
608 |
-- Now colorTag stores the tag of ball (in this case a number denoting its color) |
|
609 |
</code> |
|
610 |
||
421
d584704354ad
Add link to GearTypes for SetTag and GetTag.
almikes@aol.com
parents:
419
diff
changeset
|
611 |
The meaning of tags are described in [GearTypes]. |
419 | 612 |
|
209
26805ae2a319
Edited wiki page LuaAPI through web user interface.
RedGrinner@gmail.com
parents:
203
diff
changeset
|
613 |
=== <tt>!GetFollowGear()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
614 |
Returns the uid of the gear that is currently being followed. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
615 |
|
181 | 616 |
=== <tt>!GetTimer(gearUid)</tt> === |
891 | 617 |
Returns the timer of the gear. This is for example the time it takes for watermelon, mine, etc. to explode. This is also the time used to specify the blowtorch or RC plane time. See [GearTypes] for a full list. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
618 |
|
181 | 619 |
=== <tt>!GetHealth(gearUid)</tt> === |
891 | 620 |
Returns the health of the gear. Depending on the gear type, the gear's “health” can also refer to other things, see [GearTypes] for a full list. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
621 |
|
181 | 622 |
=== <tt>!GetHogLevel(gearUid)</tt> === |
1243 | 623 |
Returns the bot level ranging from `0` to `5`. `1` is the strongest bot level and `5` is the weakest one (this is the reverse of what players see). `0` is for human player. |
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
624 |
|
503 | 625 |
=== <tt>!GetGearPos(gearUid)</tt> === |
891 | 626 |
Get the `Pos` value of the specified gear. `Pos` is just another arbitrary value to hold the state of the gear, such as `Tag` and `Health`, the meaning depends on the gear type. See [GearTypes] for the conrete meaning of a gear's `Pos` value. |
627 |
||
628 |
*Important*: Pos is *not* related to the gear's position, use `GetGearPosition` for that. |
|
503 | 629 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
630 |
=== <tt>!GetGearValues(gearUid)</tt> === |
616 | 631 |
This returns a bunch of values associated with the gear, their meaning is often depending on the gear type and many values might be unused for certain gear types. |
612 | 632 |
|
633 |
This is returned (all variables are integers): |
|
634 |
||
688
d9fc58ac04f2
Update EraseSprite, PlaceSprite and Get/Set GearValues
nemo
parents:
685
diff
changeset
|
635 |
`Angle, Power, WDTimer, Radius, Density, Karma, DirAngle, AdvBounce, ImpactSound, nImpactSounds, Tint, Damage, Boom` |
d9fc58ac04f2
Update EraseSprite, PlaceSprite and Get/Set GearValues
nemo
parents:
685
diff
changeset
|
636 |
|
612 | 637 |
A rough description of some of the parameters: |
615 | 638 |
|
639 |
* `Radius`: Effect or collision radius, most of the time |
|
625 | 640 |
* `ImpactSound`: Sound it makes on a collision (see [Sounds]) |
615 | 641 |
* `Tint`: Used by some gear types to determine its colorization. The color is in RGBA format. |
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
642 |
* `Boom`: Used by most gears to determine the damage dealt. |
612 | 643 |
|
644 |
Example: |
|
645 |
<code language="lua"> |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
646 |
-- Get all values in a single line of code: |
688
d9fc58ac04f2
Update EraseSprite, PlaceSprite and Get/Set GearValues
nemo
parents:
685
diff
changeset
|
647 |
local Angle, Power, WDTimer, Radius, Density, Karma, DirAngle, AdvBounce, ImpactSound, nImpactSounds, Tint, Damage, Boom = GetGearValues(myGear) |
612 | 648 |
</code> |
649 |
||
181 | 650 |
=== <tt>!GetVisualGearValues(vgUid)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
651 |
This returns the typically set visual gear values, useful if manipulating things like smoke or bubbles or circles. It returns the following values: |
614 | 652 |
|
653 |
`X, Y, dX, dY, Angle, Frame, FrameTicks, State, Timer, Tint` |
|
654 |
||
615 | 655 |
* `X`, `Y`: typically position |
656 |
* `dX`, `dY`: typically speed |
|
657 |
* `Angle` is usually the rotation angle |
|
658 |
* `Frame` is typically the animation frame |
|
659 |
* `FrameTicks` is usually an animation counter |
|
660 |
* `State` can have a variety of values, but is typically bit packed |
|
661 |
* `Timer` is usually the gear lifetime |
|
662 |
* `Tint` is the RGBA color |
|
614 | 663 |
|
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
664 |
Most visual gears require little to no modification of parameters. |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
665 |
|
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
666 |
Example: |
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
667 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
668 |
<code language="lua"> GetVisualGearValues(vgUid) -- return visual gear values |
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
669 |
</code> |
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
670 |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
671 |
== Functions to modify gears == |
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
672 |
|
243
ac34d3763a17
Edited wiki page LuaAPI through web user interface.
szabibibi@gmail.com
parents:
209
diff
changeset
|
673 |
=== <tt>!HideHog(gearUid)</tt> === |
1004 | 674 |
Removes a hedgehog from the map. The hidden hedgehog can be restored with `RestoreHog(gearUid)`. Since 0.9.23, returns `true` on success and `false` on failure (if gear does not exist / hog is already hidden). |
243
ac34d3763a17
Edited wiki page LuaAPI through web user interface.
szabibibi@gmail.com
parents:
209
diff
changeset
|
675 |
|
ac34d3763a17
Edited wiki page LuaAPI through web user interface.
szabibibi@gmail.com
parents:
209
diff
changeset
|
676 |
Example: |
ac34d3763a17
Edited wiki page LuaAPI through web user interface.
szabibibi@gmail.com
parents:
209
diff
changeset
|
677 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
678 |
<code language="lua"> gear = AddGear(...) |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
679 |
HideHog(gear) -- Hide the newly created gear.</code> |
243
ac34d3763a17
Edited wiki page LuaAPI through web user interface.
szabibibi@gmail.com
parents:
209
diff
changeset
|
680 |
|
ac34d3763a17
Edited wiki page LuaAPI through web user interface.
szabibibi@gmail.com
parents:
209
diff
changeset
|
681 |
=== <tt>!RestoreHog(gearUid)</tt> === |
1513 | 682 |
Restores a previously hidden hedgehog. Nothing happens if the hedgehog does not exist or is not hidden. |
243
ac34d3763a17
Edited wiki page LuaAPI through web user interface.
szabibibi@gmail.com
parents:
209
diff
changeset
|
683 |
|
ac34d3763a17
Edited wiki page LuaAPI through web user interface.
szabibibi@gmail.com
parents:
209
diff
changeset
|
684 |
Example: |
ac34d3763a17
Edited wiki page LuaAPI through web user interface.
szabibibi@gmail.com
parents:
209
diff
changeset
|
685 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
686 |
<code language="lua"> gear = AddGear(...) |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
687 |
HideHog(gear) -- Hide the newly created gear. |
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
688 |
RestoreHog(gear) -- Restore the newly hidden gear.</code> |
243
ac34d3763a17
Edited wiki page LuaAPI through web user interface.
szabibibi@gmail.com
parents:
209
diff
changeset
|
689 |
|
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
690 |
=== <tt>!DeleteGear(gearUid)</tt> === |
1513 | 691 |
Deletes a gear. If the specified gear did not exist, nothing happens. |
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
692 |
|
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
693 |
Example: |
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
694 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
695 |
<code language="lua"> gear = AddGear(...) |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
696 |
DeleteGear(gear) -- Delete the newly created gear.</code> |
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
697 |
|
181 | 698 |
=== <tt>!DeleteVisualGear(vgUid)</tt> === |
1513 | 699 |
Deletes a visual gear. If it does not exist, nothing happens. |
700 |
||
701 |
Note, most visual gears delete themselves after a while. |
|
702 |
||
703 |
||
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
704 |
|
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
705 |
Example: |
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
706 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
707 |
<code language="lua"> vgear = AddVisualGear(...) |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
708 |
DeleteVisualGear(vgear) -- Delete the newly created visual gear.</code> |
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
709 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
710 |
=== <tt>!SetGearValues(gearUid, Angle, Power, WDTimer, Radius, Density, Karma, DirAngle, AdvBounce, ImpactSound, ImpactSounds, Tint, Damage, Boom)</tt> === |
1512 | 711 |
Sets various gear value for the specified gear (`gearUid`). The meaining of each value often depends on the gear type. See the documentation on !GetGearValues for a brief description of the gear values. If `gearUid` is invalid or the gear does not exist, nothing happens. |
612 | 712 |
|
713 |
Set `nil` for each value you do not want to change. |
|
714 |
||
715 |
Example: |
|
716 |
<code language="lua"> |
|
717 |
-- Paints all RC planes into a white color |
|
718 |
function onGearAdd(gear) |
|
719 |
if GetGearType(gear) == gtRCPlane then |
|
720 |
SetGearValues(gear, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, 0xFFFFFFFF) |
|
721 |
end |
|
722 |
end |
|
723 |
</code> |
|
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
724 |
|
554 | 725 |
=== <tt>!SetVisualGearValues(vgUid, X, Y, dX, dY, Angle, Frame, !FrameTicks, State, Timer, Tint)</tt> === |
1510 | 726 |
This allows manipulation of the internal state of the visual gear `vgUid`. If `vgUid` is invalid or the `vgUid` does not refer to an existing visual gear, the function does nothing- Thus, you can safely call this function even if you are not sure if the visual gear actually exists. |
727 |
||
728 |
All visual gear values are numbers. Each visual gear may be using these parameters differently, but the *usual* meaning of these is the following: |
|
613 | 729 |
|
615 | 730 |
* `X`, `Y`: Position |
1188 | 731 |
* `dX`, `dY`: Speed along the X and Y axis |
732 |
* `Angle`: Current rotation |
|
733 |
* `Frame`: Image frame, if using a sprite sheet |
|
734 |
* `FrameTicks`: ??? |
|
735 |
* `State`: Helper value to save some internal state |
|
736 |
* `Timer`: Time in milliseconds until it expires |
|
615 | 737 |
* `Tint`: RGBA color |
613 | 738 |
|
1510 | 739 |
Some visual gears interpret these values differently, just like normal gears. See [VisualGearTypes] for details. Also, most visual gears are not using all possible values, while some values are just ignored. |
1188 | 740 |
|
741 |
Note that most visual gears require little to no modification of their values. |
|
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
742 |
|
613 | 743 |
Example 1: |
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
744 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
745 |
<code language="lua"> -- set a circle to position 1000,1000 pulsing from opacity 20 to 200 (8%-78%), radius of 50, 3px thickness, bright red. |
552 | 746 |
SetVisualGearValues(circleUid, 1000,1000, 20, 200, 0, 0, 100, 50, 3, 0xff0000ff)</code> |
747 |
||
1188 | 748 |
Only the first argument is required. Everything else is optional. Any such argument which is declared as `nil` will not overwrite the corresponding value of the visual gear. |
552 | 749 |
|
613 | 750 |
Example 2: |
552 | 751 |
|
1188 | 752 |
<code language="lua"> -- set a visual gear to position 1000,1000 |
552 | 753 |
SetVisualGearValues(circleUid, 1000, 1000)</code> |
1188 | 754 |
<code language="lua"> -- set the tint of a visual gear to bright red. |
552 | 755 |
SetVisualGearValues(circleUid, nil, nil, nil, nil, nil, nil, nil, nil, nil, 0xff0000ff)</code> |
756 |
||
39
45a576e56425
Updating with visual gear functions and delete gear
kyberneticist
parents:
38
diff
changeset
|
757 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
758 |
=== <tt>!FindPlace(gearUid, fall, left, right[, tryHarder])</tt> === |
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
759 |
Finds a place for the specified gear between x=`left` and x=`right` and places it there. `tryHarder` is optional, setting it to `true`/`false` will determine whether the engine attempts to make additional passes, even attempting to place gears on top of each other. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
760 |
|
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
761 |
Example: |
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
762 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
763 |
<code language="lua"> gear = AddGear(...) |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
764 |
FindPlace(gear, true, 0, LAND_WIDTH) -- places the gear randomly between 0 and LAND_WIDTH</code> |
1254 | 765 |
=== `HogSay(gearUid, text, manner [,vgState])` === |
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
766 |
Makes the specified gear say, think, or shout some text in a comic-style speech or thought bubble. `gearUid` is _not_ limited to hedgehogs, altough the function name suggests otherwise. |
533 | 767 |
|
768 |
The `manner` parameter specifies the type of the bubble and can have one of these values: |
|
59
233360620ae2
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
58
diff
changeset
|
769 |
|
533 | 770 |
|| *Value of `manner`* || *Looks* || |
771 |
|| `SAY_THINK` || Thought bubble || |
|
772 |
|| `SAY_SAY` || Speech bubble || |
|
773 |
|| `SAY_SHOUT` || Exclamatory bubble (denotes shouting) || |
|
59
233360620ae2
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
58
diff
changeset
|
774 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
775 |
There is a optional 4th parameter `vgState`, it defines wheather the speechbubble is drawn fully opaque or semi-transparent. The value `0` is the default value. |
533 | 776 |
|
777 |
|| *Value of `vgState`* || *Effect* || |
|
778 |
|| `0` || If the specified gear is a hedgehog, and it’s the turn of the hedgehog’s team, the bubble is drawn fully opaque.<br>If the gear is a hedgehog, and it’s another team’s turn, the bubble is drawn translucent.<br>If the gear is not a hedgehog, the bubble is drawn fully opaque. || |
|
779 |
|| `1` || The bubble is drawn translucent. || |
|
780 |
|| `2` || The bubble is drawn fully opaque. || |
|
781 |
||
782 |
Examples: |
|
783 |
||
784 |
<code language="lua">HogSay(CurrentHedgehog, "I wonder what to do …", SAY_THINK) -- thought bubble with text “I wonder what to do …”</code> |
|
785 |
<code language="lua">HogSay(CurrentHedgehog, "I'm hungry.", SAY_SAY) -- speech bubble with text “I’m hungry.”</code> |
|
786 |
<code language="lua">HogSay(CurrentHedgehog, "I smell CAKE!", SAY_SHOUT) -- exclamatory bubble with text “I smell CAKE!”</code> |
|
52
714b56de5ea1
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
51
diff
changeset
|
787 |
=== <tt>!HogTurnLeft(gearUid, boolean)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
788 |
Faces the specified hog left or right. |
52
714b56de5ea1
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
51
diff
changeset
|
789 |
|
714b56de5ea1
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
51
diff
changeset
|
790 |
Example: |
714b56de5ea1
Edited wiki page LuaAPI through web user interface.
RedGrinner
parents:
51
diff
changeset
|
791 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
792 |
<code language="lua"> HogTurnLeft(CurrentHedgehog, true) -- turns CurrentHedgehog left |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
793 |
HogTurnLeft(CurrentHedgehog, false) -- turns CurrentHedgehog right</code> |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
794 |
=== <tt>!SetGearPosition(gearUid, x, y)</tt> === |
891 | 795 |
Places the specified gear exactly at the position (`x`,`y`). Not to be confused with `SetGearPos`. |
71
2dcbebb06088
Edited wiki page LuaAPI through web user interface.
henrik.rostedt
parents:
70
diff
changeset
|
796 |
|
1227
edda2e2b973f
LuaAPI: Add SetGearCollisionMask and GetGearCollisionMask
Wuzzy
parents:
1226
diff
changeset
|
797 |
=== `SetGearCollisionMask(gearUid, mask)` === |
edda2e2b973f
LuaAPI: Add SetGearCollisionMask and GetGearCollisionMask
Wuzzy
parents:
1226
diff
changeset
|
798 |
Set the collision mask of the given gear with `gearUid`. |
edda2e2b973f
LuaAPI: Add SetGearCollisionMask and GetGearCollisionMask
Wuzzy
parents:
1226
diff
changeset
|
799 |
The collision mask defines with which gears and terrain types the gear can collide. |
edda2e2b973f
LuaAPI: Add SetGearCollisionMask and GetGearCollisionMask
Wuzzy
parents:
1226
diff
changeset
|
800 |
|
1302 | 801 |
`mask` is a number between `0x0000` and `0xFFFF` and used as a bitfield, which means you can combine these flags with `bor`. These are the available flags: |
1227
edda2e2b973f
LuaAPI: Add SetGearCollisionMask and GetGearCollisionMask
Wuzzy
parents:
1226
diff
changeset
|
802 |
|
1303 | 803 |
|| *Identifier* || *Collision with …* || |
804 |
|| `lfLandMask` || Terrain || |
|
1443 | 805 |
|| `lfCurrentHog` || *Deprecated! Do not use.* || |
1303 | 806 |
|| `lfHHMask` || Any hedgehogs || |
807 |
|| `lfNotHHObjMask` || Objects, not hogs (e.g. mines, explosives) || |
|
808 |
|| `lfAllObjMask` || Hedgehogs and objects || |
|
1227
edda2e2b973f
LuaAPI: Add SetGearCollisionMask and GetGearCollisionMask
Wuzzy
parents:
1226
diff
changeset
|
809 |
|
edda2e2b973f
LuaAPI: Add SetGearCollisionMask and GetGearCollisionMask
Wuzzy
parents:
1226
diff
changeset
|
810 |
Beware, the collision mask is often set by the engine as well. |
edda2e2b973f
LuaAPI: Add SetGearCollisionMask and GetGearCollisionMask
Wuzzy
parents:
1226
diff
changeset
|
811 |
|
1228 | 812 |
Examples: |
1301 | 813 |
<code language="lua">SetGearCollisionMask(gear, bnot(lfCurrentHegehog)) |
1231 | 814 |
-- Ignore collision with current hedgehog</code> |
1227
edda2e2b973f
LuaAPI: Add SetGearCollisionMask and GetGearCollisionMask
Wuzzy
parents:
1226
diff
changeset
|
815 |
|
1231 | 816 |
<code language="lua">SetGearCollisionMask(gear, 0xFFFF) |
817 |
-- Collide with everything</code> |
|
1228 | 818 |
|
1302 | 819 |
<code language="lua">SetGearCollisionMask(gear, lfAllObjMask) |
1231 | 820 |
-- Collide with hedgehogs and objects</code> |
1228 | 821 |
|
1231 | 822 |
<code language="lua">SetGearCollisionMask(gear, 0x0000) |
823 |
-- Collide with nothing</code> |
|
1228 | 824 |
|
1304 | 825 |
There are actual more flags availbable, but they are not as useful for use in Lua and their constants have not been exposed to Lua. You can find the full range of flags in the engine source code (in Pascal): |
826 |
||
827 |
[https://hg.hedgewars.org/hedgewars/file/default/hedgewars/uConsts.pas#l112] |
|
1227
edda2e2b973f
LuaAPI: Add SetGearCollisionMask and GetGearCollisionMask
Wuzzy
parents:
1226
diff
changeset
|
828 |
|
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
829 |
=== <tt>!SetGearVelocity(gearUid, dx, dy)</tt> === |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
830 |
Gives the specified gear the velocity of `dx`, `dy`. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
831 |
|
555 | 832 |
=== <tt>!SetFlightTime(gearUid, flighttime)</tt> === |
833 |
Sets the `FlightTime` of the given gear to `flighttime`. The meaning of `FlightTime` is explained in the section `GetFlightTime`. |
|
834 |
||
611 | 835 |
=== <tt>!SetGearElasticity(gearUid, Elasticity) </tt> === |
836 |
Sets the elasticity of the specified gear. For most gears, the elasticity determines how strong the gear will bounce after collisions, where higher elasticity is for stronger bounces. Recommended are values between `0` and `9999`. |
|
837 |
||
838 |
=== <tt>!SetGearFriction(gearUid, Friction) </tt> === |
|
839 |
Sets the friction of the specified gear. The friction normally determines how well the gear will slide on terrain. Higher values are for increased sliding properties. `0` is for no sliding whatsoever, where `9999` is for very long slides, greater values are not recommended. |
|
840 |
||
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
841 |
=== <tt>!SetHealth(gearUid, health)</tt> === |
891 | 842 |
Sets the health of the specified gear. The “health” of a gear can refer to many things, depending on the gear type. |
99
983ec9ac63c7
Added a non-exhaustive list of examples for further applications of SetHealth()
RedGrinner@gmail.com
parents:
98
diff
changeset
|
843 |
|
1381 | 844 |
*Hint*: If you like to increase the health of a hedgehog with nice visual effects, consider using `HealHog` instead. |
845 |
||
891 | 846 |
Use cases: |
99
983ec9ac63c7
Added a non-exhaustive list of examples for further applications of SetHealth()
RedGrinner@gmail.com
parents:
98
diff
changeset
|
847 |
|
891 | 848 |
* Setting the health of a hedgehog (`gtHedgehog`) to 99 |
849 |
* Starting the RC Plane (`gtRCPlane`) with 10 bombs |
|
850 |
* Starting flying saucer (`gtJetpack`) with only 50% fuel |
|
851 |
* Setting all the mines (`gtMine`) to duds |
|
852 |
* And more! |
|
853 |
||
854 |
See [GearTypes] for a full description. |
|
99
983ec9ac63c7
Added a non-exhaustive list of examples for further applications of SetHealth()
RedGrinner@gmail.com
parents:
98
diff
changeset
|
855 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
856 |
<code language="lua"> function onGearAdd(gear) |
891 | 857 |
if (GetGearType(gear) == gtHedgehog) then |
858 |
-- Set hedgehog health to 99 |
|
859 |
SetHealth(gear, 99) |
|
860 |
end |
|
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
861 |
if (GetGearType(gear) == gtRCPlaane) then |
891 | 862 |
-- Give the plane 10 bombs |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
863 |
SetHealth(gear, 10) |
99
983ec9ac63c7
Added a non-exhaustive list of examples for further applications of SetHealth()
RedGrinner@gmail.com
parents:
98
diff
changeset
|
864 |
end |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
865 |
if (GetGearType(gear) == gtJetpack) then |
891 | 866 |
-- Set fuel to 50% only |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
867 |
SetHealth(gear, 1000) |
99
983ec9ac63c7
Added a non-exhaustive list of examples for further applications of SetHealth()
RedGrinner@gmail.com
parents:
98
diff
changeset
|
868 |
end |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
869 |
if (GetGearType(gear) == gtMine) then |
891 | 870 |
-- Turn mine into dud |
361
315e9db1f458
no need to prevent linking of names in code blocks
sheepyluva@gmail.com
parents:
360
diff
changeset
|
871 |
SetHealth(gear, 0) |
99
983ec9ac63c7
Added a non-exhaustive list of examples for further applications of SetHealth()
RedGrinner@gmail.com
parents:
98
diff
changeset
|
872 |
end |
983ec9ac63c7
Added a non-exhaustive list of examples for further applications of SetHealth()
RedGrinner@gmail.com
parents:
98
diff
changeset
|
873 |
end</code> |
983ec9ac63c7
Added a non-exhaustive list of examples for further applications of SetHealth()
RedGrinner@gmail.com
parents:
98
diff
changeset
|
874 |
|
1189 | 875 |
=== `HealHog(gearUid, healthBoost[, showMessage[, tint]])` (0.9.24) === |
1381 | 876 |
Convenience function to increase the health of a hedgehog with default visual effects. |
99
983ec9ac63c7
Added a non-exhaustive list of examples for further applications of SetHealth()
RedGrinner@gmail.com
parents:
98
diff
changeset
|
877 |
|
1381 | 878 |
Specifically, this increases the health of the hedgehog gear with the given ID `gearUid` by `healthBoost`, displays some healing particles at the hedgehog and shows the health increae as a message. This is similar to the behavour after taking a health crate, or getting a health boost from vampirism. |
1189 | 879 |
|
880 |
If `showMessage` is false, no message is shown. With `tint` you can set the RGBA color of the particles (default: `0x00FF00FF`). |
|
99
983ec9ac63c7
Added a non-exhaustive list of examples for further applications of SetHealth()
RedGrinner@gmail.com
parents:
98
diff
changeset
|
881 |
|
1191 | 882 |
This function does not affect the poison state, however (see `SetEffect`). |
883 |
||
373 | 884 |
=== <tt>!SetEffect(gearUid, effect, effectState)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
885 |
Sets the state for one of the effects <tt>heInvulnerable, heResurrectable, hePoisoned, heResurrected, heFrozen</tt> for the specified hedgehog gear. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
886 |
A value of 0 usually means the effect is disabled, values other than that indicate that it is enabled and in some cases specify e.g. the remaining time of that effect. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
887 |
|
824 | 888 |
|| *`effect`* || *Description* || *`effectState`* || |
823 | 889 |
|| `heInvulnerable` || Wether hog is invulnerable || Any non-zero value turns on invulnerability. `0` turns it off. || |
890 |
|| `hePoisoned` || Poison damage, damages hog each turn. || Amount of damage per turn. Use `0` to disable poisoning. || |
|
891 |
|| `heResurrectable` || Whether to resurrect the hog on death || With a non-zero value, the hedgehog will be resurrected and teleported to a random location on death. `0` disables this. || |
|
824 | 892 |
|| `heResurrected` || Whether the hedgehog has been resurrected once. This is only a subtle graphical effect. || With a non-zero value, the hedgehog was resurrected, `0` otherwise. || |
1216 | 893 |
|| `heFrozen` || Freeze level. Frozen hedgehogs skip turn, are heavy and take half damage || The hog is considered frozen if the value is `256` or higher, otherwise not. A number of `256` or higher denotes “how frozen” the hedgehog is, i.e. how long it takes to melt. The freezer sets this to `199999` initially. The value will be reduced by `50000` each round. Being hit by a flame reduces this number by `1000`. The values `0` to `255` are used for the freeze/melt animations. || |
1299 | 894 |
|| `heArtillery` || If enabled, the hedgehog can't walk (since 0.9.24). || `0` = disabled. `1` = permanently enabled. `2` = temporarily enabled (used by sniper rifle between shots) || |
823 | 895 |
|
896 |
Example (sets all bots poisoned with poison damage of 1): |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
897 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
898 |
<code language="lua"> function onGearAdd(gear) |
558 | 899 |
if (GetGearType(gear) == gtHedgehog) and (GetHogLevel(gear) > 0) then |
373 | 900 |
SetEffect(gear, hePoisoned, 1) |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
901 |
end |
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
902 |
end</code> |
181 | 903 |
|
17 | 904 |
=== <tt>CopyPV(gearUid, gearUid)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
905 |
This sets the position and velocity of the second gear to the first one. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
906 |
|
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
907 |
=== <tt>!FollowGear(gearUid)</tt> === |
1515 | 908 |
Makes the game client follow the specifiec gear (if it exists). Does not work for visual gears. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
909 |
|
139
6bf231a611a7
Edited wiki page LuaAPI through web user interface.
RedGrinner@gmail.com
parents:
138
diff
changeset
|
910 |
=== <tt>!SetHogName(gearUid, name)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
911 |
Sets the name of the specified hedgehog gear. |
139
6bf231a611a7
Edited wiki page LuaAPI through web user interface.
RedGrinner@gmail.com
parents:
138
diff
changeset
|
912 |
|
398
1f9f7fb00be3
Added entries for SetHogTeamName, SetWeapon
RedGrinner@gmail.com
parents:
394
diff
changeset
|
913 |
=== <tt>!SetHogTeamName(gearUid, name)</tt> === |
1039 | 914 |
Sets the team name of the specified gear. The gear can be a hedgehog or grave. |
398
1f9f7fb00be3
Added entries for SetHogTeamName, SetWeapon
RedGrinner@gmail.com
parents:
394
diff
changeset
|
915 |
|
139
6bf231a611a7
Edited wiki page LuaAPI through web user interface.
RedGrinner@gmail.com
parents:
138
diff
changeset
|
916 |
=== <tt>!SetHogHat(gearUid, hat)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
917 |
Sets the hat of the specified hedgehog gear. |
139
6bf231a611a7
Edited wiki page LuaAPI through web user interface.
RedGrinner@gmail.com
parents:
138
diff
changeset
|
918 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
919 |
=== <tt>!SetGearTarget(gearUid, x, y)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
920 |
Sets the x and y coordinate of target-based weapons/utilities. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
921 |
*Note*: This can’t be used in onGearAdd() but must be called after gear creation. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
922 |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
923 |
=== <tt>!SetState(gearUid, state)</tt> === |
415
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
924 |
Sets the state of the specified gear to the specified `state`. This is a bitmask made out of the variables as seen in [States]. |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
925 |
|
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
926 |
This function is often used together with `GetState` and the bitmask utility functions `band` and `bnot` in order to manipulate a single flag. |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
927 |
|
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
928 |
Examples: |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
929 |
<code language="lua"> |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
930 |
SetState(CurrentHedgehog, bor(GetState(CurrentHedgehog), gstInvisible)) |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
931 |
--[[ first the state bitmask of CurrentHedgehog is bitwise ORed with |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
932 |
the gstInvisible flag, thus making the bit responsible for |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
933 |
invisiblity to become 1. Then the new bitmask is applied to |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
934 |
CurrentHedgehog, thus making it invisible. ]] |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
935 |
</code> |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
936 |
|
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
937 |
<code language="lua"> |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
938 |
SetState(CurrentHedgehog, band(GetState(CurrentHedgehog), bnot(gstInvisible))) |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
939 |
--[[ The reverse of the above: This function toggles CurrentHedgehog’s |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
940 |
gstInvisible flag off, thus making it visible again. ]] |
70961d4eef05
Fixed misleading descriptions of GetState and SetState (use of bitmasks were not mentioned). Added commented examples.
almikes@aol.com
parents:
414
diff
changeset
|
941 |
</code> |
28
026591d95ac6
Edited wiki page LuaAPI through web user interface.
henrik.rostedt
parents:
24
diff
changeset
|
942 |
|
114
e311af715b57
Edited wiki page LuaAPI through web user interface.
henrik.rostedt@gmail.com
parents:
107
diff
changeset
|
943 |
=== <tt>!SetGearMessage(gearUid, message)</tt> === |
625 | 944 |
Sets the gear messages of the specified gear. `message` is a bitmask built out of flags seen in [GearMessages]. |
114
e311af715b57
Edited wiki page LuaAPI through web user interface.
henrik.rostedt@gmail.com
parents:
107
diff
changeset
|
945 |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
946 |
=== <tt>!SetTag(gearUid, tag)</tt> === |
891 | 947 |
Sets the `Tag` value of the specified gear (by `gearUid`). The `Tag` value of a gear is simply an extra variable to modify misc. things. The meaning of a tag depends on the gear type. For example, for `gtBall` gears, it specifies the ball color, for `gtAirAttack` gears (airplane) it specifies the direction of the plane, etc. See [GearTypes] for a full list. `tag` has to be an integer. |
419 | 948 |
|
949 |
Note that the word “tag” here does _not_ refer to the name and health tags you see above hedgehogs, this is something different. |
|
950 |
||
951 |
<code language="lua"> |
|
952 |
-- This adds a ball (the one from the ballgun) at (123, 456): |
|
953 |
ball = AddGear(123, 456, gtBall, 0, 0, 0, 0) |
|
954 |
-- This sets the tag of the gear. For gtBall, the tag specified the color. “8” is the color white. |
|
955 |
SetTag(ball, 8) -- |
|
956 |
</code> |
|
957 |
||
421
d584704354ad
Add link to GearTypes for SetTag and GetTag.
almikes@aol.com
parents:
419
diff
changeset
|
958 |
The meaning of tags are described in [GearTypes]. |
28
026591d95ac6
Edited wiki page LuaAPI through web user interface.
henrik.rostedt
parents:
24
diff
changeset
|
959 |
|
181 | 960 |
=== <tt>!SetTimer(gearUid, timer)</tt> === |
891 | 961 |
Sets the timer of the specified gear. Also see `GetTimer`. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
962 |
|
360 | 963 |
=== <tt>!SetHogLevel(gearUid, level)</tt> === |
1243 | 964 |
Sets the bot level from 0 to 5. `1` is the strongest bot level and `5` is the weakest one (this is the reverse of what players see). `0` means human player. |
69
48f6e6c0076d
Edited wiki page LuaAPI through web user interface.
henrik.rostedt
parents:
68
diff
changeset
|
965 |
|
1224 | 966 |
=== `SetGearAIHints(gearUid, aiHint)` === |
967 |
Set some behaviour hints for computer-controlled hedgehogs for any given gear with `gearUid`. |
|
968 |
||
969 |
Set `aiHint` to either of: |
|
970 |
||
971 |
* `aihUsualProcessing`: AI hogs treat this gear the usual way. This is the default. |
|
972 |
* `aihDoesntMatter`: AI hogs don't bother attacking this gear intentionally. |
|
973 |
||
974 |
Example: |
|
975 |
||
1231 | 976 |
<code language="lua"> |
1224 | 977 |
SetGearAIHints(uselessHog, aihDoesntMatter) |
1231 | 978 |
-- This makes AI hogs stop caring about attacking uselessHog</code> |
1224 | 979 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
980 |
=== <tt>!SetGearPos(gearUid, value)</tt> === |
891 | 981 |
Sets the `Pos` value (not the position!) of the specified gear to specified value. See `GetGearPos` for more information. |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
982 |
|
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
983 |
== Gameplay functions == |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
984 |
|
549 | 985 |
=== `GameFlags` functions === |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
986 |
|
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
987 |
==== <tt>!ClearGameFlags()</tt> ==== |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
988 |
Disables *all* !GameFlags. |
380 | 989 |
|
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
990 |
==== <tt>!DisableGameFlags(gameflag, ...)</tt> ==== |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
991 |
Disables the listed !GameFlags, without changing the status of other !GameFlags. |
380 | 992 |
|
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
993 |
==== <tt>!EnableGameFlags(gameflag, ...)</tt> ==== |
1253 | 994 |
Enables the listed !GameFlags, without changing the status of other !GameFlags. In missions, no !GameFlags are set initially. |
380 | 995 |
|
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
996 |
==== <tt>!GetGameFlag(gameflag)</tt> ==== |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
997 |
Returns `true` if the specified gameflag is enabled, otherwise `false`. |
380 | 998 |
|
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
999 |
=== Environment === |
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1000 |
|
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1001 |
==== <tt>!SetGravity(percent)</tt> ==== |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1002 |
Changes the current gravity of the game in percent (relative to default, integer value). |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1003 |
Setting it to 100 will set gravity to default gravity of hedgewars, 200 will double it, etc. |
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1004 |
|
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1005 |
==== <tt>!GetGravity()</tt> ==== |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1006 |
Returns the current gravity in percent. |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1007 |
|
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1008 |
==== <tt>!SetWaterLine(waterline)</tt> ==== |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1009 |
Sets the water level (`WaterLine`) to the specified y-coordinate. |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1010 |
|
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1011 |
==== <tt>!SetWind(windSpeed)</tt> ==== |
1189 | 1012 |
Sets the current wind in the range of -100 to 100 inclusive. Use together with `gfDisableWind` for full control. |
1013 |
||
1014 |
==== <tt>!GetWind()</tt> (0.9.24) ==== |
|
1015 |
Returns current wind, expressed as a floating point number between -100 to 100 inclusive. Note there may be rounding errors. |
|
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1016 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
1017 |
==== <tt>!SetMaxBuildDistance(distInPx)</tt> ==== |
790 | 1018 |
Sets the maximum building distance for of girders and rubber bands in pixels to `distInPx`. If `distInPx` is `0`, the limit is disabled. If called without arguments, the distance will be reset to the default value. |
608 | 1019 |
|
1270 | 1020 |
==== `Explode(x, y, radius[, options])` (0.9.24) ==== |
1021 |
Cause an explosion or erase land, push or damage gears. |
|
1022 |
||
1271 | 1023 |
By default, an explosion destroys a circular piece of land and damages and pushes gears in its radius. |
1024 |
||
1025 |
The explosion occours at coordinates `(x, y)` with the given `radius`. Assuming 100% damage, the explosion damage at the center equals the explosion radius. |
|
1270 | 1026 |
|
1272 | 1027 |
The explosion will also have a visual effect (by spawning an explosion visual gear), unless the radius is very small. |
1028 |
||
1270 | 1029 |
`options` is a bitmask which can be used to tweak how the explosion behaves: |
1030 |
||
1031 |
|| *Flag* || *Meaning* || |
|
1032 |
|| `EXPLAutoSound` || Plays an appropriate sound || |
|
1033 |
|| `EXPLNoDamage` || Deal no damage to gears || |
|
1034 |
|| `EXPLDoNotTouchHH` || Do not push hedgehogs || |
|
1035 |
|| `EXPLDoNotTouchAny` || Do not push any gears || |
|
1036 |
|| `EXPLDontDraw` || Do not destroy land || |
|
1037 |
|| `EXPLNoGfx` || Do not show an explosion animation and do not shake the screen || |
|
1038 |
|| `EXPLPoisoned` || Poison all hedgehogs in explosion radius || |
|
1039 |
||
1040 |
`options` is assumed to be `EXPLAutoSound` by default. Set `options` to 0 to disable all flags. |
|
1041 |
||
1042 |
Examples: |
|
1043 |
<code language="lua"> |
|
1044 |
-- Simple explosion at (100, 50) with radius 50 |
|
1045 |
Explode(100, 50, 50) |
|
1046 |
||
1047 |
-- Simlpe explosion without sound |
|
1048 |
Explode(100, 50, 50, 0) |
|
1049 |
||
1271 | 1050 |
-- Fake explosion which only pushes gears but deals no damage to gears and terrain |
1270 | 1051 |
Explode(500, 1000, 50, EXPLAutoSound + EXPLNoDamage + EXPLDontDraw) |
1052 |
||
1271 | 1053 |
-- Erase a circle of land without side effects |
1270 | 1054 |
Explode(500, 100, 100, EXPLNoDamage + EXPLDoNotTouchAny + EXPLNoGfx) |
1055 |
</code> |
|
1056 |
||
1269 | 1057 |
==== `SkipTurn()` (0.9.24) ==== |
1058 |
Forces the current hedgehog to skip its turn. |
|
1059 |
||
1212 | 1060 |
==== `EndTurn([noTaunts])` (0.9.23) ==== |
1325 | 1061 |
Ends the current turn immediately. |
997 | 1062 |
|
1063 |
Normally, a “Coward” taunt may be played and an announcer message may be shown (depending on the situation). Set the optional `noTaunts` parameter to `true` to force the engine to never play a taunt or show a message. `noTaunts` is `false` by default. |
|
1064 |
||
1327 | 1065 |
==== `Retreat(time [, respectGetAwayTimeFactor)` (0.9.25) ==== |
1325 | 1066 |
Forces the current turn into the retreating phase, as if the hog made an attack. That is, the current hedgehog is unable to attack or select a weapon, only movement is possible until the retreat time is up. |
1067 |
||
1068 |
The retreat time must be set with `time` in milliseconds. By default, this time is automatically multiplied with get-away time percentage from the game scheme for seamless integration with schemes. If you want to ignore the game scheme for some reason and set the retreat time no matter what, set `respectGetAwayTimeFactor` to `false`. |
|
1069 |
||
1326 | 1070 |
If the current hedgehog was busy doing an attack, the attack is aborted, no shot is made. If this function is called in the ready phase of af a turn, the ready phase continues normally, but the turn will begin in the retreat phase instead. |
1325 | 1071 |
|
1072 |
Note: If you want the turn to end instantly, it is recommended to use `EndTurn` instead. |
|
1073 |
||
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1074 |
==== <tt>!EndGame()</tt> ==== |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1075 |
Makes the game end. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
1076 |
|
912
ea13b02292c5
LuaAPI: Move non-gear related ammo functions to new section
Wuzzy
parents:
911
diff
changeset
|
1077 |
=== Ammo === |
ea13b02292c5
LuaAPI: Move non-gear related ammo functions to new section
Wuzzy
parents:
911
diff
changeset
|
1078 |
==== <tt>!SetAmmo(ammoType, count, probability, delay, numberInCrate)</tt> ==== |
1425 | 1079 |
This updates the settings (initial ammo, crate probability, etc.) for a specified [AmmoTypes ammo type]. This must only be used in the `onAmmoStoreInit()` event handler. In other places, this function will not work. |
912
ea13b02292c5
LuaAPI: Move non-gear related ammo functions to new section
Wuzzy
parents:
911
diff
changeset
|
1080 |
|
1032 | 1081 |
In Lua missions, for *all* ammo types, the ammo count, probability, delay and number in crates is set to 0 initially. Note: This also includes skip! |
1031
637ad254daf9
LuaAPI: Explain the initial ammo setting in missions
Wuzzy
parents:
1030
diff
changeset
|
1082 |
|
1425 | 1083 |
Parameters: |
1084 |
||
1426 | 1085 |
* `ammoType`: Ammo type to be set |
1086 |
* `count`: Initial ammo count. 9 = infinite |
|
1087 |
* `probability`: Crate probability. Max. value is 9. 0 = never |
|
1088 |
* `delay`: Number of rounds this ammo is delayed |
|
1089 |
* `numberInCrate`: Amount of ammo in a crate |
|
1425 | 1090 |
|
912
ea13b02292c5
LuaAPI: Move non-gear related ammo functions to new section
Wuzzy
parents:
911
diff
changeset
|
1091 |
Example: |
ea13b02292c5
LuaAPI: Move non-gear related ammo functions to new section
Wuzzy
parents:
911
diff
changeset
|
1092 |
|
ea13b02292c5
LuaAPI: Move non-gear related ammo functions to new section
Wuzzy
parents:
911
diff
changeset
|
1093 |
<code language="lua"> SetAmmo(amShotgun, 9, 0, 0, 0) -- unlimited amount of shotgun ammo for players |
1031
637ad254daf9
LuaAPI: Explain the initial ammo setting in missions
Wuzzy
parents:
1030
diff
changeset
|
1094 |
SetAmmo(amGrenade, 0, 0, 0, 3) -- crates should contain always three grenade |
637ad254daf9
LuaAPI: Explain the initial ammo setting in missions
Wuzzy
parents:
1030
diff
changeset
|
1095 |
SetAmmo(amSkip, 9, 0, 0, 0) -- enable skip</code> |
637ad254daf9
LuaAPI: Explain the initial ammo setting in missions
Wuzzy
parents:
1030
diff
changeset
|
1096 |
|
637ad254daf9
LuaAPI: Explain the initial ammo setting in missions
Wuzzy
parents:
1030
diff
changeset
|
1097 |
Hint: It is recommended to always enable skip in missions. Only in exceptional circumstances you should choose to not enable skip. |
912
ea13b02292c5
LuaAPI: Move non-gear related ammo functions to new section
Wuzzy
parents:
911
diff
changeset
|
1098 |
|
1427 | 1099 |
==== <tt>!GetAmmo(ammoType)</tt> ==== |
1100 |
Returns ammo settings (initial ammo, crate probability, etc.) for a specified [AmmoTypes ammo type]. This function is analogue to `SetAmmo`. |
|
1101 |
||
1102 |
This function returns four numbers, in this order: initial ammo count, probability, delay and number in crate. These values correspond to the parameters 2-5 provided in `SetAmmo` and have the same meaning. |
|
1103 |
||
1104 |
Example: |
|
1105 |
||
1106 |
<code language="lua">count, prob, delay, numberInCrate = GetAmmo(amGrenade) -- Get ammo settings of amGrenade</code> |
|
1107 |
||
912
ea13b02292c5
LuaAPI: Move non-gear related ammo functions to new section
Wuzzy
parents:
911
diff
changeset
|
1108 |
==== <tt>!SetAmmoDelay(ammoType, delay)</tt> ==== |
ea13b02292c5
LuaAPI: Move non-gear related ammo functions to new section
Wuzzy
parents:
911
diff
changeset
|
1109 |
Changes the delay of a specified [AmmoTypes Ammo Type]. |
ea13b02292c5
LuaAPI: Move non-gear related ammo functions to new section
Wuzzy
parents:
911
diff
changeset
|
1110 |
|
918
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1111 |
==== <tt>!SetAmmoTexts(ammoType, name, caption, description)</tt> (0.9.23) ==== |
1006
160112dc2fcf
LuaAPI: Clarify SetAmmoTexts usage: Must not be called before onGameStart was fired
Wuzzy
parents:
1004
diff
changeset
|
1112 |
Allows you to overwrite the displayed name and tooltip descriptions of a given ammo type. This function must only be called either inside the `onGameStart` callback function, or after the engine has called `onGameStart`. |
918
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1113 |
|
919 | 1114 |
* `ammoType`: The ammo type to set the text for |
1115 |
* `name`: Name of the ammo type (e.g. “Grenade” for `amGrenade`), affects both name in ammo menu and in the “ticker” message on the screen top. |
|
1116 |
* `caption`: The second line in the ammo menu (below the title). E.g. “Timed grenade” for `amGrenade`. |
|
1117 |
* `description`: Description text in ammo menu, below the caption. |
|
918
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1118 |
|
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1119 |
`title`, `caption`, `description` can be `nil`, in which case they will be reverted to the engine default value. This function returns `nil`. |
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1120 |
|
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1121 |
Example: |
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1122 |
<code language="lua"> |
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1123 |
-- Overwrites bazooka name and description |
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1124 |
SetAmmoTexts(amBazooka, "Spoon Missile", "Crazy weapon", "This crazy weapon looks like a spoon and explodes on impact.|Attack: Hold to launch with more power")</code> |
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1125 |
|
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1126 |
==== <tt>!SetAmmoDescriptionAppendix(ammoType, descAppend)</tt> (0.9.23) ==== |
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1127 |
Will set a string `descAppend` to be appended below the “core” description (ammo tooltip) of the specified `ammoType`, without changing the ordinary description. |
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1128 |
Note that calling this function always sets the complete appended string, you can't use this function to append multiple texts in row. |
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1129 |
|
920 | 1130 |
This function is recommended if you have tweaked an existing ammo type only a little and want to keep the original description intact as much as possible. |
918
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1131 |
|
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1132 |
Example: |
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1133 |
<code language="lua"> |
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1134 |
-- Appends a text to the ammo tooltip of the bazooka but leaves name and main description intact |
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1135 |
SetAmmoTexts(amBazooka, "This weapon deals double the damage than usually.")</code> |
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1136 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
1137 |
==== <tt>!AddAmmo(gearUid, ammoType, ammoCount)</tt> ==== |
1030 | 1138 |
Adds `ammoType` to the specified gear. The amount added is determined by the arguments passed via `SetAmmo()` in the `onAmmoStoreInit()` event handler. `ammoCount` is an optional parameter. If this is set, the ammo will **not** be added, but instead set to `ammoCount`. A value of 0 will remove the weapon, a value of 100 will give infinite ammo. |
912
ea13b02292c5
LuaAPI: Move non-gear related ammo functions to new section
Wuzzy
parents:
911
diff
changeset
|
1139 |
|
918
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1140 |
==== <tt>!GetAmmoName(ammoType [, ignoreOverwrite ])</tt> (0.9.23) ==== |
87e1d0a11e99
LuaAPI: Add SetAmmoDescriptionAppendix, SetAmmoTexts and update GetAmmoName
Wuzzy
parents:
917
diff
changeset
|
1141 |
Returns the localized name for the specified `ammoType`, taking an ammo name overwritten by `SetAmmoTexts` into account. If `ignoreOverwrite` is `true`, this function will always return the original ammo name of the weapon and ignores names which may have been overwritten by `SetAmmoTexts`. |
912
ea13b02292c5
LuaAPI: Move non-gear related ammo functions to new section
Wuzzy
parents:
911
diff
changeset
|
1142 |
|
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1143 |
=== Map === |
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1144 |
==== <tt>!MapHasBorder()</tt> ==== |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1145 |
Returns `true`/`false` if the map has a border or not. |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1146 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
1147 |
==== <tt>!TestRectForObstacle(x1, y1, x2, y2, landOnly)</tt> ==== |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1148 |
Checks the rectangle between the given coordinates for possible collisions. Set `landOnly` to `true` if you don’t want to check for collisions with gears (hedgehogs, etc.). |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1149 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
1150 |
==== <tt>!PlaceGirder(x, y, frameIdx)</tt> ==== |
940 | 1151 |
Attempts to place a girder with centre points `x`, `y` and a certain length and orientation, specified by `frameIdx`. The girder can only be placed in open space and must not collide with anything so this function may fail. It will return `true` on successful placement and `false` on failure. |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1152 |
|
940 | 1153 |
These are the accepted values for `frameIdx`: |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1154 |
|
940 | 1155 |
|| *`frameIdx`* || *Length* || *Orientation* || |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1156 |
|| 0 || short || horizontal || |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1157 |
|| 1 || short || decreasing right || |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1158 |
|| 2 || short || vertical || |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1159 |
|| 3 || short || increasing right || |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1160 |
|| 4 || long || horizontal || |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1161 |
|| 5 || long || decreasing right || |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1162 |
|| 6 || long || vertical || |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1163 |
|| 7 || long || increasing right || |
412 | 1164 |
|
940 | 1165 |
==== <tt>!PlaceRubber(x, y, frameIdx)</tt> (0.9.23) ==== |
1166 |
Attempts to place a rubber with centre points `x`, `y` and a certain orientation, specified by `frameIdx`. The rubber can only be placed in open space and must not collide with anything so this function may fail. It will return `true` on successful placement and `false` on failure. |
|
1167 |
||
1168 |
These are the accepted values for `frameIdx`: |
|
1169 |
||
1170 |
|| *`frameIdx`* || *Orientation* || |
|
1171 |
|| 0 || horizontal || |
|
1172 |
|| 1 || decreasing right || |
|
1173 |
|| 2 || vertical || |
|
1174 |
|| 3 || increasing right || |
|
1175 |
||
688
d9fc58ac04f2
Update EraseSprite, PlaceSprite and Get/Set GearValues
nemo
parents:
685
diff
changeset
|
1176 |
==== <tt>!PlaceSprite(x, y, sprite, frameIdx, tint, behind, flipHoriz, flipVert, [, landFlag, ...])</tt> ==== |
869 | 1177 |
Places a [Sprites sprite] at the specified position (`x`, `y`) on the map, it behaves like terrain then. Unlike `PlaceGirder`, this function does not check for collisions, so the sprite can be placed anywhere within map boundaries. The function returns `true` if the placement was successful, `false` otherwise. `frameIdx` is the frame index starting by 0. `frameIdx` is used if the sprite consists of several sub-images. Only a subset of the sprites is currently supported by this function: |
539 | 1178 |
|
1179 |
* `sprAmGirder` |
|
1180 |
* `sprAmRubber` |
|
1181 |
* `sprAMSlot` |
|
1182 |
* `sprAMAmmos` |
|
1183 |
* `sprAMAmmosBW` |
|
1184 |
* `sprAMCorners` |
|
1185 |
* `sprHHTelepMask` |
|
1186 |
* `sprTurnsLeft` |
|
1187 |
* `sprSpeechCorner` |
|
1188 |
* `sprSpeechEdge` |
|
1189 |
* `sprSpeechTail` |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
1190 |
* `sprTargetBee` |
539 | 1191 |
* `sprThoughtCorner` |
1192 |
* `sprThoughtEdge` |
|
1193 |
* `sprThoughtTail` |
|
1194 |
* `sprShoutCorner` |
|
1195 |
* `sprShoutEdge` |
|
1196 |
* `sprShoutTail` |
|
1197 |
* `sprBotlevels` |
|
1198 |
* `sprIceTexture` |
|
1199 |
* `sprCustom1` |
|
1200 |
* `sprCustom2` |
|
1201 |
||
1506 | 1202 |
`tint` is for an RGBA colouring to apply, this works about the same as `Tint` in gears. If `nil`, the original color is used. |
1203 |
||
1204 |
`behind` indicates the sprite should not replace existing land. |
|
1205 |
||
1206 |
`flipHoriz` and `flipVert` are for mirroring the sprite vertically and horizontally before placing, respectively. |
|
1207 |
||
1208 |
The 9th and later arguments specify land flags (see the constants section) to be used for the newly created terrain. If omitted, `lfNormal` is assumed. |
|
539 | 1209 |
|
1210 |
Example: |
|
1211 |
||
688
d9fc58ac04f2
Update EraseSprite, PlaceSprite and Get/Set GearValues
nemo
parents:
685
diff
changeset
|
1212 |
<code language="lua">PlaceSprite(2836, 634, sprAmGirder, 5) |
539 | 1213 |
-- Places the girder sprite as normal terrain at (2836, 634). The `frameIdx` 5 is for the long decreasing right girder.</code> |
688
d9fc58ac04f2
Update EraseSprite, PlaceSprite and Get/Set GearValues
nemo
parents:
685
diff
changeset
|
1214 |
<code language="lua">PlaceSprite(1411, 625, sprAmRubber, 1, nil, nil, nil, nil, lfBouncy) |
539 | 1215 |
-- Places the rubber band sprite as bouncy terrain at (2836, 634). The `frameIdx` 1 is for the decreasing right rubber band.</code> |
1216 |
||
688
d9fc58ac04f2
Update EraseSprite, PlaceSprite and Get/Set GearValues
nemo
parents:
685
diff
changeset
|
1217 |
==== <tt>!EraseSprite(x, y, sprite, frameIdx, eraseOnLFMatch, onlyEraseLF, flipHoriz, flipVert, [, landFlag, ...])</tt> ==== |
692
111f39408390
Clean up markup for PlaceSprite and EraseSprite and clarify some stuff
Wuzzy
parents:
691
diff
changeset
|
1218 |
Erases a [Sprites sprite] at the specified position (`x`, `y`) on the map. `frameIdx` is the frame index starting by 0. `sprite`, `frameIdx`, `flipHoriz` and `flipVert` behave the same as in `PlaceSprite`. For `sprite`, the same subset of sprites is permitted. |
688
d9fc58ac04f2
Update EraseSprite, PlaceSprite and Get/Set GearValues
nemo
parents:
685
diff
changeset
|
1219 |
|
692
111f39408390
Clean up markup for PlaceSprite and EraseSprite and clarify some stuff
Wuzzy
parents:
691
diff
changeset
|
1220 |
Set `eraseOnLFMatch` to `true` to erase all land for a pixel that matches any of the passed in land flags. This is useful if, for example, an `lfBouncy` sprite was placed “behind” land using `PlaceSprite` and you want to remove it without destroying the non-bouncy terrain. |
688
d9fc58ac04f2
Update EraseSprite, PlaceSprite and Get/Set GearValues
nemo
parents:
685
diff
changeset
|
1221 |
|
692
111f39408390
Clean up markup for PlaceSprite and EraseSprite and clarify some stuff
Wuzzy
parents:
691
diff
changeset
|
1222 |
Set `onlyEraseLF` to `true` to only remove specific land flags. If for example a sprite consists of `lfIndestructible` and `lfBouncy`, and you call `EraseSprite` with `onlyEraseLF` and `lfIndestructible` set, the sprite will remain bouncy but can be destroyed. You can use this to entirely remove all land flags from a sprite—at this point the sprite will be visual only, painted on the map but with no collision. |
688
d9fc58ac04f2
Update EraseSprite, PlaceSprite and Get/Set GearValues
nemo
parents:
685
diff
changeset
|
1223 |
|
692
111f39408390
Clean up markup for PlaceSprite and EraseSprite and clarify some stuff
Wuzzy
parents:
691
diff
changeset
|
1224 |
Examples: |
688
d9fc58ac04f2
Update EraseSprite, PlaceSprite and Get/Set GearValues
nemo
parents:
685
diff
changeset
|
1225 |
|
d9fc58ac04f2
Update EraseSprite, PlaceSprite and Get/Set GearValues
nemo
parents:
685
diff
changeset
|
1226 |
<code language="lua">EraseSprite(2836, 634, sprAmGirder, 5) |
692
111f39408390
Clean up markup for PlaceSprite and EraseSprite and clarify some stuff
Wuzzy
parents:
691
diff
changeset
|
1227 |
-- Removes the girder sprite at (2836, 634). The frameIdx 5 is for the long decreasing right girder.</code> |
688
d9fc58ac04f2
Update EraseSprite, PlaceSprite and Get/Set GearValues
nemo
parents:
685
diff
changeset
|
1228 |
<code language="lua">EraseSprite(1411, 625, sprAmRubber, 1, true, true, nil, nil, lfIndestructible) |
692
111f39408390
Clean up markup for PlaceSprite and EraseSprite and clarify some stuff
Wuzzy
parents:
691
diff
changeset
|
1229 |
-- Removes indestructibility from a rubber band sprite at (2836, 634). The frameIdx 1 is for the decreasing right rubber band.</code> |
688
d9fc58ac04f2
Update EraseSprite, PlaceSprite and Get/Set GearValues
nemo
parents:
685
diff
changeset
|
1230 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
1231 |
==== <tt>!AddPoint(x, y [, width [, erase] ])</tt> ==== |
412 | 1232 |
This function is used to draw your own maps using Lua. The maps drawn with this are of type “hand-drawn”. |
1233 |
||
1234 |
The function takes a `x`,`y` location, a `width` (means start of a new line) and `erase` (if `false`, this function will draw normally, if `true`, this function will erase drawn stuff). |
|
1235 |
||
1236 |
This function must be called within `onGameInit`, where `MapGen` has been set to `mgDrawn`. You also should call `FlushPoints` when you are finished with drawing. |
|
1237 |
||
1391 | 1238 |
See [LuaDrawning] for some examples. |
1239 |
||
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
1240 |
==== <tt>!FlushPoints()</tt> ==== |
412 | 1241 |
Makes sure that all the points/lines specified using `AddPoint` are actually applied to the map. This function must be called within `onGameInit`. |
1242 |
||
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1243 |
=== Current hedgehog === |
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1244 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
1245 |
==== <tt>!GetCurAmmoType()</tt> ==== |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1246 |
Returns the currently selected [AmmoTypes Ammo Type]. |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1247 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
1248 |
==== <tt>!SwitchHog(gearUid)</tt> ==== |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1249 |
This function will switch to the hedgehog with the specifiedd `gearUid`. |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1250 |
|
1246 | 1251 |
==== <tt>!SetWeapon(ammoType)</tt> ==== |
1245 | 1252 |
Sets the selected weapon of `CurrentHedgehog` to one of the [AmmoTypes Ammo Type]. |
1253 |
||
1299 | 1254 |
Examples: |
1245 | 1255 |
|
1256 |
<code language="lua"> |
|
1299 | 1257 |
SetWeapon(amBazooka) -- select the bazooka (if hog has one) |
1258 |
</code> |
|
1259 |
<code language="lua"> |
|
1260 |
SetWeapon(amNothing) -- unselects the weapon. |
|
1261 |
</code> |
|
1245 | 1262 |
|
1246 | 1263 |
==== <tt>!SetNextWeapon()</tt> ==== |
1245 | 1264 |
This function makes the current hedgehog switch to the next weapon in list of available weapons. It can be used for example in trainings to pre-select a weapon. |
1265 |
||
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1266 |
==== <tt>!SetInputMask(mask)</tt> ==== |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1267 |
Masks specified player input. This means that Hedgewars ignores certain player inputs, such as walking or jumping. |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1268 |
|
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1269 |
Example: |
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
1270 |
<code language="lua"> -- masks the long and high jump commands |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1271 |
SetInputMask(band(0xFFFFFFFF, bnot(gmLJump + gmHJump))) |
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1272 |
-- clears input mask, allowing player to take actions |
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1273 |
SetInputMask(0xFFFFFFFF) |
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1274 |
</code> |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1275 |
*Note*: Using the input mask is an effective way to script uninterrupted cinematics, or create modes such as No Jumping. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1276 |
|
936 | 1277 |
*Note*: This function is used internally in the Animate [LuaLibraries library]. |
1278 |
||
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1279 |
See also [GearMessages]. |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1280 |
|
405 | 1281 |
==== <tt>!GetInputMask()</tt> ==== |
1282 |
Returns the current input mask of the player. |
|
1283 |
||
1219
b467502126fd
LuaAPI: Move SetVampiric and SetLaserSight one level down
Wuzzy
parents:
1218
diff
changeset
|
1284 |
==== `SetVampiric(bool)` (0.9.24) ==== |
1189 | 1285 |
Toggles vampirism mode for this turn. Set `bool` to `true` to enable (same effect as if the hedgehog has used Vampirism), `false` to disable. |
1286 |
||
1498 | 1287 |
==== `GetVampiric()` (0.9.25) ==== |
1288 |
Returns true if vampirism mode is currently active. |
|
1289 |
||
1219
b467502126fd
LuaAPI: Move SetVampiric and SetLaserSight one level down
Wuzzy
parents:
1218
diff
changeset
|
1290 |
==== `SetLaserSight(bool)` (0.9.24) ==== |
1189 | 1291 |
Toggles laser sight for this turn. Set `bool` to `true` to enable (same effect as if the hedgehog has used Laser Sight), `false` to disable. |
1292 |
||
1498 | 1293 |
==== `GetLaserSight()` (0.9.25) ==== |
1294 |
Returns true if laser sight (as utility) is currently active. The sniper rifle's built-in laser sight does not count. |
|
1295 |
||
1411 | 1296 |
==== `EnableSwitchHog()` (0.9.25) ==== |
1297 |
Enable hog switching mode for the current hedgehog. This function should be called while the hedgehog is standing on solid ground (`GetFlightTime` returns 0). |
|
1298 |
||
1299 |
Internally, this tries to spawn a `gtSwitcher` gear which, as long it exists, handles the hog switching. You can delete this gear to stop the hog switching prematurely. If there already is a `gtSwitcher` gear, no additional gear is spawned. |
|
1300 |
||
1301 |
On success, returns the `gtSwitcher` gear being spawned or, if hog switching mode is already active, returns the exsting gear. On failure, returns `nil`. |
|
1302 |
||
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1303 |
=== Randomness === |
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1304 |
==== <tt>!GetRandom(number)</tt> ==== |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1305 |
Returns a randomly generated number in the range of 0 to number - 1. This random number uses the game seed, so is synchronised, and thus safe for multiplayer and saved games. Use `GetRandom` for anything that could impact the engine state. For example, a visual gear could simply use Lua’s `math.random`, but adding a regular gear should use `GetRandom`. |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1306 |
|
413
6d90d6994e95
Add DismissTeam, move AddTeam to new “Clans and teams” section.
almikes@aol.com
parents:
412
diff
changeset
|
1307 |
=== Clans and teams === |
6d90d6994e95
Add DismissTeam, move AddTeam to new “Clans and teams” section.
almikes@aol.com
parents:
412
diff
changeset
|
1308 |
==== <tt>!AddTeam(teamname, color, grave, fort, voicepack, flag)</tt> ==== |
6d90d6994e95
Add DismissTeam, move AddTeam to new “Clans and teams” section.
almikes@aol.com
parents:
412
diff
changeset
|
1309 |
|
476
dd4470df66ad
Restructure information about AddTeam, add info that Hedgewars does not support empty teams.
almikes@aol.com
parents:
461
diff
changeset
|
1310 |
Adds a new team. Note that this can only be done in `onGameInit`, not at a later time. |
dd4470df66ad
Restructure information about AddTeam, add info that Hedgewars does not support empty teams.
almikes@aol.com
parents:
461
diff
changeset
|
1311 |
You *must* add at least one hedgehog with `AddHog` after calling this. The engine does not support empty teams. |
dd4470df66ad
Restructure information about AddTeam, add info that Hedgewars does not support empty teams.
almikes@aol.com
parents:
461
diff
changeset
|
1312 |
|
dd4470df66ad
Restructure information about AddTeam, add info that Hedgewars does not support empty teams.
almikes@aol.com
parents:
461
diff
changeset
|
1313 |
Arguments: |
dd4470df66ad
Restructure information about AddTeam, add info that Hedgewars does not support empty teams.
almikes@aol.com
parents:
461
diff
changeset
|
1314 |
|
dd4470df66ad
Restructure information about AddTeam, add info that Hedgewars does not support empty teams.
almikes@aol.com
parents:
461
diff
changeset
|
1315 |
* `teamname`: The name of the team. |
583
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
1316 |
* `color`: The RGB color of the team as defined in [LuaAPI#Color] |
476
dd4470df66ad
Restructure information about AddTeam, add info that Hedgewars does not support empty teams.
almikes@aol.com
parents:
461
diff
changeset
|
1317 |
* `grave`: The name of the team’s grave (equals file name without the suffix) |
638 | 1318 |
* `fort`: The name of the team’s fort (equals file name without the suffix and without the letter “L” or “R” before that suffix) |
476
dd4470df66ad
Restructure information about AddTeam, add info that Hedgewars does not support empty teams.
almikes@aol.com
parents:
461
diff
changeset
|
1319 |
* `voicepack`: The name of the team’s voice pack (equals the directory name) |
638 | 1320 |
* `flag`: Optional argument for the name of the team’s flag (equals file name without the suffix). If set to `nil`, the flag “hedgewars” is used. |
476
dd4470df66ad
Restructure information about AddTeam, add info that Hedgewars does not support empty teams.
almikes@aol.com
parents:
461
diff
changeset
|
1321 |
|
625 | 1322 |
*Note*: This works only for singleplayer training missions for now and will desync multiplayer games. |
413
6d90d6994e95
Add DismissTeam, move AddTeam to new “Clans and teams” section.
almikes@aol.com
parents:
412
diff
changeset
|
1323 |
|
6d90d6994e95
Add DismissTeam, move AddTeam to new “Clans and teams” section.
almikes@aol.com
parents:
412
diff
changeset
|
1324 |
Example: |
6d90d6994e95
Add DismissTeam, move AddTeam to new “Clans and teams” section.
almikes@aol.com
parents:
412
diff
changeset
|
1325 |
|
476
dd4470df66ad
Restructure information about AddTeam, add info that Hedgewars does not support empty teams.
almikes@aol.com
parents:
461
diff
changeset
|
1326 |
<code language="lua">AddTeam("team 1", 0xDD0000, "Simple", "Tank", "Default", "hedgewars") |
dd4470df66ad
Restructure information about AddTeam, add info that Hedgewars does not support empty teams.
almikes@aol.com
parents:
461
diff
changeset
|
1327 |
--[[ Adds a new team with name “team 1”, red color (hexadecimal notation), the grave “Simple”, |
dd4470df66ad
Restructure information about AddTeam, add info that Hedgewars does not support empty teams.
almikes@aol.com
parents:
461
diff
changeset
|
1328 |
the fort “Tank” the voicepack “Default” and the flag “hedgewars”. ]]</code> |
413
6d90d6994e95
Add DismissTeam, move AddTeam to new “Clans and teams” section.
almikes@aol.com
parents:
412
diff
changeset
|
1329 |
|
1189 | 1330 |
==== <tt>!GetTeamName(teamIdx)</tt> (0.9.24) ==== |
1331 |
Returns the name of the team with the index `teamIdx`. `teamIdx` is a number between 0 and `TeamsCount-1`. |
|
1332 |
||
1218 | 1333 |
==== <tt>!GetTeamIndex(teamname)</tt> (0.9.24) ==== |
1217 | 1334 |
Returns the team index (number between 0 and `TeamsCount-1`) of the team with the name `teamName`. |
1335 |
||
1336 |
==== <tt>!GetTeamClan(teamname)</tt> (0.9.24) ==== |
|
1337 |
Returns the clan ID of the team with the given `teamName`. |
|
1338 |
||
413
6d90d6994e95
Add DismissTeam, move AddTeam to new “Clans and teams” section.
almikes@aol.com
parents:
412
diff
changeset
|
1339 |
==== <tt>!DismissTeam(teamname)</tt> ==== |
1217 | 1340 |
Vaporizes all the hogs of the team with the given team name in a puff of smoke. |
1341 |
||
1342 |
This function must not be called while it's the team's turn. |
|
1343 |
||
1240 | 1344 |
==== `SetTeamLabel(teamname[, label])` (0.9.24) ==== |
1217 | 1345 |
Set or remove a label for the team with the given team name. The label is a string and will be displayed next to the team's health bar. |
1346 |
||
1347 |
If `label` is `nil`, the label will be removed. |
|
1348 |
||
1349 |
There's a special case: If the AI Survival game modifier is active, the AI kill counter will be replaced by the custom team label if it has been set. If `label` is set to `nil`, the default AI counter is shown again. |
|
1350 |
||
1351 |
Use this to display a score, power value or another important team attribute. There's no hard length limit, but please try to keep it as short as possible to avoid visual clutter. |
|
413
6d90d6994e95
Add DismissTeam, move AddTeam to new “Clans and teams” section.
almikes@aol.com
parents:
412
diff
changeset
|
1352 |
|
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1353 |
==== <tt>!GetClanColor(clan)</tt> ==== |
858
2a562faa73fb
LuaAPI: GetClanColor, SetClanColor: They use RGBA instead of RGB
Wuzzy
parents:
826
diff
changeset
|
1354 |
Returns the RGBA color of the chosen clan by its number. The color data type is described in [LuaAPI#Color]. |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1355 |
|
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1356 |
==== <tt>!SetClanColor(clan, color)</tt> ==== |
858
2a562faa73fb
LuaAPI: GetClanColor, SetClanColor: They use RGBA instead of RGB
Wuzzy
parents:
826
diff
changeset
|
1357 |
Sets the RGBA color of the chosen clan by its number. The color data type is described in [LuaAPI#Color]. |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1358 |
|
577 | 1359 |
=== Campaign management === |
1360 |
==== <tt>!SaveCampaignVar(varname, value)</tt> ==== |
|
1361 |
Stores the value `value` (a string) into the campaign variable `varname` (also a string). Campaign variables allow you to save progress of a team in a certain campaign. Campaign variables are saved on a per-team per-campaign basis. They are written into the team file (see [ConfigurationFiles#TeamName.hwt]). |
|
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1362 |
|
579
9895045e9963
Updated SaveCampaignVar / GetCampaignVar links
almikes@aol.com
parents:
577
diff
changeset
|
1363 |
There are some special campaign variables which are used by Hedgewars to determine which missions to display in the campaign menu. This is described [ConfigurationFiles#%5BCampaign%20%3CCAMPAIGN_NAME%3E%5D here]. |
9895045e9963
Updated SaveCampaignVar / GetCampaignVar links
almikes@aol.com
parents:
577
diff
changeset
|
1364 |
|
577 | 1365 |
==== <tt>!GetCampaignVar(varname)</tt> ==== |
579
9895045e9963
Updated SaveCampaignVar / GetCampaignVar links
almikes@aol.com
parents:
577
diff
changeset
|
1366 |
Returns the value of the campaign variable `varname` as a string. See also `SaveCampaignVar`. |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1367 |
|
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1368 |
== Functions affecting the GUI == |
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1369 |
|
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1370 |
=== <tt>!AddCaption(text)</tt> === |
561 | 1371 |
Display an event text in the upper part of the screen. The text will be white and the caption group will be `capgrpMessage`. |
1372 |
||
583
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
1373 |
Example: |
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
1374 |
<code language="lua"> |
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
1375 |
AddCaption("Hello, world!") |
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
1376 |
</code> |
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
1377 |
|
561 | 1378 |
=== <tt>!AddCaption(text, color, captiongroup)</tt> === |
583
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
1379 |
Display an event text in the upper part of the screen with the specified RGBA [LuaAPI#Color color] and caption group. Although an RBGA color is used, Hedgewars does not actually support transparent or semi-transparent captions, so the fourth byte is ignored. We recommend you to always specify a full opacity (`FF` in hexadecimal) for the caption. |
561 | 1380 |
|
1381 |
|| *`captiongroup`* || *Meaning* || |
|
1382 |
|| `capgrpGameState` || Used for important global game events, like Sudden Death || |
|
1383 |
|| `capgrpAmmoinfo` || Used for new weapon crates and some other events || |
|
1502 | 1384 |
|| `capgrpVolume` || Used for “local” changes of client settings that don't affect gameplay, like volume change, auto camera on/off, etc. || |
561 | 1385 |
|| `capgrpMessage` || Generic message || |
1386 |
|| `capgrpMessage2` || Generic message || |
|
1387 |
|| `capgrpAmmostate` || Used to show information about weapon state, i.e. bounce level, timer, remaining shots, etc. || |
|
1388 |
||
583
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
1389 |
Example: |
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
1390 |
<code language="lua"> |
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
1391 |
AddCaption("Melon bomb rain in 2 rounds!", 0xFF0000FF, capgrpGameState) |
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
1392 |
-- Green example message. |
0818d57c392f
Clarifications on differences of RGB vs RGBA.
almikes@aol.com
parents:
579
diff
changeset
|
1393 |
</code> |
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1394 |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
1395 |
=== <tt>!ShowMission(caption, subcaption, text, icon, time)</tt> === |
894 | 1396 |
This function will open the mission panel and set the texts in it. |
1397 |
||
1398 |
Use to tell the player what he/she is supposed to do. If you use this function, a mission panel is shown for the amount of time specified in `time` (in milliseconds). If `time` is set to 0, it will be displayed for a default amount of time. |
|
1399 |
This function replaces the *entire* text of the mission panel. Compare this to the global `Goals` variable, which *adds* to the default text without replacing it. |
|
645 | 1400 |
|
1401 |
`caption` is the text displayed in the first line, `subcaption` is displayed in the second line and `text` is the text displayed in the third and following lines. |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
1402 |
|
647 | 1403 |
`text` uses some special characters for formatting: `|` is used for a line break, and everything written before and including a `:` in a line is written in a lighter color. |
645 | 1404 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
1405 |
`icon` accepts the following values: |
79 | 1406 |
|
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1407 |
|| *`icon`* || *What is shown* || |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1408 |
|| _negative number_ || Icon of an ammo type. It is specified as the negative of an ammo type constant (see [AmmoTypes]), i.e. `-amBazooka` for the bazooka icon. || |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1409 |
|| `0` || Golden crown || |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1410 |
|| `1` || Target || |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1411 |
|| `2` || Exclamation mark || |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1412 |
|| `3` || Question mark || |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1413 |
|| `4` || Golden star || |
636 | 1414 |
|| `5` || Utility crate || |
1415 |
|| `6` || Health crate || |
|
1416 |
|| `7` || Ammo crate || |
|
1417 |
|| `8` || Barrel || |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
1418 |
|| `9` || Dud mine || |
28
026591d95ac6
Edited wiki page LuaAPI through web user interface.
henrik.rostedt
parents:
24
diff
changeset
|
1419 |
|
645 | 1420 |
Example: |
1421 |
<code language="lua"> |
|
1422 |
ShowMission(loc("Nobody Laugh"), loc("User Challenge"), loc("Eliminate the enemy before the time runs out"), 0, 0) |
|
1423 |
</code> |
|
1424 |
||
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
1425 |
=== <tt>!HideMission()</tt> === |
894 | 1426 |
Hides the mission panel if it is currently displayed, otherwise, this function does nothing. |
28
026591d95ac6
Edited wiki page LuaAPI through web user interface.
henrik.rostedt
parents:
24
diff
changeset
|
1427 |
|
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1428 |
=== <tt>!SetZoom(zoomLevel)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1429 |
Sets the zoom level. The value for maximum zoom is currently 1.0 and for minimum 3.0 The default zoom level is 2.0 |
28
026591d95ac6
Edited wiki page LuaAPI through web user interface.
henrik.rostedt
parents:
24
diff
changeset
|
1430 |
|
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1431 |
=== <tt>!GetZoom()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1432 |
Returns the current zoom level. |
147
379d7931ffc7
Edited wiki page LuaAPI through web user interface.
RedGrinner@gmail.com
parents:
146
diff
changeset
|
1433 |
|
775 | 1434 |
=== `SetCinematicMode(enable)` (0.9.23) === |
1435 |
Turns on or off cinematic mode. Cinematic mode can be used for cutscenes etc. |
|
1436 |
If `enable` is set to `true`, cinematic mode is enabled, |
|
1437 |
if it is `false`, cinematic mode is disabled. |
|
1438 |
||
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1439 |
== Sound functions == |
1256 | 1440 |
=== `PlaySound(soundId, [gearUid [, instaVoice]])` === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1441 |
Plays the specified sound. Possible values for `soundId` are listed on the [Sounds] page. |
28
026591d95ac6
Edited wiki page LuaAPI through web user interface.
henrik.rostedt
parents:
24
diff
changeset
|
1442 |
|
1258 | 1443 |
To play a voice (see [Taunts] for a list), you must also set `gearUid`. `gearUid` is the hedgehog gear which is used to “talk”. |
1256 | 1444 |
|
1257 | 1445 |
If you play a voice, by default the voice will respect an internal queue and might be played with an delay in order to prevent annoying voice overlapping. Since version 0.9.24, you can disable this behaviour and force Hedgewars to instantly play the voice by also setting `instaVoice` to `true`. Only use `instaVoice` when you really need it. |
1256 | 1446 |
|
1447 |
=== `SetSoundMask(soundId, isMasked)` (0.9.24) === |
|
1448 |
Disables a given sound (including taunts) from being played by the engine. `soundId` is a valid sound ID on [Sounds] or [Taunts]. `isMasked` is a boolean. If `true`, the sound will not be played by the engine anymore. If `false`, playing this sound is allowed again. |
|
70
ff7d4c176303
Edited wiki page LuaAPI through web user interface.
henrik.rostedt
parents:
69
diff
changeset
|
1449 |
|
1256 | 1450 |
Sounds played by the Lua function `PlaySound` will always work, however, and ignore the sound mask. |
1451 |
||
1452 |
Note: Due to the way the voices work internally in Hedgewars, if you want to play a masked voice, you have to set `instaVoice` to `true` when you call `PlaySound`. Otherwise, it won't work. |
|
1453 |
||
1454 |
Example: |
|
1455 |
||
1456 |
<code language="lua">SetSoundMask(sndIncoming, true) |
|
1457 |
-- Disable the “Incoming” sound from being played</code> |
|
77 | 1458 |
|
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1459 |
== File system functions == |
410 | 1460 |
=== <tt>!HedgewarsScriptLoad(scriptPath)</tt> === |
407 | 1461 |
Loads a script (i.e. a [LuaLibraries library]) from the specified `scriptPath`. The root directory is here Hedgewars’ data directory. |
1462 |
||
1463 |
Example: |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
1464 |
<code language="lua"> |
407 | 1465 |
HedgewarsScriptLoad("/Scripts/Locale.lua") -- loads locale library |
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
1466 |
</code> |
407 | 1467 |
|
404
37d44392ad2b
Reorganize the section “other functions” into several logical subunits.
almikes@aol.com
parents:
403
diff
changeset
|
1468 |
== Stats functions == |
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
1469 |
=== <tt>!SendStat(TStatInfoType, statMessage[, teamName])</tt> === |
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1470 |
|
893 | 1471 |
This function allows to change the details of the stats screen seen after the end of a game. |
418
a7d34a3e5786
Make documentation for SendStat much more readable: Add a table (still not perfect), added some basic parameter descriptions.
almikes@aol.com
parents:
417
diff
changeset
|
1472 |
|
a7d34a3e5786
Make documentation for SendStat much more readable: Add a table (still not perfect), added some basic parameter descriptions.
almikes@aol.com
parents:
417
diff
changeset
|
1473 |
`TStatInfoType` is the piece of information you want to manipulate. The result of this functions varies greatly for different `TStatInfoType`s. The parameter `statMessage` is mandatory and is a string used for the statistics, its meaning depends on the `TStatInfoType`. The parameter `teamName` contains the name of a team which is relevant to the chosen stat. This parameter is not always required, this also depends on `TStatInfoType`. |
a7d34a3e5786
Make documentation for SendStat much more readable: Add a table (still not perfect), added some basic parameter descriptions.
almikes@aol.com
parents:
417
diff
changeset
|
1474 |
|
a7d34a3e5786
Make documentation for SendStat much more readable: Add a table (still not perfect), added some basic parameter descriptions.
almikes@aol.com
parents:
417
diff
changeset
|
1475 |
This tables explains the different behaviours of this function for different values of `TStatInfoType`: |
a7d34a3e5786
Make documentation for SendStat much more readable: Add a table (still not perfect), added some basic parameter descriptions.
almikes@aol.com
parents:
417
diff
changeset
|
1476 |
|
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1477 |
|| *`TStatInfoType`* || *Meaning of `statMessage`* || *Team parameter used?* || |
418
a7d34a3e5786
Make documentation for SendStat much more readable: Add a table (still not perfect), added some basic parameter descriptions.
almikes@aol.com
parents:
417
diff
changeset
|
1478 |
|| `siGraphTitle` || Title of the graph. If you use this, the health icon changes into a star. || No || |
a7d34a3e5786
Make documentation for SendStat much more readable: Add a table (still not perfect), added some basic parameter descriptions.
almikes@aol.com
parents:
417
diff
changeset
|
1479 |
|| `siGameResult` || Title of the stats screen, used to show the result of the game, i.e. who won the game || No || |
a7d34a3e5786
Make documentation for SendStat much more readable: Add a table (still not perfect), added some basic parameter descriptions.
almikes@aol.com
parents:
417
diff
changeset
|
1480 |
|| `siCustomAchievement` || A freeform text for a single “bullet point” in the “bullet point” list in the details section. For each time you call `SendStat` with this `TStatInfoType`, a new “bullet point” gets added to the list. || No || |
685 | 1481 |
|| `siPointType` || Replaces the word “kills” in the ranking list. You have to call this each time before you report the score or kills of a team with `siPlayerKills`. Sadly, grammatical number is currently not respected at all here. || No || |
418
a7d34a3e5786
Make documentation for SendStat much more readable: Add a table (still not perfect), added some basic parameter descriptions.
almikes@aol.com
parents:
417
diff
changeset
|
1482 |
|| `siPlayerKills` || The number of kills for the specified team (converted to a string), as shown in the ranking list. Unless the word “kills” has been replaced by `siPointType`, then that word is used instead. Only integers (converted to string) are possible. || Yes || |
1265 | 1483 |
|| `siClanHealth` || Value of a data point. This sets a single data point on the graph for the specified team. All teams will be converted to clans prior to drawing, there can only be one chart per clan. Subsequent calls will draw the next point along the horizontal axis; the frontend will then simply connect the dots in the final chart. Only whole numbers are supported. There must be at least 2 data points for any given clan, otherwise there won't be much to look at. ;-) You also should have called `SendHealthStatsOff` if to prevent the default health graphs to be drawn. || Yes || |
418
a7d34a3e5786
Make documentation for SendStat much more readable: Add a table (still not perfect), added some basic parameter descriptions.
almikes@aol.com
parents:
417
diff
changeset
|
1484 |
|| `siMaxStepKills` || Most hedgehogs killed in a round. `statText` must be in format “`<kills> <name of killer hedgehog> (<team name of killer>)`”. || No || |
a7d34a3e5786
Make documentation for SendStat much more readable: Add a table (still not perfect), added some basic parameter descriptions.
almikes@aol.com
parents:
417
diff
changeset
|
1485 |
|| `siMaxTeamDamage` || Hedgehog with most damage inflicted to his own team. `statText` must be in the format “`<damage> <hedgehog name>`”. || No || |
a7d34a3e5786
Make documentation for SendStat much more readable: Add a table (still not perfect), added some basic parameter descriptions.
almikes@aol.com
parents:
417
diff
changeset
|
1486 |
|| `siKilledHHs` || Total number of killed hedgehogs (converted to string). || No || |
1038 | 1487 |
|| `siTeamStats` || Sets the ranking of each team. Use number 0 for default ranking. Format: “`<team name 1>:<rank 1>:<team name 2>:<rank 2>:`” (and so on) || No || |
1265 | 1488 |
|| `siMaxStepDamage` || Most damage in one turn for the “best shot award”. `statText` must be in format “`<damage> <hedgehog name> (<team name>)`”. || No || |
418
a7d34a3e5786
Make documentation for SendStat much more readable: Add a table (still not perfect), added some basic parameter descriptions.
almikes@aol.com
parents:
417
diff
changeset
|
1489 |
|| `siMaxTurnSkips` || Team with most skips. `statText` must be of format “`<number> <teamName>`”. || No || |
a7d34a3e5786
Make documentation for SendStat much more readable: Add a table (still not perfect), added some basic parameter descriptions.
almikes@aol.com
parents:
417
diff
changeset
|
1490 |
|
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1491 |
|
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1492 |
<b>Examples:</b> |
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1493 |
|
416
5aa55bbe4b73
Fixed faulty syntax highlighting in code block (was: “<code lang=…” instead of “<code language=…”)
almikes@aol.com
parents:
415
diff
changeset
|
1494 |
<code language="lua"> |
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1495 |
-- will automatically change the health icon to a star |
347
edc8d322d02d
Edited wiki page LuaAPI, fixing SendStat
pntanasis@gmail.com
parents:
346
diff
changeset
|
1496 |
SendStat(siGraphTitle,'Custom Graph Title') |
edc8d322d02d
Edited wiki page LuaAPI, fixing SendStat
pntanasis@gmail.com
parents:
346
diff
changeset
|
1497 |
SendStat(siGameResult,'Winner is Team A!') |
418
a7d34a3e5786
Make documentation for SendStat much more readable: Add a table (still not perfect), added some basic parameter descriptions.
almikes@aol.com
parents:
417
diff
changeset
|
1498 |
SendStat(siCustomAchievement,'This is a custom message posted in the Details section!') |
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1499 |
-- Changes the word kill to Point, call it just before sending kills/score for each hog |
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1500 |
-- in case you want to change the word i.e. print Point or Points |
347
edc8d322d02d
Edited wiki page LuaAPI, fixing SendStat
pntanasis@gmail.com
parents:
346
diff
changeset
|
1501 |
SendStat(siPointType,'Point') |
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1502 |
-- if above function call was not used it will print 3 kills for teamName in Ranking section. |
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1503 |
-- if it was used it will print 3 Point for teamName in Ranking section. |
347
edc8d322d02d
Edited wiki page LuaAPI, fixing SendStat
pntanasis@gmail.com
parents:
346
diff
changeset
|
1504 |
SendStat(siPlayerKills,'3',teamName) |
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1505 |
-- call siClanHealth to send the "value" of a clan that will be used for the graph creation |
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1506 |
-- a good idea is to call it always for every hog by using the runOnGears(function) |
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1507 |
-- in normal mode "value" represents clan health |
347
edc8d322d02d
Edited wiki page LuaAPI, fixing SendStat
pntanasis@gmail.com
parents:
346
diff
changeset
|
1508 |
SendStat(siClanHealth, "100",teamName) |
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1509 |
-- most hedgehogs killed in a round (hedgeHogName is who killed them) |
347
edc8d322d02d
Edited wiki page LuaAPI, fixing SendStat
pntanasis@gmail.com
parents:
346
diff
changeset
|
1510 |
SendStat(siMaxStepKills, "1 hedgeHogName (teamName)") |
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1511 |
-- hog with most damage inflicted to his own team |
347
edc8d322d02d
Edited wiki page LuaAPI, fixing SendStat
pntanasis@gmail.com
parents:
346
diff
changeset
|
1512 |
SendStat(siMaxTeamDamage, "100 hedgeHogName") |
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1513 |
-- total number of killed hedgehogs |
347
edc8d322d02d
Edited wiki page LuaAPI, fixing SendStat
pntanasis@gmail.com
parents:
346
diff
changeset
|
1514 |
SendStat(siKilledHHs, "1") |
1038 | 1515 |
-- ranking: sets rank of Megateam to 1 and rank of Superteam to 2 |
1516 |
SendStat(siTeamStats, "Megateam:1:Superteam:2:") |
|
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1517 |
-- best shot award |
347
edc8d322d02d
Edited wiki page LuaAPI, fixing SendStat
pntanasis@gmail.com
parents:
346
diff
changeset
|
1518 |
SendStat(siMaxStepDamage, "30 hedgeHogName (teamName)") |
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1519 |
-- team with most kills of own hedgehogs |
347
edc8d322d02d
Edited wiki page LuaAPI, fixing SendStat
pntanasis@gmail.com
parents:
346
diff
changeset
|
1520 |
SendStat(siMaxStepDamage, "2 teamName") |
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1521 |
-- team with most skips |
347
edc8d322d02d
Edited wiki page LuaAPI, fixing SendStat
pntanasis@gmail.com
parents:
346
diff
changeset
|
1522 |
SendStat(siMaxTurnSkips, "3 teamName") |
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1523 |
</code> |
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1524 |
|
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1525 |
<b>Important:</b> |
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1526 |
|
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1527 |
* As the game engine send stats to the frontend at the end of the game one should send her stats when the game is going to finish and right before the call of `EndGame()`. (Note: Stats are sent from the engine in `CheckForWin`. If conditions are met (win or draw) then `SendStats(uStats)` is called.) |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1528 |
* Calling just `EndGame()` won’t produce any stats. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1529 |
* If one would like to produce a custom graph see also `SendHealthStatsOff()`. |
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1530 |
|
1232
4ac63a5c0184
LuaAPI: Remove most pre-0.9.23 version number mentions as very old
Wuzzy
parents:
1231
diff
changeset
|
1531 |
=== <tt>!SendHealthStatsOff()</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1532 |
Prevents the engine of sending health stats to the frontend. |
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1533 |
|
996
9d49deef533c
LuaAPI: Add SendRankingStatsOff, SendAchievementsStatsOff, SendGameResultOff
Wuzzy
parents:
993
diff
changeset
|
1534 |
If any health stats haven’t been sent before this will cause the health graph to the stats page to be hidden. Use this function in the Lua scripts to produce custom graphs by calling it inside `onGameStart()` and using the `SendStat()` function. |
9d49deef533c
LuaAPI: Add SendRankingStatsOff, SendAchievementsStatsOff, SendGameResultOff
Wuzzy
parents:
993
diff
changeset
|
1535 |
|
9d49deef533c
LuaAPI: Add SendRankingStatsOff, SendAchievementsStatsOff, SendGameResultOff
Wuzzy
parents:
993
diff
changeset
|
1536 |
=== <tt>!SendAchievementsStatsOff()</tt> (0.9.23) === |
9d49deef533c
LuaAPI: Add SendRankingStatsOff, SendAchievementsStatsOff, SendGameResultOff
Wuzzy
parents:
993
diff
changeset
|
1537 |
Prevents the engine of populating the snarky comments in the “Details” section (internally known as “achievements”) of the stats screen, such as “best shot award”, etc. So you can start with a clean list when the game ends normally. This function needs to be called inside `onGameStart()`. |
9d49deef533c
LuaAPI: Add SendRankingStatsOff, SendAchievementsStatsOff, SendGameResultOff
Wuzzy
parents:
993
diff
changeset
|
1538 |
|
9d49deef533c
LuaAPI: Add SendRankingStatsOff, SendAchievementsStatsOff, SendGameResultOff
Wuzzy
parents:
993
diff
changeset
|
1539 |
=== <tt>!SendRankingStatsOff()</tt> (0.9.23) === |
9d49deef533c
LuaAPI: Add SendRankingStatsOff, SendAchievementsStatsOff, SendGameResultOff
Wuzzy
parents:
993
diff
changeset
|
1540 |
Prevents the engine of populating the team rankings in the stats screen, so you can start with a clean list when the game ends normally. This function needs to be called inside `onGameStart()`. |
9d49deef533c
LuaAPI: Add SendRankingStatsOff, SendAchievementsStatsOff, SendGameResultOff
Wuzzy
parents:
993
diff
changeset
|
1541 |
|
9d49deef533c
LuaAPI: Add SendRankingStatsOff, SendAchievementsStatsOff, SendGameResultOff
Wuzzy
parents:
993
diff
changeset
|
1542 |
=== <tt>!SendGameResultOff()</tt> (0.9.23) === |
9d49deef533c
LuaAPI: Add SendRankingStatsOff, SendAchievementsStatsOff, SendGameResultOff
Wuzzy
parents:
993
diff
changeset
|
1543 |
Prevents the engine of setting the game result text at the top of the stats screen, e.g. “Team 1 wins!” when the game ends normally. This function needs to be called inside `onGameStart()`. |
328
fdc71ac8db83
Updated wiki page LuaAPI with the SendStat() and SendHealthStatsOff() functions.
pntanasis@gmail.com
parents:
313
diff
changeset
|
1544 |
|
1040 | 1545 |
=== <tt>!GetTeamStats(teamname)</tt> (0.9.23) === |
1546 |
Returns a table of internal stats of a team. This table has the following fields: |
|
1547 |
||
1211 | 1548 |
* `Kills`: Number of kills |
1549 |
* `Suicides`: Number of suicides (not yet working) |
|
1550 |
* `AIKills`: Number of AI kills |
|
1551 |
* `TeamKills`: Number of hedgehogs killes in own team (excluding current hedghog) |
|
1552 |
* `TurnSkips`: Number of skipped turns |
|
1553 |
* `TeamDamage`: Damage inflicted to own team (excluding current hedgehog) |
|
1040 | 1554 |
|
382 | 1555 |
== Math Functions == |
1556 |
||
383
6679b75048c0
I really have to get used to using preview on google code wiki...
sheepyluva@gmail.com
parents:
382
diff
changeset
|
1557 |
=== <tt>div(dividend, divisor)</tt> === |
515
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1558 |
Performs an integer division and returns the result. |
8e9d86efc07b
Copy-editing of the entire page. Also a few updates to some fairly out-dated information while I’m at it.
almikes@aol.com
parents:
505
diff
changeset
|
1559 |
The result is an integer and has the value of the first parameter (an integer) divided by the second parameter (another integer), rounded towards zero. |
382 | 1560 |
|
401
aee281298267
Documented the following functions: band, bnot, bor.
almikes@aol.com
parents:
400
diff
changeset
|
1561 |
=== <tt>band(value1, value2)</tt> === |
aee281298267
Documented the following functions: band, bnot, bor.
almikes@aol.com
parents:
400
diff
changeset
|
1562 |
Returns the bitwise logical AND of `value1` and `value2`. |
aee281298267
Documented the following functions: band, bnot, bor.
almikes@aol.com
parents:
400
diff
changeset
|
1563 |
|
aee281298267
Documented the following functions: band, bnot, bor.
almikes@aol.com
parents:
400
diff
changeset
|
1564 |
=== <tt>bor(value1, value2)</tt> === |
aee281298267
Documented the following functions: band, bnot, bor.
almikes@aol.com
parents:
400
diff
changeset
|
1565 |
Returns the bitwise logical OR of `value1` and `value2`. |
aee281298267
Documented the following functions: band, bnot, bor.
almikes@aol.com
parents:
400
diff
changeset
|
1566 |
|
aee281298267
Documented the following functions: band, bnot, bor.
almikes@aol.com
parents:
400
diff
changeset
|
1567 |
=== <tt>bnot(value)</tt> === |
aee281298267
Documented the following functions: band, bnot, bor.
almikes@aol.com
parents:
400
diff
changeset
|
1568 |
Returns the bitwise logical NOT of `value`. |
aee281298267
Documented the following functions: band, bnot, bor.
almikes@aol.com
parents:
400
diff
changeset
|
1569 |
|
aee281298267
Documented the following functions: band, bnot, bor.
almikes@aol.com
parents:
400
diff
changeset
|
1570 |
|
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
1571 |
== Debugging Functions == |
820 | 1572 |
=== `WriteLnToConsole(string)` === |
1573 |
Writes `string` to `Logs/game0.log`, found in the user data directory. |
|
1574 |
||
1189 | 1575 |
=== `WriteLnToChat(string)` (0.9.24) === |
1576 |
Writes `string` into the chat. |
|
1577 |
||
820 | 1578 |
=== `DumpPoint(x, y)` (0.9.23) === |
821 | 1579 |
Converts the whole numbers `x` and `y` to strings and writes them to `Logs/game0.log`, one line each. |
12
74ead59b6c64
LuaAPI page + GearTypes,AmmoTypes,Sounds,States listing pages
Tobias Neumann <mail@tobias-neumann.eu>
parents:
diff
changeset
|
1580 |
|
1221 | 1581 |
=== `StartGhostPoints(count)` === |
1582 |
Just prints out “GHOST_POINTS” and the argument on the console. This function might change in later versions. |
|
1583 |
||
1226 | 1584 |
=== `DeclareAchievement(id, teamname, location, value)` === |
1225
64b95a681971
LuaAPI: Add onAchievementsDeclaration and DeclareAchievement
Wuzzy
parents:
1224
diff
changeset
|
1585 |
Declares an achievement with the identifier `id` achieved by the team `teamname` on the map `location` with an achievement value (e.g. score) of `value`. `value` must be an integer. You are supposed to call this function inside an `onAchievementsDeclaration` callback. |
64b95a681971
LuaAPI: Add onAchievementsDeclaration and DeclareAchievement
Wuzzy
parents:
1224
diff
changeset
|
1586 |
|
64b95a681971
LuaAPI: Add onAchievementsDeclaration and DeclareAchievement
Wuzzy
parents:
1224
diff
changeset
|
1587 |
Currently, this actually just triggers a console output, but it might be changed later. The idea is to track multiplayer records. |
64b95a681971
LuaAPI: Add onAchievementsDeclaration and DeclareAchievement
Wuzzy
parents:
1224
diff
changeset
|
1588 |
|
64b95a681971
LuaAPI: Add onAchievementsDeclaration and DeclareAchievement
Wuzzy
parents:
1224
diff
changeset
|
1589 |
Example: |
64b95a681971
LuaAPI: Add onAchievementsDeclaration and DeclareAchievement
Wuzzy
parents:
1224
diff
changeset
|
1590 |
|
1231 | 1591 |
<code language="lua">DeclareAchievement("height reached", teamname, "ClimbHome", -score)</code> |
1225
64b95a681971
LuaAPI: Add onAchievementsDeclaration and DeclareAchievement
Wuzzy
parents:
1224
diff
changeset
|
1592 |
Records a team's best height in !ClimbHome. |
64b95a681971
LuaAPI: Add onAchievementsDeclaration and DeclareAchievement
Wuzzy
parents:
1224
diff
changeset
|
1593 |
|
394
b2742eb19396
Edited wiki page LuaAPI through web abuser interface.
sheepyluva@gmail.com
parents:
384
diff
changeset
|
1594 |
=== <tt>!ParseCommand(string)</tt> === |
1046 | 1595 |
Makes the game client parse and execute the specified internal game engine command. |
1596 |
||
1597 |
The available commands depend on the current engine protocol version. The *engine protocol can (and will) change* between releases. |
|
1044 | 1598 |
|
1046 | 1599 |
**Important**: If you use `ParseCommand` to overcome a shortcoming in our Lua API (e.g. a missing function), please make sure to [https://issues.hedgewars.org/enter_bug.cgi report the issue]. |
394
b2742eb19396
Edited wiki page LuaAPI through web abuser interface.
sheepyluva@gmail.com
parents:
384
diff
changeset
|
1600 |
|
1046 | 1601 |
With your report we can fix the shortcoming in future releases. We will try to remove the reliance on `ParseCommand` as good as possible. This will allow scripts to use the previously missing feature in a way that won’t break! |
1602 |
||
1398 | 1603 |
There are many available commands, but actual use in scripting is rare, and even then it's discouraged for long-term use. As of 0.9.24, the only command used in official scripts is: |
394
b2742eb19396
Edited wiki page LuaAPI through web abuser interface.
sheepyluva@gmail.com
parents:
384
diff
changeset
|
1604 |
|
1074 | 1605 |
* `"draw <map>"`: Draws a hand-drawn map. `MapGen` must be `mgDrawn` for this to work. `<map>` is a string which must follow the format specified in [DrawnMapFormat] |
1044 | 1606 |
|
1057 | 1607 |
Moreover, the control action names as listed in [ConfigurationFiles] (under “Binds”) can be used. Note we will eventually try to remove all `ParseCommand`s in the official scripts. |
1054 | 1608 |
|
1609 |
=== <tt>!EndLuaTest(success)</tt> === |
|
1610 |
This function is used by the Hedgewars developers in testing scripts in order to test the game engine. The testing scripts can be found in the Hedgewars source code under `tests/lua`. This function is useless for anything else. |
|
1611 |
||
1612 |
Calling this function ends an engine test and reports a test result. |
|
1613 |
||
1055
754e0a7bdd44
Explain briefly how engine testing works
Wuzzy <almikes@aol.com>
parents:
1054
diff
changeset
|
1614 |
`success` is either one of `TEST_SUCCESSFUL` to report a successful test or `TEST_FAILED` for a failed test. |
754e0a7bdd44
Explain briefly how engine testing works
Wuzzy <almikes@aol.com>
parents:
1054
diff
changeset
|
1615 |
|
754e0a7bdd44
Explain briefly how engine testing works
Wuzzy <almikes@aol.com>
parents:
1054
diff
changeset
|
1616 |
See [EngineTestCases] to learn more about testing the engine. |