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>
This commit is contained in:
Will 2023-07-09 19:14:54 +01:00 committed by GitHub
parent 05c9e4247b
commit ab2207924f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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