LuaAPI.wiki
author Wuzzy
Wed, 08 Jul 2020 18:19:41 +0200
changeset 2172 798ddaa7aa94
parent 1833 9dcf9aab2dc9
child 2190 0baf61915a8a
permissions -rw-r--r--
TODO: AI: Mudball is DONE!
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
     1
#summary API for writing Lua scripts in Hedgewars
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
     2
#labels Featured
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
     3
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
     4
= Core Lua API documentation =
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
     5
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
     6
The Lua API in Hedgewars allows creating all scripted content in Hedgewars. Lua handles [Missions missions], [GameStyles styles] and more. If you want to create your own missions, this is the place to start.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
     7
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
     8
For a introduction into scripting, read [LuaGuide].
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
     9
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    10
== Sections ==
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    11
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    12
The Lua API documentation is divided into the following sections:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    13
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    14
 * [LuaGuide Beginner's guide]
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    15
 * [LuaOverview Overview]
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    16
 * [LuaGlobals Global variables and constants]
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    17
 * [LuaEvents Event handlers]
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    18
 * [LuaGameplay Gameplay functions]
1803
d75d30743663 LuaMain: Change link of LuaGears
Wuzzy
parents: 1750
diff changeset
    19
 * [LuaGears Gear functions]
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    20
 * [LuaStats Stats functions]
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    21
 * [LuaGUI GUI functions]
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    22
 * [LuaAudio Audio functions]
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    23
 * [LuaUtil Utility functions]
1833
9dcf9aab2dc9 LuaAPI: Add undocumented functions script back
Wuzzy
parents: 1807
diff changeset
    24
 * [LuaLibraries Lua libraries]
9dcf9aab2dc9 LuaAPI: Add undocumented functions script back
Wuzzy
parents: 1807
diff changeset
    25
9dcf9aab2dc9 LuaAPI: Add undocumented functions script back
Wuzzy
parents: 1807
diff changeset
    26
== Undocumented functions ==
9dcf9aab2dc9 LuaAPI: Add undocumented functions script back
Wuzzy
parents: 1807
diff changeset
    27
We try to keep the wiki up-to date as fast we can, but recent additions to the Lua API might be undocumented. We have a script that checks the wiki automatically for undocumented functions: [http://hw.ercatec.net/docs/lua_wiki_check.php]