2D Editor: Take On Helicopters Sample Mission

## Overview

*Take On Helicopters* presents the players with a powerful - and sometimes overwhelming - Editor.

The goal of this section is to introduce new players to the basics, and show some veteran users a little of the new features introduced by this project.

* Below you'll find a step-by-step guide to creating sample mission 1
* You can find and download the scenario itself here!
	+ *note, unzip the file, and put the directory:*`SampleMission.United_States_H`*into your TKOH user profile's mission directory:*`[USER]\Documents\Take On Helicopters\missions\`
* We've also used this scenario as the basis for a video guide, which you can find here: http://www.youtube.com/watch?v=wcSgRoSJGZk
* Once you've completed part one, we've created sample mission 2
	+ Part 2 builds upon this mission, and introduces more advanced techniques!

## Sample Mission 1 - Guide

### Getting Started

1. **Pick Seattle**
	* Select "Singleplayer" > "Editor" > "Seattle" to open up the editor screen.
2. **Editor interface**
	* We've updated the community wiki page, which explains the basic principles, icons, etc: Mission Editor

Tkoh FIG Started.jpgSeattle Terrain in the Editor menu
### Creating the Mission

1. **Create a Save**
	* Select the "Save" Icon (or press Ctrl + S) to open the save dialogue
	* Enter a save-name to store your mission as Mission Folder.
2. **Place the Heliport**
	* Select the "Modules" Icon (or press F7)
	* Double-click anywhere on the map, pick "Heliport", and click "OK".
	* This will spawn (create) the 'heliport composition' (3D objects of hangar, landing pads, etc) and also set up some other simple things, which will make designing your mission easier (we needn't go into detail now).
	* The 'Heliport' is spawned near the marker '(H)WT42'. You should be familiar with this from playing the Career Mode and Challenges.
3. **Place a Unit**
	* Find the Heliport (WT42)
		+ *note, if you select the "Textures" Icon, you can toggle hiding/revealing the ground textures - useful for placing objects!*
	* Select the "Units" Icon (or press F1), and double click near the heliport to open the "Insert Unit" Interface.
	* Choose a player, by setting: Side ("civilian"), Faction ("Story"), Class ("People"), and Unit ("Tom Larkin").
		+ *note, you can choose any character you like by changing the selections here.*
	* In the "Variable Name" field, enter *hsim\_Player*, and click "OK".
		+ *note, this will assign an identity to the unit.*
4. **Place a Helicopter**
	* With "Units" still selected, double click at the heliport again to open the "Insert Unit" interface.
	* place an empty heavy helicopter, by setting: Side ("Empty", Class ("Helicopters (Heavy)") and Unit ("Larkin Aviation [Story]")
		+ *note, you needn't be to precise about where you place this, as the 'Heliport Module' will set it up for you*
5. **Synchronize!**
	* Select the Synchronize Icon (or press F5)
	* Click and hold on where you placed the 'Heliport Module', drag your cursor to the helicopter, and release.
	* You should see a thin line drawn between the two symbols, which shows they are 'synchronized'.
		+ *note, here you're connecting up the game's logic, telling the heliport which is the helicopter you want the player to fly.*
6. **Place a Ship**
	* Scroll the map nearby in Elliot bay, select the Unit Icon, and double click in the water to open the "Insert Unit" interface.
	* Place an empty ship, by setting: Side ("Empty"), Class ("Ships"), Unit ("Cargo Ship [empty, blue]").
		+ *note: you can change the orientation of the ship by clicking and holding the LMB, holding the 'Shift' key, and moving the mouse*
7. **Preview the Mission**
	* Save the mission (Ctrl-S or the "Save" Icon) and click "Preview"
	* You should start, at the heliport, in a heavy helicopter, and might be able to see the ship you placed.
	* If you don't, something is wrong, and you should check to see if you've made an error!

Tkoh FIG Modules.jpgModules interface with heliport selectedTkoh FIG Player.jpgUnit interface with Player selectedTkoh FIG HeavyHeli.jpgUnit interface with heavy heli selectedTkoh FIG Sync.jpgUnit interface with Player selectedTkoh FIG Ship.jpgUnit interface with a ship selectedTkoh FIG Preview1.jpgA heavy helicopter facing Seattle

### Creating the Gameplay

1. **Place a Container Crate**
	* With the Unit Icon still selected double click nearby the ship to open the "Insert Unit" interface.
	* Place a crate, by setting: Side ("Empty"), Class ("Objects (Military)"), Unit ("Container in net"), and click "OK".
	* Zoom in the view and move the object, by clicking, holding, and dragging it, so it is positioned directly above the empty ship.
	* To make it sit on the deck, we now need to raise the object by around two meters. Double click on the crate the open the "Edit Unit" Interface.
	* In the 'initialisation' field, type:`this setPos [position this select 0, position this select 1,2]` and click "OK".
		+ *note, this is an example of a scripting command, what we're doing is setting the position of the object, relative to where you place it, by adding 2 to the Z-axis of the object in 3D space*
2. **Place a Trigger**
	* Select the "Trigger" Icon (or press F3) and double click somewhere nearby the ship and cargo.
	* We want to enlarge the 'area' of the trigger by setting Axis a (100) and Axis b (100).
3. **Group the Trigger with the Player**
	* Select the "Group" Icon (or press F2), click and hold the trigger, drag your cursor above the Player, and release.
	* You should see a thin, highlighted line showing the trigger is now grouped with the unit.
		+ *note, here, you're grouping the trigger with the unit, this sets the 'activation' of the trigger to this vehicle.*
4. **Set an Effect**
	* Double click on the trigger to open the "Edit Trigger" interface.
	* In the "On Act.:" field, enter:`setWind [10,10,true];` and click OK.
		+ *note, here, we're triggering a scripting command that forces the wind to blow, which will make picking up the cargo a bit more of a challenge!*
5. **Create a Waypoint**
	* Select the "Waypoint" Icon (or press F4), and then click on the Player unit, Tom Larkin.
	* Scroll back over to the "Container in Net" object, and double click to select it, and open the "Insert Waypoint" interface.
		+ *note, make sure you select the Container, not the ship!*
	* Select "SCRIPTED - HELICOPTERS" in the Category selection box, and "ATTACH SLINGLOAD" in the "Select Type" box.
	* Enter '6' in the "Completion Radius" field, and '[5]' in the Arguments field, and click OK.
		+ *note, here we're changing some basic conditions of a slingload task, which are explained in better detail here*
6. **Create another Waypoint**
	* With the "Waypoint" Icon still selected, scroll back to the heliport, find an open patch of ground, and double click to open the Insert Waypoint interface.
		+ *note, toggling the 'Textures' icon can help here.*
	* Select "SCRIPTED - HELICOPTERS" in the Category selection box, and "DETACH SLINGLOAD" in the "Select Type" box, and click OK.
		+ *note, you should notice that the waypoint order field now reads '1', which means it happens after the first waypoint, '0',*
7. **Preview the Mission**
	* Save the mission (Ctrl-S or the "Save" Icon) and click "Preview"
		+ *note, be sure to select Preview and not "Continue", which resumes your previous state.*
	* You should start, at the heliport, in a heavy helicopter, and might be able to see the ship you placed.
	* You should have a waypoint (if you have them visible) to go pick up the cargo.
	* When you get near you might see a PiP screen appear (if you have it enabled).
	* Hovering low over the cargo will trigger the attach.
	* You should then be prompted to fly back and drop off the cargo.
	* If you don't, something is wrong, and you should check to see if you've made an error!

Tkoh FIG Script1.jpgScreenshot of the Edit Unit interface with a cargo and init scriptTkoh FIG Trigger1.jpgInsert Trigger Interface edited axis variablesTkoh FIG Group1.jpgConnecting the unit to the triggerTkoh FIG Trigger2.jpgInsert Trigger Interface with edited On Act. variablesTkoh FIG Waypoint1.jpgInsert Waypoint Interface with scripted slingload attachTkoh FIG Waypoint2.jpgInsert Waypoint Interface with scripted slingload detach

### Finishing the Mission

1. **Create a Final Waypoint**
	* With the Waypoints Icon still selected, double click near the '(H)WT42' symbol (which is where a helipad is positioned) to open the Insert Waypoint interface.
	* Select "SCRIPTED - HELICOPTERS" in the Category selection box, and "LAND" in the "Select Type" box.
	* To trigger the end of the mission, type in the "On Act.:" field:`endMission "DEFAULT"`
		+ *note: there are different types of ending, but you can learn more elsewhere!*
2. **Add some Markers**
	* Select the "Markers" Icon (or press F6), and double click near the ship to open the "Insert Marker" interface.
	* Enter a Name ("hsim\_PickUp") and Text ("Pick Up").
		+ *note, the "Text" field is visible in game via the map.*
	* repeat the process by adding another marker to the drop-off point.
3. **Enter some Briefing info**
	* Double click on the Time & Date to open the "Intel" interface.
	* Enter a Name for your mission and, if you like, a description.
		+ *note, the description is only visible in Multiplayer, the single-player overview is defined elsewhere*

Tkoh FIG Waypoint3.jpgInsert Waypoint Interface with scripted landTkoh FIG Markers.jpgInsert Marker InterfaceTkoh FIG Intel.jpgIntel interface
Sample mission 2 is designed to specifically build upon the techniques introduced in this mission.