author henrik.rostedt
Sun, 14 Nov 2010 00:14:22 +0000
changeset 32 5f66adfa478c
parent 31 e713a5d2a7f9
child 35 532bb2509f0b
permissions -rw-r--r--
Edited wiki page LuaGuide through web user interface.

#summary Guide to writing Lua scripts in Hedgewars.

= Under Construction =

This is both an introduction to Lua scripting in Hedgewars and a guide for more advanced control over the game and gears.

== What is a Lua script ==

A Lua script is used to make the game behave different by giving the Hedgewars engine different command. The script gets called by the engine on different events and the script tells the engine what to do.

Missions and Training are the parts of Hedgewars that are scripted. Try them out and get a feel of what scripted maps is.

== The basic structure ==

Dependent on what type of script you want to write the requirements are a bit different, but before we go into that we must first create the .lua file.

If you want to make a Mission for multi player you create a map and create a new file map.lua in the map's folder.

If you want to make a Training or Campaign (coming) then you create a new .lua file in the appropriate folder under Missions in the Data folder.

The .lua file should be structured like this:
function onGameInit()

function onAmmoStoreInit()

function onGameStart()

function onGameTick()

function onGearAdd(gear)

function onGearDelete(gear)