Hostage Task Module

Description

This module adds support for Hostage Tasks/Missions.

The mission maker must define hostage units, the framework will monitor the status of those units.

An extraction area and a threshhold must be set, specifying a given amount of hostages that have to be in the extraction zone in order to complete the task.

The module can also trigger mission complete or mission fail.

Usage

Setup Hostage(s)

Setup the Hostage Task set
Place down the hostage unit(s)
Place down an area marker that marks the extraction zone, also give it a unique name
Call the forge_client_task_fnc_makeHostage function within the hostages' init field that links the unit to the Hostage Task

// Arguments:
//  0: OBJECT - The AI unit
//  1: STRING - The ID of the task

// Example:
    [this, "task_name"] call forge_client_task_fnc_makeHostage;

Setup Shooter(s)

Place down the shooter units(s) (Optional)
Call the forge_client_task_fnc_makeShooter function within the shooters' init field that links the unit to the Hostage Task (Optional, Shooter Unit(s) Must Be Placed)

// Arguments:
//  0: OBJECT - The AI unit
//  1: STRING - The ID of the task

// Example:
    [this, "task_name"] call forge_client_task_fnc_makeShooter;

Register Task

// Arguments:
//  0: STRING - ID of the task
//  1: SCALAR - Number of hostages KIA to fail the task
//  2: SCALAR - Number of hostages rescued to complete the task
//  3: STRING - Marker name for the extraction zone
//  4: SCALAR - Amount of funds the company recieves if the task is successful (default: 0)
//  5: SCALAR - Amount of rating the company and player lose if the task is failed (default: 0)
//  6: SCALAR - Amount of rating the company and player recieve if the task is successful (default: 0)
//  7: ARRAY - Subcategory of task type to select from (Optional, default: [false, true])
//  8: BOOLEAN - Should the mission end (MissionSuccess) if the task is successful (Optional, default: false)
//  9: BOOLEAN - Should the mission end (MissionFailed) if the task is failed (Optional, default: false)
//  10: SCALAR - Number of seconds before hostages are killed (Optional)
//  11: STRING - Marker name for the cbrn zone

// Example:
    // Default No Time Limit
    ["task_name", 1, 2, "marker_name", 1500000, -75, 500, [false, true], false, false] spawn forge_client_task_fnc_hostage;

    // CBRN Attack When Time Limit Expires
    ["task_name", 1, 2, "marker_name", 1500000, -75, 500, [false, true], false, false, 45] spawn forge_client_task_fnc_hostage;

    // Execution When Time Limit Expires
    ["task_name", 1, 2, "marker_name", 1500000, -75, 500, [true, false], false, false, 45, "marker_name"] spawn forge_client_task_fnc_hostage;

Links

FORGE - Hostage Task