share/hedgewars/Data/Missions/Training/Shotgun.lua
changeset 3234 668c7d0a00a6
child 3235 c7ceda2f5d4a
equal deleted inserted replaced
3233:9d9ff51b9789 3234:668c7d0a00a6
       
     1 -- Hedgewars Shotgun Training
       
     2 -- Scripting Example
       
     3 
       
     4 -- Lines such as this one are comments - they are ignored
       
     5 -- by the game, no matter what kind of text is in there.
       
     6 -- It's also possible to place a comment after some real
       
     7 -- instruction as you see below. In short, everything
       
     8 -- following "--" is ignored.
       
     9 
       
    10 ---------------------------------------------------------------
       
    11 -- At first we put all text we'd like to use in some arrays.
       
    12 -- This way we're able to localize the text to be shown without
       
    13 -- modifying other files.
       
    14 -- The language to be used is stored in the global variable
       
    15 -- 'L' that is set by the game (string).
       
    16 -- Text may then be accessed using "arrayname[L]".
       
    17 
       
    18 local caption = {
       
    19 	["en"] = "Shotgun Training",
       
    20 	["de"] = "Schrotflinten-Training",
       
    21 	["es"] = "Entrenamiento con escopeta",
       
    22 	["pl"] = "Trening strzelecki",
       
    23 	["pt_PT"] = "Treino com Caçadeira"
       
    24 	-- To add other languages, just add lines similar to the
       
    25 	-- existing ones - don't forget the trailing ","!
       
    26 	}
       
    27 
       
    28 local subcaption = {
       
    29 	["en"] = "Aiming Practice",
       
    30 	["de"] = "Zielübung",
       
    31 	["es"] = "Practica tu puntería",
       
    32 	["pl"] = "Potrenuj celność",
       
    33 	["pt_PT"] = "Pratica a tua pontaria"
       
    34 	}
       
    35 
       
    36 local goal = {
       
    37 	["en"] = "Eliminate all targets before your time runs out.|You have unlimited ammo for this mission.",
       
    38 	["de"] = "Eliminiere alle Ziele bevor die Zeit ausläuft.|Du hast in dieser Mission unbegrenzte Munition.",
       
    39 	["es"] = "Destruye todos los objetivos antes de que se agote el tiempo.|La munición en esta misión es ilimitada.",
       
    40 	["pl"] = "Zniszcz wszystkie cele zanim upłynie czas.|W tej misji masz nieskończoną ilość amunicji.",
       
    41 	["pt_PT"] = "Destrói todos os alvos antes do tempo terminar.|Tens munições infinitas para esta missão."
       
    42 	}
       
    43 
       
    44 local timeout = {
       
    45 	["en"] = "Oh no! Time's up! Just try again.",
       
    46 	["de"] = "Oh nein! Die Zeit ist um! Versuche es nochmal.",
       
    47 	["es"] = "¡Oh, no, se te acabó el tiempo! ¿Por qué no lo intentas de nuevo?",
       
    48 	["pl"] = "Ajajaj! Koniec czasu! Spróbuj jeszcze raz.",
       
    49 	["pt_PT"] = "Oh não! Acabou o tempo! Tenta novamente."
       
    50 	}
       
    51 
       
    52 local success = {
       
    53 	["en"] = "Congratulations! You've eliminated all targets|within the allowed time frame.",
       
    54 	["de"] = "Gratulation! Du hast alle Ziele innerhalb der|verfügbaren Zeit ausgeschaltet.",
       
    55 	["es"] = "¡Felicidades! Has destruido todos los objectivos|dentro del tiempo establecido.",
       
    56 	["pl"] = "Gratulacje! Zniszczyłeś przed czasem wszystkie cele.",
       
    57 	["pt_PT"] = "Parabéns! Eliminaste todos os alvos|dentro do tempo limite."
       
    58 	}
       
    59 
       
    60 local teamname = {
       
    61 	["en"] = "Shotgun Team",
       
    62 	["de"] = "Die Knalltüten",
       
    63 	["es"] = "Escopeteros",
       
    64 	["pl"] = "Shotgun Team",
       
    65 	["pt_PT"] = "Caçadores"
       
    66 	}
       
    67 
       
    68 local hogname = {
       
    69 	["en"] = "Hunter",
       
    70 	["de"] = "Jäger",
       
    71 	["es"] = "Cazador",
       
    72 	["en"] = "Strzelec",
       
    73 	["pt_PT"] = "Comando"
       
    74 	}
       
    75 
       
    76 -- To handle missing texts we define a small wrapper function that
       
    77 -- we'll use to retrieve text.
       
    78 local function loc(text)
       
    79 	if text == nil then return "**missing**"
       
    80 	elseif text[L] == nil then return text["en"]
       
    81 	else return text[L]
       
    82 	end
       
    83 end
       
    84 
       
    85 ---------------------------------------------------------------
       
    86 
       
    87 -- This variable will hold the number of destroyed targets.
       
    88 local score = 0
       
    89 -- This variable represents the number of targets to destroy.
       
    90 local score_goal = 5
       
    91 -- This variable controls how many milliseconds/ticks we'd
       
    92 -- like to wait before we end the round once all targets
       
    93 -- have been destroyed.
       
    94 local end_timer = 5000 -- 5000 ms = 5 s
       
    95 -- This variable is set to true if the game is lost (i.e.
       
    96 -- time runs out).
       
    97 local game_lost = false
       
    98 -- This variable will point to the hog's gear
       
    99 local player = nil
       
   100 -- This variable will grab the time left at the end of the round
       
   101 local time_goal = 0
       
   102 
       
   103 -- This is a custom function to make it easier to
       
   104 -- spawn more targets with just one line of code
       
   105 -- You may define as many custom functions as you
       
   106 -- like.
       
   107 function spawnTarget()
       
   108 	-- add a new target gear
       
   109 	gear = AddGear(0, 0, gtTarget, 0, 0, 0, 0)
       
   110 	
       
   111 	-- move it to a random position within 0 and
       
   112 	-- LAND_WIDTH - the width of the map
       
   113 	FindPlace(gear, true, 0, LAND_WIDTH)
       
   114 	
       
   115 	-- move the target to a higher vertical position
       
   116 	-- to ensure it's not somewhere down below
       
   117 	x, y = GetGearPosition(gear)
       
   118 	SetGearPosition(gear, x, 500)
       
   119 end
       
   120 
       
   121 -- This function is called before the game loads its
       
   122 -- resources.
       
   123 -- It's one of the predefined function names that will
       
   124 -- be called by the game. They give you entry points
       
   125 -- where you're able to call your own code using either
       
   126 -- provided instructions or custom functions.
       
   127 function onGameInit()
       
   128 	-- At first we have to overwrite/set some global variables
       
   129 	-- that define the map, the game has to load, as well as
       
   130 	-- other things such as the game rules to use, etc.
       
   131 	-- Things we don't modify here will use their default values.
       
   132 
       
   133 	-- The base number for the random number generator
       
   134 	Seed = 0
       
   135 	-- Game settings and rules
       
   136 	GameFlags = gfMultiWeapon + gfOneClanMode
       
   137 	-- The time the player has to move each round (in ms)
       
   138 	TurnTime = 25000
       
   139 	-- The frequency of crate drops
       
   140 	CaseFreq = 0
       
   141 	-- The number of mines being placed
       
   142 	LandAdds = 0
       
   143 	-- The number of explosives being placed
       
   144 	Explosives = 0
       
   145 	-- The delay between each round
       
   146 	Delay = 0
       
   147 	-- The map to be played
       
   148 	Map = "Mushrooms"
       
   149 	-- The theme to be used
       
   150 	Theme = "Nature"
       
   151 
       
   152 	-- Create the player team
       
   153 	AddTeam(loc(teamname), 14483456, "Simple", "Island", "Default")
       
   154 	-- And add a hog to it
       
   155 	player = AddHog(loc(hogname), 0, 1, "NoHat")
       
   156 	SetGearPosition(player, 2334, 1254);
       
   157 end
       
   158 
       
   159 -- This function is called when the round starts
       
   160 -- it spawns the first target that has to be destroyed.
       
   161 -- In addition it shows the scenario goal(s).
       
   162 function onGameStart()
       
   163 	-- Spawn the first target.
       
   164 	spawnTarget()
       
   165 	
       
   166 	-- Show some nice mission goals.
       
   167 	-- Parameters are: caption, sub caption, description,
       
   168 	-- extra text, icon and time to show.
       
   169 	-- A negative icon parameter (-n) represents the n-th weapon icon
       
   170 	-- A positive icon paramter (n) represents the (n+1)-th mission icon
       
   171 	-- A timeframe of 0 is replaced with the default time to show.
       
   172 	ShowMission(loc(caption), loc(subcaption), loc(goal), -amShotgun, 0);
       
   173 end
       
   174 
       
   175 -- This function is called every game tick.
       
   176 -- Note that there are 1000 ticks within one second.
       
   177 -- You shouldn't try to calculate too complicated
       
   178 -- code here as this might slow down your game.
       
   179 function onGameTick()
       
   180 	-- If time's up, set the game to be lost.
       
   181 	-- We actually check the time to be "1 ms" as it
       
   182 	-- will be at "0 ms" right at the start of the game.
       
   183 	if TurnTimeLeft == 1 and score < score_goal then
       
   184 		game_lost = true
       
   185 		-- ... and show a short message.
       
   186 		ShowMission(loc(caption), loc(subcaption), loc(timeout), -amSkip, 0);
       
   187 		-- How about killing our poor hog due to his poor performance?
       
   188 		SetHealth(player, 0);
       
   189 		-- Just to be sure set the goal time to 1 ms
       
   190 		time_goal = 1
       
   191 	end
       
   192 	-- If the goal is reached or we've lost ...
       
   193 	if score == score_goal or game_lost then
       
   194 		-- ... check to see if the time we'd like to
       
   195 		-- wait has passed and then ...
       
   196 		if end_timer == 0 then
       
   197 			-- ... end the game ...
       
   198 			EndGame()
       
   199 		else
       
   200 			-- ... or just lower the timer by 1.
       
   201 			end_timer = end_timer - 1
       
   202 			-- Reset the time left to stop the timer
       
   203 			TurnTimeLeft = time_goal
       
   204 		end
       
   205 	end
       
   206 end
       
   207 
       
   208 -- This function is called when the game is initialized
       
   209 -- to request the available ammo and probabilities
       
   210 function onAmmoStoreInit()
       
   211 	-- add an unlimited supply of shotgun ammo
       
   212 	SetAmmo(amShotgun, 9, 0, 0)
       
   213 end
       
   214 
       
   215 -- This function is called when a new gear is added.
       
   216 -- We don't need it for this training, so we can
       
   217 -- keep it empty.
       
   218 function onGearAdd(gear)
       
   219 end
       
   220 
       
   221 -- This function is called before a gear is destroyed.
       
   222 -- We use it to count the number of targets destroyed.
       
   223 function onGearDelete(gear)
       
   224 	-- We're only interested in target gears.
       
   225 	if GetGearType(gear) == gtTarget then
       
   226 		-- Add one point to our score/counter
       
   227 		score = score + 1
       
   228 		-- If we haven't reached the goal ...
       
   229 		if score < score_goal then
       
   230 			-- ... spawn another target.
       
   231 			spawnTarget()
       
   232 		else
       
   233 			if not game_lost then
       
   234 			-- Otherwise show that the goal was accomplished
       
   235 			ShowMission(loc(caption), loc(subcaption), loc(success), 0, 0);
       
   236 			-- Also let the hogs shout "victory!"
       
   237 			PlaySound(sndVictory)
       
   238 			-- Save the time left so we may keep it.
       
   239 			time_goal = TurnTimeLeft
       
   240 			end
       
   241 		end
       
   242 	end
       
   243 end