ACE3/documentation/feature/captives.md

---
layout: wiki
title: Captives
description: System for taking and handling captives
group: feature
parent: wiki
---

## 1. Overview

### 1.1 Take captives
Introduces a captivity system.

### 1.2 Load and unload captives into / from vehicles
You can load and unload captives from vehicles using ACE3 interactions.

### 1.3 Frisk captives
You can frisk a restrained captive.

### 1.4 Surrendering
Allows players to surrender. It renders the unit unable to move and with the hands behind its head. When surrendered AI won't fire.

## 2. Usage

### 2.1 Taking a unit into captivity
- You need `Cable Tie`.
- Approach the unit and Interact <kbd>⊞ win</kbd> (ACE3 default).
- The interaction is located around the hands in the form of a handcuffs icon.
- Repeat to release.

### 2.2 Escorting a captive
- Interact with the captive <kbd>⊞ win</kbd>.
- Select the `Escort prisoner` option.
- To stop escorting, use the mousewheel and select `Release` or use Self Interaction <kbd>Ctrl</kbd>+<kbd>⊞ win</kbd> and select `Release`.

### 2.3 Loading and unloading a captive into/from a vehicle
- Escort the captive.
- Approach the vehicle you wish to load the captive unit into.
- Interact with the vehicle <kbd>⊞ win</kbd> and select `Load captive`.
- To unload the captive interact with the vehicle <kbd>⊞ win</kbd>
- Select `Passengers`.
- Select the captive.
- Select `Unload captive`.

## 3. Dependencies

`ace_interaction`
Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start. 2015-05-13 00:28:18 +00:00			`---`
			`layout: wiki`
			`title: Captives`
Docs: proofread, 1st iteration Proofread AB, AI, Aircraft, Attach, Backpacks, Ballistics and Captives Fix typos, grammar, inconsistencies Not fully satisfied with captives, will reiterate 2015-05-17 22:39:48 +00:00			`description: System for taking and handling captives`
Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start. 2015-05-13 00:28:18 +00:00			`group: feature`
			`parent: wiki`
			`---`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Documentation pass2 - guidelines added - classnames added 2015-05-15 15:08:29 +00:00			`## 1. Overview`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Documentation pass2 - guidelines added - classnames added 2015-05-15 15:08:29 +00:00			`### 1.1 Take captives`
Docs: proofread continues Perform proofread on all \documentation\feature\ starting from AB till Explosives. All mentioned docs are uniform/standardized. Improve grammar, typos, etc. 2015-05-19 20:15:26 +00:00			`Introduces a captivity system.`
Documentation pass Documentation improved for - ai - aircraft - attach - captives 2015-05-13 19:26:51 +00:00
Documentation pass2 - guidelines added - classnames added 2015-05-15 15:08:29 +00:00			`### 1.2 Load and unload captives into / from vehicles`
Docs: proofread, 1st iteration Proofread AB, AI, Aircraft, Attach, Backpacks, Ballistics and Captives Fix typos, grammar, inconsistencies Not fully satisfied with captives, will reiterate 2015-05-17 22:39:48 +00:00			`You can load and unload captives from vehicles using ACE3 interactions.`
Documentation pass Documentation improved for - ai - aircraft - attach - captives 2015-05-13 19:26:51 +00:00
Documentation pass2 - guidelines added - classnames added 2015-05-15 15:08:29 +00:00			`### 1.3 Frisk captives`
Documentation pass Documentation improved for - ai - aircraft - attach - captives 2015-05-13 19:26:51 +00:00			`You can frisk a restrained captive.`

Documentation pass2 - guidelines added - classnames added 2015-05-15 15:08:29 +00:00			`### 1.4 Surrendering`
fix some documenation (didn't touch medical and mortar) 2015-06-03 13:15:14 +00:00			`Allows players to surrender. It renders the unit unable to move and with the hands behind its head. When surrendered AI won't fire.`
Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start. 2015-05-13 00:28:18 +00:00
Documentation pass2 - guidelines added - classnames added 2015-05-15 15:08:29 +00:00			`## 2. Usage`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Docs: proofread continues Perform proofread on all \documentation\feature\ starting from AB till Explosives. All mentioned docs are uniform/standardized. Improve grammar, typos, etc. 2015-05-19 20:15:26 +00:00			`### 2.1 Taking a unit into captivity`
			- You need `Cable Tie`.
documentation pass 7 2015-06-25 18:59:00 +00:00			`- Approach the unit and Interact <kbd>⊞ win</kbd> (ACE3 default).`
Docs: proofread continues Perform proofread on all \documentation\feature\ starting from AB till Explosives. All mentioned docs are uniform/standardized. Improve grammar, typos, etc. 2015-05-19 20:15:26 +00:00			`- The interaction is located around the hands in the form of a handcuffs icon.`
			`- Repeat to release.`
Insert additional newlines 2015-05-14 14:02:01 +00:00
Documentation pass2 - guidelines added - classnames added 2015-05-15 15:08:29 +00:00			`### 2.2 Escorting a captive`
documentation pass 7 2015-06-25 18:59:00 +00:00			`- Interact with the captive <kbd>⊞ win</kbd>.`
Docs: proofread continues Perform proofread on all \documentation\feature\ starting from AB till Explosives. All mentioned docs are uniform/standardized. Improve grammar, typos, etc. 2015-05-19 20:15:26 +00:00			- Select the `Escort prisoner` option.
Documentation pass 8 - Finished: MicroDAGR doc, note that the images can't be viewed properly on GitHub. - Coding guidelines are more readable now, added the STRING family of macros to it. - How to enable dragging / carrying added to dragging / carrying framework with a BIG disclaimer that the functions are not public and may change. - Shortcut updated to fit the convention established in the shortcut page. 2015-06-30 14:04:00 +00:00			- To stop escorting, use the mousewheel and select `Release` or use Self Interaction <kbd>Ctrl</kbd>+<kbd>⊞ win</kbd> and select `Release`.
Insert additional newlines 2015-05-14 14:02:01 +00:00
Docs: proofread, 1st iteration Proofread AB, AI, Aircraft, Attach, Backpacks, Ballistics and Captives Fix typos, grammar, inconsistencies Not fully satisfied with captives, will reiterate 2015-05-17 22:39:48 +00:00			`### 2.3 Loading and unloading a captive into/from a vehicle`
Docs: proofread continues Perform proofread on all \documentation\feature\ starting from AB till Explosives. All mentioned docs are uniform/standardized. Improve grammar, typos, etc. 2015-05-19 20:15:26 +00:00			`- Escort the captive.`
			`- Approach the vehicle you wish to load the captive unit into.`
documentation pass 7 2015-06-25 18:59:00 +00:00			- Interact with the vehicle <kbd>⊞ win</kbd> and select `Load captive`.
			`- To unload the captive interact with the vehicle <kbd>⊞ win</kbd>`
			- Select `Passengers`.
			`- Select the captive.`
			- Select `Unload captive`.
Merge branch 'doc-dependencies' of https://github.com/dharmab/ACE3 into docs-merge 2015-05-14 14:44:44 +00:00
Documentation pass2 - guidelines added - classnames added 2015-05-15 15:08:29 +00:00			`## 3. Dependencies`
Create missing documentation placeholders Creates placeholder documentation for modules which did not previously have any. If a module had the same name and apparent purpose as a module from AGM, AGM's documentation was imported into the placeholder. These documentation are useful to users for explaining what ACE3 changes. They are also useful to community admins who want to create a custom distribution of ACE3 and need to know which modules to disable. The documentation needs to be significantly fleshed out before it's ready for public consumption, but this should be a helpful start. 2015-05-13 00:28:18 +00:00
Document module dependencies Add a list of dependencies to each module's documentation. Also add a note to the documenation of modules which are a dependency for many other modules. Dependency lists are pulled from each module's config.cpp. 2015-05-13 19:31:53 +00:00			`ace_interaction`