1. Overview
The Wardrobe addon gives the player the opportunity to change/modify their current wearables into different variants.
For example, if a uniform has a normal variant and a “rolled-up sleeves” variant, the player will be able to use ACE Self Interaction to switch from one variant to another.
Since there is no reliable, common patterns in terms of class inheritance, not even within the same DLC, each possible variant has to be defined individually within configFile >> "ace_wardrobe".
1.1 Components
Components are an optional assistance to define a group of variants where a variant is made of one or more components. For example, a bandana with sunglasses would have the the bandana and the sunglasses as components, while the bandana and sunglasses only have themselves as a component.
If the player switches from a variant with more components to a variant with less components, the surplus components will be deposited in their inventory. On the other hand, if the player wants to change from a variant with less components to a variant with more components, they are required to have the missing components in their inventory, which will be removed on conversion.
More examples can be found below.
2. Config
Only directly defined subclasses will be taken into account. A fully inherited subclass will be ignored and will not provide any interaction. The ace_wardrobe properties are to be found as a subclass of the item itself. Multiple base configs are designed at root of configFile.
2.1 Properties
All supported Properties can be found within the ace_wardrobe_base baseclass.
| Class Property | Data Type | Description |
|---|---|---|
modifiableTo | Subclasses | Possible variants this item can be turned into. Subclass can contain optional directionalActionName property to use as a display name for the action. |
components[] | Array of Classnames | Components the current variant contains within itself |
sound[] | Array of CfgSound Entries | To be chosen by random when the action is performed |
sound_timing | Number 0..1 | Defines the point in time relative to the duration when the sound is played |
gesture | String of Classname | Gesture to be played when the action is performed |
alternativePicture | String of path to icon | Will be used instead of target variant picture |
alternativeActionName | String | Will be used instead of the target variants displayname |
duration | Number in seconds (>= 1) | Duration of action. Items are being replaced at the end. |
fallbackComponent | String of Classname | Fallback for components that are not present within the same mod/addon. Example: RHS AFRF helmets use rhs_ess_black goggles, which are only part of USAF. fallbackComponent can be used to default to a vanilla alternative. |
2.2 Base Classes
All base classes can be found in addons\wardrobe\BaseClasses.hpp
2.2.1 Base
// root of configFile
class ace_wardrobe {
class ace_wardrobe_base {
class modifiableTo {};
components[] = {};
// Supports multiple sounds, will pick one by random.
sound[] = { "ace_wardrobe_fabric_06", "ace_wardrobe_fabric_07", "ace_wardrobe_fabric_16", "ace_wardrobe_fabric_20", "ace_wardrobe_fabric_25"};
sound_timing = 0; // [0..1] 0 at the start of the action, 0.5 half way during the duration of the action - always, if completed or not. 1 at the end, only when completed.
// Gesture
gesture = "Gear";
// These will be read from the target class, so for example, the uniformclass with the rolled up sleaves, it should say "roll up sleeves"
alternativePicture = "";
alternativeActionName = "";
duration = 1; // Minimum value: 1 - Anything above will produce a progressbar.
fallbackComponent = ""; // To be used as an alternative for components where the intended component is from another addon/mod in case the source addon is not loaded.
};
};
2.2.2 Base Uniform Sleeves Up / Down
Common base class for uniforms with Sleeves up/down variants
class ace_wardrobe_base_U_sleeves_up: ace_wardrobe_base {
alternativeActionName = CSTRING(sleevesUp);
};
class ace_wardrobe_base_U_sleeves_down: ace_wardrobe_base {
alternativeActionName = CSTRING(sleevesDown);
};
2.2.3 Base Uniform Gloves On / Off
Common base class for uniforms with gloves on/off variants
class ace_wardrobe_base_U_gloves_on: ace_wardrobe_base {
alternativeActionName = CSTRING(glovesOn);
};
class ace_wardrobe_base_U_gloves_off: ace_wardrobe_base {
alternativeActionName = CSTRING(glovesOff);
};
2.2.4 Base Uniform Jacket Open / Closed
Common base class for uniforms who are open/closed in the front
class ace_wardrobe_base_U_jacket_open: ace_wardrobe_base {
alternativeActionName = CSTRING(jacketOpen);
};
class ace_wardrobe_base_U_jacket_closed: ace_wardrobe_base {
alternativeActionName = CSTRING(jacketClose);
};
2.2.5 Base Helmet Visor Up / Down
Common base class for helmets with a visor that can be flipped up or down. Here, the duration is carefully timed to be aligned with the “click” of the sound.
class ace_wardrobe_base_H_visor_up: ace_wardrobe_base {
duration = 0.25;
gesture ="gestureNod";
sound[] = {CN_SOUND(helmet_visor,05)};
sound_timing = 0;
alternativeActionName = CSTRING(visorUp);
};
class ace_wardrobe_base_H_visor_down: ace_wardrobe_base {
duration = 0.25;
gesture ="gestureNod";
sound[] = {"ace_wardrobe_05"};
sound_timing = 0;
alternativeActionName = CSTRING(visorDown);
};
2.2.6 Base Headgear with Goggles on / off
Common base class for headgear with goggles that can be used as a facewear item.
class ace_wardrobe_base_H_goggles_on: ace_wardrobe_base {
gesture ="GestureWipeFace";
alternativeActionName = CSTRING(gogglesOn);
};
class ace_wardrobe_base_H_goggles_off: ace_wardrobe_base {
gesture ="GestureWipeFace";
alternativeActionName = CSTRING(gogglesOff);
};
3. Porting - Ease of Use
3.1 Macros
To streamline the configuration of compatible items a set of macros can be found here addons\wardrobe\script_macros_wardrobe.hpp
3.2 Example
#include "\z\ace\addons\wardrobe\script_macros_wardrobe.hpp"
class ace_wardrobe {
// Remove unused imported base classes once done
class ace_wardrobe_base;
class ace_wardrobe_base_H_visor_up;
class ace_wardrobe_base_H_visor_down;
class ace_wardrobe_base_H_goggles_on;
class ace_wardrobe_base_H_goggles_off;
class ace_wardrobe_base_H_mask_on;
class ace_wardrobe_base_H_mask_off;
class ace_wardrobe_base_U_sleeves_up;
class ace_wardrobe_base_U_sleeves_down;
class ace_wardrobe_base_U_gloves_on;
class ace_wardrobe_base_U_gloves_off;
class ace_wardrobe_base_U_jacket_open;
class ace_wardrobe_base_U_jacket_closed;
// Begin to define your configs ...
};
4. Configuration examples
4.1 Simple Example - Uniform sleeves - No requirement for components
class ace_wardrobe {
class ace_wardrobe_base_U_sleeves_down;
class ace_wardrobe_base_U_sleeves_up;
class U_B_CTRG_1: ace_wardrobe_base_U_sleeves_down {
components[] = {};
class modifiableTo {
class U_B_CTRG_3 {};
};
};
class U_B_CTRG_3: ace_wardrobe_base_U_sleeves_up {
components[] = {};
class modifiableTo {
class U_B_CTRG_1 {};
};
};
};
4.2 Advanced example - Balaclava with combat glasses - Partial use of components
class ace_wardrobe {
class ace_wardrobe_base;
class G_Balaclava: ace_wardrobe_base {
class modifiableTo {
class G_Balaclava_lowprofile {};
};
components[] = {};
};
class G_Lowprofile: ace_wardrobe_base {
components[] = { "G_Lowprofile" };
};
class G_Balaclava_lowprofile: ace_wardrobe_base {
class modifiableTo {
class G_Balaclava {};
};
components[] = { "G_Lowprofile" };
};
};
4.3 Complex example - Bandana with aviators - Complex use of multiple components
class ace_wardrobe {
class ace_wardrobe_base;
class G_Bandanna_blk: ace_wardrobe_base {
class modifiableTo {
class G_Bandanna_aviator {};
class G_Aviator {};
};
components[] = {"G_Bandanna_blk"};
};
class G_Aviator: ace_wardrobe_base {
class modifiableTo {
class G_Bandanna_aviator {};
};
components[] = { "G_Aviator" };
};
class G_Bandanna_aviator: ace_wardrobe_base {
class modifiableTo {
class G_Bandanna_blk {};
class G_Aviator {};
};
components[] = { "G_Aviator", "G_Bandanna_blk" };
};
};
5. Sounds
The following CfgSounds classes are integrated in ace_wardrobe and are the default sounds for the ace_wardrobe_base and ace_wardrobe_base_H_visor_up/ace_wardrobe_base_H_visor_down base classes.
5.1 Integrated Sounds
The number at the end of the classnames indicates the length of the file in 1/10th seconds. 10 -> 1 sec, 15 -> 1.5sec, …
ace_wardrobe_fabric_06ace_wardrobe_fabric_07ace_wardrobe_fabric_16ace_wardrobe_fabric_20ace_wardrobe_fabric_25ace_wardrobe_helmet_visor_05
6. Compatibility
6.1 MagazineID
If an addon/mod utilizes a magazine’s magazineID to handle additional data on items, then the process of modifying a wearable container (uniform, vest, backpack) to another variant will result in new magazineIDs for all magazines on the player. Therefore additional handling of exceptions is required.
These exceptions can be defined via config.
class ace_wardrobe_exceptions {
class ACE_SpareBarrel {
mode = "server";
code = "ace_wardrobe_fnc_exceptionAceSparebarrel";
};
class acex_intelitems_document {
code = "ace_wardrobe_fnc_exceptionAceIntel";
mode = "local";
};
class acex_intelitems_notepad: acex_intelitems_document {};
class acex_intelitems_photo: acex_intelitems_document {};
};
Per magazine classname that needs to be handled exceptionally, a configclass inside class ace_wardrobe_exceptions is needed where the classname is identical to the items classname.
| Class Property | Data Type | Description |
|---|---|---|
| code | string | Functionname - provided parameters: [“_className”, “_oldMagIDs”, “_newMagIDs”] |
| mode | string | “server” or “local” - defines where code shall be executed |
Currently, ace_intelitems and ace_overheating (spare barrels) are already supported and can be referenced as an example.
6.2 Container Size - Uniform, Vest, Backpack
When the player changes from one container item to another through the wardrobe action and the container’s maximumLoad is smaller than previously, the player risks the loss of items carried inside said container.
Therefore, the debug script found at addons\wardrobe\dev\compareContainerMaxLoad.sqf can be used to compare the item’s maximumLoad. The result will be dumped into the .rpt.