{"updated":"2026-11-04T00:04:10Z","source":"https://community.bistudio.com/wiki/Main_Page","count":675,"items":[{"name":"2D Editor","title":"2D Editor","type":"topic","url":"https://community.bistudio.com/wiki/2D_Editor","revid":342186,"updated":"2023-07-09T12:27:05Z","aliases":["ArmA 2: Mission Editor","Arma 2: Mission Editor"],"markdown":"> [!NOTE]\n> **Arma 3:** The 2D-Editor is now permanently replaced by Eden Editor (3D-Editor), but can still be invoked from the editor map selection screen with Ctrl + O shortcut for legacy purposes!\n\nThe **2D Mission Editor** is the primary tool for creating both singleplayer and multiplayer scenarios in majority of Bohemia Interactive's products.\n\nThe focus of this article is explaining the function and effect of each option, rather than recommending which option should be used to create a desired outcome.\nMany options create different effects depending on different circumstances.\nThe sheer amount of information presented may seem daunting at first, but remember games based on Real Virtuality engine are more complex than many other games, and there is always more than one way to create the desired effect.\n\n> [!NOTE]\n> As the editor evolved through time, some features are marked by icons on the right, indicating games introducing the functionality.\n> If no icon is present, it means the feature was always available.\n\n### Starting the Editor\n\nEditor is accessible from the main menu through the button labelled \"Mission Editor\" or just \"Editor\". In Arma 2 and Take On Helicopters, this button can be found in the Singleplayer subcategory.\n\n### Controls\n\n| Keyboard Shortcuts | | | | | |\n|---|---|---|---|---|---|\n| Function | OFP | ArmA | Arma 2 | TKOH | Arma 3 |\n| Units | F1 | | | | |\n| Groups | F2 | | | | |\n| Triggers | F3 | | | | |\n| Waypoints | F4 | | | | |\n| Synchronization | F5 | | | | |\n| Markers | F6 | | | | |\n| Modules | N/A | | F7 | | |\n| New | | | R | Ctrl + N | |\n| Load | | | | Ctrl + O | |\n| Save | | | | Ctrl + S | |\n| Save As | | | S | Ctrl + ⇧ Shift + S | |\n| Merge | | | M | Ctrl + M | |\n| Show IDs | | | | Ctrl + I | |\n| Show Textures | | | T | Ctrl + T | |\n| Preview | Return ↵ | | | | |\n| Continue | | | | | |\n| Intel | | | | | |\n| Exit | Esc | | | | |\n| Debug Console | N/A | | | Ctrl + D | |\n| Functions | N/A | | | Ctrl + F | |\n| Config Viewer | N/A | | | Ctrl + G | |\n\n### Map Controls\n\n- **Clicking and holding Right Mouse Button anywhere on the map** allows the user to pan around the map by moving the mouse.\n- The **mouse wheel** and **numpad +/-** keys control the map zoom level.\n- **Left Mouse Button on an entity** selects it. Selected entities are opaque, non selected entities are slightly transparent.\n- **Double Left Mouse Button on an entity** generally opens the entity's editing menu. In Waypoint mode, double left clicking on a object will create a waypoint for the selected group that is attached to the clicked object.\n- **Double Left Mouse Button on empty space** will create a new entity, if it is possible in the current editing mode.\n- **Clicking and holding Left Mouse Button on an entity** allows it to be dragged around the map. It is not possible to move units in group mode or move waypoints in synchronize mode.\n- **Clicking and holding Left Mouse Button on empty space** allows a drag box to be created for selecting multiple entities.\n- **Holding Ctrl** allows the user to select more than one entity using the **drag box** or individually by **left clicking on them**.\n- **⇧ Shift + Left Mouse Button on an unit or waypoint** will select all entities associated with that unit's group.\n- **⇧ Shift + Left Mouse Button holding Left Mouse Button on a selected entity** rotates the selected entities.\n- **⇧ Shift + Left Mouse Button on an object with a waypoint attached to it** selects the underlaying object.\n- **⇧ Shift + Double Left Mouse Button entity with a waypoint** on it opens the appropriate entity's menu (rather than the waypoints).\n- Del will erase the entity under the mouse cursor.\n- ⇧ Shift + Del will erase all selected entities.\n- Ctrl + X will cut the selected entities to the clipboard.\n- Ctrl + C will copy the selected entities to the clipboard.\n- Ctrl + V will paste a copy of entities from the clipboard. Copy and pasted named entities automatically have a number appended to their names to avoid conflicts.\n- Ctrl + ⇧ Shift + V will paste a copy of entities on their original position (useful when copying units between missions).\n\n#### Status Bar (Take On Helicopters v1.00)\n\nStatus bar on the bottom of a screen displays current map grid and cursor's XYZ coordinates.\n\n### Mission Modes\n\nThis drop down list allows you to choose which component of a mission you are currently editing.\nA single mission stores all objects and mission parameters for the intro and outro cutscenes completely separately from the gameplay component of a mission.\nIt is not essential to use any of these other than the mission component. While each component requires a player unit if it is to be used, the player will only have control of the unit in the *Mission* component.\nIn the *Intro* and *Outros*, AI will control the player's unit. The *Intro* and *Outros* will not end when the player unit dies, but must be ended using a trigger.\n\n- **Mission** is the default. This defines the interactive component of a mission. It is the only essential part of a mission.\n- **Intro** plays before the briefing screen.\n- **Outro - Win** will play after the debriefing screen in the case of a Win 1-6 trigger being activated.\n- **Outro - Loose** will play after the debriefing screen in the case of a Lose trigger being activated.\n\n### Editing Modes\n\nThe mission editor is always in one of these seven modes. Each different mode allows the creation and manipulation of different types of map entities.\nThe required mode can be set by either clicking on the modes name/icon or pressing the associated function key.\nThe modes are set out in the basic order they would be used while creating a mission.\n\n#### Units\n\n*Main article: Mission Editor: Units*\n\nUnit mode is used to add individual units, vehicles and objects on the map. To do so, double click on the empty space where you would like to add a unit.\nThis will open the *Unit Menu*. You can also open the unit menu of an existing unit while in any editing mode other than waypoints by double clicking on the unit.\nNote that if there is no player unit on the map, the unit menu will only allow valid player units may be placed.\n\n#### Groups\n\n*Main article: Mission Editor: Groups*\n\nGroup editing mode can be used in several ways. The primary use is to join previously placed individual entities together into groups.\nJoining individual units together into groups can greatly improve their combat abilities. A group will move together, share information about enemy units and can bring greater firepower to bare on a target.\nEach individual unit on the map that has no visible group links is actually in a group of it is own. When a unit is created near another unit of the same side, it will automatically be placed in the other unit's group.\nTo join a unit into an existing group, simply left click and hold on the unit, then drag a line to any unit of the group you wish to add it too. Release the button to join the unit into that group.\nGroup links are displayed by light blue line drawn from the leader to each other unit in the group.\nRemoving a unit from a group is done by left clicking and holding on the unit and dragging the group link line into empty space, then releasing. The highest ranking unit in a group will generally be the leader.\nWhile it is possible to create extremely large groups, huge formations of AI units create path finding issues and can be very hard to manage for a human leader.\n\n#### Triggers\n\n*Main article: Mission Editor: Triggers*\n\nA trigger is an abstract game entity that will wait until it is condition block returns true, then carry out the *On Activation* string.\nWhen used effectively, they can make your mission seem much more dynamic and realistic.\nFor example, you can use a trigger to set off a siren and call reinforcements when the player is spotted near an enemy base, or to start a convoy moving when the player gives a radio command.\n\nTriggers are represented in the mission editor by a dark blue ellipse or rectangle with a small blue flag in the centre.\nTriggers may be linked to an object in Groups Mode (F2), which generally means that only that object or group can activate the trigger.\nTriggers can be used in various ways, for example the location and dimensions of a trigger are not always used as part of it is conditions,\nand triggers do not necessarily require an *On Activation* block, instead being used to return a list of objects that satisfy it is conditions.\nEach trigger's *Condition* block will be checked approximately twice every second for the duration of the mission.\nTo add a new trigger to your mission, double left click in some empty map space. The *Trigger Menu* will open.\n\n#### Waypoints\n\n*Main article: Mission Editor: Waypoints*\n\nWaypoints are used to define the route and behaviour of a group during the mission. At any point in time a group will have one active waypoint (generally the waypoint they are to move towards). Once a waypoint's conditions have been met, it will become complete and the group's next waypoint automatically becomes active. Some of a waypoint's settings will take place as the waypoint becomes active, others when the waypoint is complete.\n\n#### Synchronization\n\n*Main article: Mission Editor: Synchronization*\n\nSynchronization mode is used to make different groups carry out their waypoint orders at the same time, and optionally only under specific circumstances. Synchronization can seem a hard concept to understand at first, but it is a very powerful and easy to use tool. For example, synchronization can be used to organize friendly forces to wait until everyone is in position before launching a mass attack, or wait in ambush until an enemy convoy is in the perfect location before opening fire. Synchronizing links can be made between any of a group's waypoints and any number of other group's waypoints, and any number of triggers. A synchronized waypoint will not complete until all waypoints it is linked with are ready to complete, and all synchronized triggers are activated. Synchronizing links are displayed by a dark blue line connecting the entities.\n\nTo create a synchronized link between a waypoint and another group's waypoint or a trigger, simply left click and hold on the waypoint, move the mouse to the desired waypoint/trigger then release. To remove synchronization lines from a waypoint or trigger, left click on it, hold and drag a line into empty space. Note this will remove **all** synchronizing lines from that entity, so be careful.\n\n#### Markers\n\n*Main article: Mission Editor: Markers*\n\nMarker mode is primarily used to place visual map icons and zones on the mission map. Markers are only visible while the mission editor is in marker mode, but can still be manipulated while in other modes. To do so, hover the mouse cursor over a marker's position to display it is name. The second use of markers is to define a possible starting position for any number of objects. To do this, create a group link between the marker and the object. The object will begin the mission at any one of the markers it is grouped with or at it is original position, chosen at random. This offers another way to create some randomness in a mission, with more precise control compared to using the object's *Placement radius* option. Note that any marker used in this way will still be drawn on the mission map (although setting the axis sizes to 0 can be used to hide a marker). Markers can not be attached to objects. To create a map marker, double left click in empty space.\n\n#### Modules\n\n*Main article: Mission Editor: Modules*\n\nModules offers complex scripted solutions\n\n### Basic Operations\n\n#### New\n\nRemove all map entities such as units, waypoints, markers and triggers. Settings such as those defined in the Intel are retained. Be warned that there is no undo function in the mission editor.\n\n#### Load\n\nAllows you to load a previously saved mission. Only uncompressed mission folders in your current profiles missions folder can be loaded.\n\n#### Save As\n\nYou can save your current mission with this menu.\n\n- **User missions** - These missions are only available through the mission editor while using the current user profile. *Note that if you save your mission under a new name, **only** the Mission.sqm file will be written in the new folder*. Saving a already named *User mission* also reloads any mission support files that are in the chosen mission folder, such as Description.ext and Init.sqs.\n- **Export to single missions/multiplayer missions** - You can also choose to export your mission to either the single mission or multiplayer mission folders. This process creates a pbo file of the current mission folder (includes all files) in \"Mission\" or \"MPMissions\" folder in game's root.\n - Note: You have to manually create the folders, otherwise mission won't be exported.\n- **Send by e-mail** - This option will create a pbo file of the mission folder and load your default email program using it as an attachment.\n\n#### Save\n\nSaves a currently edited mission without opening any menu, unless mission was not saved previously.\n\n#### Merge\n\nMerge will import all map data (units, groups, waypoints, triggers, etc) from one mission into the currently loaded mission.\nOther settings such as those set in the Intel Display are not imported.\n\n#### Show IDs\n\nEvery object defined in the terrain you are using has an assigned ID number that can be used to refer to the object in script code.\nThese IDs are normally hidden for clarity, and this button toggles them on or off. IDs are only visible at high zoom levels.\n\n#### Show Textures\n\nClicking on this option will backfill the map with the satellite map texture rather than the default white.\nThis gives the user an idea of the type of terrain found in an area, although the satellite map does not always correspond exactly with the ground detail textures as seen at close range.\n\n#### Preview\n\nPreview will start the mission from within the editor so that you can test the results of your labour. A player unit must be on the map for the preview button to be visible.\nIf shift is held down while clicking on the preview button, the mission preview will include the mission briefing and debriefing.\nNote that in preview mode, some aspects of a mission may not always behave in the same way as they would if the mission was played as a single mission.\nIt is wise to check your mission in \"single mission mode\" (outside of the mission editor) before considering release.\n\n#### Continue\n\nAfter you have exited from the preview mode, clicking 'Continue' will allow you resume the mission from the point you left it.\nNote that any changes made in the editor since you exited the preview will not be shown. You must click 'Preview' again to restart with the updated version of your mission.\n\n#### Intel\n\n*Main article: Mission Editor: Intel*\n\nIntel display allows you to name your mission, give it a brief description, set the mission starting date and time, the current and forecast weather and which sides resistance forces are friendly to.\nClicking on the Intel box will bring up the Intel menu.\n\n#### Easy / Advanced\n\nThe mission editor has two modes, easy and advanced. The easy mode simply hides aspects of the mission editor and takes away a lot of the control you have as a skilled designer, but could distract you when new to the editing.\n\n#### Exit\n\nWill exit the mission editor and return to the main menu. Any unsaved work will be lost. A confirmation menu is shown.\n\n### Advanced Operations\n\n#### Functions\n\n*Main article: Functions*\n\nFunctions Viewer show list of scripting functions, both official and community made.\n\n#### Config Viewer\n\nConfig Viewer allows to explore games' config files, including list of vehicles, weapons, displays etc.\n\n#### Debug Console\n\n*Main article: Arma 3: Debug Console*\n\nDebug Console allows designer to watch desired values and execute custom codes.\n\n### External Editing\n\n*Main article: Mission Editor: External*\n\nMission editor provides majority of tools required for designing a mission, but finishing touches are usually made outside of it. Briefings, custom scripts, multiplayer settings or final packing are only handled by separate files programs.\n\n### Mission Export\n\n*Main article: Mission Export*\n\nWhen the mission is finished, you can export it to PBO format and release it, so anybody can play it.\n\n### Official Video Tutorials\n\n| |\n|---|\n| Expression error: Unrecognized word "size".\" width=\"size\"> W2Af6e0n7fQ
Arma 2: Operation Arrowhead v1.50 YouTube - Arma 2 Mission Editor Tutorial 1/2 \\|\\| Expression error: Unrecognized word "size".\" width=\"size\"> bynzzMt7Fg4
Arma 2: Operation Arrowhead v1.50 YouTube - Arma 2 Mission Editor Tutorial 2/2 |","sections":[{"heading":null,"level":1,"markdown":"> [!NOTE]\n> **Arma 3:** The 2D-Editor is now permanently replaced by Eden Editor (3D-Editor), but can still be invoked from the editor map selection screen with Ctrl + O shortcut for legacy purposes!\n\nThe **2D Mission Editor** is the primary tool for creating both singleplayer and multiplayer scenarios in majority of Bohemia Interactive's products.\n\nThe focus of this article is explaining the function and effect of each option, rather than recommending which option should be used to create a desired outcome.\nMany options create different effects depending on different circumstances.\nThe sheer amount of information presented may seem daunting at first, but remember games based on Real Virtuality engine are more complex than many other games, and there is always more than one way to create the desired effect.\n\n> [!NOTE]\n> As the editor evolved through time, some features are marked by icons on the right, indicating games introducing the functionality.\n> If no icon is present, it means the feature was always available."},{"heading":"Starting the Editor","level":3,"markdown":"Editor is accessible from the main menu through the button labelled \"Mission Editor\" or just \"Editor\". In Arma 2 and Take On Helicopters, this button can be found in the Singleplayer subcategory."},{"heading":"Controls","level":3,"markdown":"| Keyboard Shortcuts | | | | | |\n|---|---|---|---|---|---|\n| Function | OFP | ArmA | Arma 2 | TKOH | Arma 3 |\n| Units | F1 | | | | |\n| Groups | F2 | | | | |\n| Triggers | F3 | | | | |\n| Waypoints | F4 | | | | |\n| Synchronization | F5 | | | | |\n| Markers | F6 | | | | |\n| Modules | N/A | | F7 | | |\n| New | | | R | Ctrl + N | |\n| Load | | | | Ctrl + O | |\n| Save | | | | Ctrl + S | |\n| Save As | | | S | Ctrl + ⇧ Shift + S | |\n| Merge | | | M | Ctrl + M | |\n| Show IDs | | | | Ctrl + I | |\n| Show Textures | | | T | Ctrl + T | |\n| Preview | Return ↵ | | | | |\n| Continue | | | | | |\n| Intel | | | | | |\n| Exit | Esc | | | | |\n| Debug Console | N/A | | | Ctrl + D | |\n| Functions | N/A | | | Ctrl + F | |\n| Config Viewer | N/A | | | Ctrl + G | |"},{"heading":"Map Controls","level":3,"markdown":"- **Clicking and holding Right Mouse Button anywhere on the map** allows the user to pan around the map by moving the mouse.\n- The **mouse wheel** and **numpad +/-** keys control the map zoom level.\n- **Left Mouse Button on an entity** selects it. Selected entities are opaque, non selected entities are slightly transparent.\n- **Double Left Mouse Button on an entity** generally opens the entity's editing menu. In Waypoint mode, double left clicking on a object will create a waypoint for the selected group that is attached to the clicked object.\n- **Double Left Mouse Button on empty space** will create a new entity, if it is possible in the current editing mode.\n- **Clicking and holding Left Mouse Button on an entity** allows it to be dragged around the map. It is not possible to move units in group mode or move waypoints in synchronize mode.\n- **Clicking and holding Left Mouse Button on empty space** allows a drag box to be created for selecting multiple entities.\n- **Holding Ctrl** allows the user to select more than one entity using the **drag box** or individually by **left clicking on them**.\n- **⇧ Shift + Left Mouse Button on an unit or waypoint** will select all entities associated with that unit's group.\n- **⇧ Shift + Left Mouse Button holding Left Mouse Button on a selected entity** rotates the selected entities.\n- **⇧ Shift + Left Mouse Button on an object with a waypoint attached to it** selects the underlaying object.\n- **⇧ Shift + Double Left Mouse Button entity with a waypoint** on it opens the appropriate entity's menu (rather than the waypoints).\n- Del will erase the entity under the mouse cursor.\n- ⇧ Shift + Del will erase all selected entities.\n- Ctrl + X will cut the selected entities to the clipboard.\n- Ctrl + C will copy the selected entities to the clipboard.\n- Ctrl + V will paste a copy of entities from the clipboard. Copy and pasted named entities automatically have a number appended to their names to avoid conflicts.\n- Ctrl + ⇧ Shift + V will paste a copy of entities on their original position (useful when copying units between missions)."},{"heading":"Status Bar (Take On Helicopters v1.00)","level":4,"markdown":"Status bar on the bottom of a screen displays current map grid and cursor's XYZ coordinates."},{"heading":"Mission Modes","level":3,"markdown":"This drop down list allows you to choose which component of a mission you are currently editing.\nA single mission stores all objects and mission parameters for the intro and outro cutscenes completely separately from the gameplay component of a mission.\nIt is not essential to use any of these other than the mission component. While each component requires a player unit if it is to be used, the player will only have control of the unit in the *Mission* component.\nIn the *Intro* and *Outros*, AI will control the player's unit. The *Intro* and *Outros* will not end when the player unit dies, but must be ended using a trigger.\n\n- **Mission** is the default. This defines the interactive component of a mission. It is the only essential part of a mission.\n- **Intro** plays before the briefing screen.\n- **Outro - Win** will play after the debriefing screen in the case of a Win 1-6 trigger being activated.\n- **Outro - Loose** will play after the debriefing screen in the case of a Lose trigger being activated."},{"heading":"Editing Modes","level":3,"markdown":"The mission editor is always in one of these seven modes. Each different mode allows the creation and manipulation of different types of map entities.\nThe required mode can be set by either clicking on the modes name/icon or pressing the associated function key.\nThe modes are set out in the basic order they would be used while creating a mission."},{"heading":"Units","level":4,"markdown":"*Main article: Mission Editor: Units*\n\nUnit mode is used to add individual units, vehicles and objects on the map. To do so, double click on the empty space where you would like to add a unit.\nThis will open the *Unit Menu*. You can also open the unit menu of an existing unit while in any editing mode other than waypoints by double clicking on the unit.\nNote that if there is no player unit on the map, the unit menu will only allow valid player units may be placed."},{"heading":"Groups","level":4,"markdown":"*Main article: Mission Editor: Groups*\n\nGroup editing mode can be used in several ways. The primary use is to join previously placed individual entities together into groups.\nJoining individual units together into groups can greatly improve their combat abilities. A group will move together, share information about enemy units and can bring greater firepower to bare on a target.\nEach individual unit on the map that has no visible group links is actually in a group of it is own. When a unit is created near another unit of the same side, it will automatically be placed in the other unit's group.\nTo join a unit into an existing group, simply left click and hold on the unit, then drag a line to any unit of the group you wish to add it too. Release the button to join the unit into that group.\nGroup links are displayed by light blue line drawn from the leader to each other unit in the group.\nRemoving a unit from a group is done by left clicking and holding on the unit and dragging the group link line into empty space, then releasing. The highest ranking unit in a group will generally be the leader.\nWhile it is possible to create extremely large groups, huge formations of AI units create path finding issues and can be very hard to manage for a human leader."},{"heading":"Triggers","level":4,"markdown":"*Main article: Mission Editor: Triggers*\n\nA trigger is an abstract game entity that will wait until it is condition block returns true, then carry out the *On Activation* string.\nWhen used effectively, they can make your mission seem much more dynamic and realistic.\nFor example, you can use a trigger to set off a siren and call reinforcements when the player is spotted near an enemy base, or to start a convoy moving when the player gives a radio command.\n\nTriggers are represented in the mission editor by a dark blue ellipse or rectangle with a small blue flag in the centre.\nTriggers may be linked to an object in Groups Mode (F2), which generally means that only that object or group can activate the trigger.\nTriggers can be used in various ways, for example the location and dimensions of a trigger are not always used as part of it is conditions,\nand triggers do not necessarily require an *On Activation* block, instead being used to return a list of objects that satisfy it is conditions.\nEach trigger's *Condition* block will be checked approximately twice every second for the duration of the mission.\nTo add a new trigger to your mission, double left click in some empty map space. The *Trigger Menu* will open."},{"heading":"Waypoints","level":4,"markdown":"*Main article: Mission Editor: Waypoints*\n\nWaypoints are used to define the route and behaviour of a group during the mission. At any point in time a group will have one active waypoint (generally the waypoint they are to move towards). Once a waypoint's conditions have been met, it will become complete and the group's next waypoint automatically becomes active. Some of a waypoint's settings will take place as the waypoint becomes active, others when the waypoint is complete."},{"heading":"Synchronization","level":4,"markdown":"*Main article: Mission Editor: Synchronization*\n\nSynchronization mode is used to make different groups carry out their waypoint orders at the same time, and optionally only under specific circumstances. Synchronization can seem a hard concept to understand at first, but it is a very powerful and easy to use tool. For example, synchronization can be used to organize friendly forces to wait until everyone is in position before launching a mass attack, or wait in ambush until an enemy convoy is in the perfect location before opening fire. Synchronizing links can be made between any of a group's waypoints and any number of other group's waypoints, and any number of triggers. A synchronized waypoint will not complete until all waypoints it is linked with are ready to complete, and all synchronized triggers are activated. Synchronizing links are displayed by a dark blue line connecting the entities.\n\nTo create a synchronized link between a waypoint and another group's waypoint or a trigger, simply left click and hold on the waypoint, move the mouse to the desired waypoint/trigger then release. To remove synchronization lines from a waypoint or trigger, left click on it, hold and drag a line into empty space. Note this will remove **all** synchronizing lines from that entity, so be careful."},{"heading":"Markers","level":4,"markdown":"*Main article: Mission Editor: Markers*\n\nMarker mode is primarily used to place visual map icons and zones on the mission map. Markers are only visible while the mission editor is in marker mode, but can still be manipulated while in other modes. To do so, hover the mouse cursor over a marker's position to display it is name. The second use of markers is to define a possible starting position for any number of objects. To do this, create a group link between the marker and the object. The object will begin the mission at any one of the markers it is grouped with or at it is original position, chosen at random. This offers another way to create some randomness in a mission, with more precise control compared to using the object's *Placement radius* option. Note that any marker used in this way will still be drawn on the mission map (although setting the axis sizes to 0 can be used to hide a marker). Markers can not be attached to objects. To create a map marker, double left click in empty space."},{"heading":"Modules","level":4,"markdown":"*Main article: Mission Editor: Modules*\n\nModules offers complex scripted solutions"},{"heading":"Basic Operations","level":3,"markdown":""},{"heading":"New","level":4,"markdown":"Remove all map entities such as units, waypoints, markers and triggers. Settings such as those defined in the Intel are retained. Be warned that there is no undo function in the mission editor."},{"heading":"Load","level":4,"markdown":"Allows you to load a previously saved mission. Only uncompressed mission folders in your current profiles missions folder can be loaded."},{"heading":"Save As","level":4,"markdown":"You can save your current mission with this menu.\n\n- **User missions** - These missions are only available through the mission editor while using the current user profile. *Note that if you save your mission under a new name, **only** the Mission.sqm file will be written in the new folder*. Saving a already named *User mission* also reloads any mission support files that are in the chosen mission folder, such as Description.ext and Init.sqs.\n- **Export to single missions/multiplayer missions** - You can also choose to export your mission to either the single mission or multiplayer mission folders. This process creates a pbo file of the current mission folder (includes all files) in \"Mission\" or \"MPMissions\" folder in game's root.\n - Note: You have to manually create the folders, otherwise mission won't be exported.\n- **Send by e-mail** - This option will create a pbo file of the mission folder and load your default email program using it as an attachment."},{"heading":"Save","level":4,"markdown":"Saves a currently edited mission without opening any menu, unless mission was not saved previously."},{"heading":"Merge","level":4,"markdown":"Merge will import all map data (units, groups, waypoints, triggers, etc) from one mission into the currently loaded mission.\nOther settings such as those set in the Intel Display are not imported."},{"heading":"Show IDs","level":4,"markdown":"Every object defined in the terrain you are using has an assigned ID number that can be used to refer to the object in script code.\nThese IDs are normally hidden for clarity, and this button toggles them on or off. IDs are only visible at high zoom levels."},{"heading":"Show Textures","level":4,"markdown":"Clicking on this option will backfill the map with the satellite map texture rather than the default white.\nThis gives the user an idea of the type of terrain found in an area, although the satellite map does not always correspond exactly with the ground detail textures as seen at close range."},{"heading":"Preview","level":4,"markdown":"Preview will start the mission from within the editor so that you can test the results of your labour. A player unit must be on the map for the preview button to be visible.\nIf shift is held down while clicking on the preview button, the mission preview will include the mission briefing and debriefing.\nNote that in preview mode, some aspects of a mission may not always behave in the same way as they would if the mission was played as a single mission.\nIt is wise to check your mission in \"single mission mode\" (outside of the mission editor) before considering release."},{"heading":"Continue","level":4,"markdown":"After you have exited from the preview mode, clicking 'Continue' will allow you resume the mission from the point you left it.\nNote that any changes made in the editor since you exited the preview will not be shown. You must click 'Preview' again to restart with the updated version of your mission."},{"heading":"Intel","level":4,"markdown":"*Main article: Mission Editor: Intel*\n\nIntel display allows you to name your mission, give it a brief description, set the mission starting date and time, the current and forecast weather and which sides resistance forces are friendly to.\nClicking on the Intel box will bring up the Intel menu."},{"heading":"Easy / Advanced","level":4,"markdown":"The mission editor has two modes, easy and advanced. The easy mode simply hides aspects of the mission editor and takes away a lot of the control you have as a skilled designer, but could distract you when new to the editing."},{"heading":"Exit","level":4,"markdown":"Will exit the mission editor and return to the main menu. Any unsaved work will be lost. A confirmation menu is shown."},{"heading":"Advanced Operations","level":3,"markdown":""},{"heading":"Functions","level":4,"markdown":"*Main article: Functions*\n\nFunctions Viewer show list of scripting functions, both official and community made."},{"heading":"Config Viewer","level":4,"markdown":"Config Viewer allows to explore games' config files, including list of vehicles, weapons, displays etc."},{"heading":"Debug Console","level":4,"markdown":"*Main article: Arma 3: Debug Console*\n\nDebug Console allows designer to watch desired values and execute custom codes."},{"heading":"External Editing","level":3,"markdown":"*Main article: Mission Editor: External*\n\nMission editor provides majority of tools required for designing a mission, but finishing touches are usually made outside of it. Briefings, custom scripts, multiplayer settings or final packing are only handled by separate files programs."},{"heading":"Mission Export","level":3,"markdown":"*Main article: Mission Export*\n\nWhen the mission is finished, you can export it to PBO format and release it, so anybody can play it."},{"heading":"Official Video Tutorials","level":3,"markdown":"| |\n|---|\n| Expression error: Unrecognized word "size".\" width=\"size\"> W2Af6e0n7fQ
Arma 2: Operation Arrowhead v1.50 YouTube - Arma 2 Mission Editor Tutorial 1/2 \\|\\| Expression error: Unrecognized word "size".\" width=\"size\"> bynzzMt7Fg4
Arma 2: Operation Arrowhead v1.50 YouTube - Arma 2 Mission Editor Tutorial 2/2 |"}],"categories":["2D Editor"],"groups":["Mission Editing"]},{"name":"2D Editor: External","title":"2D Editor: External","type":"topic","url":"https://community.bistudio.com/wiki/2D_Editor:_External","revid":353557,"updated":"2024-03-19T12:01:40Z","aliases":["Mission Editor: External"],"markdown":"Mission Editor provides majority of tools required for designing a mission, but finishing touches are usually made outside of it. Briefings, custom scripts, multiplayer settings or final packing are only handled by separate files programs.\n\n### Mission Folder\n\n#### Folder Name\n\nMissions are stored as folders with name composed of mission name set in Save window and world name:\n\n```\nmissionName.worldName\n```\n\nExamples:\n\n```\nTopGun.abel\nSpyGame.Chernarus\nDomino.ProvingGrounds_PMC\nThis.is.Sparta.Altis\n```\n\nWorld names match classes present in *CfgWorlds*.\n\n#### Folder Directory\n\nYou can find all missions in your Profile directory.\n\nSingle player missions are located in *Missions* folder, multiplayer missions can be found in *MPMissions* folder in same directory.\n\n#### Subfolders\n\nWithin the mission folder, you can create as many subfolders as desired. As paths in mission are relative, you can refer to such subfolder using:\n\n```\n\\subFolderName\\desiredFile.sqf\n```\n\n### Files\n\n#### Mission.sqm\n\n*Main article: Mission.sqm*\n\n#### Description.ext\n\n*Main article: Description.ext*\n\n#### Scripts\n\n*Main article: Script File*\n\nExternal script files are executed by filename, so they can have any filename the author chooses. There are however several special Event Scripts that are automatically executed by the game engine at certain times during the mission.\n\n#### FSM\n\n*Main article: FSM*\n\n#### Overview.html\n\n*Main article: Overview.html*\n\nThe overview.html contains simple mission description and picture visible in main menu mission selection.\n\n#### Briefing.html\n\n*Main article: Briefing.html*\n\nFile loaded automatically when the mission begins, providing mission plan and notes.\n\nThe briefing is broken into 4 main sections:\n\n- Notes\n- Plan\n- Objectives\n- Endings\n\nTo preview your briefing whilst in the editor, hold SHIFT while clicking 'Preview'.\n\nSince Arma 2, briefing.html is only used for the debriefing text. For more information see Arma 2 Briefing creation.","sections":[{"heading":null,"level":1,"markdown":"Mission Editor provides majority of tools required for designing a mission, but finishing touches are usually made outside of it. Briefings, custom scripts, multiplayer settings or final packing are only handled by separate files programs."},{"heading":"Mission Folder","level":3,"markdown":""},{"heading":"Folder Name","level":4,"markdown":"Missions are stored as folders with name composed of mission name set in Save window and world name:\n\n```\nmissionName.worldName\n```\n\nExamples:\n\n```\nTopGun.abel\nSpyGame.Chernarus\nDomino.ProvingGrounds_PMC\nThis.is.Sparta.Altis\n```\n\nWorld names match classes present in *CfgWorlds*."},{"heading":"Folder Directory","level":4,"markdown":"You can find all missions in your Profile directory.\n\nSingle player missions are located in *Missions* folder, multiplayer missions can be found in *MPMissions* folder in same directory."},{"heading":"Subfolders","level":4,"markdown":"Within the mission folder, you can create as many subfolders as desired. As paths in mission are relative, you can refer to such subfolder using:\n\n```\n\\subFolderName\\desiredFile.sqf\n```"},{"heading":"Files","level":3,"markdown":""},{"heading":"Mission.sqm","level":4,"markdown":"*Main article: Mission.sqm*"},{"heading":"Description.ext","level":4,"markdown":"*Main article: Description.ext*"},{"heading":"Scripts","level":4,"markdown":"*Main article: Script File*\n\nExternal script files are executed by filename, so they can have any filename the author chooses. There are however several special Event Scripts that are automatically executed by the game engine at certain times during the mission."},{"heading":"FSM","level":4,"markdown":"*Main article: FSM*"},{"heading":"Overview.html","level":4,"markdown":"*Main article: Overview.html*\n\nThe overview.html contains simple mission description and picture visible in main menu mission selection."},{"heading":"Briefing.html","level":4,"markdown":"*Main article: Briefing.html*\n\nFile loaded automatically when the mission begins, providing mission plan and notes.\n\nThe briefing is broken into 4 main sections:\n\n- Notes\n- Plan\n- Objectives\n- Endings\n\nTo preview your briefing whilst in the editor, hold SHIFT while clicking 'Preview'.\n\nSince Arma 2, briefing.html is only used for the debriefing text. For more information see Arma 2 Briefing creation."}],"categories":["2D Editor"],"groups":["Mission Editing"]},{"name":"2D Editor: Groups","title":"2D Editor: Groups","type":"topic","url":"https://community.bistudio.com/wiki/2D_Editor:_Groups","revid":353482,"updated":"2024-03-19T12:00:38Z","aliases":["Mission Editor: Groups"],"markdown":"Group editing mode can be used in several ways. The primary use is to join previously placed individual entities together into groups. Joining individual units together into groups can greatly improve their combat abilities. A group will move together, share information about enemy units and can bring greater firepower to bear on a target. Each individual unit on the map that has no visible group links is actually in a group of its own. When a unit is created near another unit of the same side, it will automatically be placed in the other unit's group. To join a unit into an existing group, simply left click and hold on the unit, then drag a line to any unit of the group you wish to add it too. Release the button to join the unit into that group. Group links are displayed by light blue line drawn from the leader to each other unit in the group. Removing a unit from a group is done by left clicking and holding on the unit and dragging the group link line into empty space, then releasing. The highest ranking unit in a group will generally be the leader. While it is possible to create extremely large groups in ArmA, huge formations of AI units create path finding issues and can be very hard to manage for a human leader.\n\nIndividual objects may also be grouped to Triggers (to link a specific object to the trigger) and Markers (allowing an object to start at a random but specific location), see those sections for further details.\n\nThe final function of Group Mode is to place an entire group in one step. These groups have been pre-defined within game's main config file (*class CfgGroups*). Any units placed in this manner may be individually manipulated as normal. To place a group, simply double click on an empty map location. The Group Menu will open.\n\n### Menu\n\n#### Side\n\nChoose the side of the group you wish to place.\n\n#### Type\n\nChoose the type of group to be placed. Mechanized infantry are listed under *Infantry*, not *Armor*.\n\n#### Name\n\nDefines the specific group to be placed. Armor platoons and Air Squadrons consist of 4 vehicles, infantry squads consist of up to 9 men. Motorized squads and mechanized squads will begin with only the crew in their vehicle.\n\n#### Azimut / Direction / Azimuth\n\nDefines which direction the group will be facing. You can drag the pointer around the circle, or type in the desired facing into the box. Note that the group formation will be built around the leader, using his location and facing.","sections":[{"heading":null,"level":1,"markdown":"Group editing mode can be used in several ways. The primary use is to join previously placed individual entities together into groups. Joining individual units together into groups can greatly improve their combat abilities. A group will move together, share information about enemy units and can bring greater firepower to bear on a target. Each individual unit on the map that has no visible group links is actually in a group of its own. When a unit is created near another unit of the same side, it will automatically be placed in the other unit's group. To join a unit into an existing group, simply left click and hold on the unit, then drag a line to any unit of the group you wish to add it too. Release the button to join the unit into that group. Group links are displayed by light blue line drawn from the leader to each other unit in the group. Removing a unit from a group is done by left clicking and holding on the unit and dragging the group link line into empty space, then releasing. The highest ranking unit in a group will generally be the leader. While it is possible to create extremely large groups in ArmA, huge formations of AI units create path finding issues and can be very hard to manage for a human leader.\n\nIndividual objects may also be grouped to Triggers (to link a specific object to the trigger) and Markers (allowing an object to start at a random but specific location), see those sections for further details.\n\nThe final function of Group Mode is to place an entire group in one step. These groups have been pre-defined within game's main config file (*class CfgGroups*). Any units placed in this manner may be individually manipulated as normal. To place a group, simply double click on an empty map location. The Group Menu will open."},{"heading":"Menu","level":3,"markdown":""},{"heading":"Side","level":4,"markdown":"Choose the side of the group you wish to place."},{"heading":"Type","level":4,"markdown":"Choose the type of group to be placed. Mechanized infantry are listed under *Infantry*, not *Armor*."},{"heading":"Name","level":4,"markdown":"Defines the specific group to be placed. Armor platoons and Air Squadrons consist of 4 vehicles, infantry squads consist of up to 9 men. Motorized squads and mechanized squads will begin with only the crew in their vehicle."},{"heading":"Azimut / Direction / Azimuth","level":4,"markdown":"Defines which direction the group will be facing. You can drag the pointer around the circle, or type in the desired facing into the box. Note that the group formation will be built around the leader, using his location and facing."}],"categories":["2D Editor"],"groups":["Mission Editing"]},{"name":"2D Editor: Intel","title":"2D Editor: Intel","type":"topic","url":"https://community.bistudio.com/wiki/2D_Editor:_Intel","revid":353564,"updated":"2024-03-19T12:01:44Z","aliases":["Mission Editor: Intel"],"markdown":"The Intel box is the dark grey box with a weather icon, the time and date. It allows you to name your mission, give it a brief description, set the mission starting date and time, the current and forecast weather and which sides resistance forces are friendly to. Clicking on the Intel box will bring up the Intel menu.\n\n### Menu\n\n#### Name\n\nThe mission name is used in mission lists, such as when browsing missions in the \"Single Mission\" mode, on multiplayer sessions and mission lists, in the campaign mission list, and on the map notepad. If you do not name your mission, the missions folder/pbo name will be used.\n\n#### Description\n\nThis description is only displayed while in multiplayer mode, but it is recommended to give every mission a short description to explain what the mission is about, failing all else to allow you to identify it yourself in the future.\n\n#### Date and Time\n\nThese options should be self explanatory. Remember that Armed Assault is highly accurate in its rendering of seasonal patterns. Thus daylight hours, the sun's path across the sky, star constellations and moon phases are all simulated correctly given the current terrain's world location. Tides are also accurately simulated, and can be somewhat hard to predict as different seasons and moon phases create vastly differing high/low water marks.\n\n#### Weather Sliders\n\nWeather sliders are devided into pairs, each of them setting starting value and forecast value which engine will reach in 30 minutes.\n\n- **Weather** - sets overcast, initiate raining when value is low enough\n- **Fog** - modifies visibility, no matter what view distance is set in video options.\n- **Wind (Take On helicopters only)** - wind strength, affecting helicopter flight model.\n\n#### Resistance Is Friendly to:\n\nChoose which side(s) the resistance side will be friendly to at the start of the mission. Note that the civilian side will inherit the same allies and enemies of the resistance side.\n\n### Scripting\n\nSee Command Group: Environment for list of all marker-related commands.","sections":[{"heading":null,"level":1,"markdown":"The Intel box is the dark grey box with a weather icon, the time and date. It allows you to name your mission, give it a brief description, set the mission starting date and time, the current and forecast weather and which sides resistance forces are friendly to. Clicking on the Intel box will bring up the Intel menu."},{"heading":"Menu","level":3,"markdown":""},{"heading":"Name","level":4,"markdown":"The mission name is used in mission lists, such as when browsing missions in the \"Single Mission\" mode, on multiplayer sessions and mission lists, in the campaign mission list, and on the map notepad. If you do not name your mission, the missions folder/pbo name will be used."},{"heading":"Description","level":4,"markdown":"This description is only displayed while in multiplayer mode, but it is recommended to give every mission a short description to explain what the mission is about, failing all else to allow you to identify it yourself in the future."},{"heading":"Date and Time","level":4,"markdown":"These options should be self explanatory. Remember that Armed Assault is highly accurate in its rendering of seasonal patterns. Thus daylight hours, the sun's path across the sky, star constellations and moon phases are all simulated correctly given the current terrain's world location. Tides are also accurately simulated, and can be somewhat hard to predict as different seasons and moon phases create vastly differing high/low water marks."},{"heading":"Weather Sliders","level":4,"markdown":"Weather sliders are devided into pairs, each of them setting starting value and forecast value which engine will reach in 30 minutes.\n\n- **Weather** - sets overcast, initiate raining when value is low enough\n- **Fog** - modifies visibility, no matter what view distance is set in video options.\n- **Wind (Take On helicopters only)** - wind strength, affecting helicopter flight model."},{"heading":"Resistance Is Friendly to:","level":4,"markdown":"Choose which side(s) the resistance side will be friendly to at the start of the mission. Note that the civilian side will inherit the same allies and enemies of the resistance side."},{"heading":"Scripting","level":3,"markdown":"See Command Group: Environment for list of all marker-related commands."}],"categories":["2D Editor"],"groups":["Mission Editing"]},{"name":"2D Editor: Layout Customization","title":"2D Editor: Layout Customization","type":"topic","url":"https://community.bistudio.com/wiki/2D_Editor:_Layout_Customization","revid":364506,"updated":"2024-05-16T20:42:05Z","aliases":["Mission Editor: Layout Customization"],"markdown":"### Description\n\n- Arma 3 provides the ability to switch layout of the mission editor's main display. Two layouts are provided by default, but custom made could be added.\n- Layouts are listed in RscDisplayChooseEditorLayout, that could be invoked via layout button in mission editor.\n- Layout is switched without restarting of the game, only restart of mission editor is needed. Automatic restart of editor via *Restart Now* button in MessageBox is much quicker, than manual restart. This could be beneficial when designing new custom made layout.\n- Selected layout is stored in user's profile and so is remembered after game restart.\n\n### Configuration\n\n- New layout could be created via creating .hpp and optionally .sqf file. .hpp should be included in config.cpp. See *A3\\Ui_f\\hpp\\Editor\\RscDisplayArcadeMap_Layout_6.hpp* and *A3\\Ui_f\\scripts\\GUI\\RscDisplayArcadeMap_Layout_6.sqf* as an example.\n- Each layout that should be displayed in RscDisplayChooseEditorLayout should be configured in *A3\\Ui_f\\hpp\\cfgEditorLayouts.hpp*.\n- Parameters of the layout's class:\n - **name** - name of the class that will be used as resource for the layout. If name of non-existing class is used, *RscDisplayArcadeMap* is used as a failsafe.\n\n > [!NOTE]\n > **name** can be anything but should be unique within CfgEditorLayouts.\n - **displayName** - name that will be displayed in ListBox in RscDisplayChooseEditorLayout.\n - **layoutPicture** - path to the preview picture of the layout. Picture should have aspect ratio 2:1 and should be stored in *A3\\Ui_f\\data\\GUI\\Rsc\\RscDisplayChooseEditorLayout\\*.\n\n#### Example\n\n```cpp\nclass CfgEditorLayouts\n{\n class Layout01\n {\n name = \"RscDisplayArcadeMap_Layout_2\";\n displayName = \"$STR_A3_CfgEditorLayouts_Layout011\"; // Streamlined\n layoutPicture = \"\\A3\\Ui_f\\data\\GUI\\Rsc\\RscDisplayChooseEditorLayout\\Layout_2.paa\";\n };\n\n class Layout02\n {\n name = \"RscDisplayArcadeMap_Layout_6\";\n displayName = \"$STR_A3_CfgEditorLayouts_Layout021\"; // Traditional\n layoutPicture = \"\\A3\\Ui_f\\data\\GUI\\Rsc\\RscDisplayChooseEditorLayout\\Layout_6.paa\";\n };\n};\n```","sections":[{"heading":"Description","level":3,"markdown":"- Arma 3 provides the ability to switch layout of the mission editor's main display. Two layouts are provided by default, but custom made could be added.\n- Layouts are listed in RscDisplayChooseEditorLayout, that could be invoked via layout button in mission editor.\n- Layout is switched without restarting of the game, only restart of mission editor is needed. Automatic restart of editor via *Restart Now* button in MessageBox is much quicker, than manual restart. This could be beneficial when designing new custom made layout.\n- Selected layout is stored in user's profile and so is remembered after game restart."},{"heading":"Configuration","level":3,"markdown":"- New layout could be created via creating .hpp and optionally .sqf file. .hpp should be included in config.cpp. See *A3\\Ui_f\\hpp\\Editor\\RscDisplayArcadeMap_Layout_6.hpp* and *A3\\Ui_f\\scripts\\GUI\\RscDisplayArcadeMap_Layout_6.sqf* as an example.\n- Each layout that should be displayed in RscDisplayChooseEditorLayout should be configured in *A3\\Ui_f\\hpp\\cfgEditorLayouts.hpp*.\n- Parameters of the layout's class:\n - **name** - name of the class that will be used as resource for the layout. If name of non-existing class is used, *RscDisplayArcadeMap* is used as a failsafe.\n\n > [!NOTE]\n > **name** can be anything but should be unique within CfgEditorLayouts.\n - **displayName** - name that will be displayed in ListBox in RscDisplayChooseEditorLayout.\n - **layoutPicture** - path to the preview picture of the layout. Picture should have aspect ratio 2:1 and should be stored in *A3\\Ui_f\\data\\GUI\\Rsc\\RscDisplayChooseEditorLayout\\*."},{"heading":"Example","level":4,"markdown":"```cpp\nclass CfgEditorLayouts\n{\n class Layout01\n {\n name = \"RscDisplayArcadeMap_Layout_2\";\n displayName = \"$STR_A3_CfgEditorLayouts_Layout011\"; // Streamlined\n layoutPicture = \"\\A3\\Ui_f\\data\\GUI\\Rsc\\RscDisplayChooseEditorLayout\\Layout_2.paa\";\n };\n\n class Layout02\n {\n name = \"RscDisplayArcadeMap_Layout_6\";\n displayName = \"$STR_A3_CfgEditorLayouts_Layout021\"; // Traditional\n layoutPicture = \"\\A3\\Ui_f\\data\\GUI\\Rsc\\RscDisplayChooseEditorLayout\\Layout_6.paa\";\n };\n};\n```"}],"categories":["2D Editor"],"groups":["Mission Editing"]},{"name":"2D Editor: Markers","title":"2D Editor: Markers","type":"topic","url":"https://community.bistudio.com/wiki/2D_Editor:_Markers","revid":353540,"updated":"2024-03-19T12:01:33Z","aliases":["Mission Editor: Markers"],"markdown":"Marker mode is primarily used to place visual map icons and zones on the mission map.\nMarkers are only visible while the mission editor is in marker mode, but can still be manipulated while in other modes.\nTo do so, hover the mouse cursor over a marker's position to display it is name.\n\nThe second use of markers is to define a possible starting position for any number of objects.\nTo do this, create a group link between the marker and the object.\nThe object will begin the mission at any one of the markers it is grouped with or at it is original position, chosen at random.\nThis offers another way to create some randomness in a mission, with more precise control compared to using the object's *Placement radius* option.\n\nNote that any marker used in this way will still be drawn on the mission map (although setting the axis sizes to 0 can be used to hide a marker).\nMarkers can not be attached to objects. To create a map marker, double left click in empty space.\n\n#### Name\n\nEvery marker must have a unique name. Marker names should comply with normal variable naming rules (no spaces, reserved characters or reserved words) but ArmA will only provide a warning in the case of a duplicate marker name.\nMarkers can only be found by recognizing their name while in another map editing mode.\n\n#### Icon/Rectangle/Ellipse\n\nMarkers can be one of two types :\n\n- **Icons** - These represent points, and will be drawn on the mission map at a fixed scale, no matter what zoom level is used. Icons are completely opaque and will cover whatever lies below them.\n- **Ellipse/Rectangle** - Markers can also take the form of a pattern filled zone, defined by either one of these shapes. The zone will always be displayed covering the same physical area, no matter what scale the map is viewed at.\n\n#### Color\n\nChoose the desired color. *Default* for icon markers is red, and black for zoned shapes.\n\n#### Icon\n\nThis option is only available if the marker is an *Icon* type.\nChoose any icon from the list. The two *Empty* types are valid, they just lack proper names.\nPlayers can create icon markers during the mission by double clicking on the map.\n\n#### Fill\n\nOnly available for *Ellipse* or *Rectangle* markers.\nThe shape will be filled with the selected fill pattern.\nAll fill patterns are slightly transparent.\n\n#### Axis a/Axis b\n\nThese options define the scale at which the marker will be drawn.\n*Icon* type markers have no absolute size, but rather display at a constant size irrespective of map zoom.\nThe axis values define the relative scale for the icon, for example marker with an axis value of 10 will be displayed 10 times larger than normal icon display size.\nFor *zone* type markers, these values define the radius of the marker, in meters.\n*Axis a* is east west, *Axis b* north south, assuming angle of 0.\nTo make an invisible marker (such as those used to define possible starting locations for a object) set both axis to 0.\n\n#### Angle\n\nA marker can be rotated as with any object or trigger.\n\n#### Text\n\nOnly *Icon* markers will use this text.\nIt will be displayed in small colored font directly east of the marker, irrespective of the marker's angle.\n\n#### Preview (Take On Helicopters v1.00)\n\nDisplays preview of currently selected marker.\n\n### Scripting\n\nSee Command Group: Markers for a list of all marker-related commands.","sections":[{"heading":null,"level":1,"markdown":"Marker mode is primarily used to place visual map icons and zones on the mission map.\nMarkers are only visible while the mission editor is in marker mode, but can still be manipulated while in other modes.\nTo do so, hover the mouse cursor over a marker's position to display it is name.\n\nThe second use of markers is to define a possible starting position for any number of objects.\nTo do this, create a group link between the marker and the object.\nThe object will begin the mission at any one of the markers it is grouped with or at it is original position, chosen at random.\nThis offers another way to create some randomness in a mission, with more precise control compared to using the object's *Placement radius* option.\n\nNote that any marker used in this way will still be drawn on the mission map (although setting the axis sizes to 0 can be used to hide a marker).\nMarkers can not be attached to objects. To create a map marker, double left click in empty space."},{"heading":"Name","level":4,"markdown":"Every marker must have a unique name. Marker names should comply with normal variable naming rules (no spaces, reserved characters or reserved words) but ArmA will only provide a warning in the case of a duplicate marker name.\nMarkers can only be found by recognizing their name while in another map editing mode."},{"heading":"Icon/Rectangle/Ellipse","level":4,"markdown":"Markers can be one of two types :\n\n- **Icons** - These represent points, and will be drawn on the mission map at a fixed scale, no matter what zoom level is used. Icons are completely opaque and will cover whatever lies below them.\n- **Ellipse/Rectangle** - Markers can also take the form of a pattern filled zone, defined by either one of these shapes. The zone will always be displayed covering the same physical area, no matter what scale the map is viewed at."},{"heading":"Color","level":4,"markdown":"Choose the desired color. *Default* for icon markers is red, and black for zoned shapes."},{"heading":"Icon","level":4,"markdown":"This option is only available if the marker is an *Icon* type.\nChoose any icon from the list. The two *Empty* types are valid, they just lack proper names.\nPlayers can create icon markers during the mission by double clicking on the map."},{"heading":"Fill","level":4,"markdown":"Only available for *Ellipse* or *Rectangle* markers.\nThe shape will be filled with the selected fill pattern.\nAll fill patterns are slightly transparent."},{"heading":"Axis a/Axis b","level":4,"markdown":"These options define the scale at which the marker will be drawn.\n*Icon* type markers have no absolute size, but rather display at a constant size irrespective of map zoom.\nThe axis values define the relative scale for the icon, for example marker with an axis value of 10 will be displayed 10 times larger than normal icon display size.\nFor *zone* type markers, these values define the radius of the marker, in meters.\n*Axis a* is east west, *Axis b* north south, assuming angle of 0.\nTo make an invisible marker (such as those used to define possible starting locations for a object) set both axis to 0."},{"heading":"Angle","level":4,"markdown":"A marker can be rotated as with any object or trigger."},{"heading":"Text","level":4,"markdown":"Only *Icon* markers will use this text.\nIt will be displayed in small colored font directly east of the marker, irrespective of the marker's angle."},{"heading":"Preview (Take On Helicopters v1.00)","level":4,"markdown":"Displays preview of currently selected marker."},{"heading":"Scripting","level":3,"markdown":"See Command Group: Markers for a list of all marker-related commands."}],"categories":["2D Editor"],"groups":["Mission Editing"]},{"name":"2D Editor: Synchronization","title":"2D Editor: Synchronization","type":"topic","url":"https://community.bistudio.com/wiki/2D_Editor:_Synchronization","revid":369649,"updated":"2024-09-30T09:13:41Z","aliases":["Mission Editor: Synchronization"],"markdown":"Synchronisation mode is used to make different groups carry out their waypoint orders at the same time, and optionally only under specific circumstances.\nSynchronisation can seem a hard concept to understand at first, but it is a very powerful and easy to use tool.\nFor example, synchronisation can be used to organise friendly forces to wait until everyone is in position before launching a mass attack, or wait in ambush until an enemy convoy is in the perfect location before opening fire.\nSynchronising links can be made between any of a group's waypoints and any number of other group's waypoints, and any number of triggers.\nA synchronised waypoint will not complete until all waypoints it is linked with are ready to complete, and all synchronised triggers are activated.\nSynchronising links are displayed by a dark blue line connecting the entities.\nTo create a synchronised link between a waypoint and another group's waypoint or a trigger, simply left click and hold on the waypoint, move the mouse to the desired waypoint/trigger then release.\nTo remove synchronisation lines from a waypoint or trigger, left click on it, hold and drag a line into empty space. Note this will remove **all** synchronising lines from that entity, so be careful.\n\nWhen a group's current waypoint is synchronised, the HUD will display the waypoint type as \"Wait\", and the group will move to the waypoints position, even if the true waypoint type would not normally involve moving to the waypoint's position.\nAnother important thing to know is that while a group's waypoint's *Activation* code block does not return true, but the waypoint is otherwise ready to activate that waypoint will be considered complete for the purposes of synchronisation!\nIt is possible to link one waypoint with more than one waypoint of another single group.\nIt is also possible to create synchronised links that can never be satisfied, in which case no warning will be given and groups will stuck waiting forever.\n\nTriggers do not wait for synchronised waypoints, only the waypoint needs to wait until the trigger is active.\nLines of synchronisation generally do not have any polarity, so it does not matter which waypoint is clicked on and which is dragged to.\nThere are some exceptions to this rule. With some waypoint types such as *Get In* and *Join*, the synchronising link has greater significance than just timing in this case, it defines which group shall join and which shall be joined.\nSee those waypoints types descriptions for details. Game Logic's *OR* type waypoint.","sections":[{"heading":null,"level":1,"markdown":"Synchronisation mode is used to make different groups carry out their waypoint orders at the same time, and optionally only under specific circumstances.\nSynchronisation can seem a hard concept to understand at first, but it is a very powerful and easy to use tool.\nFor example, synchronisation can be used to organise friendly forces to wait until everyone is in position before launching a mass attack, or wait in ambush until an enemy convoy is in the perfect location before opening fire.\nSynchronising links can be made between any of a group's waypoints and any number of other group's waypoints, and any number of triggers.\nA synchronised waypoint will not complete until all waypoints it is linked with are ready to complete, and all synchronised triggers are activated.\nSynchronising links are displayed by a dark blue line connecting the entities.\nTo create a synchronised link between a waypoint and another group's waypoint or a trigger, simply left click and hold on the waypoint, move the mouse to the desired waypoint/trigger then release.\nTo remove synchronisation lines from a waypoint or trigger, left click on it, hold and drag a line into empty space. Note this will remove **all** synchronising lines from that entity, so be careful.\n\nWhen a group's current waypoint is synchronised, the HUD will display the waypoint type as \"Wait\", and the group will move to the waypoints position, even if the true waypoint type would not normally involve moving to the waypoint's position.\nAnother important thing to know is that while a group's waypoint's *Activation* code block does not return true, but the waypoint is otherwise ready to activate that waypoint will be considered complete for the purposes of synchronisation!\nIt is possible to link one waypoint with more than one waypoint of another single group.\nIt is also possible to create synchronised links that can never be satisfied, in which case no warning will be given and groups will stuck waiting forever.\n\nTriggers do not wait for synchronised waypoints, only the waypoint needs to wait until the trigger is active.\nLines of synchronisation generally do not have any polarity, so it does not matter which waypoint is clicked on and which is dragged to.\nThere are some exceptions to this rule. With some waypoint types such as *Get In* and *Join*, the synchronising link has greater significance than just timing in this case, it defines which group shall join and which shall be joined.\nSee those waypoints types descriptions for details. Game Logic's *OR* type waypoint."}],"categories":["2D Editor"],"groups":["Mission Editing"]},{"name":"2D Editor: Take On Helicopters Sample Mission","title":"2D Editor: Take On Helicopters Sample Mission","type":"topic","url":"https://community.bistudio.com/wiki/2D_Editor:_Take_On_Helicopters_Sample_Mission","revid":347373,"updated":"2023-09-14T15:22:18Z","aliases":["Mission Editor: Sample Mission"],"markdown":"Take On Helicopters presents the players with a powerful - and sometimes overwhelming - Editor.\n\nThe 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.\n\n- Below you will find a step-by-step guide to creating sample mission 1\n- You can find and download the scenario itself [here](http://takeonthegame.com/take-on-editing/)!\n - *note, unzip the file, and put the directory:*\n\n ```\n SampleMission.United_States_H\n ```\n\n *into your TKOH user profile's mission directory:*\n\n ```\n [USER]\\Documents\\Take On Helicopters\\missions\\\n ```\n- We also used this scenario as the basis for a video guide, which you can find here: \n- Once you've completed part one, we've created sample mission 2\n - Part 2 builds upon this mission, and introduces more advanced techniques!\n\n### Sample Mission 1 - Guide\n\nTake On Helicopters: Sample Mission 1","sections":[{"heading":null,"level":1,"markdown":"Take On Helicopters presents the players with a powerful - and sometimes overwhelming - Editor.\n\nThe 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.\n\n- Below you will find a step-by-step guide to creating sample mission 1\n- You can find and download the scenario itself [here](http://takeonthegame.com/take-on-editing/)!\n - *note, unzip the file, and put the directory:*\n\n ```\n SampleMission.United_States_H\n ```\n\n *into your TKOH user profile's mission directory:*\n\n ```\n [USER]\\Documents\\Take On Helicopters\\missions\\\n ```\n- We also used this scenario as the basis for a video guide, which you can find here: \n- Once you've completed part one, we've created sample mission 2\n - Part 2 builds upon this mission, and introduces more advanced techniques!"},{"heading":"Sample Mission 1 - Guide","level":3,"markdown":"Take On Helicopters: Sample Mission 1"}],"categories":["2D Editor"],"groups":["Mission Editing"]},{"name":"2D Editor: Triggers","title":"2D Editor: Triggers","type":"topic","url":"https://community.bistudio.com/wiki/2D_Editor:_Triggers","revid":353555,"updated":"2024-03-19T12:01:39Z","aliases":["Mission Editor: Triggers"],"markdown":"A trigger is an abstract game entity that will wait until it is condition block returns true, then carry out the *On Activation* string. When used effectively, they can make your mission seem much more dynamic and realistic. For example, you can use a trigger to set off a siren and call reinforcements when the player is spotted near an enemy base, or to start a convoy moving when the player gives a radio command. Triggers are represented in the mission editor by a dark blue ellipse or rectangle with a small blue flag in the centre. Triggers may be linked to an object in Groups Mode (F2), which generally means that only that object or group can activate the trigger. Triggers can be used in various ways, for example the location and dimensions of a trigger are not always used as part of it is conditions, and triggers do not necessarily require an *On Activation* block, instead being used to return a list of objects that satisfy it is conditions. Each trigger's *Condition* block will be checked approximately twice every second for the duration of the mission. To add a new trigger to your mission, double left click in some empty map space. The *Trigger Menu* will open.\n\n### Menu\n\n#### Axis a/Axis b\n\nThese two controls define the radius size of the trigger, in metres. If a trigger has not been rotated (angle = 0), then Axis a is aligned East-West, Axis b is North to South.\n\n#### Angle\n\nDefines the angle of the trigger. 0 faces north, 90 faces east, etc. Triggers can also be rotated on the map by holding down shift, the left clicking on the trigger and dragging.\n\n#### Ellipse/Rectangle\n\nChoose the shape of the trigger.\n\n#### Activation\n\nThese options provide a graphical method of creating a trigger condition. The chosen *Activation* option generally combines with selected condition type from the six condition types below (*Present*, *Not Present*, *Detected by West*, etc). Some of these conditions can not be easily or efficiently recreated using script commands. Note that these options only define what value *this* (in the condition string) will have each time the trigger is checked. Choose who or what will activate the trigger from the drop down menu. If the trigger is linked to a unit, only the relevant options will be available. You may choose :\n\n- **None** - The trigger can still be activated when the *Condition* string returns true, but in this case *this* will always return false.\n- **** - Which of the sides will activate the trigger when any unit of that side satisfies the currently chosen one of the six conditions below.\n- **Radio ** - The trigger will be activated by a radio command available to all players leader of a group or possess a radio. Activation of radio triggers can be limited to specific players using the setRadioMsg command. Radio triggers do not make use of the six type conditions below, or wait for the Countdown/Timeout Counters!\n- **Seized by ** - Will activate when the seizing side is deemed to be in control of the area. This trigger type works with the *Timeout Counter* values - a low level of dominance will activate the trigger after a period of time close to the max timeout, and visa versa. Depending on unit types, the seizing side can be completely outnumbered (4:1) and still satisfy the minimum required level of presence for the Maximum timeout counter. This trigger type can also be used with the any *Detected By * option, meaning only units known to the *Detected By* side will be considered by the seized by calculation. This can easily create some interesting area domination effects. For example, a *Seized by BLUFOR* trigger using the *Detected By BLUFOR* option will activate when BLUFOR think they have seized the area, while the same trigger using *Detected by OPFOR* option will activate when OPFOR think BLUFOR have seized the area. The *Not Present* option inverts the triggers normal behaviour (ie, Not Seized by ).\n- **Vehicle** - This option is only available if the trigger is linked to an unit, vehicle or object. Only that entity can activate the trigger when it satisfies whichever of the six conditions below is being used.\n- **Whole Group** - This option is only available if the trigger is linked to a unit. The trigger will activate when the linked unit's entire group satisfy whichever of the six conditions below is being used.\n- **Group Leader** - This option is only available if the trigger is linked to a unit. The trigger will activate when the linked unit's group leader satisfies whichever of the six conditions below is being used.\n- **Any Group Member** - Again, this option only available if the trigger is linked to a unit. The trigger will activate when any single unit in the unit's group satisfies whichever of the six conditions below is being used.\n\n#### Once/Repeatedly\n\nDefines how many times the trigger can be activated. Only repeatable triggers can deactivate, single use triggers will remain active forever. Most repeatable triggers can only be reactivated once they have deactivated (radio triggers do not follow this rule).\n\n#### Present/Not Present\n\nIf the activator is a side or object, the trigger will be activated if that side/object is or is not present within the trigger's boundaries. To be considered present, an object must be alive/undestroyed.\n\n#### Detected By \n\nA unit is considered detected when the leader of any group on the detecting side can correctly identify the detected units side. Depending on the type of unit being detected, this may occur at various knowsAbout levels. The *Seized by * Activation type also use these options, see above for details.\n\n#### Countdown/Timeout Counters\n\nThese counters can add a degree of randomness to a trigger, and can make the trigger's activation less obvious to the player. For example, player immersion can be destroyed by a \"enemy not present\" trigger that completes an objective the very microsecond the bullet strikes the last enemy unit.\n\n- **Countdown** - Once the trigger's conditions are met, the trigger will activate after the specified amount of time has elapsed. The activation conditions do not need to remain satisfied during this time.\n- **Timeout** - The trigger's conditions must be satisfied for the entirety of specified amount of time for the trigger to activate. For example, if a soldier walks into a * Present* type trigger but leaves the area before the timeout is complete, the trigger will not activate.\n\nBelow the *Countdown* and *Timeout* buttons you will see three boxes; *Min*, *Max* and *Mid*.\nThese define the period of trigger activity in seconds between the Min and Max values, gravitating towards the Mid value.\nIf all three are set to 10, then the period would be 10 seconds, with no randomness. If Min was 5, Max was 15 and Mid 10, the period would be somewhere between 5 and 15 seconds, most likely being close to 10.\n\n#### Type\n\nThese are several types of trigger activation effects and abstract types that are generally unavailable through script code.\nThese events will take place immediately after the *On Activation* code block is executed.\n\n- **None** - The trigger will have no other effects other than those listed in the *On Activation* block. This is the default.\n\n- **Guarded by (side)** - The trigger's centre point will define a point to be guarded. If the trigger is group linked to an object, it will be moved to that object's initial position during mission initialization. Guarded triggers do not activate, they only define guard points. Groups who are in *Guard* waypoint induced guard mode will move to the first placed (highest priority) available unguarded guard point. If an enemy unit is detected by any unit on the guarding group's side ***anywhere*** on the map, the group that is guarding the lowest priority guard point will leave their guard point to attack. Note they react over any distance, even if they are not capable of damaging the detected object. Also the normal *Detected by* rules do not apply - an unarmed man can detect a tank for the purposes of guarding. See the *Guard* waypoint type for more details. See also: Waypoint:Guard.\n\n- **Switch** - A switch trigger is very useful for \"breaking\" a group out of a *Cycle* waypoint loop, or moving the group away from a *Hold* or *Guard* waypoint. When the trigger is synchronized with a waypoint, activating the trigger will instantly change the group's current waypoint to the first waypoint after the synchronized one. Note the synchronized waypoint's *On Activation* block is not executed.\n\n- **End <#>** - Will cause the mission to end once the conditions are met. There are 6 different winning endings, each with a different possible debriefing text. Different endings to a mission can also lead the player down a different \"branch\" of a campaign.\n\n- **Lose** - Activating a trigger of this type will end the mission in failure. Note this is not the same as the death of the player. If the mission is part of a campaign, the campaign can continue along the defined losing mission branch.\n\n#### Name\n\nDefines the name of the trigger, allowing it to be manipulated by script code.\nIt must comply with normal variable name rules (no spaces, reserved characters or reserved words allowed, warnings may not be given!).\n\n#### Text\n\nIf the trigger is activated by a radio command, this text will replace the default radio command name in both the command menu and on the radio visible on the mission map.\nThis text will also be displayed within the editor when the mouse cursor hovers over the trigger, allowing the user to quickly identify what the trigger is and does.\n\n#### Condition\n\nThe trigger will activate when this script code block returns true. If you leave the *Condition* box blank, the trigger will never activate.\nWithin this block *this* refers to a boolean defined by whether the conditions chosen within the *Activation* options above are currently true or false, and *thisList* (or list ) refers to an array of objects that are currently inside the trigger area and satisfy the trigger's *Activation* conditions, and *thisTrigger* refers to the trigger itself.\nNote that *thisList* does **not** always refer to units that are activating the trigger.\nTwo exceptions are the *Not Present* condition, which is returns the same list as if it were a *Present* type (ie, returns objects of the chosen side that are inside the trigger) and the *Seized by * trigger, which returns all units that are considered when calculating dominance (ie, if the *Detected by* side thinks that a unit is still within the trigger even though it is not, it will still be included in thisList).\nUsing script code in the Condition box allows the creation of more complex trigger activation requirements, including multiple and/or conditions.\nThe trigger checks the condition approximately once every 0.501239 seconds (averaged over 10,000 checks).\n\n#### On Act(ivation)\n\nThis script code block will be executed when the trigger's conditions are met, so long as the trigger's type allows activation.\nAny actions defined by the trigger's *Type* will take place immediately after this activation block begins executing.\nWithin the *On Activation* block, *this* is always false, *thisList* refers to the same array as it does in the *Condition* block above, and *thisTrigger* refers to the trigger itself like above. Any expressions in the On Act field must return nothing, or an error message will prevent the trigger dialogue from closing.\n\n#### On Dea(ctivation)\n\nA script code block that will be executed the first time a repeatable trigger's conditions check returns false after having been previously true.\nOnly repeatable triggers deactivate. *Radio * types do not deactivate, or at least never execute *On Deactivation* block. Other than in the *On Activation* block, the special variables *thisList* and *this* are undefined in the *On Deactivation* block.\nAny expressions in the On Dea field must return nothing, or an error message will prevent the trigger dialogue from closing.\n\n#### Effects\n\nClick on this button to open the Trigger Effects menu. It allows for the easy creation of some audio and visual effects that will be carried out immediately after the trigger's *On Activation* code block.\nMore than one effect may be used at once. Note that most if not all of the effects in this menu could be created using script code in the *On Activation* block.\n\n##### Condition Block (untitled)\n\nThe script code block at the top of the Effects menu can be used to require a condition that must be satisfied in order to execute the chosen effects.\nThe block must return *true* in order for the chosen effects to take place. This block is checked after the trigger's *On Activation* code block is executed.\n\n##### Anonymous\n\nThis drop down list allows you to play an anonymous vocal sample. The audio will seem to be coming from a nearby source to all players in the mission, irrespective of their position.\nSome of these sounds do not have a text description.\n\n##### Voice\n\nThis drop down list causes the trigger to play a vocal sample.\nThe audio will seem to be coming from close to the entity that activated the trigger, or if the trigger is linked to a group, the unit will speak the vocal sample (with lip movement).\nSome of these sounds do not have a text description.\n\n##### Environment\n\nThis list allows you to play the chosen environmental sound-scape sounds for the duration of a mission.\nSince the normal environmental sounds are chosen dynamically based upon the player's position, time and weather, this option is unlikely to be of any use other than testing.\n**(NEEDS CONFIRMATION - does it stop?)**\n\n##### Trigger\n\nThe chosen sound effect will play. The sound source is at the centre of the trigger.\n\n##### Track\n\nThe chosen music track will play once when the trigger activates, immediately halting any previously playing music.\n\n##### Type\n\nDefines the creation of one of the following types of visual effects:\n\n- **Object** - This is apparently used to create a pre-defined 3d object in front of the player's field of vision.\n- **Resource** - This can be used to display pre-defined graphical resources over the player's field of vision. This resource can be chosen from the *Text* drop down menu below.\n- **Text** - will display the text entered in the *Text* box below, in the style chosen in the *Effect* menu. This effect is identical to the cutText script code command.\n- **Effect** - Will only have an effect if *Type* is not \"NONE\", and the *Text* box is not empty. It creates the same visual screen effect as the cutText command would given the same type.\n\n##### Text\n\nThis option will only be available if *Type* is not set to \"None\". It will either behave as a drop-down list of available Resource or Object types, or a box in which to enter text.\n\n### Scripting\n\nSee Command Group: Triggers for list of all triggers-related commands.","sections":[{"heading":null,"level":1,"markdown":"A trigger is an abstract game entity that will wait until it is condition block returns true, then carry out the *On Activation* string. When used effectively, they can make your mission seem much more dynamic and realistic. For example, you can use a trigger to set off a siren and call reinforcements when the player is spotted near an enemy base, or to start a convoy moving when the player gives a radio command. Triggers are represented in the mission editor by a dark blue ellipse or rectangle with a small blue flag in the centre. Triggers may be linked to an object in Groups Mode (F2), which generally means that only that object or group can activate the trigger. Triggers can be used in various ways, for example the location and dimensions of a trigger are not always used as part of it is conditions, and triggers do not necessarily require an *On Activation* block, instead being used to return a list of objects that satisfy it is conditions. Each trigger's *Condition* block will be checked approximately twice every second for the duration of the mission. To add a new trigger to your mission, double left click in some empty map space. The *Trigger Menu* will open."},{"heading":"Menu","level":3,"markdown":""},{"heading":"Axis a/Axis b","level":4,"markdown":"These two controls define the radius size of the trigger, in metres. If a trigger has not been rotated (angle = 0), then Axis a is aligned East-West, Axis b is North to South."},{"heading":"Angle","level":4,"markdown":"Defines the angle of the trigger. 0 faces north, 90 faces east, etc. Triggers can also be rotated on the map by holding down shift, the left clicking on the trigger and dragging."},{"heading":"Ellipse/Rectangle","level":4,"markdown":"Choose the shape of the trigger."},{"heading":"Activation","level":4,"markdown":"These options provide a graphical method of creating a trigger condition. The chosen *Activation* option generally combines with selected condition type from the six condition types below (*Present*, *Not Present*, *Detected by West*, etc). Some of these conditions can not be easily or efficiently recreated using script commands. Note that these options only define what value *this* (in the condition string) will have each time the trigger is checked. Choose who or what will activate the trigger from the drop down menu. If the trigger is linked to a unit, only the relevant options will be available. You may choose :\n\n- **None** - The trigger can still be activated when the *Condition* string returns true, but in this case *this* will always return false.\n- **** - Which of the sides will activate the trigger when any unit of that side satisfies the currently chosen one of the six conditions below.\n- **Radio ** - The trigger will be activated by a radio command available to all players leader of a group or possess a radio. Activation of radio triggers can be limited to specific players using the setRadioMsg command. Radio triggers do not make use of the six type conditions below, or wait for the Countdown/Timeout Counters!\n- **Seized by ** - Will activate when the seizing side is deemed to be in control of the area. This trigger type works with the *Timeout Counter* values - a low level of dominance will activate the trigger after a period of time close to the max timeout, and visa versa. Depending on unit types, the seizing side can be completely outnumbered (4:1) and still satisfy the minimum required level of presence for the Maximum timeout counter. This trigger type can also be used with the any *Detected By * option, meaning only units known to the *Detected By* side will be considered by the seized by calculation. This can easily create some interesting area domination effects. For example, a *Seized by BLUFOR* trigger using the *Detected By BLUFOR* option will activate when BLUFOR think they have seized the area, while the same trigger using *Detected by OPFOR* option will activate when OPFOR think BLUFOR have seized the area. The *Not Present* option inverts the triggers normal behaviour (ie, Not Seized by ).\n- **Vehicle** - This option is only available if the trigger is linked to an unit, vehicle or object. Only that entity can activate the trigger when it satisfies whichever of the six conditions below is being used.\n- **Whole Group** - This option is only available if the trigger is linked to a unit. The trigger will activate when the linked unit's entire group satisfy whichever of the six conditions below is being used.\n- **Group Leader** - This option is only available if the trigger is linked to a unit. The trigger will activate when the linked unit's group leader satisfies whichever of the six conditions below is being used.\n- **Any Group Member** - Again, this option only available if the trigger is linked to a unit. The trigger will activate when any single unit in the unit's group satisfies whichever of the six conditions below is being used."},{"heading":"Once/Repeatedly","level":4,"markdown":"Defines how many times the trigger can be activated. Only repeatable triggers can deactivate, single use triggers will remain active forever. Most repeatable triggers can only be reactivated once they have deactivated (radio triggers do not follow this rule)."},{"heading":"Present/Not Present","level":4,"markdown":"If the activator is a side or object, the trigger will be activated if that side/object is or is not present within the trigger's boundaries. To be considered present, an object must be alive/undestroyed."},{"heading":"Detected By ","level":4,"markdown":"A unit is considered detected when the leader of any group on the detecting side can correctly identify the detected units side. Depending on the type of unit being detected, this may occur at various knowsAbout levels. The *Seized by * Activation type also use these options, see above for details."},{"heading":"Countdown/Timeout Counters","level":4,"markdown":"These counters can add a degree of randomness to a trigger, and can make the trigger's activation less obvious to the player. For example, player immersion can be destroyed by a \"enemy not present\" trigger that completes an objective the very microsecond the bullet strikes the last enemy unit.\n\n- **Countdown** - Once the trigger's conditions are met, the trigger will activate after the specified amount of time has elapsed. The activation conditions do not need to remain satisfied during this time.\n- **Timeout** - The trigger's conditions must be satisfied for the entirety of specified amount of time for the trigger to activate. For example, if a soldier walks into a * Present* type trigger but leaves the area before the timeout is complete, the trigger will not activate.\n\nBelow the *Countdown* and *Timeout* buttons you will see three boxes; *Min*, *Max* and *Mid*.\nThese define the period of trigger activity in seconds between the Min and Max values, gravitating towards the Mid value.\nIf all three are set to 10, then the period would be 10 seconds, with no randomness. If Min was 5, Max was 15 and Mid 10, the period would be somewhere between 5 and 15 seconds, most likely being close to 10."},{"heading":"Type","level":4,"markdown":"These are several types of trigger activation effects and abstract types that are generally unavailable through script code.\nThese events will take place immediately after the *On Activation* code block is executed.\n\n- **None** - The trigger will have no other effects other than those listed in the *On Activation* block. This is the default.\n\n- **Guarded by (side)** - The trigger's centre point will define a point to be guarded. If the trigger is group linked to an object, it will be moved to that object's initial position during mission initialization. Guarded triggers do not activate, they only define guard points. Groups who are in *Guard* waypoint induced guard mode will move to the first placed (highest priority) available unguarded guard point. If an enemy unit is detected by any unit on the guarding group's side ***anywhere*** on the map, the group that is guarding the lowest priority guard point will leave their guard point to attack. Note they react over any distance, even if they are not capable of damaging the detected object. Also the normal *Detected by* rules do not apply - an unarmed man can detect a tank for the purposes of guarding. See the *Guard* waypoint type for more details. See also: Waypoint:Guard.\n\n- **Switch** - A switch trigger is very useful for \"breaking\" a group out of a *Cycle* waypoint loop, or moving the group away from a *Hold* or *Guard* waypoint. When the trigger is synchronized with a waypoint, activating the trigger will instantly change the group's current waypoint to the first waypoint after the synchronized one. Note the synchronized waypoint's *On Activation* block is not executed.\n\n- **End <#>** - Will cause the mission to end once the conditions are met. There are 6 different winning endings, each with a different possible debriefing text. Different endings to a mission can also lead the player down a different \"branch\" of a campaign.\n\n- **Lose** - Activating a trigger of this type will end the mission in failure. Note this is not the same as the death of the player. If the mission is part of a campaign, the campaign can continue along the defined losing mission branch."},{"heading":"Name","level":4,"markdown":"Defines the name of the trigger, allowing it to be manipulated by script code.\nIt must comply with normal variable name rules (no spaces, reserved characters or reserved words allowed, warnings may not be given!)."},{"heading":"Text","level":4,"markdown":"If the trigger is activated by a radio command, this text will replace the default radio command name in both the command menu and on the radio visible on the mission map.\nThis text will also be displayed within the editor when the mouse cursor hovers over the trigger, allowing the user to quickly identify what the trigger is and does."},{"heading":"Condition","level":4,"markdown":"The trigger will activate when this script code block returns true. If you leave the *Condition* box blank, the trigger will never activate.\nWithin this block *this* refers to a boolean defined by whether the conditions chosen within the *Activation* options above are currently true or false, and *thisList* (or list ) refers to an array of objects that are currently inside the trigger area and satisfy the trigger's *Activation* conditions, and *thisTrigger* refers to the trigger itself.\nNote that *thisList* does **not** always refer to units that are activating the trigger.\nTwo exceptions are the *Not Present* condition, which is returns the same list as if it were a *Present* type (ie, returns objects of the chosen side that are inside the trigger) and the *Seized by * trigger, which returns all units that are considered when calculating dominance (ie, if the *Detected by* side thinks that a unit is still within the trigger even though it is not, it will still be included in thisList).\nUsing script code in the Condition box allows the creation of more complex trigger activation requirements, including multiple and/or conditions.\nThe trigger checks the condition approximately once every 0.501239 seconds (averaged over 10,000 checks)."},{"heading":"On Act(ivation)","level":4,"markdown":"This script code block will be executed when the trigger's conditions are met, so long as the trigger's type allows activation.\nAny actions defined by the trigger's *Type* will take place immediately after this activation block begins executing.\nWithin the *On Activation* block, *this* is always false, *thisList* refers to the same array as it does in the *Condition* block above, and *thisTrigger* refers to the trigger itself like above. Any expressions in the On Act field must return nothing, or an error message will prevent the trigger dialogue from closing."},{"heading":"On Dea(ctivation)","level":4,"markdown":"A script code block that will be executed the first time a repeatable trigger's conditions check returns false after having been previously true.\nOnly repeatable triggers deactivate. *Radio * types do not deactivate, or at least never execute *On Deactivation* block. Other than in the *On Activation* block, the special variables *thisList* and *this* are undefined in the *On Deactivation* block.\nAny expressions in the On Dea field must return nothing, or an error message will prevent the trigger dialogue from closing."},{"heading":"Effects","level":4,"markdown":"Click on this button to open the Trigger Effects menu. It allows for the easy creation of some audio and visual effects that will be carried out immediately after the trigger's *On Activation* code block.\nMore than one effect may be used at once. Note that most if not all of the effects in this menu could be created using script code in the *On Activation* block."},{"heading":"Condition Block (untitled)","level":5,"markdown":"The script code block at the top of the Effects menu can be used to require a condition that must be satisfied in order to execute the chosen effects.\nThe block must return *true* in order for the chosen effects to take place. This block is checked after the trigger's *On Activation* code block is executed."},{"heading":"Anonymous","level":5,"markdown":"This drop down list allows you to play an anonymous vocal sample. The audio will seem to be coming from a nearby source to all players in the mission, irrespective of their position.\nSome of these sounds do not have a text description."},{"heading":"Voice","level":5,"markdown":"This drop down list causes the trigger to play a vocal sample.\nThe audio will seem to be coming from close to the entity that activated the trigger, or if the trigger is linked to a group, the unit will speak the vocal sample (with lip movement).\nSome of these sounds do not have a text description."},{"heading":"Environment","level":5,"markdown":"This list allows you to play the chosen environmental sound-scape sounds for the duration of a mission.\nSince the normal environmental sounds are chosen dynamically based upon the player's position, time and weather, this option is unlikely to be of any use other than testing.\n**(NEEDS CONFIRMATION - does it stop?)**"},{"heading":"Trigger","level":5,"markdown":"The chosen sound effect will play. The sound source is at the centre of the trigger."},{"heading":"Track","level":5,"markdown":"The chosen music track will play once when the trigger activates, immediately halting any previously playing music."},{"heading":"Type","level":5,"markdown":"Defines the creation of one of the following types of visual effects:\n\n- **Object** - This is apparently used to create a pre-defined 3d object in front of the player's field of vision.\n- **Resource** - This can be used to display pre-defined graphical resources over the player's field of vision. This resource can be chosen from the *Text* drop down menu below.\n- **Text** - will display the text entered in the *Text* box below, in the style chosen in the *Effect* menu. This effect is identical to the cutText script code command.\n- **Effect** - Will only have an effect if *Type* is not \"NONE\", and the *Text* box is not empty. It creates the same visual screen effect as the cutText command would given the same type."},{"heading":"Text","level":5,"markdown":"This option will only be available if *Type* is not set to \"None\". It will either behave as a drop-down list of available Resource or Object types, or a box in which to enter text."},{"heading":"Scripting","level":3,"markdown":"See Command Group: Triggers for list of all triggers-related commands."}],"categories":["2D Editor"],"groups":["Mission Editing"]},{"name":"2D Editor: Units","title":"2D Editor: Units","type":"topic","url":"https://community.bistudio.com/wiki/2D_Editor:_Units","revid":353522,"updated":"2024-03-19T12:01:21Z","aliases":["Mission Editor: Units"],"markdown":"Unit mode is used to add individual units, vehicles and objects on the map. To do so, double click on the empty space where you would like to add a unit. This will open the *Unit Dialogue*. You can also open the unit menu of an existing unit while in any editing mode other than waypoints by double clicking on the unit. Note that if there is no player unit on the map, the unit dialogue will only allow valid player units may be placed.\n\n### Menu\n\n#### Side\n\nThere are four sides to which units can be assigned to: *BLUFOR*, *OPFOR*, *Independent* and *Civilian*. *BLUFOR* and *OPFOR* will always start the mission as enemies. The *Independent* side's relations with the first two sides can be set on a mission by mission basis using the Intel Dialogue. The *Civilian* side will also inherit the friends and enemies of the *Independent* side. The difference is that the *Civilian* side are considered to be friends by all sides (killing civilians is bad!).\n\nOnce a player unit is on the map, *Game Logic* and *Empty* sides become available. The *Game Logic* side is used for abstract game logic objects, which among other uses can be used to create script like effects from within the mission editor. The *Empty* side includes empty versions of every side's vehicles, and map objects such ammo crates, sound sources, tents, flagpoles and fences. The side of an entity changes the available options is many other dialogues. It is not possible to change the side of an object once it has been placed. Player friendly units are represented by green icons, enemy units by red, *Civilian* and *Game Logic* units by blue, and *Empty* side objects by dark yellow.\n\n#### Faction\n\nEach of the playable sides (except Ambient Life) allows placement of units from several different factions. The faction an object belongs to limits the available units in the Unit selection box, generally to units belonging to specific nations.\n\n#### Class\n\nThis is the general type of entity you wish to place. The purpose of this class is to reduce the many hundreds of available entities into more easily searched groups. It is not related to any game config classes.\n\n#### Control\n\nDefines who controls the entity. This option is not available for *Game Logic* or *Empty* side objects. All non-player controlled units will be controlled by AI. If the selected object is a vehicles, extra options will become available.\n\n- **Non playable** - Self explanatory.\n- **Player (as *vehicle position*)** - This unit will be controlled in single player mode. There can only be one *Player* controlled unit on the map. The player's unit is marked by a red circular icon.\n- **Playable (as *vehicle position(s)*)** - Is used to define units that may be player controlled in multiplayer mode, and are available via *Team Switch* in single player mode. Playable units are marked by a magenta circular icon.\n\n#### Info Age\n\nDefines how long it has been since some unit belonging to the same side as player has seen this target. By default enemy units are not known unless somebody sees them (unknown). This way you can reveal some enemy unit to the center of the player. The impact of this value on AI behaviour is minimal, it influences mostly path-finding (AI groups try to avoid known enemies), to some extent it changes how fast will AI recognize the unit once they see it, and it may also cause AI center to send units which are available as guards (are ready at a guard waypoint).\n\n#### Vehicle Lock\n\nThis option is only functional if the selected object is a vehicle. It defines whether any player controlled unit or members of a group lead by a player can board the vehicle or not. Default is unlocked. Note that an AI leader will not understand that a player unit can not enter a locked vehicle, and script commands will not respect this setting.\n\n#### Rank\n\nThis defines the rank of the unit. The highest ranking unit in a group will normally be the group leader. Rank also has some affect on gameplay, such as highly ranked units being less likely to flee and more intimidating to enemy forces.\n\n#### Unit\n\nThis is the specific type of entity you want to place or edit. The options available in this list box depend on the chosen *Class*.\n\n#### Special\n\nDefines special placement options for the starting position for the unit at the very beginning of a mission. If the unit is part of a group, default AI behaviour will make it try to return to formation as soon as the mission begins.\n\n- **None** - If you wish the unit to begin the mission out of formation, choose 'None' from this list. It will start the mission at it is location in the mission editor.\n- **In Cargo** - If the unit's group possess a vehicle with empty cargo spaces, choosing \"In Cargo\" will place the unit in one of those cargo spaces. If no cargo seats are available, it will start at it is location in the mission editor as it would if it is special setting was *None*.\n- **Flying** - Aircraft units will begin the mission in the air, and in formation around the group leader irrespective of the unit's map position. If the unit can not fly, it will begin the mission as it would if it were *In Formation*.\n- **In Formation** - The unit will begin in formation around the group leader, irrespective of the unit's position in the mission editor.\n\n#### Name\n\nThe name of a unit can be used to refer to the object in script code. Like all variable names, the name must not contain any spaces or reserved characters. You should try to make it something meaningful and avoid conflicts. Note that if a variable exists with an identical name, no warning will be given and the name will refer to the variable first, rather than the named unit. If you copy and paste a named entity, the duplicate will be automatically have an underscore and number appended to it is name to avoid conflicts.\n\n#### Skill\n\nHighly skilled units can see farther, shoot more accurately and be generally more devious. At lowest skill units will be less observant, poor marksmen and generally stupid. Moving the slider to the right gives the unit a higher skill. Skill values set by the slider range between 0.2 and 1.\n\n#### Initialization\n\nAny script code placed in this box will be executed as the mission begins. Script code is extremely powerful and useful - it allows you to create many effects and change aspects of the mission that would not be possible using only the graphical interface of the mission editor. For example, to make a soldier begin the mission unarmed, add \"removeAllWeapons this\" (without the quotation marks) to it is initialization string. Any expressions in the initialization field must return nothing, or an error message will prevent the unit dialogue from closing.\nIn MP every init field is always run on every computer on every initialization - including JIP.\n\n#### Description\n\nThis text will appear next to the unit in the multiplayer unit selection screen.\n\n#### Health/Armour\n\nDefines how damaged the object is at the beginning of the mission. Moving the slider to the left makes it more damaged, up to a maximum of 0.97. Note that fully damaged units will begin the mission alive, then be instantaneously damaged. This means fully damaged soldiers will display a death animation, and vehicles will generally explode within 10 seconds of the mission starting.\n\n#### Fuel\n\nDefines how much fuel the object has, moving the slide left results in less fuel. This only has an effect on vehicles. Note that this setting does not change the amount of fuel cargo a refueling truck or petrol station holds. Use setFuelCargo for that purpose.\n\n#### Ammunition\n\nDefines how much ammunition the unit has at the start of the mission. Moving the slider left removes whole magazines for most units and removes individual rounds for single magazine weapons (such as the main tank cannon and aircraft missiles). This setting does not change the amount of ammunition cargo carried by a vehicle or ammunition crate.\n\n#### Azimut / Direction / Azimuth\n\nDefines which direction the unit will be facing. You can drag the pointer around the circle, or enter the desired bearing into the text box. If the unit is set to start *In Formation*, the unit will use the group leader's facing.\n\n#### Probability of Presence\n\nDefines how likely it is that the entity will exist each time the mission is played. This can be used to add a bit of randomness to missions. Moving the slider all the way to the right means the object will always be there, all the way to the left means the unit will never appear. Note the *Condition of Presence* must also return true if the entity is to appear in the mission.\n\n#### Condition of Presence\n\nThis is a script code condition which must return true in order for the object to appear in the mission. By default this reads \"true\" which means the object will appear as defined by it is *Probability of Presence*. For an example, if you wanted a unit to appear only if the mission is being played in Veteran mode, place \"!cadetMode\" (without quotation marks) in it is Condition of Presence box. A unit with a Condition of Presence that returns false will not exist in the mission, irrespective of its *Probability of Presence*.\n\n#### Placement Radius\n\nChanges the object's starting position to a random point within a circle of this radius, in metres. This can be used to add some randomness to your mission. For grouped units, the placement radius is only used by the group leader, and group members with a *Special* setting of *None* (or *In Cargo* for a group without suitable vehicle).\n\n#### Show Info (Take On Helicopters v1.00)\n\nDisplays description of currently selected entity, including map icon, command bar picture and author.","sections":[{"heading":null,"level":1,"markdown":"Unit mode is used to add individual units, vehicles and objects on the map. To do so, double click on the empty space where you would like to add a unit. This will open the *Unit Dialogue*. You can also open the unit menu of an existing unit while in any editing mode other than waypoints by double clicking on the unit. Note that if there is no player unit on the map, the unit dialogue will only allow valid player units may be placed."},{"heading":"Menu","level":3,"markdown":""},{"heading":"Side","level":4,"markdown":"There are four sides to which units can be assigned to: *BLUFOR*, *OPFOR*, *Independent* and *Civilian*. *BLUFOR* and *OPFOR* will always start the mission as enemies. The *Independent* side's relations with the first two sides can be set on a mission by mission basis using the Intel Dialogue. The *Civilian* side will also inherit the friends and enemies of the *Independent* side. The difference is that the *Civilian* side are considered to be friends by all sides (killing civilians is bad!).\n\nOnce a player unit is on the map, *Game Logic* and *Empty* sides become available. The *Game Logic* side is used for abstract game logic objects, which among other uses can be used to create script like effects from within the mission editor. The *Empty* side includes empty versions of every side's vehicles, and map objects such ammo crates, sound sources, tents, flagpoles and fences. The side of an entity changes the available options is many other dialogues. It is not possible to change the side of an object once it has been placed. Player friendly units are represented by green icons, enemy units by red, *Civilian* and *Game Logic* units by blue, and *Empty* side objects by dark yellow."},{"heading":"Faction","level":4,"markdown":"Each of the playable sides (except Ambient Life) allows placement of units from several different factions. The faction an object belongs to limits the available units in the Unit selection box, generally to units belonging to specific nations."},{"heading":"Class","level":4,"markdown":"This is the general type of entity you wish to place. The purpose of this class is to reduce the many hundreds of available entities into more easily searched groups. It is not related to any game config classes."},{"heading":"Control","level":4,"markdown":"Defines who controls the entity. This option is not available for *Game Logic* or *Empty* side objects. All non-player controlled units will be controlled by AI. If the selected object is a vehicles, extra options will become available.\n\n- **Non playable** - Self explanatory.\n- **Player (as *vehicle position*)** - This unit will be controlled in single player mode. There can only be one *Player* controlled unit on the map. The player's unit is marked by a red circular icon.\n- **Playable (as *vehicle position(s)*)** - Is used to define units that may be player controlled in multiplayer mode, and are available via *Team Switch* in single player mode. Playable units are marked by a magenta circular icon."},{"heading":"Info Age","level":4,"markdown":"Defines how long it has been since some unit belonging to the same side as player has seen this target. By default enemy units are not known unless somebody sees them (unknown). This way you can reveal some enemy unit to the center of the player. The impact of this value on AI behaviour is minimal, it influences mostly path-finding (AI groups try to avoid known enemies), to some extent it changes how fast will AI recognize the unit once they see it, and it may also cause AI center to send units which are available as guards (are ready at a guard waypoint)."},{"heading":"Vehicle Lock","level":4,"markdown":"This option is only functional if the selected object is a vehicle. It defines whether any player controlled unit or members of a group lead by a player can board the vehicle or not. Default is unlocked. Note that an AI leader will not understand that a player unit can not enter a locked vehicle, and script commands will not respect this setting."},{"heading":"Rank","level":4,"markdown":"This defines the rank of the unit. The highest ranking unit in a group will normally be the group leader. Rank also has some affect on gameplay, such as highly ranked units being less likely to flee and more intimidating to enemy forces."},{"heading":"Unit","level":4,"markdown":"This is the specific type of entity you want to place or edit. The options available in this list box depend on the chosen *Class*."},{"heading":"Special","level":4,"markdown":"Defines special placement options for the starting position for the unit at the very beginning of a mission. If the unit is part of a group, default AI behaviour will make it try to return to formation as soon as the mission begins.\n\n- **None** - If you wish the unit to begin the mission out of formation, choose 'None' from this list. It will start the mission at it is location in the mission editor.\n- **In Cargo** - If the unit's group possess a vehicle with empty cargo spaces, choosing \"In Cargo\" will place the unit in one of those cargo spaces. If no cargo seats are available, it will start at it is location in the mission editor as it would if it is special setting was *None*.\n- **Flying** - Aircraft units will begin the mission in the air, and in formation around the group leader irrespective of the unit's map position. If the unit can not fly, it will begin the mission as it would if it were *In Formation*.\n- **In Formation** - The unit will begin in formation around the group leader, irrespective of the unit's position in the mission editor."},{"heading":"Name","level":4,"markdown":"The name of a unit can be used to refer to the object in script code. Like all variable names, the name must not contain any spaces or reserved characters. You should try to make it something meaningful and avoid conflicts. Note that if a variable exists with an identical name, no warning will be given and the name will refer to the variable first, rather than the named unit. If you copy and paste a named entity, the duplicate will be automatically have an underscore and number appended to it is name to avoid conflicts."},{"heading":"Skill","level":4,"markdown":"Highly skilled units can see farther, shoot more accurately and be generally more devious. At lowest skill units will be less observant, poor marksmen and generally stupid. Moving the slider to the right gives the unit a higher skill. Skill values set by the slider range between 0.2 and 1."},{"heading":"Initialization","level":4,"markdown":"Any script code placed in this box will be executed as the mission begins. Script code is extremely powerful and useful - it allows you to create many effects and change aspects of the mission that would not be possible using only the graphical interface of the mission editor. For example, to make a soldier begin the mission unarmed, add \"removeAllWeapons this\" (without the quotation marks) to it is initialization string. Any expressions in the initialization field must return nothing, or an error message will prevent the unit dialogue from closing.\nIn MP every init field is always run on every computer on every initialization - including JIP."},{"heading":"Description","level":4,"markdown":"This text will appear next to the unit in the multiplayer unit selection screen."},{"heading":"Health/Armour","level":4,"markdown":"Defines how damaged the object is at the beginning of the mission. Moving the slider to the left makes it more damaged, up to a maximum of 0.97. Note that fully damaged units will begin the mission alive, then be instantaneously damaged. This means fully damaged soldiers will display a death animation, and vehicles will generally explode within 10 seconds of the mission starting."},{"heading":"Fuel","level":4,"markdown":"Defines how much fuel the object has, moving the slide left results in less fuel. This only has an effect on vehicles. Note that this setting does not change the amount of fuel cargo a refueling truck or petrol station holds. Use setFuelCargo for that purpose."},{"heading":"Ammunition","level":4,"markdown":"Defines how much ammunition the unit has at the start of the mission. Moving the slider left removes whole magazines for most units and removes individual rounds for single magazine weapons (such as the main tank cannon and aircraft missiles). This setting does not change the amount of ammunition cargo carried by a vehicle or ammunition crate."},{"heading":"Azimut / Direction / Azimuth","level":4,"markdown":"Defines which direction the unit will be facing. You can drag the pointer around the circle, or enter the desired bearing into the text box. If the unit is set to start *In Formation*, the unit will use the group leader's facing."},{"heading":"Probability of Presence","level":4,"markdown":"Defines how likely it is that the entity will exist each time the mission is played. This can be used to add a bit of randomness to missions. Moving the slider all the way to the right means the object will always be there, all the way to the left means the unit will never appear. Note the *Condition of Presence* must also return true if the entity is to appear in the mission."},{"heading":"Condition of Presence","level":4,"markdown":"This is a script code condition which must return true in order for the object to appear in the mission. By default this reads \"true\" which means the object will appear as defined by it is *Probability of Presence*. For an example, if you wanted a unit to appear only if the mission is being played in Veteran mode, place \"!cadetMode\" (without quotation marks) in it is Condition of Presence box. A unit with a Condition of Presence that returns false will not exist in the mission, irrespective of its *Probability of Presence*."},{"heading":"Placement Radius","level":4,"markdown":"Changes the object's starting position to a random point within a circle of this radius, in metres. This can be used to add some randomness to your mission. For grouped units, the placement radius is only used by the group leader, and group members with a *Special* setting of *None* (or *In Cargo* for a group without suitable vehicle)."},{"heading":"Show Info (Take On Helicopters v1.00)","level":4,"markdown":"Displays description of currently selected entity, including map icon, command bar picture and author."}],"categories":["2D Editor"],"groups":["Mission Editing"]},{"name":"2D Editor: Waypoints","title":"2D Editor: Waypoints","type":"topic","url":"https://community.bistudio.com/wiki/2D_Editor:_Waypoints","revid":353561,"updated":"2024-03-19T12:01:41Z","aliases":["Mission Editor: Waypoints"],"markdown":"Waypoints are used to define the route and behaviour of a group during the mission.\nAt any point in time a group will have one active waypoint (generally the waypoint they are to move towards).\nOnce a waypoint's conditions have been met, it will become complete and the group's next waypoint automatically becomes active.\nSome of a waypoint's settings will take place as the waypoint becomes active, others when the waypoint is complete.\n\nWaypoints are a property of their group - only one group can use each waypoint, and if that group is deleted all of its waypoints are deleted (both in the mission editor and in the mission).\nWaypoints can be placed either spatially (created in empty space), or attached to an object (directly placed on an object).\nWaypoints can only be attached to objects with a class definition (for example, all mission placed objects, and houses can be used, but rocks, fences and trees can not).\n\nSeveral waypoint types only function correctly if the waypoint is spatial, some only work if it is attached to an object, and others behave differently depending on the placement type.\nSpatial waypoints can be moved as desired in the same manner as moving units, while object linked waypoints remain attached to the object, even if the object moves while the mission is running.\nIt is interesting to note that a non-editable waypoint is automatically created at every group leader's initial position.\n\nWaypoints are represented by a black dot within a circle, joined together with black arrows.\nTo create a waypoint, first select any unit of the group you wish to create waypoints for. Then double left click in either empty space, or on the desired object.\nMultiple waypoints can be attached to the same object by holding down shift and double left clicking on the object.\nOnce a waypoint has been created, it is placement can not be swapped between a spatial waypoint and an attached waypoint (unless the attached object is deleted).\n\n> [!NOTE]\n> **Arma 3:** For information regarding Arma 3 and Eden Editor, refer to Eden Editor - Waypoints\n\n### Category (Take On Helicopters v1.00)\n\nFor Take On Helicopters, use to select between default engine waypoints and scripted waypoints provided by specific official or community projects.\nScripted waypoints can be added in *CfgWaypoints*.\n\n### Select Type\n\nDefines what happens when a waypoint's conditions was fullfilled. See Waypoints for a full list.\n\n### Waypoint Attributes\n\n#### Height (Take On Helicopters v1.00)\n\nSet waypoint height above terrain. AI will still behave as if waypoint would be placed on ground, but icon in player's view will be placed in correct height.\n\n#### Waypoint Order\n\nIn this drop down menu, you can choose the number that the currently edited waypoint will be. It is possible to insert a new waypoint between two existing waypoints by changing this to the desired waypoint number in the new waypoint's menu. The order in which existing waypoints will be carried out can also be changed.\n\n#### Description\n\nText in this box will be displayed on the HUD when the waypoint is currently active. If left blank, the waypoints type shall be used. When the group is close to the waypoint, but it requires conditions that are not satisfied to be completed, the HUD text will always change to \"Wait\".\n\n#### Combat Mode\n\nThe group's combat mode can be defined in this drop down box. Combat Modes change as the waypoint becomes the group's current active waypoint, rather than when the group completes the waypoint. Note if the group is lead by a player, these changes will not automatically take place. See Combat Modes for a list of combat modes and their descriptions.\n\n#### Formation\n\nThis will specify which formation the group should enter as the waypoint becomes active. Unless specified otherwise, all groups start a mission in the default formation *Wedge*. Formations are normally formed around unit 1 (normally also the group leader) and each unit will normally keep in the same formation position as his number. For these descriptions, infantry units have been used. As a rough guide, each adjacent land or sea vehicle seems to use an additional \"width\" spacing of approximately twice the normal spacing, and an additional three times the \"depth\" (behind or in front) spacing. Air units will keep about five times the width, and ten times the depth spacing. The effect is cumulative, so that two helicopters will keep twice as far apart as one helicopter will stay from one soldier. Some behaviour modes can override the formation setting. Some large formation types may have trouble moving through object rich areas such as towns.\n\n- **No Change** - The group will continue under with it is current formation.\n- **Column** - The group will line up in a single file behind unit 1, five meters apart.\n- **Staggered Column** - The group will form into two columns separated by a width of five meters. The right column is staggered five meters behind the left, unit 1 leads the left column.\n- **Wedge** - The group will form into a wedge shape, with unit 1 at the forward point. Each following unit will stay five meters behind and five meters further left or right from the man in front. All even units will be on the right side of the formation leader, all odd units on the left.\n- **Echelon L(eft)** - The group will form into a line behind and to the left of unit 1. Each unit is five meters behind and further left than the previous unit.\n- **Echelon R(ight)** - Same as Echelon L(eft), except the formation will be to the right.\n- **Vee** - Similar to *Wedge*, but inversed. Each unit stands five meters in front of and further to the left or right of the nearest man.\n- **Line** - The group will form a line perpendicular to the facing of unit 1. Each man stands five meters apart.\n- **Delta** - This formation will form into three columns behind the formation leader. The outside columns are each 2.5 meters behind the middle column and 2.5 meters to either side.**Not in Arma 3**\n- **Column (compact)/File** - This formation is the same as *Column*, except only 2.5 meters between each unit.\n\n##### Formation preview pictures (Arma 3)\n\n#### Speed\n\nThis setting will define the movement speed of the group. Changes will take place as the waypoint becomes active, rather than when the waypoint is completed.\nIn *Normal* or *Limited* mode, the group leader will slow his movement rate to allow his units to keep up with the formation.\nNote that a leader in an aircraft will not be able to move slowly enough to allow slow ground units to keep up.\n\n- **No Change** - Group will continue moving in it is current speed mode\n- **Limited** - Soldiers will walk to their destination. Vehicles will move at a low speed.\n- **Normal** - This is the default movement speed. Soldiers will jog, vehicles move at moderate speed.\n- **Full** - The group leader will move as quickly as possible to the waypoint. He will make no effort to slow himself down to allow the formation to keep up. Any units that might be able to travel faster than the leader will not do so, instead they will stay in formation.\n\n#### Behaviour\n\nFor more information about behaviour, see AI Behaviour.\n\n#### Placement Radius\n\nThis option works in a similar way to a objects placement radius. The waypoint will be placed at random within a circle of the given radius, in meters.\nNote that the waypoint's position is set during mission initialization, so a group that uses a *Cycle* loop to go to a waypoint with a placement radius more than once will always move to the same location. If the waypoint is attached to an object, the waypoint HUD marker will appear at a random location for players, until they know of the object it is attached to, when the HUD marker will reposition itself onto the object.\nAI leaders will always move directly to the object.\n\n#### Completion Radius (Arma 2 v1.00 Arma 2: Operation Arrowhead v1.50 Take On Helicopters v1.00)\n\nThe distance to the waypoint at which the waypoint is considered as reached/completed.\nThis can be used to set a \"close enough\" range, so that the unit doesn't need to go right on top of the waypoint position/center.\nWhen the group leader is a player, the required distance to a waypoint in automatically increased compared to an AI leader.\n\n#### Position In House\n\nThis option is only available if the waypoint is attached to an object with a defined path \"Level Of Detail\" (LOD) with positions.\nMost enterable buildings should have these, and only infantry units can use them. The positions are often near doorways and windows, although since the numbering system follows no simple rule a lot of trial and error will be needed to place the waypoint in the desire location.\nPath LODs allow units to ignore clipping, allowing them to walk through anything.\nIf you send a multi-unit group to a position, they will all move to that position, standing inside each other!\nA move type waypoint set to a building position will never be considered complete without scripting. More than one waypoint can be set on the same building.\n\nAs of the introduction of Eden in **Arma 3** this waypoint type is only available via scripting. see waypointAttachObject and setWaypointHousePosition\n\n#### Timeout Counters\n\nDespite it is name, this counter works in a similar manner to the Trigger *Countdown* counter.\nOnce the waypoint would normally be considered complete, the waypoint will wait for the specified time period before it becomes complete and the group is allowed to continue to the next waypoint.\nThe conditions of completion do **not** have to remain true for the duration of this time period.\nThe *Min*, *Mid* and *Max* fields define the possible delay in seconds between the Min and Max values, gravitating towards the Mid value.\nFor example, if all three values are set to 10, then the waypoint delay will always be 10 seconds, without any variation between mission play-throughs.\nIf Min was 5, Mid was 10 and Max 15, the delay would be somewhere between 5 and 15 seconds, most likely being close to 10.\n\n#### Condition\n\nThis script code block allows creation of additional conditions before the waypoint will be completed.\nWhile the block's return value is false, the waypoint's type will be changed to type \"Wait\", which can not be completed.\nThe group will move to the waypoints position (irrespective of whether they would normally do this for the waypoint's true type!), generally waiting until the *Condition* block returns true before carrying out the waypoint's type actions (but not for all types).\nIf the *Condition* block is left empty, the waypoint will never complete. Within the *Condition* block, *this* refers to the group leader, and *thisList* refers to an array containing each unit in the group.\n\n#### On Activation\n\nAnother script code block, executed when the waypoint is completed. Within this block, *this* refers to the group leader, and *thisList* refers to an array containing each unit in the group.\nAny expressions in the On Act. field must return nothing, or an error message will prevent the waypoint dialogue from closing.\n\n#### Script\n\nThis block will only be used if the waypoint is of type *Scripted*. See that waypoint type description above for details.\n\n#### Never Show/Show in Cadet/Always Show\n\nChoose whether or not you wish this specific waypoint to visible on the mission map during gameplay. Waypoints will only be visible to units within their group.\nIf any waypoint is shown, the group leader's initial position in the mission editor will also be drawn (this position is set before any changes made during initialization take place).\nLines are drawn between the shown waypoints, irrespective of how many non-shown waypoints lie between them.\n\n#### Effects\n\nThe waypoint effects menu allows for audio and visual effects to be created as the waypoint is completed, immediately after the trigger's *On Activation* code block is executed.\nThe menu is almost identical to the Trigger Effects menu.\n\n#### Scripting\n\nSee Command Group: Waypoints for list of all waypoints-related commands.\n\n### See Also\n\n- Waypoints\n- Eden Editor: Waypoint","sections":[{"heading":null,"level":1,"markdown":"Waypoints are used to define the route and behaviour of a group during the mission.\nAt any point in time a group will have one active waypoint (generally the waypoint they are to move towards).\nOnce a waypoint's conditions have been met, it will become complete and the group's next waypoint automatically becomes active.\nSome of a waypoint's settings will take place as the waypoint becomes active, others when the waypoint is complete.\n\nWaypoints are a property of their group - only one group can use each waypoint, and if that group is deleted all of its waypoints are deleted (both in the mission editor and in the mission).\nWaypoints can be placed either spatially (created in empty space), or attached to an object (directly placed on an object).\nWaypoints can only be attached to objects with a class definition (for example, all mission placed objects, and houses can be used, but rocks, fences and trees can not).\n\nSeveral waypoint types only function correctly if the waypoint is spatial, some only work if it is attached to an object, and others behave differently depending on the placement type.\nSpatial waypoints can be moved as desired in the same manner as moving units, while object linked waypoints remain attached to the object, even if the object moves while the mission is running.\nIt is interesting to note that a non-editable waypoint is automatically created at every group leader's initial position.\n\nWaypoints are represented by a black dot within a circle, joined together with black arrows.\nTo create a waypoint, first select any unit of the group you wish to create waypoints for. Then double left click in either empty space, or on the desired object.\nMultiple waypoints can be attached to the same object by holding down shift and double left clicking on the object.\nOnce a waypoint has been created, it is placement can not be swapped between a spatial waypoint and an attached waypoint (unless the attached object is deleted).\n\n> [!NOTE]\n> **Arma 3:** For information regarding Arma 3 and Eden Editor, refer to Eden Editor - Waypoints"},{"heading":"Category (Take On Helicopters v1.00)","level":3,"markdown":"For Take On Helicopters, use to select between default engine waypoints and scripted waypoints provided by specific official or community projects.\nScripted waypoints can be added in *CfgWaypoints*."},{"heading":"Select Type","level":3,"markdown":"Defines what happens when a waypoint's conditions was fullfilled. See Waypoints for a full list."},{"heading":"Waypoint Attributes","level":3,"markdown":""},{"heading":"Height (Take On Helicopters v1.00)","level":4,"markdown":"Set waypoint height above terrain. AI will still behave as if waypoint would be placed on ground, but icon in player's view will be placed in correct height."},{"heading":"Waypoint Order","level":4,"markdown":"In this drop down menu, you can choose the number that the currently edited waypoint will be. It is possible to insert a new waypoint between two existing waypoints by changing this to the desired waypoint number in the new waypoint's menu. The order in which existing waypoints will be carried out can also be changed."},{"heading":"Description","level":4,"markdown":"Text in this box will be displayed on the HUD when the waypoint is currently active. If left blank, the waypoints type shall be used. When the group is close to the waypoint, but it requires conditions that are not satisfied to be completed, the HUD text will always change to \"Wait\"."},{"heading":"Combat Mode","level":4,"markdown":"The group's combat mode can be defined in this drop down box. Combat Modes change as the waypoint becomes the group's current active waypoint, rather than when the group completes the waypoint. Note if the group is lead by a player, these changes will not automatically take place. See Combat Modes for a list of combat modes and their descriptions."},{"heading":"Formation","level":4,"markdown":"This will specify which formation the group should enter as the waypoint becomes active. Unless specified otherwise, all groups start a mission in the default formation *Wedge*. Formations are normally formed around unit 1 (normally also the group leader) and each unit will normally keep in the same formation position as his number. For these descriptions, infantry units have been used. As a rough guide, each adjacent land or sea vehicle seems to use an additional \"width\" spacing of approximately twice the normal spacing, and an additional three times the \"depth\" (behind or in front) spacing. Air units will keep about five times the width, and ten times the depth spacing. The effect is cumulative, so that two helicopters will keep twice as far apart as one helicopter will stay from one soldier. Some behaviour modes can override the formation setting. Some large formation types may have trouble moving through object rich areas such as towns.\n\n- **No Change** - The group will continue under with it is current formation.\n- **Column** - The group will line up in a single file behind unit 1, five meters apart.\n- **Staggered Column** - The group will form into two columns separated by a width of five meters. The right column is staggered five meters behind the left, unit 1 leads the left column.\n- **Wedge** - The group will form into a wedge shape, with unit 1 at the forward point. Each following unit will stay five meters behind and five meters further left or right from the man in front. All even units will be on the right side of the formation leader, all odd units on the left.\n- **Echelon L(eft)** - The group will form into a line behind and to the left of unit 1. Each unit is five meters behind and further left than the previous unit.\n- **Echelon R(ight)** - Same as Echelon L(eft), except the formation will be to the right.\n- **Vee** - Similar to *Wedge*, but inversed. Each unit stands five meters in front of and further to the left or right of the nearest man.\n- **Line** - The group will form a line perpendicular to the facing of unit 1. Each man stands five meters apart.\n- **Delta** - This formation will form into three columns behind the formation leader. The outside columns are each 2.5 meters behind the middle column and 2.5 meters to either side.**Not in Arma 3**\n- **Column (compact)/File** - This formation is the same as *Column*, except only 2.5 meters between each unit."},{"heading":"Formation preview pictures (Arma 3)","level":5,"markdown":""},{"heading":"Speed","level":4,"markdown":"This setting will define the movement speed of the group. Changes will take place as the waypoint becomes active, rather than when the waypoint is completed.\nIn *Normal* or *Limited* mode, the group leader will slow his movement rate to allow his units to keep up with the formation.\nNote that a leader in an aircraft will not be able to move slowly enough to allow slow ground units to keep up.\n\n- **No Change** - Group will continue moving in it is current speed mode\n- **Limited** - Soldiers will walk to their destination. Vehicles will move at a low speed.\n- **Normal** - This is the default movement speed. Soldiers will jog, vehicles move at moderate speed.\n- **Full** - The group leader will move as quickly as possible to the waypoint. He will make no effort to slow himself down to allow the formation to keep up. Any units that might be able to travel faster than the leader will not do so, instead they will stay in formation."},{"heading":"Behaviour","level":4,"markdown":"For more information about behaviour, see AI Behaviour."},{"heading":"Placement Radius","level":4,"markdown":"This option works in a similar way to a objects placement radius. The waypoint will be placed at random within a circle of the given radius, in meters.\nNote that the waypoint's position is set during mission initialization, so a group that uses a *Cycle* loop to go to a waypoint with a placement radius more than once will always move to the same location. If the waypoint is attached to an object, the waypoint HUD marker will appear at a random location for players, until they know of the object it is attached to, when the HUD marker will reposition itself onto the object.\nAI leaders will always move directly to the object."},{"heading":"Completion Radius (Arma 2 v1.00 Arma 2: Operation Arrowhead v1.50 Take On Helicopters v1.00)","level":4,"markdown":"The distance to the waypoint at which the waypoint is considered as reached/completed.\nThis can be used to set a \"close enough\" range, so that the unit doesn't need to go right on top of the waypoint position/center.\nWhen the group leader is a player, the required distance to a waypoint in automatically increased compared to an AI leader."},{"heading":"Position In House","level":4,"markdown":"This option is only available if the waypoint is attached to an object with a defined path \"Level Of Detail\" (LOD) with positions.\nMost enterable buildings should have these, and only infantry units can use them. The positions are often near doorways and windows, although since the numbering system follows no simple rule a lot of trial and error will be needed to place the waypoint in the desire location.\nPath LODs allow units to ignore clipping, allowing them to walk through anything.\nIf you send a multi-unit group to a position, they will all move to that position, standing inside each other!\nA move type waypoint set to a building position will never be considered complete without scripting. More than one waypoint can be set on the same building.\n\nAs of the introduction of Eden in **Arma 3** this waypoint type is only available via scripting. see waypointAttachObject and setWaypointHousePosition"},{"heading":"Timeout Counters","level":4,"markdown":"Despite it is name, this counter works in a similar manner to the Trigger *Countdown* counter.\nOnce the waypoint would normally be considered complete, the waypoint will wait for the specified time period before it becomes complete and the group is allowed to continue to the next waypoint.\nThe conditions of completion do **not** have to remain true for the duration of this time period.\nThe *Min*, *Mid* and *Max* fields define the possible delay in seconds between the Min and Max values, gravitating towards the Mid value.\nFor example, if all three values are set to 10, then the waypoint delay will always be 10 seconds, without any variation between mission play-throughs.\nIf Min was 5, Mid was 10 and Max 15, the delay would be somewhere between 5 and 15 seconds, most likely being close to 10."},{"heading":"Condition","level":4,"markdown":"This script code block allows creation of additional conditions before the waypoint will be completed.\nWhile the block's return value is false, the waypoint's type will be changed to type \"Wait\", which can not be completed.\nThe group will move to the waypoints position (irrespective of whether they would normally do this for the waypoint's true type!), generally waiting until the *Condition* block returns true before carrying out the waypoint's type actions (but not for all types).\nIf the *Condition* block is left empty, the waypoint will never complete. Within the *Condition* block, *this* refers to the group leader, and *thisList* refers to an array containing each unit in the group."},{"heading":"On Activation","level":4,"markdown":"Another script code block, executed when the waypoint is completed. Within this block, *this* refers to the group leader, and *thisList* refers to an array containing each unit in the group.\nAny expressions in the On Act. field must return nothing, or an error message will prevent the waypoint dialogue from closing."},{"heading":"Script","level":4,"markdown":"This block will only be used if the waypoint is of type *Scripted*. See that waypoint type description above for details."},{"heading":"Never Show/Show in Cadet/Always Show","level":4,"markdown":"Choose whether or not you wish this specific waypoint to visible on the mission map during gameplay. Waypoints will only be visible to units within their group.\nIf any waypoint is shown, the group leader's initial position in the mission editor will also be drawn (this position is set before any changes made during initialization take place).\nLines are drawn between the shown waypoints, irrespective of how many non-shown waypoints lie between them."},{"heading":"Effects","level":4,"markdown":"The waypoint effects menu allows for audio and visual effects to be created as the waypoint is completed, immediately after the trigger's *On Activation* code block is executed.\nThe menu is almost identical to the Trigger Effects menu."},{"heading":"Scripting","level":4,"markdown":"See Command Group: Waypoints for list of all waypoints-related commands."},{"heading":"See Also","level":3,"markdown":"- Waypoints\n- Eden Editor: Waypoint"}],"categories":["2D Editor"],"groups":["Mission Editing"]},{"name":"A3 Launcher","title":"A3 Launcher","type":"topic","url":"https://community.bistudio.com/wiki/A3_Launcher","revid":364284,"updated":"2024-05-06T09:38:35Z","aliases":[],"markdown":"#### Basic information\n\n**Author:** Bohemia Interactive\n\n**Version:** 1.3\n\n**Compatibility:** Arma 3\n\n**Download:** Part of Arma 3 package on Steam\n\n#### Description\n\n**Description:**\n\nLauncher is a new interface to run the game and manage [Steam Workshop](http://steamcommunity.com/workshop/browse/?appid=107410) addons.\nThe purpose of this tool is to simplify start-up parameters, game options and manage mods. Read detailed documentation here: Arma 3: Launcher.\n\n#### Usage\n\n**Line call:** arma3launcher.exe\n\n**Examples:** arma3launcher.exe\n\n#### Licenses\n\n**Licensing:** Bohemia Interactive End User License Agreement\n\n**See also:** Addon Builder, Publisher, Arma 3: Launcher","sections":[{"heading":"Basic information","level":4,"markdown":"**Author:** Bohemia Interactive\n\n**Version:** 1.3\n\n**Compatibility:** Arma 3\n\n**Download:** Part of Arma 3 package on Steam"},{"heading":"Description","level":4,"markdown":"**Description:**\n\nLauncher is a new interface to run the game and manage [Steam Workshop](http://steamcommunity.com/workshop/browse/?appid=107410) addons.\nThe purpose of this tool is to simplify start-up parameters, game options and manage mods. Read detailed documentation here: Arma 3: Launcher."},{"heading":"Usage","level":4,"markdown":"**Line call:** arma3launcher.exe\n\n**Examples:** arma3launcher.exe"},{"heading":"Licenses","level":4,"markdown":"**Licensing:** Bohemia Interactive End User License Agreement\n\n**See also:** Addon Builder, Publisher, Arma 3: Launcher"}],"categories":["Arma 3: Official Tools"],"groups":["Tools and File Formats"]},{"name":"Addon Builder","title":"Addon Builder","type":"topic","url":"https://community.bistudio.com/wiki/Addon_Builder","revid":341605,"updated":"2023-06-10T09:16:42Z","aliases":[],"markdown":"#### Basic information\n\n**Author:** Bohemia Interactive\n\n**Compatibility:** Arma 3\n\n**Download:** [Part of Arma 3 Tools package on Steam](http://store.steampowered.com/app/233800/)\n\n#### Description\n\n**Description:**\n\nAddon Builder is a packing tool created by Bohemia Interactive.\nThe purpose of this tool is to convert all data into formats readable by the Real Virtuality engine and pack them into a single archive. The tool was formerly known as BinPBO.\n\n#### Usage\n\n**Line call:**\n\nAddonBuilder.exe\nAddonBuilder.exe -help\n\n**Options:**\n\nAddon Builder can used in console mode with the following parameters:\n\n- -packonly: only stores the folder to a PBO. Do NOT binarize files. I.e. binarization is default behavior\n- -clear: before binarizing, the content of subfolder for the current project is deleted.\n- -temp: path for the folder which stores binarized files, default destination is temp in Windows, if no value is present then the last folder is used, if you use the same folder, the next time you binarize the same addon it will take less time.\n- -prefix: relative path to files used in addon, if not present then this value is calculated automatically.\n- -project: path to folder where project starts from, if you are packing only the path of a project. It is recommended to use the same as the source path or to define it accordingly to the need. In case it is defined to P:, Binarize will process the entire P: drive which takes time.\n- -sign: *.biprivatekey file with signature, addons created with a signature can be added to secure servers.\n- -include: directly copy matched files to PBO. absolute path to file with wildcard patterns. separator is ';' and ','.\n- -binarize: path to binarize tool. default is used if not specified.\n- -cfgconvert: path to cfg convert tool. default is used if not specified.\n- -filebank: path to filebank tool. default is used if not specified.\n- -dssignfile: path to DssignFile tool. default is used if not specified.\n\n> [!NOTE]\n> Be aware that arguments are case sensitive. `-packonly` will work, but `-packOnly` will not.\n\nexample: c:\\addon d:\\addon_build -clear -sign=c:\\keys\\bistudio.biprivatekey -project=c: -include=c:\\include.txt -binarize=c:\\mybinarize.exe\n\n#### Licenses\n\n**Licensing:** Bohemia Interactive End User License Agreement\n\n**See also:** BinPBO\n\n#### Options\n\n##### Clear temp folder\n\nThis checkbox in main screen of the interface allows user to pack clean data without any interference. Packing takes longer after cleaning temp folder, but data cannot be affected by previous versions. Use this regularly if you pack data referencing other addons to ensure everything is correctly referenced.\n\n##### Create signature\n\nUse this option to create digital signatures of the PBOs using digital key defined in options. Use DSCreateKey to create the key to work with.\n\n##### Binarize\n\nThis option allows you to convert possible files in addon into format readable by RV Engine. Leave this checked most of the time unless you want to publish the MLODs for some reason for example.\n\n##### List of files to copy directly\n\nThis is list of files (with possible use of wild-cards) to copy directly from source directory to the packed addon. Some files are added by default and the rest has to be mentioned in here.\n\n##### Addon prefix\n\nUse this option to set the path prefix to the structure of the addon.\n\n##### Path to signature file\n\nUse this path to a key if you want to sign your PBO with digital signature, leave it empty otherwise.\n\n##### Path to temporary folder\n\nThe addon is going to be processed in temporary folder during its building, the folder is set to the Windows temporary folder by default. You may want to clean the folder by Clear temp folder option in main menu of the Addon Builder.\n\n##### Path to project folder\n\nIs the same as path to source directory by default, may be set to different values to enable linking from different addons. Note, in some case, it can be the parent of the project folder, e.g. P:\\ for a mod located in P:\\A3\n\nIt is recommended to use the same as the source path or to define it accordingly to the need. In case it is defined to P:, Binarize will process the entire P: drive which takes time.\n\n##### Exclusion pattern file\n\nFile which contains list of file pattern which shouldn't included in the resulting PBO. An examples of exclusion file can be found in the folder of FileBank.","sections":[{"heading":"Basic information","level":4,"markdown":"**Author:** Bohemia Interactive\n\n**Compatibility:** Arma 3\n\n**Download:** [Part of Arma 3 Tools package on Steam](http://store.steampowered.com/app/233800/)"},{"heading":"Description","level":4,"markdown":"**Description:**\n\nAddon Builder is a packing tool created by Bohemia Interactive.\nThe purpose of this tool is to convert all data into formats readable by the Real Virtuality engine and pack them into a single archive. The tool was formerly known as BinPBO."},{"heading":"Usage","level":4,"markdown":"**Line call:**\n\nAddonBuilder.exe\nAddonBuilder.exe -help\n\n**Options:**\n\nAddon Builder can used in console mode with the following parameters:\n\n- -packonly: only stores the folder to a PBO. Do NOT binarize files. I.e. binarization is default behavior\n- -clear: before binarizing, the content of subfolder for the current project is deleted.\n- -temp: path for the folder which stores binarized files, default destination is temp in Windows, if no value is present then the last folder is used, if you use the same folder, the next time you binarize the same addon it will take less time.\n- -prefix: relative path to files used in addon, if not present then this value is calculated automatically.\n- -project: path to folder where project starts from, if you are packing only the path of a project. It is recommended to use the same as the source path or to define it accordingly to the need. In case it is defined to P:, Binarize will process the entire P: drive which takes time.\n- -sign: *.biprivatekey file with signature, addons created with a signature can be added to secure servers.\n- -include: directly copy matched files to PBO. absolute path to file with wildcard patterns. separator is ';' and ','.\n- -binarize: path to binarize tool. default is used if not specified.\n- -cfgconvert: path to cfg convert tool. default is used if not specified.\n- -filebank: path to filebank tool. default is used if not specified.\n- -dssignfile: path to DssignFile tool. default is used if not specified.\n\n> [!NOTE]\n> Be aware that arguments are case sensitive. `-packonly` will work, but `-packOnly` will not.\n\nexample: c:\\addon d:\\addon_build -clear -sign=c:\\keys\\bistudio.biprivatekey -project=c: -include=c:\\include.txt -binarize=c:\\mybinarize.exe"},{"heading":"Licenses","level":4,"markdown":"**Licensing:** Bohemia Interactive End User License Agreement\n\n**See also:** BinPBO"},{"heading":"Options","level":4,"markdown":""},{"heading":"Clear temp folder","level":5,"markdown":"This checkbox in main screen of the interface allows user to pack clean data without any interference. Packing takes longer after cleaning temp folder, but data cannot be affected by previous versions. Use this regularly if you pack data referencing other addons to ensure everything is correctly referenced."},{"heading":"Create signature","level":5,"markdown":"Use this option to create digital signatures of the PBOs using digital key defined in options. Use DSCreateKey to create the key to work with."},{"heading":"Binarize","level":5,"markdown":"This option allows you to convert possible files in addon into format readable by RV Engine. Leave this checked most of the time unless you want to publish the MLODs for some reason for example."},{"heading":"List of files to copy directly","level":5,"markdown":"This is list of files (with possible use of wild-cards) to copy directly from source directory to the packed addon. Some files are added by default and the rest has to be mentioned in here."},{"heading":"Addon prefix","level":5,"markdown":"Use this option to set the path prefix to the structure of the addon."},{"heading":"Path to signature file","level":5,"markdown":"Use this path to a key if you want to sign your PBO with digital signature, leave it empty otherwise."},{"heading":"Path to temporary folder","level":5,"markdown":"The addon is going to be processed in temporary folder during its building, the folder is set to the Windows temporary folder by default. You may want to clean the folder by Clear temp folder option in main menu of the Addon Builder."},{"heading":"Path to project folder","level":5,"markdown":"Is the same as path to source directory by default, may be set to different values to enable linking from different addons. Note, in some case, it can be the parent of the project folder, e.g. P:\\ for a mod located in P:\\A3\n\nIt is recommended to use the same as the source path or to define it accordingly to the need. In case it is defined to P:, Binarize will process the entire P: drive which takes time."},{"heading":"Exclusion pattern file","level":5,"markdown":"File which contains list of file pattern which shouldn't included in the resulting PBO. An examples of exclusion file can be found in the folder of FileBank."}],"categories":["Arma 3: Official Tools"],"groups":["Tools and File Formats"]},{"name":"Addons","title":"Addons","type":"topic","url":"https://community.bistudio.com/wiki/Addons","revid":364737,"updated":"2024-06-03T07:37:04Z","aliases":[],"markdown":"**Addons** are content additions to the game engine.\n**Addons** can take many forms such as **weapons**, **buildings**, **vehicles** to name a few, are developed and released by members of the Bohemia Interactive community or by Bohemia Interactive themselves.\n\nAn **addon** is an archive (pbo) of files that the game loads at startup.\nGenerally when most people think of addons, they immediately think of a new unit, or a new terrain, but in some cases an addon can contain only a `config.cpp` file and a few scripts, or some images.\n\n### Installation\n\nThere comes a time when you've downloaded so many addons from the Internet and plunked them in your `~\\addons` folder, that eventually, can cause a clash between one addon and another.\nWhat Bohemia Interactive has done is introducing mod folders to separate addons into different folders. The **mod folders** is the method that should be used when testing out new addons.\n\nAlways review the included ReadMe file for further information about the installation of an addon.\n\n#### Arma 3\n\n- **Addons**\n must be installed into a custom modfolder. It is not recommended to place addons into the original Addons folder. Mods can also be installed from the Steam Workshop.\n\n##### Steam Workshop\n\nArma 3 has introduced a new way of publishing, browsing and installing mods: [Steam Workshop](http://steamcommunity.com/workshop/browse?appid=107410).\nThere are two main parts to using Workshop: Publisher to publish addons into Steam Cloud and Arma 3: Launcher to download and/or update mods and launch the game with a selected set.\n\nA typical use for **mods** case is:\n\n- Creator publishes file to Steam Workshop using Publisher. He adds a tag *mod* to the published file.\n- User browses Steam Workshop and subscribes to content he likes.\n- Arma 3: Launcher downloads and updates the subscribed mods (it only shows files with a steam tag *mod*).\n- User can select which mods to load into the game.\n\nA typical use for **scenarios** is:\n\n- Creator publishes a scenario from in-game editor. Editor auto-adds the tag *scenarios*.\n- User browses Steam Workshop and subscribes to content he likes.\n- Steam downloads and updates the subscribed scenarios. They are accessible in-game from Play/Scenarios/Steam subscribed content (only content with a tag *scenario* is displayed here).\n\n#### Arma 2\n\n- **Addons**\n must be installed into a custom modfolder. It is not recommended to place addons into the original Addons folder.\n\n#### Armed Assault\n\n- **Addons**\n must be installed to *\"Addons\"* or *\"ArmA\\Addons\"* or into a custom modfolder. It is not recommended to place addons into the original Addons folder.\n\n#### Operation Flashpoint\n\n- **Addons**\n must be installed to *\"...directory\\Operation Flashpoint\\Addons\"* or *\"...directory\\Operation Flashpoint\\Res\\Addons\"* or into a custom modfolder.\n- **Custom Animations**\n must be installed to *\"...directory\\Operation Flashpoint\\dta\\\"* (overwrite existing Anim.pbo) or *\"...directory\\Operation Flashpoint\\Res\\dta\\\"* (overwrite existing Anim.pbo) or into a custom modfolder (*\"...directory\\Operation Flashpoint\\modfolder\\dta\\\"*).\n The original Anim.pbo can be restored from the Resistance CD.\n- **Custom Campaigns**\n must be installed to *\"...directory\\Operation Flashpoint\\Campaigns\\\"* or *\"...directory\\Operation Flashpoint\\Res\\Campaigns\\\"* or into a custom modfolder (*\"...directory\\Operation Flashpoint\\modfolder\\Campaigns\\\"*).\n This only works with campaigns. Single missions have to be installed to *\"...directory\\Operation Flashpoint\\Missions\\\"*.\n- **Mods**\n mostly come with an installer and create their own modfolder.\n- **Custom Skies**\n mostly come with an installer and create their own modfolder.\n\n### Creation\n\nSee the Bohemia Interactive games's categories below for more information.\n\n- Operation Flashpoint: Editing\n- ArmA: Armed Assault: Addon Editing\n- Arma 2: Editing\n- Arma 3: Editing","sections":[{"heading":null,"level":1,"markdown":"**Addons** are content additions to the game engine.\n**Addons** can take many forms such as **weapons**, **buildings**, **vehicles** to name a few, are developed and released by members of the Bohemia Interactive community or by Bohemia Interactive themselves.\n\nAn **addon** is an archive (pbo) of files that the game loads at startup.\nGenerally when most people think of addons, they immediately think of a new unit, or a new terrain, but in some cases an addon can contain only a `config.cpp` file and a few scripts, or some images."},{"heading":"Installation","level":3,"markdown":"There comes a time when you've downloaded so many addons from the Internet and plunked them in your `~\\addons` folder, that eventually, can cause a clash between one addon and another.\nWhat Bohemia Interactive has done is introducing mod folders to separate addons into different folders. The **mod folders** is the method that should be used when testing out new addons.\n\nAlways review the included ReadMe file for further information about the installation of an addon."},{"heading":"Arma 3","level":4,"markdown":"- **Addons**\n must be installed into a custom modfolder. It is not recommended to place addons into the original Addons folder. Mods can also be installed from the Steam Workshop."},{"heading":"Steam Workshop","level":5,"markdown":"Arma 3 has introduced a new way of publishing, browsing and installing mods: [Steam Workshop](http://steamcommunity.com/workshop/browse?appid=107410).\nThere are two main parts to using Workshop: Publisher to publish addons into Steam Cloud and Arma 3: Launcher to download and/or update mods and launch the game with a selected set.\n\nA typical use for **mods** case is:\n\n- Creator publishes file to Steam Workshop using Publisher. He adds a tag *mod* to the published file.\n- User browses Steam Workshop and subscribes to content he likes.\n- Arma 3: Launcher downloads and updates the subscribed mods (it only shows files with a steam tag *mod*).\n- User can select which mods to load into the game.\n\nA typical use for **scenarios** is:\n\n- Creator publishes a scenario from in-game editor. Editor auto-adds the tag *scenarios*.\n- User browses Steam Workshop and subscribes to content he likes.\n- Steam downloads and updates the subscribed scenarios. They are accessible in-game from Play/Scenarios/Steam subscribed content (only content with a tag *scenario* is displayed here)."},{"heading":"Arma 2","level":4,"markdown":"- **Addons**\n must be installed into a custom modfolder. It is not recommended to place addons into the original Addons folder."},{"heading":"Armed Assault","level":4,"markdown":"- **Addons**\n must be installed to *\"Addons\"* or *\"ArmA\\Addons\"* or into a custom modfolder. It is not recommended to place addons into the original Addons folder."},{"heading":"Operation Flashpoint","level":4,"markdown":"- **Addons**\n must be installed to *\"...directory\\Operation Flashpoint\\Addons\"* or *\"...directory\\Operation Flashpoint\\Res\\Addons\"* or into a custom modfolder.\n- **Custom Animations**\n must be installed to *\"...directory\\Operation Flashpoint\\dta\\\"* (overwrite existing Anim.pbo) or *\"...directory\\Operation Flashpoint\\Res\\dta\\\"* (overwrite existing Anim.pbo) or into a custom modfolder (*\"...directory\\Operation Flashpoint\\modfolder\\dta\\\"*).\n The original Anim.pbo can be restored from the Resistance CD.\n- **Custom Campaigns**\n must be installed to *\"...directory\\Operation Flashpoint\\Campaigns\\\"* or *\"...directory\\Operation Flashpoint\\Res\\Campaigns\\\"* or into a custom modfolder (*\"...directory\\Operation Flashpoint\\modfolder\\Campaigns\\\"*).\n This only works with campaigns. Single missions have to be installed to *\"...directory\\Operation Flashpoint\\Missions\\\"*.\n- **Mods**\n mostly come with an installer and create their own modfolder.\n- **Custom Skies**\n mostly come with an installer and create their own modfolder."},{"heading":"Creation","level":3,"markdown":"See the Bohemia Interactive games's categories below for more information.\n\n- Operation Flashpoint: Editing\n- ArmA: Armed Assault: Addon Editing\n- Arma 2: Editing\n- Arma 3: Editing"}],"categories":["ArmA: Armed Assault: Addon Editing","Arma 2: Editing","Arma 3: Editing","Operation Flashpoint: Editing","Take On Helicopters: Editing"],"groups":["Modding"]},{"name":"AI Behaviour","title":"AI Behaviour","type":"topic","url":"https://community.bistudio.com/wiki/AI_Behaviour","revid":372967,"updated":"2025-03-02T17:42:48Z","aliases":["AIBehaviour","Arma 3 AI Behavior","Arma 3: AI Behavior"],"markdown":"A group's behaviour determines how its units move from one point to another, behave when idle, and how they engage an enemy. This setting can override Combat Mode, Formation, and Speed. As with those three modes, this setting also takes effect as the waypoint becomes active. Behaviour effects are most obvious in infantry groups.\n\nThe setBehaviour and setWaypointBehaviour commands can be used to change group behaviour.\n\n- **No Change** - The group will continue to behave in its current state.\n- **Careless** - Careless behaviour will cause the group to move and behave in a very non-combat manner. The group will form into a *Compact Column*-like formation, where each unit will directly follow the man in front rather than moving in a formation. Soldiers will carry their weapons in a safe, lowered position (rifles across body, pistols holstered) and walk slowly. Infantry will not fire on enemy targets (unless they have wounded legs), but vehicles will still fire on enemies. Vehicle occupants will be turned out when able. Groups in careless mode do not switch to a more alert mode if enemies are encountered. All unit types show preference moving along roads whenever possible.\n- **Safe** - Similar to *Careless*, except the group will change behaviour to *Aware* upon detecting an enemy unit.\n- **Aware** - This is the default behaviour mode. The group will move at moderate speed, with soldiers generally standing upright and making some occasional efforts to use cover when available. Most unit types still prefer to travel along roads and vehicles will travel in convoy irrespective of their current formation type. Tracked vehicles will not use headlights, and will drive across any surface with no preference given to staying on roads. Air units will not use lights. When enemies are known to be in the area, troops will disembark from any of their group's wheeled transport vehicles and the group will move on foot while carrying out \"[bounding](https://en.wikipedia.org/wiki/Bounding_Overwatch)\" maneuvers, making stronger use of available cover. As of Arma 3 v1.36, AI Infantry appear to avoid being on the road directly, but will usually stay somewhat close to the road if possible.\n- **Combat** - This behaviour mode will result in a much higher combat performance than *Aware*. Infantry groups will always move using bounding maneuvers, and will normally keep crouched or prone unless moving. They will make some use of available cover, choosing to spend some time crawling when in cover. They will call out contact reports more frequently. They seem to occasionally send out one unit ahead of the group as a scout. No vehicles will use headlights at night. If enemy units are known to be in the area, infantry groups will move is a more cautious manner. The \"DISMISS\" waypoint is cancelled. All lights are turned off. The limited speed waypoint parameter gets ignored. AI will eject from damaged vehicles. As of Arma 3 v1.36, AI seem to take about a full minute to get across roads.\n- **Stealth** - Stealth mode will cause a group to behave in a very cautious manner. Infantry groups will move via cover whenever possible, spending much of their time prone or moving along cover. When they need to cross open ground, they appear to occasionally choose to send scouts running ahead to reach the cover ahead as quickly as possible. A stealthy infantry formation can tend to end up quite fractured. Wheeled vehicles will still follow roads if available, but no longer convoy. Tanks will avoid knocking down trees. If enemy units are known to be in the area, infantry groups will move more closely together and spend even more time prone.","sections":[{"heading":null,"level":1,"markdown":"A group's behaviour determines how its units move from one point to another, behave when idle, and how they engage an enemy. This setting can override Combat Mode, Formation, and Speed. As with those three modes, this setting also takes effect as the waypoint becomes active. Behaviour effects are most obvious in infantry groups.\n\nThe setBehaviour and setWaypointBehaviour commands can be used to change group behaviour.\n\n- **No Change** - The group will continue to behave in its current state.\n- **Careless** - Careless behaviour will cause the group to move and behave in a very non-combat manner. The group will form into a *Compact Column*-like formation, where each unit will directly follow the man in front rather than moving in a formation. Soldiers will carry their weapons in a safe, lowered position (rifles across body, pistols holstered) and walk slowly. Infantry will not fire on enemy targets (unless they have wounded legs), but vehicles will still fire on enemies. Vehicle occupants will be turned out when able. Groups in careless mode do not switch to a more alert mode if enemies are encountered. All unit types show preference moving along roads whenever possible.\n- **Safe** - Similar to *Careless*, except the group will change behaviour to *Aware* upon detecting an enemy unit.\n- **Aware** - This is the default behaviour mode. The group will move at moderate speed, with soldiers generally standing upright and making some occasional efforts to use cover when available. Most unit types still prefer to travel along roads and vehicles will travel in convoy irrespective of their current formation type. Tracked vehicles will not use headlights, and will drive across any surface with no preference given to staying on roads. Air units will not use lights. When enemies are known to be in the area, troops will disembark from any of their group's wheeled transport vehicles and the group will move on foot while carrying out \"[bounding](https://en.wikipedia.org/wiki/Bounding_Overwatch)\" maneuvers, making stronger use of available cover. As of Arma 3 v1.36, AI Infantry appear to avoid being on the road directly, but will usually stay somewhat close to the road if possible.\n- **Combat** - This behaviour mode will result in a much higher combat performance than *Aware*. Infantry groups will always move using bounding maneuvers, and will normally keep crouched or prone unless moving. They will make some use of available cover, choosing to spend some time crawling when in cover. They will call out contact reports more frequently. They seem to occasionally send out one unit ahead of the group as a scout. No vehicles will use headlights at night. If enemy units are known to be in the area, infantry groups will move is a more cautious manner. The \"DISMISS\" waypoint is cancelled. All lights are turned off. The limited speed waypoint parameter gets ignored. AI will eject from damaged vehicles. As of Arma 3 v1.36, AI seem to take about a full minute to get across roads.\n- **Stealth** - Stealth mode will cause a group to behave in a very cautious manner. Infantry groups will move via cover whenever possible, spending much of their time prone or moving along cover. When they need to cross open ground, they appear to occasionally choose to send scouts running ahead to reach the cover ahead as quickly as possible. A stealthy infantry formation can tend to end up quite fractured. Wheeled vehicles will still follow roads if available, but no longer convoy. Tanks will avoid knocking down trees. If enemy units are known to be in the area, infantry groups will move more closely together and spend even more time prone."}],"categories":["AI"],"groups":["Configuration"]},{"name":"AI Group Vehicle Management","title":"AI Group Vehicle Management","type":"topic","url":"https://community.bistudio.com/wiki/AI_Group_Vehicle_Management","revid":330316,"updated":"2022-08-31T15:05:00Z","aliases":[],"markdown":"Real Virtuality games' AI groups all work the same way with vehicles. Aside from game-specific commands, this page applies from Operation Flashpoint to Arma 3.\n\n### System\n\n- A group has a \"vehicle pool\" that is an array of vehicles it can use. A group can \"own\" multiple vehicles.\n- A vehicle can be in the vehicle pool of **multiple groups** at once. A vehicle itself has no \"group pool\".\n\n- A vehicle can be added to a group with addVehicle.\n- A vehicle can be assigned (added) to a group with none of its units assigned to any of its vehicle role.\n - A group leader will most likely assign its units to the vehicle if need be.\n- A unit can be unassigned from its role from a vehicle with unassignVehicle. However, as the vehicle itself remains in the group's vehicle pool, the leader may at one point order the unit back in (a) seat.\n - To prevent a unit from being reassigned, allowGetIn can be used.\n- A vehicle can be removed from the group's vehicle pool with leaveVehicle, unassigning any units from their role in the process.\n\n#### AI Decisions\n\n- The AI choosing what vehicle to use based on the vehicle's cost value. The distance from the vehicle may also play a role.\n- When deciding whether to board a vehicle, AI leaders seem to only consider the transport benefit of a vehicle, ignoring any combat benefits the vehicle may provide.\n- An AI group leader can be forced to order his group to board the specified vehicle with orderGetIn true. Setting to false will cancel the order, but the AI will first enter to get out again immediately thereafter. To immediately (potentially temporarily) halt the AI moving to the vehicle one can use allowGetIn false.\n- When a vehicle is added this way, it can appear as a target for the enemy - even if the vehicle currently has no crew.Clarify\n- If used on a vehicle already driven by a member of another group, the driver will continue under his own group's orders, which may not benefit the addVehicle'd group.\n- Seems to have no affect on AI under player command - at least as long as the player remains the GL.Clarify\n\n### Commands\n\n#### Assign/MoveIn Commands (Unit specific)\n\n| assign setter commands | moveIn setter commands | assign getter commands |\n|---|---|---|\n| - assignAsDriver - assignAsGunner - assignAsCommander - assignAsTurret - assignAsCargo - assignAsCargoIndex - unassignVehicle | - moveInDriver - moveInGunner - moveInCommander - moveInTurret - moveInCargo - moveInAny - moveOut | - assignedVehicle - assignedVehicleRole |\n\n#### Other Commands (Group specific)\n\n- addVehicle\n- leaveVehicle\n\n#### Shared Commands\n\n- fullCrew Since Arma 3 v2.12 the output of the command includes vehicle's assigned units\n\n---\n\nfrom assignedVehicle\n\n- The assignment happens via the various assignAsXXX/moveInXXX commands, or player/AI GL getIn radio commands, getIn waypoint, or when units start in vehicles or get moved in to a vehicle by Zeus/via Eden.\n- addVehicle indirectly may also add the vehicle, however only if an AI GL assigns vehicle roles (which depends on various things).\n- vehicle returns the current vehicles an AI is in, while with assignedVehicle the AI may not (yet) be in the said vehicle (still in transit or held of by waypoints or other SQF commands).\n- To make AI under AI GL enter a vehicle, use orderGetIn true.\n- While unassignVehicle works, if the group is under AI command, the AI GL may re-assign the vehicle immediately. To stop the AI from re-entering at least, use orderGetIn or allowGetIn false, or permanently remove the assignment vi a leaveVehicle.\n- For player GL lead AI assignedVehicle seems not to be really reliable/behaves strange. Disembark radio command seems to unassign though.\n\nfrom assignedVehicleRole\n\n- When an unit enters a vehicle crew position, it gets assigned the vehicle role automatically for the given crew position.\n- The unit does not have to be in the vehicle when getting the role assignment (ie via assignAsXXX or human/AI GL getIn radio commands).\n- GL getIn radio commands result in instant assignment - the unit does not yet have to occupy the crew position.\n- Dying units will let go of the assigned role after a few seconds - seems the delay is independent of being in the vehicle or not.\n- An unit will hold on to its assigned role after exiting the vehicle.\n- One has to use unassignVehicle (and stop an AI GL to assign vehicle positions again) or leaveVehicle to remove the assignment - or assigned to another vehicle.\n- A vehicle position/role can only be assigned to one unit at a time. So even when not (visually) occupied, the \"seat\" may be blocked/reserved by another unit.\n- A player can still get into the vehicle position already assigned if not already taken, or switch seats with AI (if leader or effectiveCommander for those AI).\n\nfrom unassignVehicle\n\n- Important is to understand the basic system first:\n\n1. addVehicle creates a vehicle pool for the AI group to use.\n1. leaveVehicle removes a vehicle from the pool (and makes AI disembark when in that vehicle).\n1. However there is also assignedVehicle. This is about the *current vehicle in use* essentially. The assignment happens via the various assignAsXXX/moveInXXX commands, or player/AI GL getIn radio commands, getIn waypoint, or when units start in vehicles or get moved in to a vehicle by Zeus/via Eden.\n1. So the idea of unassignVehicle is to remove the *current vehicle in use*.\n1. However as long as the vehicle is still part of the vehicle pool of the group the AI GL may order the AI to re-enter the vehicle immediately.\n1. To stop this from happening, one can use orderGetIn/allowGetIn false to (temporarily) disallow the AI from entering any vehicle.\n\n- If you use leaveVehicle on an AI group not in the vehicle, only the AI GL will get the vehicle removed from assignedVehicle. However when you now apply unassignVehicle on the whole group, it will stick/the AI GL not order to re-enter immediately - as the AI GL no longer has the vehicle in his pool for the group.\n- For player GL lead AI, the command removes the assignment. However it won't make the AI disembark the vehicle.\n\nfrom orderGetIn\n\n- The command has no effect on AI lead by a player Group Leader (GL)\n- A vehicle needs be assigned via addVehicle or assignAsXXX or moveInXXX first for the command to have any effect. orderGetIn true makes the AI to board the vehicle. Or the AI GL orders them due to other means (ie getIn, guard waypoints).\n- However one can initially set orderGetIn false, add one or more vehicles and only once/when the AI is to enter, you set orderGetIn true for AI to start moving to the vehicle(s) or getting in the vehicle(s).\n- orderGetIn false makes AI also leave a vehicle when inside already. However it does not affect assignedVehicleRole nor assignedVehicle. Only leaveVehicle will remove both\n- orderGetIn false even makes AI eject while the vehicle positions are locked ((lockDriver, lockTurret, lockCargo - however orderGetIn true will not override the position lock to make them enter\n- AI units on the way to enter the vehicle won't stop on the way if orderGetIn false set but continue to the vehicle and just stop short without entering - allowGetIn false instead will make the AI stop instantly (same as unassignVehicle when combined with orderGetIn false)\n- One can combine orderGetIn false and allowGetIn false to manage when exactly AI is to enter vehicles\n- orderGetIn is persistent/a general group behavior setting - don't forget previous changes with future vehicle use!\n- If you want to make a vehicle no longer used by a group, you need to remove the vehicle from the group's vehicle pool via leaveVehicle.\n\n### Dis/Embarking Behaviour\n\n**Courtesy of ffur2007slx2_5**\n\n| Command | Remote Control | Behaviour | Role Unassigning |\n|---|---|---|---|\n| orderGetIn | ✗ | orderGetIn won't take effect on player controlled AI units, and which needs to be used together with assaignAs command family. Generally speaking, orderGetIn is a Role Excuator. | When orderGetIn was disabled it won't automatically unassign unit's vehicle role but will force the unit get out of the vehicle and stop him re-entering until it was enabled again. orderGetIn false won't stop a unit when he is embarking a vehicle in the half way but unassignVehicle will do. orderGetIn false will wait to fire until the unit enter a vehicle. |\n| allowGetIn | ✗ | allowGetIn won't take effect on player controlled AI units. Different from orderGetIn, this command is a Role Holder, it can control the unit's movement in the half way set by orderGetIn but not by setWaypointType, unit will be forced to get out from a vehicle by allowGetIn false and won't automatically re-enter the vehicle until allowGetIn true | allowGetIn won't do anything with unit's vehicle role |\n| doGetOut | ✓ | Works on player controlled ai silently, unit will automatically get back to the vehicle after disembarkation. (Unit won't get out until vehicle is stopped or landed) | false |\n| commandGetOut | ✓ | Same as doGetOut with radio message. (Unit won't get out until vehicle is stopped or landed) | false |\n| leaveVehicle | ✗ | leaveVehicle can't force a player controlled AI disembark | true |\n| action [\"GetOut\", _veh] | ✓ | Eject immediately without parachute | false |\n| action [\"Eject\", _veh] | ✓ | Eject immediately with parachute if needed | false |\n| setWaypointType \"GETIN\" | ✗ | Waypoint won't be affected by orderGetIn false or allowGetIn false until the unit is on the vehicle. | N/A |","sections":[{"heading":null,"level":1,"markdown":"Real Virtuality games' AI groups all work the same way with vehicles. Aside from game-specific commands, this page applies from Operation Flashpoint to Arma 3."},{"heading":"System","level":3,"markdown":"- A group has a \"vehicle pool\" that is an array of vehicles it can use. A group can \"own\" multiple vehicles.\n- A vehicle can be in the vehicle pool of **multiple groups** at once. A vehicle itself has no \"group pool\".\n\n- A vehicle can be added to a group with addVehicle.\n- A vehicle can be assigned (added) to a group with none of its units assigned to any of its vehicle role.\n - A group leader will most likely assign its units to the vehicle if need be.\n- A unit can be unassigned from its role from a vehicle with unassignVehicle. However, as the vehicle itself remains in the group's vehicle pool, the leader may at one point order the unit back in (a) seat.\n - To prevent a unit from being reassigned, allowGetIn can be used.\n- A vehicle can be removed from the group's vehicle pool with leaveVehicle, unassigning any units from their role in the process."},{"heading":"AI Decisions","level":4,"markdown":"- The AI choosing what vehicle to use based on the vehicle's cost value. The distance from the vehicle may also play a role.\n- When deciding whether to board a vehicle, AI leaders seem to only consider the transport benefit of a vehicle, ignoring any combat benefits the vehicle may provide.\n- An AI group leader can be forced to order his group to board the specified vehicle with orderGetIn true. Setting to false will cancel the order, but the AI will first enter to get out again immediately thereafter. To immediately (potentially temporarily) halt the AI moving to the vehicle one can use allowGetIn false.\n- When a vehicle is added this way, it can appear as a target for the enemy - even if the vehicle currently has no crew.Clarify\n- If used on a vehicle already driven by a member of another group, the driver will continue under his own group's orders, which may not benefit the addVehicle'd group.\n- Seems to have no affect on AI under player command - at least as long as the player remains the GL.Clarify"},{"heading":"Commands","level":3,"markdown":""},{"heading":"Assign/MoveIn Commands (Unit specific)","level":4,"markdown":"| assign setter commands | moveIn setter commands | assign getter commands |\n|---|---|---|\n| - assignAsDriver - assignAsGunner - assignAsCommander - assignAsTurret - assignAsCargo - assignAsCargoIndex - unassignVehicle | - moveInDriver - moveInGunner - moveInCommander - moveInTurret - moveInCargo - moveInAny - moveOut | - assignedVehicle - assignedVehicleRole |"},{"heading":"Other Commands (Group specific)","level":4,"markdown":"- addVehicle\n- leaveVehicle"},{"heading":"Shared Commands","level":4,"markdown":"- fullCrew Since Arma 3 v2.12 the output of the command includes vehicle's assigned units\n\n---\n\nfrom assignedVehicle\n\n- The assignment happens via the various assignAsXXX/moveInXXX commands, or player/AI GL getIn radio commands, getIn waypoint, or when units start in vehicles or get moved in to a vehicle by Zeus/via Eden.\n- addVehicle indirectly may also add the vehicle, however only if an AI GL assigns vehicle roles (which depends on various things).\n- vehicle returns the current vehicles an AI is in, while with assignedVehicle the AI may not (yet) be in the said vehicle (still in transit or held of by waypoints or other SQF commands).\n- To make AI under AI GL enter a vehicle, use orderGetIn true.\n- While unassignVehicle works, if the group is under AI command, the AI GL may re-assign the vehicle immediately. To stop the AI from re-entering at least, use orderGetIn or allowGetIn false, or permanently remove the assignment vi a leaveVehicle.\n- For player GL lead AI assignedVehicle seems not to be really reliable/behaves strange. Disembark radio command seems to unassign though.\n\nfrom assignedVehicleRole\n\n- When an unit enters a vehicle crew position, it gets assigned the vehicle role automatically for the given crew position.\n- The unit does not have to be in the vehicle when getting the role assignment (ie via assignAsXXX or human/AI GL getIn radio commands).\n- GL getIn radio commands result in instant assignment - the unit does not yet have to occupy the crew position.\n- Dying units will let go of the assigned role after a few seconds - seems the delay is independent of being in the vehicle or not.\n- An unit will hold on to its assigned role after exiting the vehicle.\n- One has to use unassignVehicle (and stop an AI GL to assign vehicle positions again) or leaveVehicle to remove the assignment - or assigned to another vehicle.\n- A vehicle position/role can only be assigned to one unit at a time. So even when not (visually) occupied, the \"seat\" may be blocked/reserved by another unit.\n- A player can still get into the vehicle position already assigned if not already taken, or switch seats with AI (if leader or effectiveCommander for those AI).\n\nfrom unassignVehicle\n\n- Important is to understand the basic system first:\n\n1. addVehicle creates a vehicle pool for the AI group to use.\n1. leaveVehicle removes a vehicle from the pool (and makes AI disembark when in that vehicle).\n1. However there is also assignedVehicle. This is about the *current vehicle in use* essentially. The assignment happens via the various assignAsXXX/moveInXXX commands, or player/AI GL getIn radio commands, getIn waypoint, or when units start in vehicles or get moved in to a vehicle by Zeus/via Eden.\n1. So the idea of unassignVehicle is to remove the *current vehicle in use*.\n1. However as long as the vehicle is still part of the vehicle pool of the group the AI GL may order the AI to re-enter the vehicle immediately.\n1. To stop this from happening, one can use orderGetIn/allowGetIn false to (temporarily) disallow the AI from entering any vehicle.\n\n- If you use leaveVehicle on an AI group not in the vehicle, only the AI GL will get the vehicle removed from assignedVehicle. However when you now apply unassignVehicle on the whole group, it will stick/the AI GL not order to re-enter immediately - as the AI GL no longer has the vehicle in his pool for the group.\n- For player GL lead AI, the command removes the assignment. However it won't make the AI disembark the vehicle.\n\nfrom orderGetIn\n\n- The command has no effect on AI lead by a player Group Leader (GL)\n- A vehicle needs be assigned via addVehicle or assignAsXXX or moveInXXX first for the command to have any effect. orderGetIn true makes the AI to board the vehicle. Or the AI GL orders them due to other means (ie getIn, guard waypoints).\n- However one can initially set orderGetIn false, add one or more vehicles and only once/when the AI is to enter, you set orderGetIn true for AI to start moving to the vehicle(s) or getting in the vehicle(s).\n- orderGetIn false makes AI also leave a vehicle when inside already. However it does not affect assignedVehicleRole nor assignedVehicle. Only leaveVehicle will remove both\n- orderGetIn false even makes AI eject while the vehicle positions are locked ((lockDriver, lockTurret, lockCargo - however orderGetIn true will not override the position lock to make them enter\n- AI units on the way to enter the vehicle won't stop on the way if orderGetIn false set but continue to the vehicle and just stop short without entering - allowGetIn false instead will make the AI stop instantly (same as unassignVehicle when combined with orderGetIn false)\n- One can combine orderGetIn false and allowGetIn false to manage when exactly AI is to enter vehicles\n- orderGetIn is persistent/a general group behavior setting - don't forget previous changes with future vehicle use!\n- If you want to make a vehicle no longer used by a group, you need to remove the vehicle from the group's vehicle pool via leaveVehicle."},{"heading":"Dis/Embarking Behaviour","level":3,"markdown":"**Courtesy of ffur2007slx2_5**\n\n| Command | Remote Control | Behaviour | Role Unassigning |\n|---|---|---|---|\n| orderGetIn | ✗ | orderGetIn won't take effect on player controlled AI units, and which needs to be used together with assaignAs command family. Generally speaking, orderGetIn is a Role Excuator. | When orderGetIn was disabled it won't automatically unassign unit's vehicle role but will force the unit get out of the vehicle and stop him re-entering until it was enabled again. orderGetIn false won't stop a unit when he is embarking a vehicle in the half way but unassignVehicle will do. orderGetIn false will wait to fire until the unit enter a vehicle. |\n| allowGetIn | ✗ | allowGetIn won't take effect on player controlled AI units. Different from orderGetIn, this command is a Role Holder, it can control the unit's movement in the half way set by orderGetIn but not by setWaypointType, unit will be forced to get out from a vehicle by allowGetIn false and won't automatically re-enter the vehicle until allowGetIn true | allowGetIn won't do anything with unit's vehicle role |\n| doGetOut | ✓ | Works on player controlled ai silently, unit will automatically get back to the vehicle after disembarkation. (Unit won't get out until vehicle is stopped or landed) | false |\n| commandGetOut | ✓ | Same as doGetOut with radio message. (Unit won't get out until vehicle is stopped or landed) | false |\n| leaveVehicle | ✗ | leaveVehicle can't force a player controlled AI disembark | true |\n| action [\"GetOut\", _veh] | ✓ | Eject immediately without parachute | false |\n| action [\"Eject\", _veh] | ✓ | Eject immediately with parachute if needed | false |\n| setWaypointType \"GETIN\" | ✗ | Waypoint won't be affected by orderGetIn false or allowGetIn false until the unit is on the vehicle. | N/A |"}],"categories":["AI","Clarification needed","To-do"],"groups":["Configuration"]},{"name":"AI Morale","title":"AI Morale","type":"topic","url":"https://community.bistudio.com/wiki/AI_Morale","revid":226044,"updated":"2021-01-31T17:33:44Z","aliases":[],"markdown":"In addition to behaviour and combat modes, there are other factors they may affect the overall activity of AI.\n\n### Fleeing\n\n- Can be disabled by allowFleeing. Details in fleeing","sections":[{"heading":null,"level":1,"markdown":"In addition to behaviour and combat modes, there are other factors they may affect the overall activity of AI."},{"heading":"Fleeing","level":3,"markdown":"- Can be disabled by allowFleeing. Details in fleeing"}],"categories":["AI"],"groups":["Configuration"]},{"name":"Altis","title":"Altis","type":"topic","url":"https://community.bistudio.com/wiki/Altis","revid":363949,"updated":"2024-04-27T20:09:59Z","aliases":[],"markdown":"Altis is an Arma 3 terrain, released with the game. It is a North Aegean Mediterranean island with an area of 268.65 km2 and is a 0.75× scale rendition of [Lemnos](https://en.wikipedia.org/wiki/Lemnos).\nIt has a Mediterranean flora and north aegean geology. The island is mountainous and has a lot of delta. The capital is Pyrgos, succeeding Kavala. It consists of 32 towns.\n\n### Geography\n\nThe island geologically has volcanic North Mediterranean properties. There are multiple pine forests scattered around the landscape. There is also a very small desert, just north of the town of Abdera.\n\nThere are 3 seasonal lakes that are all flooded in all seasons except summer, Limni, Ochrolimni and Almyra. In summer, they are completely dry with hard and cracked surfaces.\nLimni is used as an airfield during the summer thanks to its salt and hard surface properties.\n\nThe coastline is surrounded by 20 bays. Outside of the bays, the coastline mostly shows rocks and cliffs, with very little number of beaches.\n\nThe highest point in the island is the Thronos hill, with an altitude of 350m.\n\nThe northwest part of the island (north of Negades and west of Abdera) features a very rugged and mountanious terrain. Most of this part of the island is covered with forests.\nThe mountains and valleys provide a lot of coverage, hence the many wind turbines in this area. There is a paved road going across, to the town of Oreokastro. The area has a single fuel station and no military facilities.\n\nThe southwest part of the island (South of Agios Konstantinos and west of Neochori) is very mountanious as well, but without forests since the heavy population in the area has turned most of the land into farmlands.\nThis area has a very heavy population, and features the only hospital on the island, 6 observation post towers, 8 military outposts, 4 helipads, numerous fuel stations, AAC Airfield, and a long range transmission station at Magos, just south of Negades.","sections":[{"heading":null,"level":1,"markdown":"Altis is an Arma 3 terrain, released with the game. It is a North Aegean Mediterranean island with an area of 268.65 km2 and is a 0.75× scale rendition of [Lemnos](https://en.wikipedia.org/wiki/Lemnos).\nIt has a Mediterranean flora and north aegean geology. The island is mountainous and has a lot of delta. The capital is Pyrgos, succeeding Kavala. It consists of 32 towns."},{"heading":"Geography","level":3,"markdown":"The island geologically has volcanic North Mediterranean properties. There are multiple pine forests scattered around the landscape. There is also a very small desert, just north of the town of Abdera.\n\nThere are 3 seasonal lakes that are all flooded in all seasons except summer, Limni, Ochrolimni and Almyra. In summer, they are completely dry with hard and cracked surfaces.\nLimni is used as an airfield during the summer thanks to its salt and hard surface properties.\n\nThe coastline is surrounded by 20 bays. Outside of the bays, the coastline mostly shows rocks and cliffs, with very little number of beaches.\n\nThe highest point in the island is the Thronos hill, with an altitude of 350m.\n\nThe northwest part of the island (north of Negades and west of Abdera) features a very rugged and mountanious terrain. Most of this part of the island is covered with forests.\nThe mountains and valleys provide a lot of coverage, hence the many wind turbines in this area. There is a paved road going across, to the town of Oreokastro. The area has a single fuel station and no military facilities.\n\nThe southwest part of the island (South of Agios Konstantinos and west of Neochori) is very mountanious as well, but without forests since the heavy population in the area has turned most of the land into farmlands.\nThis area has a very heavy population, and features the only hospital on the island, 6 observation post towers, 8 military outposts, 4 helipads, numerous fuel stations, AAC Airfield, and a long range transmission station at Magos, just south of Negades."}],"categories":["Arma 3: Terrains"],"groups":["Tools and File Formats"]},{"name":"Ambient Parameters","title":"Ambient Parameters","type":"topic","url":"https://community.bistudio.com/wiki/Ambient_Parameters","revid":291487,"updated":"2021-08-07T11:43:01Z","aliases":[],"markdown":"See also getAllEnvSoundControllers, SoundControllers.\n\nDynamic ambient parameters:\n\n- **rain** 0..1 rain intensity\n- **windy** 0..1 wind streght (0 m/s ->0, 20 m/s -> 1)\n- **night** 0..1 night \"intensity\"\n- **deadBody** 0..1 is the place close to a dead body? (0 m ->1, 10 m -> 0)\n\nStatic ambient parameters:\n\n- **meadow** 0..1 how much does the surrounding have a character of a meadow\n- **trees** 0..1 how many trees are growing in the area\n- **forest** 0..1 forest density\n- **hills** 0..1 how much is the place \"hilly\" (160 ASL -> 0, 400 ASL -> 1)\n- **houses** 0..1 how many houses or other building are around\n- **sea** 0..1 is the place close to a sea? (0 m->1, approx. 100 m->0)\n- **waterDepth** 0..M where M is the actual water depth, and 0 on land.\n- **camDepth** 0..1 ???\n\nOperators:\n\n- mathematical operators\n- **randomGen N** float from 0 to N\n- **factor [p,q]** (V-p/q-p) if p <= V <= q, 0 otherwise\n- **interpolate [p,q,r,s]** (V-p/q-p)*(s-r) + r\n\nParameters can be combined into Simple Expressions, like:\n\n```cpp\n\"meadow * (1 - rain) * (1 - night)\"\n\"(10 - (5 * rain)) * (1 - sea) * (windy factor [0.2, 0.5])\"\n\"sea - waterDepth\" // neat way to retrieve the loveliest beaches/coastal places\n\"sea - waterDepth + (waterDepth factor [0.05, 0.5])\" // ...even more fine tuning w.r.t water depth using factor!\n```","sections":[{"heading":null,"level":1,"markdown":"See also getAllEnvSoundControllers, SoundControllers.\n\nDynamic ambient parameters:\n\n- **rain** 0..1 rain intensity\n- **windy** 0..1 wind streght (0 m/s ->0, 20 m/s -> 1)\n- **night** 0..1 night \"intensity\"\n- **deadBody** 0..1 is the place close to a dead body? (0 m ->1, 10 m -> 0)\n\nStatic ambient parameters:\n\n- **meadow** 0..1 how much does the surrounding have a character of a meadow\n- **trees** 0..1 how many trees are growing in the area\n- **forest** 0..1 forest density\n- **hills** 0..1 how much is the place \"hilly\" (160 ASL -> 0, 400 ASL -> 1)\n- **houses** 0..1 how many houses or other building are around\n- **sea** 0..1 is the place close to a sea? (0 m->1, approx. 100 m->0)\n- **waterDepth** 0..M where M is the actual water depth, and 0 on land.\n- **camDepth** 0..1 ???\n\nOperators:\n\n- mathematical operators\n- **randomGen N** float from 0 to N\n- **factor [p,q]** (V-p/q-p) if p <= V <= q, 0 otherwise\n- **interpolate [p,q,r,s]** (V-p/q-p)*(s-r) + r\n\nParameters can be combined into Simple Expressions, like:\n\n```cpp\n\"meadow * (1 - rain) * (1 - night)\"\n\"(10 - (5 * rain)) * (1 - sea) * (windy factor [0.2, 0.5])\"\n\"sea - waterDepth\" // neat way to retrieve the loveliest beaches/coastal places\n\"sea - waterDepth + (waterDepth factor [0.05, 0.5])\" // ...even more fine tuning w.r.t water depth using factor!\n```"}],"categories":["Arma 3: Sound"],"groups":["Configuration"]},{"name":"AnimationTitles","title":"AnimationTitles","type":"topic","url":"https://community.bistudio.com/wiki/AnimationTitles","revid":364475,"updated":"2024-05-16T20:41:55Z","aliases":[],"markdown":"The animation name consist of series of prefixes describing the contents of the move.\nIf the animation is a translation from one pose to another, the name contains both, the source and the destination moves, separated by an underscore.\n\n> [!NOTE]\n> Not all games contain all prefixed fields.\n\n### Animation naming\n\n| | |\n|---|---|\n| An animation name can look like this: **A**mov**P**erc**M**run**S**low**W**rfl**D**f | |\n| The \"APMSWD\" prefixes stand for: - **A**ction - General action (e.g move, cargo, weapon operation) - **P**ose - Unit stance (e.g erect, prone) - **M**ovement - Movement style/speed (e.g stop, walk, run) - **S**tance - Weapon position (e.g raised, lowered) - **W**eapon - Weapon in use (e.g rifle, pistol) - **D**irection - Where the character moves (e.g front, left) | Therefore, A**mov**P**erc**M**run**S**low**W**rfl**D**f** stands for: - Action **mov**ement - Posture **er**e**c**t - Movement **run** - Stance (of weapon) **low** - Weapon **r**i**fl**e - Direction **f**orward. |\n\n### Prefixes\n\n#### Action\n\n> [!NOTE]\n> **A** prefix\n\n| Short name | Full name | Description |\n|---|---|---|\n| mov | move | stand, walk, run, with or without weapon. Firing itself not included here. |\n| idl | idle | when character stands for a while on a place with no action – looking around |\n| crg | cargo | cargo animations in a vehicle including mount/dismount - deprecated as it is stored at each car's folder for now |\n| inj | injury | injury of a character - the injured one from a pair |\n| cin | carry injured | injury of a character - the healthy holding injured |\n| dth | death | death of a character |\n| inv | inventory | inventory actions, baggage |\n| cts | cutscenes | special for cutscenes |\n| swm | swim | swimming |\n| sig | signals | signaling - hand signals, saluting, military parade poses |\n| wop | operate a weapon | moves dedicated to firing + reloading various weapons, eg. moves for launcher etc. - includes binuculars |\n| adj | adjust | adjustment animations - slighlty lower/hier, left/right shoulder, etc (Arma 3) |\n| bdv | bottom dive | swimming under water with diving equipment (Arma 3) |\n| bsw | bottom swim | swimming under water (Arma 3) |\n| dve | dive | (Arma 3) |\n| fds | firing drills | (Arma 3) |\n| ovr | over obstacle | movements over obstacles like fences or low walls (Arma 3) |\n| pan | panic | walking/running in panic, eg. run with hands over head (Arma 3) |\n| sdv | surface dive | swimming at surface level with diving equipment (Arma 3) |\n| ssw | surface swim | swimming at surface level (Arma 3) |\n| fal | falling | (Arma 3) |\n| par | parachute | (Arma 3) |\n\n#### Pose\n\n> [!NOTE]\n> **P** prefix\n\n| Short name | Full name | Description |\n|---|---|---|\n| erc | erect | erect, standing. |\n| knl | kneel | crouched down, when stopped, so kneeling. |\n| pne | prone | prone on a ground |\n| sit | sit | sitting – e.g for cutscenes etc. Can't fire from heavy weapons (rifle+), must lay first. |\n| fal | fall | free falling from a obstacle, wall.. body pose with hands probably above a head. |\n| crh | crouched | crouched unit (Arma 3) |\n| inc | incapacitated | incapacitated animation from Revive (Arma 3) |\n\n#### Movement\n\n> [!NOTE]\n> **M** prefix\n\n| Short name | Full name | Description |\n|---|---|---|\n| stp | stop | man not moving, standing in place. |\n| wlk | walk | common relaxed move, a walk. N/A in prone! |\n| run | run | run, still possible to shoot with aimed weapon. Note - prone is either stop, run or sprint. |\n| spr | sprint | very intense sprint, impossible to shoot |\n| eva | evasive | evasive moves - e.g from lowered walk suddenly jump away and raise the gun - reaction under unexpected fire. |\n| tac | tactical | tactical pace - e.g looking down the sights while moving (Arma 3) |\n| lmp | limping | limping animation - when legs are hurt (Arma 3) |\n\n#### Stance\n\n> [!NOTE]\n> **S** prefix\n\n| Animation prefix | Short name | Full name | Description |\n|---|---|---|---|\n| **Amov** | ras | raised | aimed weapon ready for fire in horizontal position |\n| **Amov** | low | lowered | weapon in ready state, not aimed |\n| **Amov** | opt | optics | looking through optics / sight or binoculars |\n| **Amov** | sur | surrender | character surrenders |\n| **Amov** | non | no weapon | **S**non**W**non for empty hands |\n| **Awop** | gth | grenade throw | grenade throw, over the shoulder |\n\n#### Weapon\n\n> [!NOTE]\n> **W** prefix\n\n| Animation prefix | Short name | Full name | Description |\n|---|---|---|---|\n| **Acts** | una | unarmed | nothing in hands |\n| **Acts** | mag | machinegun | heavy gun impossible to put to aimed stance, firing from lower position |\n| **Amov** | pst | pistol | one hand weapon, probably empty hands will suffice. |\n| **Amov** | rfl | rifle | two hand rifle |\n| **Amov** | lnr | launcher | laucher |\n| **Amov** | non | no weapon | **S**non**W**non for empty hands |\n| **Awop** | bin | binocular | binocular moves |\n\n#### Direction\n\n> [!NOTE]\n> **D** prefix\n\n| Short name | Full name | Description |\n|---|---|---|\n| non | none | direction not specified |\n| f | forward | N/A |\n| fl | forward-left | N/A |\n| fr | forward-right | N/A |\n| l | left | N/A |\n| r | right | N/A |\n| b | back | N/A |\n| bl | back-left | N/A |\n| br | back-right | N/A |\n| up | up | ladder, climbing, parachute |\n| dn | down | ladder, climbing, parachute |\n| mul | multiple | for FBX only, not for RTM – more takes in one file |","sections":[{"heading":null,"level":1,"markdown":"The animation name consist of series of prefixes describing the contents of the move.\nIf the animation is a translation from one pose to another, the name contains both, the source and the destination moves, separated by an underscore.\n\n> [!NOTE]\n> Not all games contain all prefixed fields."},{"heading":"Animation naming","level":3,"markdown":"| | |\n|---|---|\n| An animation name can look like this: **A**mov**P**erc**M**run**S**low**W**rfl**D**f | |\n| The \"APMSWD\" prefixes stand for: - **A**ction - General action (e.g move, cargo, weapon operation) - **P**ose - Unit stance (e.g erect, prone) - **M**ovement - Movement style/speed (e.g stop, walk, run) - **S**tance - Weapon position (e.g raised, lowered) - **W**eapon - Weapon in use (e.g rifle, pistol) - **D**irection - Where the character moves (e.g front, left) | Therefore, A**mov**P**erc**M**run**S**low**W**rfl**D**f** stands for: - Action **mov**ement - Posture **er**e**c**t - Movement **run** - Stance (of weapon) **low** - Weapon **r**i**fl**e - Direction **f**orward. |"},{"heading":"Prefixes","level":3,"markdown":""},{"heading":"Action","level":4,"markdown":"> [!NOTE]\n> **A** prefix\n\n| Short name | Full name | Description |\n|---|---|---|\n| mov | move | stand, walk, run, with or without weapon. Firing itself not included here. |\n| idl | idle | when character stands for a while on a place with no action – looking around |\n| crg | cargo | cargo animations in a vehicle including mount/dismount - deprecated as it is stored at each car's folder for now |\n| inj | injury | injury of a character - the injured one from a pair |\n| cin | carry injured | injury of a character - the healthy holding injured |\n| dth | death | death of a character |\n| inv | inventory | inventory actions, baggage |\n| cts | cutscenes | special for cutscenes |\n| swm | swim | swimming |\n| sig | signals | signaling - hand signals, saluting, military parade poses |\n| wop | operate a weapon | moves dedicated to firing + reloading various weapons, eg. moves for launcher etc. - includes binuculars |\n| adj | adjust | adjustment animations - slighlty lower/hier, left/right shoulder, etc (Arma 3) |\n| bdv | bottom dive | swimming under water with diving equipment (Arma 3) |\n| bsw | bottom swim | swimming under water (Arma 3) |\n| dve | dive | (Arma 3) |\n| fds | firing drills | (Arma 3) |\n| ovr | over obstacle | movements over obstacles like fences or low walls (Arma 3) |\n| pan | panic | walking/running in panic, eg. run with hands over head (Arma 3) |\n| sdv | surface dive | swimming at surface level with diving equipment (Arma 3) |\n| ssw | surface swim | swimming at surface level (Arma 3) |\n| fal | falling | (Arma 3) |\n| par | parachute | (Arma 3) |"},{"heading":"Pose","level":4,"markdown":"> [!NOTE]\n> **P** prefix\n\n| Short name | Full name | Description |\n|---|---|---|\n| erc | erect | erect, standing. |\n| knl | kneel | crouched down, when stopped, so kneeling. |\n| pne | prone | prone on a ground |\n| sit | sit | sitting – e.g for cutscenes etc. Can't fire from heavy weapons (rifle+), must lay first. |\n| fal | fall | free falling from a obstacle, wall.. body pose with hands probably above a head. |\n| crh | crouched | crouched unit (Arma 3) |\n| inc | incapacitated | incapacitated animation from Revive (Arma 3) |"},{"heading":"Movement","level":4,"markdown":"> [!NOTE]\n> **M** prefix\n\n| Short name | Full name | Description |\n|---|---|---|\n| stp | stop | man not moving, standing in place. |\n| wlk | walk | common relaxed move, a walk. N/A in prone! |\n| run | run | run, still possible to shoot with aimed weapon. Note - prone is either stop, run or sprint. |\n| spr | sprint | very intense sprint, impossible to shoot |\n| eva | evasive | evasive moves - e.g from lowered walk suddenly jump away and raise the gun - reaction under unexpected fire. |\n| tac | tactical | tactical pace - e.g looking down the sights while moving (Arma 3) |\n| lmp | limping | limping animation - when legs are hurt (Arma 3) |"},{"heading":"Stance","level":4,"markdown":"> [!NOTE]\n> **S** prefix\n\n| Animation prefix | Short name | Full name | Description |\n|---|---|---|---|\n| **Amov** | ras | raised | aimed weapon ready for fire in horizontal position |\n| **Amov** | low | lowered | weapon in ready state, not aimed |\n| **Amov** | opt | optics | looking through optics / sight or binoculars |\n| **Amov** | sur | surrender | character surrenders |\n| **Amov** | non | no weapon | **S**non**W**non for empty hands |\n| **Awop** | gth | grenade throw | grenade throw, over the shoulder |"},{"heading":"Weapon","level":4,"markdown":"> [!NOTE]\n> **W** prefix\n\n| Animation prefix | Short name | Full name | Description |\n|---|---|---|---|\n| **Acts** | una | unarmed | nothing in hands |\n| **Acts** | mag | machinegun | heavy gun impossible to put to aimed stance, firing from lower position |\n| **Amov** | pst | pistol | one hand weapon, probably empty hands will suffice. |\n| **Amov** | rfl | rifle | two hand rifle |\n| **Amov** | lnr | launcher | laucher |\n| **Amov** | non | no weapon | **S**non**W**non for empty hands |\n| **Awop** | bin | binocular | binocular moves |"},{"heading":"Direction","level":4,"markdown":"> [!NOTE]\n> **D** prefix\n\n| Short name | Full name | Description |\n|---|---|---|\n| non | none | direction not specified |\n| f | forward | N/A |\n| fl | forward-left | N/A |\n| fr | forward-right | N/A |\n| l | left | N/A |\n| r | right | N/A |\n| b | back | N/A |\n| bl | back-left | N/A |\n| br | back-right | N/A |\n| up | up | ladder, climbing, parachute |\n| dn | down | ladder, climbing, parachute |\n| mul | multiple | for FBX only, not for RTM – more takes in one file |"}],"categories":["Moves"],"groups":["Reference Lists"]},{"name":"Anything","title":"Anything","type":"topic","url":"https://community.bistudio.com/wiki/Anything","revid":330444,"updated":"2022-09-15T21:31:40Z","aliases":["Any"],"markdown":"A variable of type **Anything** may be of any data types **or** Nothing.\n\n> [!WARNING]\n> Even though some commands list data type **Anything** as possible value, passing nil (Nothing) to a command might cause it not to work:\n>\n> ```sqf\n> str nil; // while the documentation for str states it takes Anything, nil / Nothing will cause it to not execute.\n> ```\n\n### See Also\n\n- nil\n- isNil\n- Nothing","sections":[{"heading":null,"level":1,"markdown":"A variable of type **Anything** may be of any data types **or** Nothing.\n\n> [!WARNING]\n> Even though some commands list data type **Anything** as possible value, passing nil (Nothing) to a command might cause it not to work:\n>\n> ```sqf\n> str nil; // while the documentation for str states it takes Anything, nil / Nothing will cause it to not execute.\n> ```"},{"heading":"See Also","level":3,"markdown":"- nil\n- isNil\n- Nothing"}],"categories":["Magic Types"],"groups":["Data Types"]},{"name":"Argument","title":"Argument","type":"topic","url":"https://community.bistudio.com/wiki/Argument","revid":329068,"updated":"2022-07-21T23:40:25Z","aliases":["argument"],"markdown":"An **argument** is any value that *is being passed* to a scripting command or an executed script or function. In the script or function this value is considered a parameter.\n\n**Example:**\n\n```sqf\n[variable, 5, \"string\"] execVM \"myScript.sqf\"\n```\n\nThe Array `[variable, 5, \"string\"]` and the contained values are called the arguments given to the script.\n\n### Access\n\nIn the script the argument can be accessed using the magic variable `_this`.\n\n### See also\n\n- Parameter","sections":[{"heading":null,"level":1,"markdown":"An **argument** is any value that *is being passed* to a scripting command or an executed script or function. In the script or function this value is considered a parameter.\n\n**Example:**\n\n```sqf\n[variable, 5, \"string\"] execVM \"myScript.sqf\"\n```\n\nThe Array `[variable, 5, \"string\"]` and the contained values are called the arguments given to the script."},{"heading":"Access","level":3,"markdown":"In the script the argument can be accessed using the magic variable `_this`."},{"heading":"See also","level":3,"markdown":"- Parameter"}],"categories":["Syntax"],"groups":["Scripting"]},{"name":"Arma 3: Actions","title":"Arma 3: Actions","type":"topic","url":"https://community.bistudio.com/wiki/Arma_3:_Actions","revid":376089,"updated":"2025-08-09T20:25:33Z","aliases":["ArmA 3: Actions","Arma 3 Actions","action/Arma 3 Actions List"],"markdown":"> [!NOTE]\n> - See ArmA: Armed Assault: Actions for an introduction to Actions\n> - Not to be confused with playAction\n\n## General Syntax\n\n```\nunit action [\"actionType\", parameter(s)]\n```\n\n| | |\n|---|---|\n| *unit*: | Object. Can be any occupied vehicle or person that is not in a vehicle or also a Game Logic. |\n| *\"actionType\"*: | String. Name of the action, found in the CfgActions class. Not case sensitive. |\n| *parameter(s)*: | Various data types, dependant on the action used. The number of required parameters depends on the action type. |\n\n## Actions\n\n### ActiveSensorsOn\n\n| | |\n|---|---|\n| Description | Activates the vehicle's active sensor (radar). |\n| Syntax | *unit* action [\"ActiveSensorsOn\", *vehicle*] |\n| | |\n| Example | `player action [\"ActiveSensorsOn\", vehicle player];` |\n\n### ActiveSensorsOff\n\n| | |\n|---|---|\n| Description | Deactivates the vehicle's active sensor (radar). |\n| Syntax | *unit* action [\"ActiveSensorsOff\", *vehicle*] |\n| | |\n| Example | `player action [\"ActiveSensorsOff\", vehicle player];` |\n\n### AddBag\n\n| | | |\n|---|---|---|\n| Description | Causes a unit to take backpack from another unit/vehicle or weaponholder. | |\n| Syntax | *targetUnit* action [\"AddBag\", *sourceUnit*, *\"backpackName\"*] | |\n| | Where *targetUnit* is the person to receive a backpack (the action animation will be performed), *sourceUnit* is either another unit/vehicle or weaponholder containing the backpack. *\"backpackName\"* is the classname (string) of the backpack to be picked up. | |\n| Note | Bags can be picked up at any distance. To drop bag use \"DropBag\" action. If several backpacks of the same class name exist in the container, the oldest will be added first. | |\n| Examples | `soldierOne action [\"AddBag\", soldierTwo, backpack soldierTwo];` `player action [\"AddBag\", car, typeOf firstBackpack car];` Swap player bag with parachute: ```sqf player action [\"DropBag\", _plane, backpack player]; player action [\"AddBag\", _plane, \"B_Parachute\"]; ``` | |\n\n### ArtilleryComputer\n\n| | | |\n|---|---|---|\n| Description | Opens up Artillery Computer display just like the one in action menu for a mortar. Unit has to be in gunner position or display will immediately close. | |\n| Syntax | *unit* action [\"ArtilleryComputer\", *artillery*] | |\n| | Where *unit* is any unit, and *artillery* is the artillery weapon | |\n| Example | `soldierOne action [\"ArtilleryComputer\", mortarOne];` | |\n\n### AutoHover\n\n| | |\n|---|---|\n| Description | Toggles auto-hovering on. Note that while the auto-hover status can be toggled on an AI crewed or even an empty vehicle, it will only affect a vehicle controlled by a human pilot. |\n| Syntax | *unit* action [\"AutoHover\", *targetVehicle*] |\n| | Where *unit* is any unit (no action animation is performed) and *targetVehicle* is any vehicle that is capable of hovering. |\n| Example | `chopperOne action [\"AutoHover\", chopperOne];` |\n\n### AutoHoverCancel\n\n| | |\n|---|---|\n| Description | Toggles auto-hovering off. Note that while the auto-hover status can be toggled on an AI crewed or even an empty vehicle, it will only affect a vehicle controlled by a human pilot. |\n| Syntax | *unit* action [\"AutoHoverCancel\", *targetVehicle*] |\n| | Where *unit* is any unit (no action animation is performed) and *targetVehicle* is any vehicle that is capable of hovering. |\n| Example | `driver chopperOne action [\"AutoHoverCancel\", chopperOne];` |\n\n### BackFromUAV\n\n| | |\n|---|---|\n| Description | Moves player control back from driver/gunner position of connected UAV. Does what \"Release UAV controls\" UI action does. |\n| Syntax | *unit* action [\"BackFromUAV\"] |\n| | Where *unit* is the connected UAV unit. |\n| Example | `getConnectedUAVUnit player action [\"BackFromUAV\"];` |\n\n### CancelAction\n\n| | |\n|---|---|\n| Description | Cancels an action in progress. The target unit will complete it is current animation, although the action itself will not be performed. |\n| Syntax | *unit* action [\"CancelAction\", *targetUnit*] |\n| | Where *unit* is any unit (no action animation is performed) and *targetUnit* is any unit that is in the process of performing an action. |\n| Example | `soldierOne action [\"CancelAction\", soldierOne];` |\n\n### CancelLand\n\n| | |\n|---|---|\n| Description | Cancels autopilot landing for an aircraft, including AI controlled aircraft. |\n| Syntax | *unit* action [\"CancelLand\", *targetVehicle*] |\n| | Where *unit* is any unit (no action animation is performed) and *targetVehicle* is any vehicle that is currently performing an autopilot landing. |\n| Example | `driver planeOne action [\"CancelLand\", planeOne];` |\n\n### CancelTakeFlag\n\n| | |\n|---|---|\n| Description | Cancels taking of a flag. The unit will complete the taking/action animation, but the flag will remain attached to it is current object. This action needs to be executed while the flag is being taken (which happens after the unit completes the taking/action animation) to prevent a unit taking the flag. For example, if a person is taking a flag from a flagpole, then the cancelTakeFlag action should be executed while the flag is descending the flagpole. |\n| Syntax | *unit* action [\"CancelTakeFlag\", *targetFlag*] |\n| | Where *unit* is any unit that is currently taking a flag (no action animation is performed) and *targetFlag'* is a flag object. |\n| Example | `westSoldierOne action [\"CancelTakeFlag\", eastFlag];` |\n\n### CollisionLightOff\n\n| | |\n|---|---|\n| Description | Turns off the collision lights of an air vehicle. |\n| Syntax | *unit* action [\"CollisionLightOff\", *targetVehicle*] |\n| | Where *unit* is any unit (no action animation is performed) and *targetVehicle* is a vehicle with lights. |\n| Example | `player action [\"CollisionLightOff\", vehicle player];` |\n\n### CollisionLightOn\n\n| | |\n|---|---|\n| Description | Turns on the collision lights of an air vehicle. |\n| Syntax | *unit* action [\"CollisionLightOn\", *targetVehicle*] |\n| | Where *unit* is any unit (no action animation is performed) and *targetVehicle* is a vehicle with lights. |\n| Example | `player action [\"CollisionLightOn\", vehicle player];` |\n\n### Deactivate\n\n| | |\n|---|---|\n| Description | Causes a unit to deactivate and take a active satchel charge placed by any unit. This action can be performed upon a satchel object from any distance. This action also works for landmines created with createVehicle command: ```sqf private _mine = \"ATMine_Range_Ammo\" createVehicle getPosATL player; // create player action [\"Deactivate\", player, mine]; // deactivate ``` |\n| Syntax | *unit* action [\"Deactivate\", *targetUnit*, *targetObject*] |\n| | Where *unit* is any unit (they will perform the action animation as if deactivating a satchel charge). *targetUnit* will have the deactivated satchel charge added to it is inventory. *targetObject* is the armed satchel object to be deactivated (class \"pipeBomb\" or \"timeBomb\"). |\n| Examples | `soldierOne action [\"Deactivate\", soldierOne, mySatchelCharge];` |\n| | `soldierOne action [\"Deactivate\", soldierOne, nearestObject [soldierOne, \"pipeBomb\"]];` |\n\n### DeactivateMine\n\n| | |\n|---|---|\n| Description | Causes a unit to deactivate any armed landmine that is within about two meters of a unit. Neither unit requires the ability to disable landmines. NOTE: This action works only with mines that have been spotted by player (marked with triangle). Use \"Deactivate\" if you need to deactivate any mine. |\n| Syntax | *unit* action [\"DeactivateMine\", *targetUnit*] |\n| | Where *unit* is any unit, who will perform the action animation. The closest landmine to *targetUnit* will be deactivated. |\n| Example | `soldierOne action [\"DeactivateMine\", soldierOne];` |\n\n### Diary\n\n| | |\n|---|---|\n| Description | Use and effects unknown. |\n| Syntax | *unit* action [\"Diary\", **] |\n| | |\n| Example | |\n\n### Disassemble\n\n| | |\n|---|---|\n| Description | Takes assembled weapon to parts (carry bags). Assembled weapon object reference may need to be kept for assembly. See also: enableWeaponDisassembly |\n| Syntax | *unit* action [\"Disassemble\", *weapon*] |\n| | Where *unit* is any unit and *weapon* is assembled weapon |\n| Example | `soldierOne action [\"Disassemble\", mortarOne];` |\n\n### DropBag\n\n| | | |\n|---|---|---|\n| Description | Causes a unit to drop a backpack into another unit/vehicle. To drop backpack on the ground, a weaponholder object needs to be created first. | |\n| Syntax | *sourceUnit* action [\"DropBag\", *targetUnit*, *\"backpackName\"*] | |\n| | Where *sourceUnit* is the person to drop a backpack (the action animation will be performed), *targetUnit* is either another unit/vehicle into which the backpack will be dropped or a weaponholder. *\"backpackName\"* is the classname (string) of the backpack to be dropped. | |\n| Note | Bags can be dropped into other units at any distance. If targetUnit already has a backpack, sourceUnit's backpack will drop to the ground at targetUnit's feet, and be unavailable (for picking up/using). | |\n| Examples | `soldierOne action [\"DropBag\", soldierTwo, backpack soldierOne];` ```sqf private _gwh = \"Weapon_Empty\" createVehicle getPosATL player; player action [\"DropBag\", _gwh, typeOf unitBackpack player]; // the reason \"Weapon_Empty\" type of weaponholder is used in this case is because // unlike other weaponholders it is not autodeleted when empty and will not disappear before the action is complete. // you should take care of deleting it after yourself. Alternatively use \"PutBag\" action. ``` ```sqf (unitBackpack player) setVariable [\"backpackOwner\", name player, true]; player action [\"DropBag\", car, typeOf unitBackpack player]; hint ((firstBackpack car) getVariable \"backpackOwner\"); ``` Swap player bag with parachute: ```sqf player action [\"DropBag\", _plane, backpack player]; player action [\"AddBag\", _plane, \"B_Parachute\"]; ``` Transfer player's backpack to bob `player action [\"DropBag\", bob];` | |\n\n### DropMagazine\n\n| | |\n|---|---|\n| Description | Causes a person to drop a magazine either into another unit (both persons and vehicles), or onto the ground (creating a new WeaponHolder object). Magazines can be dropped into other units at any distance. |\n| Syntax | *unit* action [\"DropMagazine\", *targetUnit*, *\"magazineName\"*] |\n| | Where *unit* is the person to drop a magazine (the action animation will be performed), *targetUnit* is either another unit into which the magazine will be dropped, or the same unit that is dropping the magazine. *\"magazineName\"* is the classname (string) of the magazine to be dropped (see the ArmA weapons list for magazine classnames). |\n| Examples | `soldierOne action [\"DropMagazine\", soldierOne, \"30Rnd_545x39_AK\"];` |\n| | `soldierOne action [\"DropMagazine\", ammoCrateOne, \"30Rnd_545x39_AK\"];` |\n\n### DropWeapon\n\n| | |\n|---|---|\n| Description | Causes a person to drop a weapon and all associated magazines either into specified vehicle or weaponholder. Weapons can be dropped at any distance. |\n| Syntax | *unit* action [\"DropWeapon\", *targetHolder*, *\"weaponName\"*] |\n| | Where *unit* is the person to drop a weapon (the action animation will be performed), *targetHolder* is either a vehicle or weaponholder. *\"weaponName\"* is the classname (string) of the CfgWeapons class. |\n| Examples | ```sqf private _weaponHolder = \"GroundWeaponHolder_Scripted\" createVehicle getPosATL player; player action [\"DropWeapon\", _weaponHolder, currentWeapon player]; ``` ```sqf soldierOne action [\"DropWeapon\", unitBackpack soldierTwo, currentWeapon soldierOne]; player action [\"DropWeapon\", tank, \"arifle_MX_ACO_pointer_F\"]; ``` |\n| | |\n\n### Eject\n\n| | |\n|---|---|\n| Description | Causes a person to eject out of the vehicle they are currently inside. If the unit was the driver of the vehicle, the vehicle will retain it is steering control input and it is engine will remain on. This action has a global effect when used on a local unit in multiplayer. If the vehicle parameter used is an moving aircraft, the ejecting person will use a parachute (and likewise if it is not an moving aircraft, no parachute will be used). |\n| Syntax | *unit* action [\"Eject\", *vehicle*] |\n| | Where *unit* is the person to eject from their current vehicle, and *vehicle* is any vehicle (generally the vehicle *unit* is within). |\n| Example | `soldierOne action [\"Eject\", vehicle soldierOne];` |\n\n### EngineOn\n\n| | |\n|---|---|\n| Description | Turns a vehicle's engine on. This command will not override an AI driver's desires. |\n| Syntax | *unit* action [\"EngineOn\", *targetVehicle*] |\n| | Where *unit* is any unit, and *targetVehicle* is the vehicle to start it is engine. |\n| Example | `soldierOne action [\"EngineOn\", vehicle soldierOne];` |\n\n### EngineOff\n\n| | |\n|---|---|\n| Description | Turns a vehicle's engine off. This command will not override an AI driver's desires. |\n| Syntax | *unit* action [\"EngineOff\", *targetVehicle*] |\n| | Where *unit* is any unit, and *targetVehicle* is the vehicle to have it is engine turned off. |\n| Example | `soldierOne action [\"EngineOff\", vehicle soldierOne];` |\n\n### FireInflame\n\n| | |\n|---|---|\n| Description | Ignites a fireplace object (from any distance). |\n| Syntax | *unit* action [\"FireInflame\", *targetObject*] |\n| | Where *unit* is any unit(the action animation will be performed), and *targetObject* is the fireplace to be ignited. |\n| Example | `soldierOne action [\"FireInflame\", firePlaceOne];` |\n\n### FirePutDown\n\n| | |\n|---|---|\n| Description | Extinguishes a fireplace object (from any distance). |\n| Syntax | *unit* action [\"FirePutDown\", *targetObject*] |\n| | Where *unit* is any unit (the action animation will be performed), and *targetObject* is the fireplace to be extinguished. |\n| Example | `soldierOne action [\"FirePutDown\", firePlaceOne];` |\n\n### FlapsUp\n\n| | |\n|---|---|\n| Description | Adjusts an aircraft's flaps upwards one notch. AI pilot's will instantly adjust their flaps to whatever setting they feel is suitable. |\n| Syntax | *unit* action [\"FlapsUp\", *targetVehicle*] |\n| | Where *unit* is any unit (the action animation will not be performed), and *targetVehicle* is the aircraft to have it is flaps adjusted. |\n| Example | `harrierOne action [\"FlapsUp\", harrierOne];` |\n\n### FlapsDown\n\n| | |\n|---|---|\n| Description | Adjusts an aircraft's flaps down one notch. AI pilot's will instantly adjust their flaps to whatever setting they feel is suitable. |\n| Syntax | *unit* action [\"FlapsDown\", *targetVehicle*] |\n| | Where *unit* is any unit (the action animation will not be performed), and *targetVehicle* is the aircraft to have it is flaps adjusted. |\n| Example | `harrierOne action [\"FlapsDown\", harrierOne];` |\n\n### Gear\n\n| | |\n|---|---|\n| Description | Opens inventory dialog for the player and plays the appropriate animation. The left part of the inventory dialog gets populated with the inventory of the target unit. Player has to be in range of inventory operations with the targetUnit (~ <5m). |\n| Syntax | *unit* action [\"Gear\", *targetUnit*] |\n| | Where *unit* is a player, and *targetUnit* is another player, vehicle or container. |\n| Examples | `player action [\"Gear\", \"GroundWeaponHolder\" createVehicle position player];` |\n| | `player action [\"Gear\", objNull];` |\n| | `player action [\"Gear\", soldier1];` |\n| | `player action [\"Gear\", cursorTarget];` |\n\n### GetInCargo\n\n| | |\n|---|---|\n| Description | Instantly moves a person to the appropriate boarding position of a vehicle, then they attempt to board the vehicle as cargo, in a specific cargo position if given as an optional parameter, otherwise in the first available cargo position. If the specific position is already occupied, the person will board in the first available cargo position. If the all cargo positions are already occupied by living persons, or no cargo position exists, the boarding will fail. This action works only with cargo positions that have no person turret, i.e. if player cannot shoot his rifle from them. If position is cargo but also person turret, it will be ignored. Use `fullCrew [_veh, \"cargo\", true]` to determine which positions are compatible cargo. Alternatively, use moveInCargo command instead, which has no such limitation. |\n| Syntax | *unit* action [\"GetInCargo\", *targetVehicle*] |\n| | *unit* action [\"GetInCargo\", *targetVehicle*, *positionNumber*] |\n| | Where *unit* is the person to board, and *targetVehicle* is the vehicle to be boarded. *positionNumber is a specific cargo position index number.* |\n| Examples | `soldierOne action [\"GetInCargo\", truckOne];` |\n| | `soldierOne action [\"GetInCargo\", truckOne, 0];` |\n\n### GetInCommander\n\n| | |\n|---|---|\n| Description | Instantly moves a person (who is not already in a vehicle) to the appropriate boarding position of a vehicle, they then attempt to board the vehicle as the commander. The boarding will fail if the position is already occupied or does not exist. |\n| Syntax | *unit* action [\"GetInCommander\", *targetVehicle*] |\n| | Where *unit* is the person to board, and *targetVehicle* is the vehicle to be boarded. |\n| Example | `soldierOne action [\"GetInCommander\", tankOne];` |\n\n### GetInDriver\n\n| | |\n|---|---|\n| Description | Instantly moves an person (who is not already in a vehicle) to the appropriate boarding position of a vehicle, then they attempt to board the vehicle as the driver/pilot. The boarding will fail if the position is already occupied or does not exist. |\n| Syntax | *unit* action [\"GetInDriver\", *targetVehicle*] |\n| | Where *unit* is the person to board, and *targetVehicle* is the vehicle to be boarded. |\n| Example | `soldierOne action [\"GetInDriver\", carOne];` |\n\n### GetInGunner\n\n| | |\n|---|---|\n| Description | Instantly moves a person (who is not already in a vehicle) to the appropriate boarding position of a vehicle, then they attempt to board the vehicle as the primary gunner. If the gunner position is already occupied by another living person or it does not exist, the boarding will fail. Also see getInTurret. |\n| Syntax | *unit* action [\"GetInGunner\", *targetVehicle*] |\n| | Where *unit* is the person to board, and *targetVehicle* is the vehicle to be boarded. |\n| Example | `soldierOne action [\"GetInGunner\", mySpotlight];` |\n\n### GetInPilot\n\n| | |\n|---|---|\n| Description | This action is identical to getInDriver. It instantly moves an person (who is not already in a vehicle) to the appropriate boarding position of a vehicle, then they attempt to board the vehicle as the driver/pilot. The boarding will fail if the position is already occupied or does not exist. |\n| Syntax | *unit* action [\"GetInPilot\", *targetVehicle*] |\n| | Where *unit* is the person to board, and *targetVehicle* is the vehicle to be boarded. |\n| Example | `pilotOne action [\"GetInPilot\", chopperOne];` |\n\n### GetInTurret\n\n| | |\n|---|---|\n| Description | Instantly moves a person (who is not already in a vehicle) to the appropriate boarding position of a vehicle, then they attempt to board the vehicle as the specified turret user. If the turret position is already occupied by another living person the boarding will fail. If the turret position does not exist, ArmA may crash. See also getInGunner. |\n| Syntax | *unit* action [\"GetInTurret\", *targetVehicle*, *turretArray*] |\n| | Where *unit* is the person to board, and *targetVehicle* is the vehicle to be boarded, and *turretArray* is an array defining the turret. For example, *[1]* would be a vehicle's second turret, and *[0, 2, 1]* is the second turret of the third turret of the first turret. A vehicle's turret order is defined in it is class CfgVehicles of the Config. |\n| Examples | `gunnerTwo action [\"GetInTurret\", myUH60MG, [1]];` |\n| | `tankCommanderOne action [\"GetInTurret\", myT72, [0,1]];` |\n\n### GetOut\n\n| | |\n|---|---|\n| Description | Causes a person to disembark from a vehicle, without a parachute in the case of aircraft. See also eject. |\n| Syntax | *unit* action [\"GetOut\", *targetVehicle*] |\n| | Where *unit* is the person to disembark, and *targetVehicle* is the vehicle to disembark from. |\n| Example | `soldierOne action [\"GetOut\", carOne];` |\n\n### HandGunOn\n\n| | |\n|---|---|\n| Description | Causes a person to ready their hand gun (if equiped). This action may not work if the unit does not have a primary rifle. |\n| Syntax | *unit* action [\"HandGunOn\", *targetUnit*] |\n| | Where *unit* is any unit (who will not play the action animation), and *targetUnit* is the unit who will ready their pistol. |\n| Example | `soldierOne action [\"HandGunOn\", soldierOne];` |\n\n### HandGunOff\n\n| | |\n|---|---|\n| Description | Causes a person to return a readied pistol to it is holster, then switch to the primary rifle. This action may not work if the unit does not have a primary rifle. |\n| Syntax | *unit* action [\"HandGunOff\", *targetUnit*] |\n| | Where *unit* is any unit (who will not play the action animation), and *targetUnit* is the person to holster it is pistol. |\n| Example | `soldierOne action [\"HandGunOff\", soldierOne];` |\n\n### Heal\n\n| | |\n|---|---|\n| Description | Instantly teleports a person unit to the target medic. The target medic then heals the unit. If the target unit is not a medic, the animations will still be played, but no healing occurs. If the medic is within a vehicle, no teleporting will occur and the wounded unit will only be healed if they are already within healing range (a few meters). |\n| Syntax | *unit* action [\"Heal\", *targetUnit*] |\n| | Where *unit* is a wounded person, and *targetUnit* is the medic to do the healing. |\n| Example | `soldierOne action [\"Heal\", medicOne];` |\n\n### HealSoldier\n\n| | |\n|---|---|\n| Description | Performs one soldier healing of another soldier. Needs to have MedKit or FAK (first aid kit) in the inventory, which gets used. |\n| Syntax | *unit* action [\"HealSoldier\", *targetUnit*] |\n| | Where *unit* is the unit to perform treatment, and *targetUnit* is the unit to receive treatment. |\n| Example | `player action [\"HealSoldier\", soldier1];` |\n\n### HealSoldierSelf\n\n| | |\n|---|---|\n| Description | Performs one soldier healing of another soldier. In case the target is the same unit, the soldier performs treatment on himself. Needs to have FAK (first aid kit) in the inventory, which gets used. |\n| Syntax | *unit* action [\"HealSoldierSelf\", *targetUnit*] |\n| | Where *unit* is the unit to perform treatment, and *targetUnit* is the unit to receive treatment. |\n| Example | `player action [\"HealSoldierSelf\", soldier1];` |\n\n### HideBody\n\n| | |\n|---|---|\n| Description | Causes a person to bend down and hide (bury) a body in the ground. The body is automatically deleted within a few seconds. The person performing the action does not require the ability to hide bodies, and may be any distance from the body. |\n| Syntax | *unit* action [\"HideBody\", *targetUnit*] |\n| | Where *unit* is a person, and *targetUnit* is a dead person. |\n| Example | `soldierOne action [\"HideBody\", soldierTwo];` |\n\n### InGameMenu\n\n| | |\n|---|---|\n| Description | Use and effects unknown. |\n| Syntax | *unit* action [\"InGameMenu\", **] |\n| | |\n| Example | |\n\n### LadderDown\n\n| | |\n|---|---|\n| Description | Causes a person to play an animation as if mounting the top of a ladder, then instantly teleport onto the specified ladder in the specified position. If the person is controlled by AI, they will automatically climb up or down the ladder. If the 2 parameter syntax is used, the person will become stuck in the ladder mounting animation state until the ladderOff action is executed upon them. It may also crash ArmA (pre 1.09). |\n| Syntax | *unit* action [\"LadderDown\", *targetObject*] |\n| | *unit* action [\"LadderDown\", *targetObject*, *ladderNumber*, *positionNumber*] |\n| | Where *unit* is any person unit, *targetObject* is an object with a ladder, *ladderNumber* is a number defining the desired ladder, and *positionNumber* is a number defining the desired position. |\n| Example | `soldierOne action [\"LadderDown\", (position soldierOne nearestObject 452221), 0, 1];` |\n\n### LadderUp\n\n| | |\n|---|---|\n| Description | Causes a person to play an animation as if mounting the bottom of a ladder, then instantly teleport onto the specified ladder in the specified position. If the person is controlled by AI, they will automatically climb up or down the ladder. If the 2 parameter syntax is used, the person will become stuck in the ladder mounting animation state until the ladderOff action is executed upon them. It may also crash ArmA (pre 1.09). |\n| Syntax | *unit* action [\"LadderUp\", *targetObject*] **!!!Warning!!! This syntax causes Arma 3 to freeze** |\n| | *unit* action [\"LadderUp\", *targetObject*, *ladderNumber*, *positionNumber*] |\n| | Where *unit* is any person unit, *targetObject* is an object with a ladder, *ladderNumber* is a number defining the desired ladder, and *positionNumber* is a number defining the desired position (0 - bottom, 1 - top). All numbers in between get rounded towards 1 or 0. |\n| Example | `soldierOne action [\"LadderUp\", (position soldierOne nearestObject 452221), 0, 0];` |\n\n### LadderOff\n\n| | |\n|---|---|\n| Description | Causes a person to dismount from any ladder of the specified object they may be happen to be on. The alternative 3 parameter syntax expects a number, the use of which is not known. |\n| Syntax | *unit* action [\"LadderOff\", *targetObject*] |\n| | *unit* action [\"LadderOff\", *targetObject*, *unknownNumber*] |\n| | Where *unit* is any person unit, *targetObject* is the object with a ladder that the person is currently upon, *unknownNumber* is a number. |\n| Example | `soldierOne action [\"LadderOff\", (position soldierOne nearestObject 452221)];` |\n\n### LadderOnDown\n\n| |\n|---|\n| **Description**: This action appears to be identical to LadderDown. |\n\n### LadderOnUp\n\n| |\n|---|\n| **Description**: This action appears to be identical to LadderUp. |\n\n### Land\n\n| | |\n|---|---|\n| Description | Turns on autopilot landing for an aircraft, including AI controlled aircraft. The aircraft will land at the closest airfield. |\n| Syntax | *unit* action [\"Land\", *targetVehicle*] |\n| | Where *unit* is any unit (no action animation is performed) and *targetVehicle* is a vehicle that can perform an autopilot landing. |\n| Example | `driver planeOne action [\"Land\", planeOne];` |\n\n### LandGear\n\n| | |\n|---|---|\n| Description | Lowers the landing gear of an aircraft. In the case of AI-controlled aircraft, it has to be used in an each-frame loop to override the AI behavior (otherwise they'll raise the landing gear when they take off). |\n| Syntax | *unit* action [\"LandGear\", *targetVehicle*] |\n| | Where *unit* is any unit (no action animation is performed) and *targetVehicle* is a vehicle that can perform an autopilot landing. |\n| Example | `driver planeOne action [\"LandGear\", planeOne];` |\n\n### LandGearUp\n\n| | |\n|---|---|\n| Description | Raises the landing gear of an aircraft. In the case of AI-controlled aircraft, it has to be used in an each-frame loop to override the AI behavior (otherwise they'll lower the landing gear when they're close to the ground). |\n| Syntax | *unit* action [\"LandGearUp\", *targetVehicle*] |\n| | Where *unit* is any unit (no action animation is performed) and *targetVehicle* is a vehicle that can perform an autopilot landing. |\n| Example | `driver planeOne action [\"LandGearUp\", planeOne];` |\n\n### LightOff\n\n| | |\n|---|---|\n| Description | Turns off the headlights of an empty vehicle. If the vehicle is AI-controlled (either as the lone driver, or as the commander/gunner) then the light status depends on the AI's behaviour mode (\"combat\" or \"stealth\" = lights off, any other mode = lights on). |\n| Syntax | *unit* action [\"LightOff\", *targetVehicle*] |\n| | Where *unit* is any unit (no action animation is performed) and *targetVehicle* is a vehicle with lights. |\n| Example | `player action [\"LightOff\", vehicle player];` |\n\n### LightOn\n\n| | |\n|---|---|\n| Description | Turns on the headlights of an empty vehicle. If vehicle is AI-controlled, see notes under the LightOff action. |\n| Syntax | *unit* action [\"LightOn\", *targetVehicle*] |\n| | Where *unit* is any unit (no action animation is performed) and *targetVehicle* is a vehicle with lights. |\n| Example | `player action [\"LightOn\", vehicle player];` |\n\n### LoadMagazine\n\n| | |\n|---|---|\n| Description | Plays a reload weapon animation. |\n| Syntax | *unit* action [\"LoadMagazine\", target, magazineCreator, *number1*, *number2*, weaponName, muzzleName] |\n| | Expects a 7 elements array: |\n| | target: Object - unit to perform the reload action. |\n| | magazineCreator: Object - unknown. Can be objNull. |\n| | *number1*: Number - cr - see magazinesDetail. For characters it is mainly 0 |\n| | *number2*: Number - id - magazine ID - can be obtained via magazinesDetail. With 0, it only plays the reload animation. With values from 1 up, it actually reloads the magazine. If the number becomes too high (meaning of the upper limit is also unknown), the action will no longer be performed. |\n| | weaponName: String - weapon to reload. Must not be selected, but may cause weapon not to reload to the full amount. |\n| | muzzleName: String - weapon's muzzle to reload. |\n| Example | `player action [\"LoadMagazine\", player, player, 0, 1 , \"vbs2_us_m16a2_iron_gla\", \"vbs2_us_m16a2_iron_gla\"];` |\n\n### LockVehicleControl\n\n| | |\n|---|---|\n| Description | Locks co-pilot controls, removes TakeVehicleControl action. enableCopilot must be set true to function. |\n| Syntax | *unit* action [\"LockVehicleControl\", *vehicle*] |\n| | Where *unit* is any unit, and *vehicle* is any vehicle with co-pilot controls. |\n| Example | `player action [\"LockVehicleControl\", vehicle player];` |\n\n### ManualFire\n\n| | |\n|---|---|\n| Description | Enables manual fire mode for a player unit that is driver or commander of a vehicle. This action toggled manual fire mode in old versions of ArmA. (See also isManualFire) |\n| Syntax | *unit* action [\"ManualFire\", *targetVehicle*] |\n| | Where *unit* is any unit (no action animation is performed) and *targetVehicle* is the vehicle in which manual fire mode is to be enabled. |\n| Example | `player action [\"ManualFire\", vehicle player];` |\n\n### ManualFireCancel\n\n| | |\n|---|---|\n| Description | Disables manual fire mode for a player unit that is driver or commander of a vehicle. (See also isManualFire) |\n| Syntax | *unit* action [\"ManualFireCancel\", *targetVehicle*] |\n| | Where *unit* is any unit (no action animation is performed) and *targetVehicle* is the vehicle in which manual fire mode is to be disabled. |\n| Example | `player action [\"ManualFireCancel\", vehicle player];` |\n\n### MarkEntity\n\n| | |\n|---|---|\n| Description | Use and effects unknown. Same as MarkWeapon action. |\n| Syntax | *unit* action [\"MarkEntity\", ] |\n| | |\n| Example | |\n\n### MoveToCargo\n\n| | |\n|---|---|\n| Description | Move a unit to the chosen cargo position within a vehicle. If another unit is already in that position, the units will swap positions. This works only with cargo positions that have no person turret, i.e. if player cannot shoot his rifle from them. If position is cargo but also person turret, it will be ignored. Use `fullCrew [_veh, \"cargo\", true]` to determine which positions are compatible cargo. |\n| Syntax | *unit* action [\"MoveToCargo\", *targetVehicle*, *cargoPosition*] |\n| | Where *unit* is a unit within *targetVehicle*, and *cargoPosition* is the number of the desired cargo position (0 being the first). |\n| Example | `player action [\"MoveToCargo\", vehicle player, 2];` |\n\n### MoveToCommander\n\n| | |\n|---|---|\n| Description | Move a unit to the commander's position within a vehicle. If another unit is already in that position, the units will swap positions. |\n| Syntax | *unit* action [\"MoveToCommander\", *targetVehicle*] |\n| | Where *unit* is a unit within *targetVehicle*. |\n| Example | `player action [\"MoveToCommander\", vehicle player];` |\n\n### MoveToDriver\n\n| | |\n|---|---|\n| Description | Move a unit to the driver's position within a vehicle. If another unit is already in that position, the units will generally swap positions, although in some scenarios this action may not work (although having the existing driver move always works). |\n| Syntax | *unit* action [\"MoveToDriver\", *targetVehicle*] |\n| | Where *unit* is a unit within *targetVehicle*. |\n| Example | `player action [\"MoveToDriver\", vehicle player];` |\n\n### MoveToGunner\n\n| | |\n|---|---|\n| Description | Move a unit to the primary gunner's position within a vehicle. If another unit is already in that position, the units will swap positions. See also moveToTurret. |\n| Syntax | *unit* action [\"MoveToGunner\", *targetVehicle*] |\n| | Where *unit* is a unit within *targetVehicle*. |\n| Example | `player action [\"MoveToGunner\", vehicle player];` |\n\n### MoveToPilot\n\n| |\n|---|\n| **Description**: Identical to moveToDriver. |\n\n### MoveToTurret\n\n| | |\n|---|---|\n| Description | Move a unit to the chosen turret position within a vehicle. If another unit is already in that position, the units will swap positions. |\n| Syntax | *unit* action [\"MoveToTurret\", *targetVehicle*, *turretArray*] |\n| | Where *unit* is a unit within *targetVehicle*, and *turret Array* is an array referring to the desired turret (for example, [0,1,2] refers to the third turret of the second turret of the first turret of the vehicle). |\n| Examples | `player action [\"MoveToTurret\", vehicle player, [0]];` |\n| | `player action [\"MoveToTurret\", vehicle player, [0,1]];` |\n\n### None\n\n| | |\n|---|---|\n| Description | Use and effects unknown. |\n| Syntax | *unit* action [\"None\", **] |\n| | |\n| Example | |\n\n### NVGoggles\n\n| | |\n|---|---|\n| Description | Causes a unit to put on it is night vision goggles. AI controlled units will automatically put on and take off goggles depending on daylight. |\n| Syntax | *unit* action [\"NvGoggles\", **] |\n| | Where *unit* is the unit to put on NVGoggles, and ** can be anything (it seems to not be used at all, but the action parameter array must contain at least two elements). |\n| Example | `player action [\"NvGoggles\", player];` |\n\n### NVGogglesOff\n\n| | |\n|---|---|\n| Description | Causes a unit to take off it is night vision goggles. AI controlled units will automatically put on and take off goggles depending on daylight. |\n| Syntax | *unit* action [\"NvGogglesOff\", **] |\n| | Where *unit* is the unit to put on goggles, and ** can be anything (it seems not to be used at all, but the action parameter array must contain at least two elements). |\n| Example | `player action [\"NvGogglesOff\", player];` |\n\n### OpenParachute\n\n| | |\n|---|---|\n| Description | Opens unit's parachute. Unit must have parachute backpack. |\n| Syntax | *unit* action [\"OpenParachute\", *unit*] |\n| | Where *unit* is the unit with parachute backpack. |\n| Example | `player action [\"OpenParachute\", player];` |\n\n### PutBag\n\n| | | |\n|---|---|---|\n| Description | Causes *sourceUnit* to bend over and put target backpack on the ground. If the *targetUnit* param is omitted or it is the same as *sourceUnit*, the *sourceUnit* will drop own backpack. If *targetUnit* is another unit, *sourceUnit* will bend over but *targetUnit* will drop its backpack at its feet. | |\n| Syntax | *sourceUnit* action [\"PutBag\", *targetUnit*] | |\n| | *targetUnit* is optional | |\n| Note | To pick the backpack from the ground use \"AddBag\" action. | |\n| Examples | ```sqf player action [\"PutBag\"]; unit1 action [\"PutBag\", unit2]; ``` | |\n\n### Rearm\n\n| | |\n|---|---|\n| Description | Causes an occupied vehicle or person to rearm from any object with some ammoCargo (generally an ammo truck) in the case of vehicles, or some magazines in it is cargo in the case of a rearming person. The rearming vehicle/person can be any distance from the rearming object. Rearming vehicles takes some time and will be interrupted if the vehicle starts to move. A rearming person will bend down as if picking up something. |\n| Syntax | *unit* action [\"Rearm\", *reamingObject*] |\n| | Where *unit* is the occupied vehicle or person to be rearmed, and *rearmingObject* is the object from which to rearm. |\n| Examples | `tankOne action [\"Rearm\", ammoTruckOne];` |\n| | `soldierOne action [\"Rearm\", ammoTruckOne];` |\n\n### Refuel\n\n| | |\n|---|---|\n| Description | Causes an occupied vehicle to refuel from any object with some fuelCargo (generally an refueling truck). The refueling object can be any distance from the vehicle. Refueling takes some time and will be interrupted if the vehicle starts to move. |\n| Syntax | *vehicle* action [\"Refuel\", *refuelingObject*] |\n| | Where *vehicle* is the occupied vehicle to be refueled, and *refuelingObject* is the object from which to refuel. |\n| Example | `tankOne action [\"Refuel\", refuelTruckOne];` |\n\n### Repair\n\n| | |\n|---|---|\n| Description | Causes an occupied vehicle to repair from any object with some repairCargo (generally an repair truck). The repair object can be any distance from the vehicle. Repairing takes some time and will be interrupted if the vehicle starts to move. |\n| Syntax | *vehicle* action [\"Repair\", *repairingObject*] |\n| | Where *vehicle* is the occupied vehicle to be repaired, and *repairingObject* is the object from which to repair. |\n| Example | `tankOne action [\"Repair\", repairTruckOne];` |\n\n### ReturnFlag\n\n| | |\n|---|---|\n| Description | Causes a person to return a flag from a nearby dead person back to it is flagpole. As of ArmA v1.12 this action is bugged and can not be used upon flags attached to destroyed vehicles. |\n| Syntax | *unit* action [\"ReturnFlag\", *targetObject*] |\n| | Where *unit* is any person, and *targetObject* is the dead person with a flag to be returned. |\n| Example | `soldierOne action [\"ReturnFlag\", westFlag];` |\n\n### RepairVehicle\n\n| | |\n|---|---|\n| Description | Causes an Engineer unit to repair an object using their Engineer Repair ability (from v1.54). The Engineer can be any distance from the vehicle. Repairing takes some time. If *unit* is not the Engineer class no repairs are made but the animation will still play. |\n| Syntax | *unit* action [\"RepairVehicle\", *vehicle*] |\n| | Where *unit* is an Engineer unit, and *vehicle* is the object to repair. |\n| Example | `engineerOne action [\"RepairVehicle\", truckOne];` |\n\n### Salute\n\n| | |\n|---|---|\n| Description | Causes a person to salute. AI controlled units will only make a momentary salute, unless the AI is in safe or careless behaviour mode. |\n| Syntax | *unit* action [\"Salute\", *targetUnit*] |\n| | Where *unit* is any unit (no animation is performed), and *targetUnit* is the person to make the salute. |\n| Example | `soldierOne action [\"Salute\", soldierOne];` |\n\n### ScudCancel\n\n| | |\n|---|---|\n| Description | There is no Scud Launcher in ArmA, however this action (probably) remains in the engine from the days of Operation Flashpoint. |\n| Syntax | *unit* action [\"ScudCancel\", *targetVehicle*] |\n| | Syntax unknown. |\n| Example | |\n\n### ScudLaunch\n\n| | |\n|---|---|\n| Description | There is no Scud Launcher in ArmA, however this action (probably) remains in the engine from the days of Operation Flashpoint. |\n| Syntax | *unit* action [\"ScudLaunch\", *targetVehicle*] |\n| | Syntax unknown. |\n| Example | |\n\n### ScudStart\n\n| | |\n|---|---|\n| Description | There is no Scud Launcher in ArmA, however this action (probably) remains in the engine from the days of Operation Flashpoint. |\n| Syntax | *unit* action [\"ScudStart\", *targetVehicle*] |\n| | Syntax unknown. |\n| Example | |\n\n### SearchlightOff\n\n| | |\n|---|---|\n| Description | Turns off the vehicle's searchlight. > [!NOTE] > Out of all the vanilla vehicles, only the WY-55 Hellcat has a searchlight and the action should be used on the copilot seat. See Arma 3: Lights - Search Light. |\n| Syntax | *unit* action [\"SearchlightOff\", *vehicle*] |\n| Example | hellcatCopilot action [\"SearchlightOff\", vehicle hellcatCopilot] |\n\n### SearchlightOn\n\n| | |\n|---|---|\n| Description | Turns on the searchlight. > [!NOTE] > Out of all the vanilla vehicles, only the WY-55 Hellcat has a searchlight and the action should be used on the copilot seat. See Arma 3: Lights - Search Light. |\n| Syntax | *unit* action [\"SearchlightOn\", *vehicle*] |\n| Example | hellcatCopilot action [\"SearchlightOn\", vehicle hellcatCopilot] |\n\n### SetTimer\n\n| | |\n|---|---|\n| Description | Soldier 'unitOne' plays the action animation. UnitTwo activates and adds 40 seconds to the timer for a satchel charge. Neither unit needs to be near the satchel. Charge has to be placed first using *unitname Fire [\"pipebombmuzzle\", \"pipebombmuzzle\", \"pipebomb\"]* or createMine command. |\n| Syntax | *unitOne* action [\"SetTimer\", *unitTwo*, *bombName*] |\n| | |\n| Example | |\n\n### SitDown\n\n| | |\n|---|---|\n| Description | Causes a person to sit down on the ground (or get up, if already sitting). AI controlled units will only stay seated if they are in safe or careless behaviour mode. |\n| Syntax | *unit* action [\"SitDown\", *targetUnit*] |\n| | Where *unit* is any unit (no animation is performed), and *targetUnit* is the person who is to sit down. |\n| Example | `soldierOne action [\"SitDown\", soldierOne];` |\n\n### StrokeFist\n\n| | |\n|---|---|\n| Description | Does nothing. There is no punch animation in Armed Assault and later titles, however this action remains in the engine from the days of Operation Flashpoint. |\n| Syntax | *unit* action [\"StrokeFist\", *targetVehicle*] |\n| | Syntax unknown. |\n| Example | |\n\n### StrokeGun\n\n| | |\n|---|---|\n| Description | Does nothing (other than making a person twitch a little). There is no suitable animation for this action in Armed Assault and later titles, however this action remains in the engine from the days of Operation Flashpoint. |\n| Syntax | *unit* action [\"StrokeGun\", *targetVehicle*] |\n| | Syntax unknown. |\n| Example | |\n\n### Surrender\n\n| | |\n|---|---|\n| Description | Makes unit to put weapon on shoulder and put hands behind the head temporarily. For the lasting effect all weapons from the unit should be removed first. |\n| Syntax | *unit* action [\"Surrender\", *targetUnit*] |\n| | Where *unit* is any unit, and *targetUnit* is the unit to surrender. |\n| Example | `soldierOne action [\"Surrender\", soldierTwo];` |\n\n### SuspendVehicleControl\n\n| | |\n|---|---|\n| Description | Release vehicle controls from co-pilot. Control immediately returns to pilot. |\n| Syntax | *unit* action [\"SuspendVehicleControl\", *vehicle*] |\n| | Where *unit* is any unit, and *vehicle* is any vehicle with co-pilot controls. |\n| Example | `player action [\"SuspendVehicleControl\", vehicle player];` |\n\n### SwitchMagazine\n\n| | |\n|---|---|\n| Description | Target unit switches to the given firing mode index. This allows selection of any firing mode for any weapon carried by a soldier, or mounted on a weapon. First are the firing modes for the primary weapon (index 0 upwards), then secondary weapon, then optics, then pistol, then thrown and placed weapons. Changing to NVGoggles just plays an animation, not actually setting NV mode. Unfortunately, the list of firing modes seems to only be created when a soldier is initiated; modes are removed from the list when a weapon is dropped and not re-added when a weapon is picked up. Thus, only use this during the initiation phase of the soldier. On vehicles, where the weapons are not likely to be changed, this action might be useful after the vehicle has been initiated. |\n| | If the mode index is higher than available indices, it assumes index 0. If you just want to change the muzzle used, rather than the firing mode, the standard command selectWeapon is generally more useful. |\n| Syntax | *unit* action [\"SwitchMagazine\", *targetVehicle*, *targetUnit*, *mode index*] |\n| | |\n| Example | ```sqf gameLogic action [\"SwitchMagazine\", unit1, unit1, 3]; gameLogic action [\"SwitchMagazine\", m1a1, gunner m1a1, 1]; ``` |\n\n### SwitchWeapon\n\n| | |\n|---|---|\n| Description | UnitOne plays the action animation. Target unit switches to the given muzzle/mode index. Target unit can also be a vehicle. The weapons array is a list of all weapon modes specific to each weapon, muzzle and firing mode combination. |\n| Syntax | *unit* action [\"SwitchWeapon\", *targetUnit*, *targetUnit*, *muzzle index*] |\n| | |\n| Example | ```sqf unit2 action [\"SwitchWeapon\", unit1, unit1, 7]; player action [\"SwitchWeapon\", player, player, 3]; // switching personal weapon player action [\"SwitchWeapon\", vehicle player, player, 3]; // switching vehicle weapon ``` |\n| | `player action [\"SwitchWeapon\", player, player, weaponIndex];` Result => weaponIndex: weaponState for \"B_soldier_LAT_F\" ``` 0: [\"arifle_MX_ACO_pointer_F\", \"arifle_MX_ACO_pointer_F\", \"Single\", \"30Rnd_65x39_caseless_mag\",30] 1: [\"arifle_MX_ACO_pointer_F\", \"arifle_MX_ACO_pointer_F\", \"FullAuto\", \"30Rnd_65x39_caseless_mag\",30] 2: [\"arifle_MX_ACO_pointer_F\", \"arifle_MX_ACO_pointer_F\", \"fullauto_medium\", \"30Rnd_65x39_caseless_mag\",30] 3: [\"arifle_MX_ACO_pointer_F\", \"arifle_MX_ACO_pointer_F\", \"single_medium_optics1\", \"30Rnd_65x39_caseless_mag\",30] 4: [\"arifle_MX_ACO_pointer_F\", \"arifle_MX_ACO_pointer_F\", \"single_far_optics2\", \"30Rnd_65x39_caseless_mag\",30] 5: [\"launch_NLAW_F\", \"launch_NLAW_F\", \"launch_NLAW_F\", \"NLAW_F\",1] 6: [\"hgun_P07_F\", \"hgun_P07_F\", \"hgun_P07_F\", \"16Rnd_9x21_Mag\",16] 7: [\"Throw\", \"HandGrenade_Stone\", \"HandGrenade_Stone\", \"\",0] 8: [\"Throw\", \"HandGrenadeMuzzle\", \"HandGrenadeMuzzle\", \"\",0] 9: [\"Throw\", \"MiniGrenadeMuzzle\", \"MiniGrenadeMuzzle\", \"\",0] 10: [\"Throw\", \"MiniGrenadeMuzzle\", \"MiniGrenadeMuzzle\", \"\",0] 11: [\"Throw\", \"SmokeShellYellowMuzzle\", \"SmokeShellYellowMuzzle\", \"\",0] 12: [\"Throw\", \"SmokeShellYellowMuzzle\", \"SmokeShellYellowMuzzle\", \"\",0] 13: [\"Throw\", \"SmokeShellRedMuzzle\", \"SmokeShellRedMuzzle\", \"\",0] 14: [\"Throw\", \"SmokeShellPurpleMuzzle\", \"SmokeShellPurpleMuzzle\", \"\",0] 15: [\"Throw\", \"SmokeShellOrangeMuzzle\", \"SmokeShellOrangeMuzzle\", \"\",0] 16: [\"Throw\", \"SmokeShellBlueMuzzle\", \"SmokeShellBlueMuzzle\", \"\",0] 17: [\"Throw\", \"SmokeShellBlueMuzzle\", \"SmokeShellBlueMuzzle\", \"\",0] 18: [\"Throw\", \"ChemlightRedMuzzle\", \"ChemlightRedMuzzle\", \"\",0] 19: [\"Throw\", \"ChemlightYellowMuzzle\", \"ChemlightYellowMuzzle\", \"\",0] 20: [\"Throw\", \"ChemlightBlueMuzzle\", \"ChemlightBlueMuzzle\", \"\",0] 21: [\"Throw\", \"IRGrenade\", \"IRGrenade\", \"\",0] 22: [\"Put\", \"DemoChargeMuzzle\", \"DemoChargeMuzzle\", \"\",0] 23: [\"Put\", \"PipeBombMuzzle\", \"PipeBombMuzzle\", \"\",0] 24: [\"Put\", \"MineMuzzle\", \"MineMuzzle\", \"\",0] 25: [\"Put\", \"ClassicMineRangeMuzzle\", \"ClassicMineRangeMuzzle\", \"\",0] 27: [\"Put\", \"BoundingMineRangeMuzzle\", \"BoundingMineRangeMuzzle\", \"\",0] 28: [\"Put\", \"DirectionalMineRangeMuzzle\", \"DirectionalMineRangeMuzzle\", \"\",0] 29: [\"Put\", \"ClassicMineWireMuzzle\", \"ClassicMineWireMuzzle\", \"\",0] ``` As of **2.10**, weaponsInfo is better suited for finding the desired weapon index. |\n\n### SwitchToUAVDriver\n\n| | |\n|---|---|\n| Description | Moves player control into driver position of connected UAV. Does what \"Take UAV controls\" UI action does. |\n| Syntax | *unit* action [\"SwitchToUAVDriver\", *uav*] |\n| | Where *unit* is a player and *uav* is the connected UAV. |\n| Example | `player action [\"SwitchToUAVDriver\", getConnectedUAV player];` |\n\n### SwitchToUAVGunner\n\n| | |\n|---|---|\n| Description | Moves player control into gunner position of connected UAV. Does what \"Take UAV turret controls\" UI action does. |\n| Syntax | *unit* action [\"SwitchToUAVGunner\", *uav*] |\n| | Where *unit* is a player and *uav* is the connected UAV. |\n| Example | `player action [\"SwitchToUAVGunner\", getConnectedUAV player];` |\n\n### TakeFlag\n\n| | |\n|---|---|\n| Description | Soldier 'unitname' takes control of 'flag1'. He must be close to the flagpole and it must belong to an enemy side. |\n| Syntax | *unit* action [\"TakeFlag\", *flag1*] |\n| | |\n| Example | `player action [\"TakeFlag\", FlagOne];` |\n\n### TakeMagazine\n\n| | |\n|---|---|\n| Description | Soldier 'unit' takes one magazine of specified type from the ground (Weaponholder) or from named vehicle (ammo box, car, etc.) Transfer happens immediately and via teleportation. Unit plays pickup animation at its current position, no matter where magazine is. Since Arma 3 v2.06.147667 optional param 'forcePutInBackpack' is added allowing to store picked up magazine in backpack. By default the magazine will go to any unit container with space, starting with uniform. |\n| Syntax | *unit* action [\"TakeMagazine\", *weaponholder*, *magazineName*, (*forcePutInBackpack*)] |\n| | Where *unit* is any unit, and *weaponholder* is storage container. |\n| Example1 | `player action [\"TakeMagazine\", ammoBox, \"RPGLauncher\"];` |\n| Example2 | Drop Magazine, then make your buddy Bob come and take magazine and put it in backpack: ```sqf 0 spawn { private _wh = \"Weapon_Empty\" createVehicle (player getRelPos [2, 0]); private _mag = currentMagazine player; player action [\"PutMagazine\", _wh, _mag]; private _bob = group player createUnit [\"B_Soldier_F\", player getRelPos [10, 0], [], 0, \"NONE\"]; _bob addBackpack \"B_AssaultPack_blk\"; _bob doMove position _wh; waitUntil { unitReady _bob }; _bob action [\"TakeMagazine\", _wh, _mag, true]; }; ``` |\n\n### TakeWeapon\n\n| | |\n|---|---|\n| Description | Soldier 'unitname' takes weapon of specified type (see list) from the ground (Weaponholder) or from named vehicle (ammo box, car, etc.) Transfer happens immediately and via teleportation. Unit1 plays pickup animation at its current position, no matter where weapon is. |\n| | *unit* action [\"TakeWeapon\", *vehicle*, *weaponName*] |\n| | Where *unit* is any unit, and *vehicle* is any unit or vehicle. |\n| Example | `player action [\"TakeWeapon\", SoldierTwo, currentWeapon player];` |\n\n### TakeMine\n\n| | |\n|---|---|\n| Description | Unit will perform pick up action animation. The closest mine that is within two meters of the target unit will be placed into the target unit's inventory. The mine has to be active for this action to succeed. If there is not enough room in the target inventory, the mine will still be picked up but will not appear in inventory. See createMine for how to place explosive by script. |\n| Syntax | *unit* action [\"TakeMine\", *targetUnit*] |\n| | |\n| Example | `player action [\"TakeMine\", player];` |\n\n### TakeVehicleControl\n\n| | | |\n|---|---|---|\n| Description | In case of a helicopter, copilot will take flying controls, even if enableCopilot is disabled and isCopilotEnabled is false. | Use SuspendVehicleControl action to release control. |\n| Syntax | *unit* action [\"TakeVehicleControl\", *vehicle*] | |\n| | Where *unit* is any unit, and *vehicle* is any vehicle with co-pilot controls. | |\n| Example | `player action [\"TakeVehicleControl\", vehicle player];` | |\n\n### Talk\n\n| | |\n|---|---|\n| Description | Use and effects unknown. |\n| Syntax | *unit* action [\"Talk\", *target*] |\n| | |\n| Example | |\n\n### TeamSwitch\n\n| | |\n|---|---|\n| Description | Opens the normal team-switch dialog. will be greyed out in the list and thus unselectable. The effect of the second array element is unknown, but it must be a unit. Works in single-player game only (in MP games, will just momentarily show the mouse cursor without the team-switch window being shown). |\n| Syntax | *currentUnit* action [\"TeamSwitch\", *unit*] |\n| | |\n| Example | `player action [\"TeamSwitch\", player];` |\n\n### TouchOff\n\n| | |\n|---|---|\n| Description | Soldier 'unitOne' plays the action animation. UnitTwo's satchels are \"touched off\". UnitTwo must be within range (300m) of his satchels to touch them off. See createMine for how to place explosives with script. |\n| Syntax | *unitOne* action [\"TouchOff\", *unitTwo*] |\n| | |\n| Example | `player action [\"TouchOff\", player];` |\n\n### TurnIn\n\n### TurnOut\n\n| | |\n|---|---|\n| Description | Crew of 'vehiclename' turns in/out (gets in and out of hatches). UnitName must be a player in effective commander of vehicleName. AI will automatically turn in/out based on their current behaviour mode. Only to be used on positions that have the turnIn/turnOut capability (otherwise it breaks the cargo anim). |\n| Syntax | *unit* action [\"TurnIn\", *vehicle*] |\n| | *unit* action [\"TurnOut\", *vehicle*] |\n| | |\n| Example | ```sqf commander TankOne action [\"TurnIn\", TankOne]; player action [\"TurnOut\", vehicle player]; ``` |\n\n### UAVTerminalHackConnection\n\n| | |\n|---|---|\n| Description | Hacks into given UAV. Does what \"Hack UAV\" UI action does. Player has to be in normal UI action proximity to the UAV for this action to work. > [!NOTE] > Controlling a UAV/UGV in Arma 3 is done via remote controlling the invisible driver or gunner AI. These AI units have to be on the same side as player. \"Hacking\" is essentially placing own AI into the UAV/UGV, either replacing existing AI, or creating own AI in empty positions (for example when UAV/UGV is placed 'without crew') |\n| Syntax | *unit* action [\"UAVTerminalHackConnection\", *uav*] |\n| | Where *unit* is any unit (enemy to the drone) and *uav* is the UAV to hack. |\n| Example | `player action [\"UAVTerminalHackConnection\", drone];` |\n\n### UAVTerminalMakeConnection\n\n| | |\n|---|---|\n| Description | Connects player to chosen UAV. Does what \"Connect terminal to UAV\" UI action does. **NOTE**: Player has to be in normal UI action proximity to the UAV for this action to work. To connect to far away UAV use connectTerminalToUAV command instead. |\n| Syntax | *unit* action [\"UAVTerminalMakeConnection\", *uav*] |\n| | Where *unit* is a player and *uav* is UAV to be connected to. |\n| Example | `player action [\"UAVTerminalMakeConnection\", allUnitsUAV select 0];` |\n\n### UAVTerminalOpen\n\n| | |\n|---|---|\n| Description | Opens UAV Terminal UI. Player must have UAV Terminal item in GPS slot of inventory. Does what \"Open UAV Terminal\" UI action does. |\n| Syntax | *unit* action [\"UAVTerminalOpen\", *unit*] |\n| | Where *unit* is a player. |\n| Example | `player action [\"UAVTerminalOpen\", player];` |\n\n### UAVTerminalReleaseConnection\n\n| | |\n|---|---|\n| Description | Disconnects player from connected UAV. Does what \"Disconnect terminal from UAV\" UI action does. **NOTE**: Unlike with \"UAVTerminalMakeConnection\", player can be far away from the UAV. Notice how the passed params are swapped around for this action. |\n| Syntax | *uav* action [\"UAVTerminalReleaseConnection\", *unit*] |\n| | Where *uav* is the connected UAV and *unit* is the player controlling it. |\n| Example | `getConnectedUAV player action [\"UAVTerminalReleaseConnection\", player];` |\n\n### UnlockVehicleControl\n\n| | |\n|---|---|\n| Description | Unlocks co-pilot controls, shows Take Control action. enableCopilot must be set true to function. |\n| Syntax | *unit* action [\"UnlockVehicleControl\", *vehicle*] |\n| | Where *unit* is any unit, and *vehicle* is any vehicle with co-pilot controls. |\n| Example | `player action [\"UnlockVehicleControl\", vehicle player];` |\n\n### UseMagazine\n\n| | |\n|---|---|\n| Description | Loads a weapon with magazine with known id and fires that weapon. The weapon is selected based on magazine type. Details for and can be found with magazinesDetail command (not 100% about but it seems 0 works for all weapons) |\n| Syntax | *logic* action [\"UseMagazine\", *target*, *magazine creator*, **, **] |\n| | |\n| Example | ```sqf private _logic = createGroup west createUnit [\"Logic\", [0,0,0], [], 0, \"NONE\"]; hint str magazinesDetail player; // loaded mags not shown /*[ \"6.5mm 30Rnd STANAG Mag(30/30)[id/cr:3/0]\", \"Smoke Round (White)(1/1)[id/cr:121/0]\", \"Smoke Round (White)(1/1)[id/cr:122/0]\", \"9mm 16Rnd Mag(16/16)[id/cr:11/0]\" ]*/ _logic action [\"UseMagazine\", player, player, 0, 3]; // loads rifle with mag id 3 and fires _logic action [\"UseMagazine\", player, player, 0, 11]; // loads pistol with mag id 11 and fires from inventory _logic action [\"UseMagazine\", player, player, 0, 121]; // throws smoke grenade with id 121 ``` |\n\n### User\n\n| | |\n|---|---|\n| Description | Soldier 'unitName' does nothing. Executes the custom action with the given index of the the target unit. Indexes are based upon the order in which the actions are added to the unit. See addAction. |\n| Syntax | *unitName* action [\"User\", *target unit*, *action index*] |\n| | |\n| Example | `gameLogic action [\"User\", player, 3];` |\n\n### UserType\n\n| | |\n|---|---|\n| Description | As of ArmA version 1.08, using this action type will cause ArmA to crash to desktop. |\n| Syntax | *unit* action [\"UserType\", *target*, *action index*] |\n| | |\n| Example | |\n\n### UseWeapon\n\n| | |\n|---|---|\n| Description | Soldier 'unitOne' will play the action animation. Target unit will fire the specified unit's position in the target vehicle's (can be the unit itself) weapon mode index. The indexes seem to be based upon the order in which weapons are added to the unit/vehicle, with each weapon's muzzle's fire mode having an unique index. Weapons can be fired in this way from a not-readied position (eg, firing a rifle on a soldiers back). Pistols will fire from the current weapon's proxy. It can also be used to sound the horn on AI controlled vehicles. |\n| | **NOTE:** If 'unitOne' is player object, the player goes into pick up animation before action is performed. If 'unitOne' is a game logic, the action is performed immediately with no animation. |\n| Syntax | *unitOne* action [\"UseWeapon\", *target vehicle*, *target unit*, *weapon index*] |\n| | |\n| Example | ```sqf _logic = createGroup west createUnit [\"Logic\", [0,0,0], [], 0, \"NONE\"]; _logic action [\"UseWeapon\", player, player, 0]; // player fires single shot _logic action [\"UseWeapon\", player, player, 2]; // player fires 3 round burst _logic action [\"UseWeapon\", player, player, 5]; // player fires pistol from inventory _logic action [\"UseWeapon\", player, player, 7]; // player throws hand grenade _logic action [\"UseWeapon\", car, car, 0]; // car sounds its horn // more examples gameLogic action [\"UseWeapon\", unit1, unit1, 16]; gameLogic action [\"UseWeapon\", vehicle unit1, unit1, 0]; gameLogic action [\"UseWeapon\", myTank, gunner myTank, 1]; gameLogic action [\"UseWeapon\", myTank, commander myTank, 0]; ``` |\n\n### VectoringDown\n\n| | |\n|---|---|\n| Description | If VTOL auto-vectoring is off, incremental forward tilt of engine nacelles. |\n| Syntax | *unit* action [\"VectoringDown\", *vehicle*] |\n| | |\n| Example | |\n\n### VectoringUp\n\n| | |\n|---|---|\n| Description | If VTOL auto-vectoring is off, incremental upward tilt of engine nacelles. |\n| Syntax | *unit* action [\"VectoringUp\", *vehicle*] |\n| | |\n| Example | |\n\n### VTOLVectoring\n\n| | |\n|---|---|\n| Description | Toggles **off** VTOL auto-vectoring (manual mode) |\n| Syntax | *unit* action [\"VTOLVectoring\", *vehicle*] |\n| | |\n| Example | |\n\n### VTOLVectoringCancel\n\n| | |\n|---|---|\n| Description | Toggles **on** VTOL auto-vectoring (forward mode) |\n| Syntax | *unit* action [\"VTOLVectoringCancel\", *vehicle*] |\n| | |\n| Example | |\n\n### WeaponInHand / WeaponOnBack\n\n| | |\n|---|---|\n| Description | Soldier 'unitName' does nothing, 'target unit' moves his weapon from/to the safety position (gun held across chest pointing at the ground). Change is persistent with player, but AI units will change back to suit their current setBehaviour\\|behaviour mode. AI generally keep their rifles safe unless moving or targeting. |\n| Syntax | *unitName* action [\"WeaponInHand\", *target unit*] |\n| | *unitName* action [\"WeaponOnBack\", *target unit*] |\n| | |\n| Example | `SoldierOne action [\"WeaponOnBack\", SoldierTwo];` |\n\n### WheelsBrakeOn\n\n| | |\n|---|---|\n| Description | Engages wheels brakes on RTM helicopter |\n| Syntax | *unit* action [\"WheelsBrakeOn\", *vehicle*] |\n| | |\n| Example | `player action [\"WheelsBrakeOn\", heli];` |\n\n### WheelsBrakeOff\n\n| | |\n|---|---|\n| Description | Disengages wheels brakes on RTM helicopter |\n| Syntax | *unit* action [\"WheelsBrakeOff\", *vehicle*] |\n| | |\n| Example | `player action [\"WheelsBrakeOff\", heli];` |\n\n## Unsorted actions found in UI.pbo/config.bin\n\n### LoadOtherMagazine\n\n| | |\n|---|---|\n| Description | |\n| Syntax | |\n| | |\n| Example | |\n\n### LoadEmptyMagazine\n\n| | |\n|---|---|\n| Description | |\n| Syntax | |\n| | |\n| Example | |\n\n### PutWeapon\n\n| | |\n|---|---|\n| Description | Is alias of DropWeapon |\n| Syntax | |\n| | |\n| Example | ```sqf _wh = \"GroundWeaponHolder_Scripted\" createVehicle position player; player action [\"PutWeapon\", _wh, currentWeapon player]; ``` |\n\n### PutMagazine\n\n| | |\n|---|---|\n| Description | is synonym for DropMagazine (same syntax)? |\n| Syntax | |\n| | |\n| Example | |\n\n### StartTimer\n\n| | |\n|---|---|\n| Description | is synonym for SetTimer (same syntax) ? |\n| Syntax | |\n| | |\n| Example | |\n\n### HideWeapon\n\n| | |\n|---|---|\n| Description | |\n| Syntax | unit action [\"HideWeapon\",