[{"data":1,"prerenderedAt":264},["ShallowReactive",2],{"content-query-MVUnjQvb8r":3},{"_path":4,"_dir":5,"_draft":6,"_partial":6,"_locale":7,"title":8,"description":7,"icon":9,"body":10,"_type":258,"_id":259,"_source":260,"_file":261,"_stem":262,"_extension":263},"/client/task/hostage","task",false,"","FORGE - Hostage Task","mdi:cog-outline",{"type":11,"children":12,"toc":247},"root",[13,22,29,35,40,45,50,56,63,97,109,115,155,164,170,187,196,202],{"type":14,"tag":15,"props":16,"children":18},"element","h1",{"id":17},"hostage-task-module",[19],{"type":20,"value":21},"text","Hostage Task Module",{"type":14,"tag":23,"props":24,"children":26},"h2",{"id":25},"description",[27],{"type":20,"value":28},"Description",{"type":14,"tag":30,"props":31,"children":32},"p",{},[33],{"type":20,"value":34},"This module adds support for Hostage Tasks/Missions.",{"type":14,"tag":30,"props":36,"children":37},{},[38],{"type":20,"value":39},"The mission maker must define hostage units, the framework will monitor the status of those units.",{"type":14,"tag":30,"props":41,"children":42},{},[43],{"type":20,"value":44},"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.",{"type":14,"tag":30,"props":46,"children":47},{},[48],{"type":20,"value":49},"The module can also trigger mission complete or mission fail.",{"type":14,"tag":23,"props":51,"children":53},{"id":52},"usage",[54],{"type":20,"value":55},"Usage",{"type":14,"tag":57,"props":58,"children":60},"h3",{"id":59},"setup-hostages",[61],{"type":20,"value":62},"Setup Hostage(s)",{"type":14,"tag":64,"props":65,"children":66},"ol",{},[67,73,78,83],{"type":14,"tag":68,"props":69,"children":70},"li",{},[71],{"type":20,"value":72},"Setup the Hostage Task set",{"type":14,"tag":68,"props":74,"children":75},{},[76],{"type":20,"value":77},"Place down the hostage unit(s)",{"type":14,"tag":68,"props":79,"children":80},{},[81],{"type":20,"value":82},"Place down an area marker that marks the extraction zone, also give it a unique name",{"type":14,"tag":68,"props":84,"children":85},{},[86,88,95],{"type":20,"value":87},"Call the ",{"type":14,"tag":89,"props":90,"children":92},"code",{"className":91},[],[93],{"type":20,"value":94},"forge_client_task_fnc_makeHostage",{"type":20,"value":96}," function within the hostages' init field that links the unit to the Hostage Task",{"type":14,"tag":98,"props":99,"children":104},"pre",{"className":100,"code":102,"language":103,"meta":7},[101],"language-sqf","// Arguments:\n//  0: OBJECT - The AI unit\n//  1: STRING - The ID of the task\n\n// Example:\n    [this, \"task_name\"] call forge_client_task_fnc_makeHostage;\n","sqf",[105],{"type":14,"tag":89,"props":106,"children":107},{"__ignoreMap":7},[108],{"type":20,"value":102},{"type":14,"tag":57,"props":110,"children":112},{"id":111},"setup-shooters",[113],{"type":20,"value":114},"Setup Shooter(s)",{"type":14,"tag":64,"props":116,"children":118},{"start":117},5,[119,130],{"type":14,"tag":68,"props":120,"children":121},{},[122,124],{"type":20,"value":123},"Place down the shooter units(s) ",{"type":14,"tag":125,"props":126,"children":127},"em",{},[128],{"type":20,"value":129},"(Optional)",{"type":14,"tag":68,"props":131,"children":132},{},[133,134,140,142],{"type":20,"value":87},{"type":14,"tag":89,"props":135,"children":137},{"className":136},[],[138],{"type":20,"value":139},"forge_client_task_fnc_makeShooter",{"type":20,"value":141}," function within the shooters' init field that links the unit to the Hostage Task ",{"type":14,"tag":125,"props":143,"children":144},{},[145,147,153],{"type":20,"value":146},"(Optional, ",{"type":14,"tag":148,"props":149,"children":150},"strong",{},[151],{"type":20,"value":152},"Shooter Unit(s) Must Be Placed",{"type":20,"value":154},")",{"type":14,"tag":98,"props":156,"children":159},{"className":157,"code":158,"language":103,"meta":7},[101],"// Arguments:\n//  0: OBJECT - The AI unit\n//  1: STRING - The ID of the task\n\n// Example:\n    [this, \"task_name\"] call forge_client_task_fnc_makeShooter;\n",[160],{"type":14,"tag":89,"props":161,"children":162},{"__ignoreMap":7},[163],{"type":20,"value":158},{"type":14,"tag":57,"props":165,"children":167},{"id":166},"register-task",[168],{"type":20,"value":169},"Register Task",{"type":14,"tag":64,"props":171,"children":173},{"start":172},6,[174],{"type":14,"tag":68,"props":175,"children":176},{},[177,179,185],{"type":20,"value":178},"Register the Hostage Task by calling the ",{"type":14,"tag":89,"props":180,"children":182},{"className":181},[],[183],{"type":20,"value":184},"forge_client_task_fnc_hostage",{"type":20,"value":186}," function within the init field of the task",{"type":14,"tag":98,"props":188,"children":191},{"className":189,"code":190,"language":103,"meta":7},[101],"// Arguments:\n//  0: STRING - ID of the task\n//  1: SCALAR - Number of hostages KIA to fail the task\n//  2: SCALAR - Number of hostages rescued to complete the task\n//  3: STRING - Marker name for the extraction zone\n//  4: SCALAR - Amount of funds the company recieves if the task is successful (default: 0)\n//  5: SCALAR - Amount of rating the company and player lose if the task is failed (default: 0)\n//  6: SCALAR - Amount of rating the company and player recieve if the task is successful (default: 0)\n//  7: ARRAY - Subcategory of task type to select from (Optional, default: [false, true])\n//  8: BOOLEAN - Should the mission end (MissionSuccess) if the task is successful (Optional, default: false)\n//  9: BOOLEAN - Should the mission end (MissionFailed) if the task is failed (Optional, default: false)\n//  10: SCALAR - Number of seconds before hostages are killed (Optional)\n//  11: STRING - Marker name for the cbrn zone\n\n// Example:\n    // Default No Time Limit\n    [\"task_name\", 1, 2, \"marker_name\", 1500000, -75, 500, [false, true], false, false] spawn forge_client_task_fnc_hostage;\n\n    // CBRN Attack When Time Limit Expires\n    [\"task_name\", 1, 2, \"marker_name\", 1500000, -75, 500, [false, true], false, false, 45] spawn forge_client_task_fnc_hostage;\n\n    // Execution When Time Limit Expires\n    [\"task_name\", 1, 2, \"marker_name\", 1500000, -75, 500, [true, false], false, false, 45, \"marker_name\"] spawn forge_client_task_fnc_hostage;\n",[192],{"type":14,"tag":89,"props":193,"children":194},{"__ignoreMap":7},[195],{"type":20,"value":190},{"type":14,"tag":23,"props":197,"children":199},{"id":198},"links",[200],{"type":20,"value":201},"Links",{"type":14,"tag":30,"props":203,"children":204},{},[205,212,214,220,221,227,228,234,235,240,241],{"type":14,"tag":206,"props":207,"children":209},"a",{"href":208},"/client/task",[210],{"type":20,"value":211},"Home",{"type":20,"value":213}," |\n",{"type":14,"tag":206,"props":215,"children":217},{"href":216},"/client/task/attack",[218],{"type":20,"value":219},"Attack Module",{"type":20,"value":213},{"type":14,"tag":206,"props":222,"children":224},{"href":223},"/client/task/defuse",[225],{"type":20,"value":226},"Defuse Module",{"type":20,"value":213},{"type":14,"tag":206,"props":229,"children":231},{"href":230},"/client/task/destroy",[232],{"type":20,"value":233},"Destroy Module",{"type":20,"value":213},{"type":14,"tag":206,"props":236,"children":237},{"href":4},[238],{"type":20,"value":239},"Hostage Module",{"type":20,"value":213},{"type":14,"tag":206,"props":242,"children":244},{"href":243},"/client/task/hvt",[245],{"type":20,"value":246},"HVT Module",{"title":7,"searchDepth":248,"depth":248,"links":249},2,[250,251,257],{"id":25,"depth":248,"text":28},{"id":52,"depth":248,"text":55,"children":252},[253,255,256],{"id":59,"depth":254,"text":62},3,{"id":111,"depth":254,"text":114},{"id":166,"depth":254,"text":169},{"id":198,"depth":248,"text":201},"markdown","content:client:task:hostage.md","content","client/task/hostage.md","client/task/hostage","md",1742777961728]