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 for taking and moving prisoners.

### 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
You can surrender. While surrendering AI will cease fire.


## 2. Usage

### 2.1 Capturing someone
- You need `cable ties`.
- Approach the victim / convict and use the interaction button <kbd> left windows </kbd> (by default).
- The interaction is around the hands in the form of a handcuffs icon.
- To free someone simply use that icon again.

### 2.2 Escorting a captive
- Interact with the captive <kbd> left windows </kbd> (by default).
- Select the escort prisoner option.
- To stop escorting just scroll down and select `release` or use self interaction <kbd> ctrl+left windows </kbd> (by default) and select `release`.

### 2.3 Loading and unloading a captive into/from a vehicle
- Escort the person.
- Approach the vehicle you desire to load the captive in.
- Interact with the vehicle <kbd> left windows </kbd> (by default) and load him.
- Same for unloading, interact with the vehicle then unload.

## 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`
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			`Introduces a captivity system for taking and moving prisoners.`
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 typos/grammar/redundancy 2015-05-14 23:24:53 +00:00			`You can surrender. While surrendering AI will cease 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
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
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
Documentation pass2 - guidelines added - classnames added 2015-05-15 15:08:29 +00:00			`### 2.1 Capturing someone`
			- You need `cable ties`.
			`- Approach the victim / convict and use the interaction button <kbd> left windows </kbd> (by default).`
Insert additional newlines 2015-05-14 14:02:01 +00:00			`- The interaction is around the hands in the form of a handcuffs icon.`
Documentation pass2 - guidelines added - classnames added 2015-05-15 15:08:29 +00:00			`- To free someone simply use that icon again.`
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`
			`- Interact with the captive <kbd> left windows </kbd> (by default).`
			`- Select the escort prisoner option.`
classnames update 2015-05-16 12:29:03 +00:00			- To stop escorting just scroll down and select `release` or use self interaction <kbd> ctrl+left windows </kbd> (by default) 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`
Documentation pass2 - guidelines added - classnames added 2015-05-15 15:08:29 +00:00			`- Escort the person.`
Insert additional newlines 2015-05-14 14:02:01 +00:00			`- Approach the vehicle you desire to load the captive in.`
Documentation pass2 - guidelines added - classnames added 2015-05-15 15:08:29 +00:00			`- Interact with the vehicle <kbd> left windows </kbd> (by default) and load him.`
			`- Same for unloading, interact with the vehicle then unload.`
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`