share/hedgewars/Data/Missions/Training/Shotgun.lua
author Henek
Sat, 11 Dec 2010 14:03:49 +0100
changeset 4506 37744d5c877e
parent 4493 45db8e97d282
permissions -rw-r--r--
Finnished up the lua translations by adding training maps, campaign is ignored for now
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3234
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
     1
-- Hedgewars Shotgun Training
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
     2
-- Scripting Example
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
     3
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
     4
-- Lines such as this one are comments - they are ignored
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
     5
-- by the game, no matter what kind of text is in there.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
     6
-- It's also possible to place a comment after some real
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
     7
-- instruction as you see below. In short, everything
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
     8
-- following "--" is ignored.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
     9
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    10
---------------------------------------------------------------
4506
37744d5c877e Finnished up the lua translations by adding training maps, campaign is ignored for now
Henek
parents: 4493
diff changeset
    11
-- At first we implement the localization library using loadfile.
37744d5c877e Finnished up the lua translations by adding training maps, campaign is ignored for now
Henek
parents: 4493
diff changeset
    12
-- This allows us to localize strings without needing to think
37744d5c877e Finnished up the lua translations by adding training maps, campaign is ignored for now
Henek
parents: 4493
diff changeset
    13
-- about translations.
37744d5c877e Finnished up the lua translations by adding training maps, campaign is ignored for now
Henek
parents: 4493
diff changeset
    14
-- We can use the function loc(text) to localize a string.
3234
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    15
4506
37744d5c877e Finnished up the lua translations by adding training maps, campaign is ignored for now
Henek
parents: 4493
diff changeset
    16
loadfile(GetDataPath() .. "Scripts/Locale.lua")()
3234
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    17
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    18
-- This variable will hold the number of destroyed targets.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    19
local score = 0
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    20
-- This variable represents the number of targets to destroy.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    21
local score_goal = 5
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    22
-- This variable controls how many milliseconds/ticks we'd
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    23
-- like to wait before we end the round once all targets
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    24
-- have been destroyed.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    25
local end_timer = 5000 -- 5000 ms = 5 s
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    26
-- This variable is set to true if the game is lost (i.e.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    27
-- time runs out).
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    28
local game_lost = false
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    29
-- This variable will point to the hog's gear
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    30
local player = nil
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    31
-- This variable will grab the time left at the end of the round
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    32
local time_goal = 0
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    33
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    34
-- This is a custom function to make it easier to
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    35
-- spawn more targets with just one line of code
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    36
-- You may define as many custom functions as you
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    37
-- like.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    38
function spawnTarget()
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    39
	-- add a new target gear
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    40
	gear = AddGear(0, 0, gtTarget, 0, 0, 0, 0)
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    41
	
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    42
	-- move it to a random position within 0 and
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    43
	-- LAND_WIDTH - the width of the map
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    44
	FindPlace(gear, true, 0, LAND_WIDTH)
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    45
	
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    46
	-- move the target to a higher vertical position
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    47
	-- to ensure it's not somewhere down below
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    48
	x, y = GetGearPosition(gear)
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    49
	SetGearPosition(gear, x, 500)
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    50
end
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    51
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    52
-- This function is called before the game loads its
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    53
-- resources.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    54
-- It's one of the predefined function names that will
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    55
-- be called by the game. They give you entry points
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    56
-- where you're able to call your own code using either
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    57
-- provided instructions or custom functions.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    58
function onGameInit()
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    59
	-- At first we have to overwrite/set some global variables
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    60
	-- that define the map, the game has to load, as well as
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    61
	-- other things such as the game rules to use, etc.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    62
	-- Things we don't modify here will use their default values.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    63
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    64
	-- The base number for the random number generator
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    65
	Seed = 0
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    66
	-- Game settings and rules
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    67
	GameFlags = gfMultiWeapon + gfOneClanMode
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    68
	-- The time the player has to move each round (in ms)
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    69
	TurnTime = 25000
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    70
	-- The frequency of crate drops
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    71
	CaseFreq = 0
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    72
	-- The number of mines being placed
4162
923db448ad16 update and fix some lua stuff
Henek
parents: 3476
diff changeset
    73
	MinesNum = 0
3234
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    74
	-- The number of explosives being placed
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    75
	Explosives = 0
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    76
	-- The delay between each round
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    77
	Delay = 0
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    78
	-- The map to be played
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    79
	Map = "Mushrooms"
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    80
	-- The theme to be used
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    81
	Theme = "Nature"
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    82
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    83
	-- Create the player team
4506
37744d5c877e Finnished up the lua translations by adding training maps, campaign is ignored for now
Henek
parents: 4493
diff changeset
    84
	AddTeam(loc("Shotgun Team"), 14483456, "Simple", "Island", "Default")
3234
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    85
	-- And add a hog to it
4506
37744d5c877e Finnished up the lua translations by adding training maps, campaign is ignored for now
Henek
parents: 4493
diff changeset
    86
	player = AddHog(loc("Hunter"), 0, 1, "NoHat")
4493
45db8e97d282 removing all ; from lua script as an act of temporary rage and perfectionism
Henek
parents: 4350
diff changeset
    87
	SetGearPosition(player, 2334, 1254)
3234
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    88
end
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    89
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    90
-- This function is called when the round starts
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    91
-- it spawns the first target that has to be destroyed.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    92
-- In addition it shows the scenario goal(s).
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    93
function onGameStart()
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    94
	-- Spawn the first target.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    95
	spawnTarget()
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    96
	
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    97
	-- Show some nice mission goals.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    98
	-- Parameters are: caption, sub caption, description,
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
    99
	-- extra text, icon and time to show.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   100
	-- A negative icon parameter (-n) represents the n-th weapon icon
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   101
	-- A positive icon paramter (n) represents the (n+1)-th mission icon
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   102
	-- A timeframe of 0 is replaced with the default time to show.
4506
37744d5c877e Finnished up the lua translations by adding training maps, campaign is ignored for now
Henek
parents: 4493
diff changeset
   103
	ShowMission(loc("Shotgun Training"), loc("Aiming Practice"), loc("Eliminate all targets before your time runs out.|You have unlimited ammo for this mission."), -amShotgun, 0)
3234
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   104
end
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   105
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   106
-- This function is called every game tick.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   107
-- Note that there are 1000 ticks within one second.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   108
-- You shouldn't try to calculate too complicated
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   109
-- code here as this might slow down your game.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   110
function onGameTick()
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   111
	-- If time's up, set the game to be lost.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   112
	-- We actually check the time to be "1 ms" as it
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   113
	-- will be at "0 ms" right at the start of the game.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   114
	if TurnTimeLeft == 1 and score < score_goal then
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   115
		game_lost = true
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   116
		-- ... and show a short message.
4506
37744d5c877e Finnished up the lua translations by adding training maps, campaign is ignored for now
Henek
parents: 4493
diff changeset
   117
		ShowMission(loc("Shotgun Training"), loc("Aiming Practice"), loc("Oh no! Time's up! Just try again."), -amSkip, 0)
3234
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   118
		-- How about killing our poor hog due to his poor performance?
4493
45db8e97d282 removing all ; from lua script as an act of temporary rage and perfectionism
Henek
parents: 4350
diff changeset
   119
		SetHealth(player, 0)
3234
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   120
		-- Just to be sure set the goal time to 1 ms
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   121
		time_goal = 1
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   122
	end
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   123
	-- If the goal is reached or we've lost ...
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   124
	if score == score_goal or game_lost then
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   125
		-- ... check to see if the time we'd like to
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   126
		-- wait has passed and then ...
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   127
		if end_timer == 0 then
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   128
			-- ... end the game ...
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   129
			EndGame()
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   130
		else
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   131
			-- ... or just lower the timer by 1.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   132
			end_timer = end_timer - 1
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   133
			-- Reset the time left to stop the timer
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   134
			TurnTimeLeft = time_goal
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   135
		end
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   136
	end
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   137
end
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   138
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   139
-- This function is called when the game is initialized
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   140
-- to request the available ammo and probabilities
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   141
function onAmmoStoreInit()
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   142
	-- add an unlimited supply of shotgun ammo
3346
967fd96f7373 Engine/Frontend:
smxx
parents: 3247
diff changeset
   143
	SetAmmo(amShotgun, 9, 0, 0, 0)
3234
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   144
end
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   145
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   146
-- This function is called when a new gear is added.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   147
-- We don't need it for this training, so we can
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   148
-- keep it empty.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   149
function onGearAdd(gear)
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   150
end
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   151
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   152
-- This function is called before a gear is destroyed.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   153
-- We use it to count the number of targets destroyed.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   154
function onGearDelete(gear)
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   155
	-- We're only interested in target gears.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   156
	if GetGearType(gear) == gtTarget then
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   157
		-- Add one point to our score/counter
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   158
		score = score + 1
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   159
		-- If we haven't reached the goal ...
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   160
		if score < score_goal then
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   161
			-- ... spawn another target.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   162
			spawnTarget()
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   163
		else
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   164
			if not game_lost then
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   165
			-- Otherwise show that the goal was accomplished
4506
37744d5c877e Finnished up the lua translations by adding training maps, campaign is ignored for now
Henek
parents: 4493
diff changeset
   166
			ShowMission(loc("Shotgun Training"), loc("Aiming Practice"), loc("Congratulations! You've eliminated all targets|within the allowed time frame."), 0, 0)
3234
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   167
			-- Also let the hogs shout "victory!"
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   168
			PlaySound(sndVictory)
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   169
			-- Save the time left so we may keep it.
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   170
			time_goal = TurnTimeLeft
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   171
			end
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   172
		end
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   173
	end
668c7d0a00a6 Trainings:
smxx
parents:
diff changeset
   174
end