From ab2207924f6311fcb15dd6372cccc27ca1db682d Mon Sep 17 00:00:00 2001 From: Will <100206101+SpicyBagpipes@users.noreply.github.com> Date: Sun, 9 Jul 2023 19:14:54 +0100 Subject: [PATCH] Logistics Wirecutter - Add documentation (#9248) * Create wirecutter-framework.md * Update docs/wiki/framework/wirecutter-framework.md --------- Co-authored-by: Grim <69561145+LinkIsGrim@users.noreply.github.com> --- docs/wiki/framework/wirecutter-framework.md | 41 +++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 docs/wiki/framework/wirecutter-framework.md diff --git a/docs/wiki/framework/wirecutter-framework.md b/docs/wiki/framework/wirecutter-framework.md new file mode 100644 index 0000000000..3f2a97c0b1 --- /dev/null +++ b/docs/wiki/framework/wirecutter-framework.md @@ -0,0 +1,41 @@ +--- +layout: wiki +title: Wirecutter Framework +description: Explains how to set-up items, backpacks and vests with ACE3 wirecutter system. +group: framework +order: 5 +parent: wiki +mod: ace +version: + major: 3 + minor: 16 + patch: 0 +--- + +## 1. Config Values + +The properties below control whether an item is considered a wirecutter. Worn items (vests and backpacks) can have "built-in" wirecutters with the `ace_logistics_wirecutter_hasWirecutter` property. +```cpp +class CfgWeapons { + class MyVest { + ace_logistics_wirecutter_hasWirecutter = 1; //1 for true, 0 for false. + }; + class MyItem { + ACE_isWirecutter = 1; //1 for true, 0 for false. + }; +}; +class CfgVehicles { + class MyBackpack { + ace_logistics_wirecutter_hasWirecutter = 1; //1 for true, 0 for false. + }; +}; +``` + + +## 2. Events + +### 2.1 Listenable + +Event Name | Description | Passed Parameter(s) | Locality +---------- | ----------- | ------------------- | -------- +`ace_wireCuttingStarted` | Wire cutting started | `[_unit, _fence]` | Global