Skip to content

readme.md

Latest commit

 

History

History
65 lines (52 loc) · 3.46 KB

readme.md

File metadata and controls

65 lines (52 loc) · 3.46 KB

CVO Arsenal - Framework for ACE Arsenal

Summary

  • Supports Different Roles
  • Auto Assigns Roles based on Traits.
  • Supports personalized Gear based on Steam64 IDs

What is a kit?

A Kit is a collection of items made available in the Arsenal. Optional requirements can be attached to a kit. For example: Roles, Addon dependency or a condition code. These requirements will be evaluated every time a player opens the CVO Arsenal.

Roles

Roles are defined by the mission makers. Some roles will be automatically assigned, based on a units trait.

  • ACE Medic / ACE Doctor
  • ACE Engineer / ACE Advanced Engineer
  • Explosives Specialist

How to Implement

  1. Load CVO Aux Mod
  2. Create cvo_arsenal_kits.hpp and include into mission's description.ext
  3. Define Units Roles:
    • [ this, "someRole" ] call cvo_arsenal_fnc_addUnitRoles;
    • [ this, ["someRole"] ] call cvo_arsenal_fnc_addUnitRoles;
    • [ this, ["someRole", "anotherRole"] ] call cvo_arsenal_fnc_addUnitRoles;
    • More Infos here

Kit Configuration

Example Kit Configurations

The following kits can be referenced as examples on how to format a kit.

Further, those kits are hardcoded through the mod itself. They can be disabled through CBA Settings when needed.

Config Properties

General Attributes

Attribute Name DataType Description
editor_layer_name Provide an Eden Editor layer name.
All Objects inside this Layer will be made into CVO Arsenal Objects.
object_variable_names Provide the variable names of individual objects to make them into CVO Arsenal Objects.

Kit Attributes:

Attribute Name DataType Description Default
addon_dependency Name of an Addon - Will Check if the Addon is currently loaded. "" Skip check.
roles Name/Identifyer of the Role. case-unsensitive. "" Applied to all.
id64 steamID64 - getPlayerUID "" Applied to all.
condition Code as String - needs to return boolean. "" Skip check.
code Code as String - needs to return array of classnames. "" Skipped.
items subclasses will get added as item classnames.

Regex Replace Templates

Regex to update old style Unit Role Definition to the new Function call. Only needed when updating an old mission to the new system.

this setVariable \[""CVO_A_ROLES"",\[(.*)\]\];
[this, [$1]] call cvo_arsenal_fnc_addUnitRoles;