LuaGuide.wiki
changeset 35 532bb2509f0b
parent 32 5f66adfa478c
child 36 f66efe81d8c0
--- a/LuaGuide.wiki	Sun Nov 14 22:32:49 2010 +0000
+++ b/LuaGuide.wiki	Sun Nov 14 23:31:14 2010 +0000
@@ -37,4 +37,59 @@
 
 function onGearDelete(gear)
 end
+}}}
+
+These are event handlers and are called on different events by the engine. Now lets look at the initiation events.
+
+== The initiation events ==
+
+The two most important event handlers are onGameInit and onAmmoStoreInit. They are used instead of loading a game scheme and weapon scheme and in Campaign or Missions onGameInit is also used to add teams and hogs.
+
+=== onGameInit ===
+
+First we have onGameInit. On this event we should add all game modifiers and team setup. If you are making a Mission you only need to specify the things you want to change on this event, everything not changed will be set to default. The available game modifiers can be found here: http://code.google.com/p/hedgewars/wiki/LuaAPI#onGameInit()
+
+An example of setting up barrel mayhem in a mission:
+{{{
+function onGameInit()
+    GameFlags = gfRandomOrder + gfSharedAmmo
+    TurnTime = 30000
+    CaseFreq = 0
+    MinesNum = 0
+    MinesTime = 0
+    Explosives = 40
+end
+}}}
+
+If you are doing a Training or Campaign you should also set Seed, Map and Theme. But you must also add teams and hogs on this event. This is done by using !AddTeam and !AddHog. An example of adding one team with one hog:
+{{{
+AddTeam("Team", 14483456, "Simple", "Island", "Default")
+AddHog("Hedgehog", 0, 1, "NoHat")
+}}}
+To be able to play you must add another team and hog that should have another team color (this team has 14483456) or if you only want one team add the game flag gfOneClanMode. Look in the LuaAPI to see what the other parameters of !AddTeam and !AddHog is.
+
+=== onAmmoStoreInit ===
+
+This is where you set what weapons is available in the game for every weapon run [http://code.google.com/p/hedgewars/wiki/LuaAPI#SetAmmo_(ammoType,_count,_probability,_delay,_numberInCrate) SetAmmo].
+
+Here is an example of initiation of a Training map:
+{{{
+function onGameInit()
+    Seed = 0
+    GameFlags = gfMultiWeapon + gfOneClanMode
+    TurnTime = 25000
+    CaseFreq = 0
+    MinesNum = 0
+    Explosives = 0
+    Delay = 0
+    Map = "Mushrooms"
+    Theme = "Nature"
+
+    AddTeam("Team", 14483456, "Simple", "Island", "Default")
+    AddHog("Hedgehog", 0, 1, "NoHat")
+end
+
+function onAmmoStoreInit()
+    SetAmmo(amShotgun, 9, 0, 0, 0)
+end
 }}}
\ No newline at end of file