HVT Task Module

Description

This module adds support for HVT Capture or Eliminate Tasks/Missions.

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

An extraction area and a threshold must be set, specifying the given amount of HVTs that have to be in the extraction zone or eliminated in order to complete the task.

The module can also trigger mission complete or mission fail.

Usage

Setup HVT(s)

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

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

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

Register Task

// Arguments:
//  0: STRING - ID of the task
//  1: SCALAR - Number of hvts KIA or escaped to fail the task
//  2: SCALAR - Number of captured or eliminated hvts 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: [true, false])
//  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 hvts escape (Optional)

// Example:
    // Capture No Time Limit
    ["task_name", 1, 1, "marker_name", 500000, -75, 300, [true, false], false, false] spawn forge_client_task_fnc_hvt;

    // Eliminate No Time Limit
    ["task_name", -1, 1, "", 500000, -75, 300, [false, true], false, false] spawn forge_client_task_fnc_hvt;

    // Capture Within Time Limit
    ["task_name", 1, 1, "marker_name", 500000, -75, 300, [true, false], false, false, 45] spawn forge_client_task_fnc_hvt;

    // Eliminate Within Time Limit
    ["task_name", -1, 1, "", 500000, -75, 300, [false, true], false, false, 45] spawn forge_client_task_fnc_hvt;

Links