Attack Task Module

Description

This module adds support for Attack Tasks/Missions.

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

A threshold must be set, specifying the given amount of targets that have to be eliminated in order to complete the task.

The module can also trigger mission complete or mission fail.

Usage

Setup Target(s)

Setup the Attack Task set
Place down the target unit(s)
Call the forge_client_task_fnc_makeTarget function within the targets' init field that links the unit to the Attack Task

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

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

Register Task

// Arguments:
//  0: STRING - ID of the task
//  1: SCALAR - Number of targets escaped to fail the task
//  2: SCALAR - Number of targets eliminated to complete the task
//  3: SCALAR - Amount of funds the company recieves if the task is successful (default: 0)
//  4: SCALAR - Amount of rating the company and player lose if the task is failed (default: 0)
//  5: SCALAR - Amount of rating the company and player recieve if the task is successful (default: 0)
//  6: BOOLEAN - Should the mission end (MissionSuccess) if the task is successful (Optional, default: false)
//  7: BOOLEAN - Should the mission end (MissionFailed) if the task is failed (Optional, default: false)
//  8: SCALAR - Number of seconds before targets escape (Optional)

// Example:
    // Default No Time Limit
    ["task_name", 1, 2, 1500000, -75, 375, false, false] spawn forge_client_task_fnc_attack;

    // Attack Within Time Limit
    ["task_name", 1, 2, 1500000, -75, 375, false, false, 45] spawn forge_client_task_fnc_attack;

Links