Skip to content

Commit

Permalink
Update Tagging Framework doc
Browse files Browse the repository at this point in the history
  • Loading branch information
dedmen committed May 13, 2020
1 parent 92a8c35 commit 44284e8
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/wiki/framework/tagging-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,24 @@ class ACE_Tags {
2 | `"ACE_SpraypaintRed"` | Required item to have in the inventory to be able to spray your tag
3 | `["tagTexture1.paa", "tagTexture2.paa"]` | List of texture variants (one is randomly selected when tagging)
4 | `"icon.paa"` | Icon being displayed in the interaction menu
### 2.2 Tags in description.ext
Tags can also be configured in description.ext like shown above.
File Paths will be relative to your mission, if you want to define Tags inside description.ext but use Addon paths for `Texture`/`Material`/`TagModel` you need to prefix the path with `@`.
This is how above config would look when using Addon paths from description.ext:
```cpp
class ACE_Tags {
class yourTagClass {
displayName = "My Tag"; // Name of your tag being displayed in the interaction menu
requiredItem = "ACE_SpraypaintBlack"; // Required item to have in the inventory to be able to spray your tag (eg. `"ACE_SpraypaintBlack"`, `"ACE_SpraypaintRed"`, `"ACE_SpraypaintGreen"`, `"ACE_SpraypaintBlue"` or any custom item from `CfgWeapons`)
textures[] = {"@path\to\texture1.paa", "@path\to\texture2.paa"}; // List of texture variations (one is randomly selected when tagging)
materials[] = {"@path\to\material.rvmat"}; // Optional: List of material variations (one is randomly selected). Keep empty if you don't need a custom material.
icon = "@path\to\icon.paa"; // Icon being displayed in the interaction menu
tagModel = "UserTexture1m_F"; // Optional: The 3D Model that will be spawned with the texture on it, can either be CfgVehicles classname or P3D file path.
};
};
```

0 comments on commit 44284e8

Please sign in to comment.