Arma 3 Scripting

Arma 3: Unit Insignia

  • Also known as Arma 3 Unit Insignia

Topic · Markdown · JSON · original wiki page

Unit insignia is a custom texture which can be mapped to a character to give it special look. It's similar to existing squad.xml clan logo, and it is based on real life shoulder sleeve insignia.

Usage

See BIS_fnc_setUnitInsignia.

Official Insignias

The game contains several predefined insignias. You can preview them in-game in Arsenal.

Image Code Name Introduced with
[this, "111thID"] call BIS_fnc_setUnitInsignia; 111th Infantry Division Arma 3
[this, "TFAegis"] call BIS_fnc_setUnitInsignia; Task Force Aegis Arma 3
[this, "GryffinRegiment"] call BIS_fnc_setUnitInsignia; Griffin Regiment Arma 3
[this, "Curator"] call BIS_fnc_setUnitInsignia; Zeus Arma 3
[this, "BI"] call BIS_fnc_setUnitInsignia; Bohemia Interactive Arma 3
[this, "MANW"] call BIS_fnc_setUnitInsignia; Make Arma Not War Arma 3
[this, "CTRG15"] call BIS_fnc_setUnitInsignia; CTRG 15 - NATO
[this, "CTRG14"] call BIS_fnc_setUnitInsignia; CTRG 14 - NATO
[this, "CTRG"] call BIS_fnc_setUnitInsignia; CTRG
[this, "Jets_ID"] call BIS_fnc_setUnitInsignia; Carrier Strike Group 14
[this, "CombatPatrol"] call BIS_fnc_setUnitInsignia; Combat Patrol
[this, "IDAP"] call BIS_fnc_setUnitInsignia; IDAP
[this, "AAF_3rdRegiment"] call BIS_fnc_setUnitInsignia; AAF 3rd Support Regiment
[this, "CSAT_ScimitarRegiment"] call BIS_fnc_setUnitInsignia; Scimitar Regiment
[this, "AAF_1stRegiment"] call BIS_fnc_setUnitInsignia; 1st Regiment
[this, "EAF_5thRegiment"] call BIS_fnc_setUnitInsignia; 5th Regiment
[this, "EnochJointTraining"] call BIS_fnc_setUnitInsignia; Exercise Electron
[this, "Spetsnaz223rdDetachment"] call BIS_fnc_setUnitInsignia; Spetsnaz 223rd Special Purpose Detachment
[this, "Astra"] call BIS_fnc_setUnitInsignia; Astra

Configuration

Insignia

You can add a new insignia in Config.cpp and Description.ext.

class CfgUnitInsignia
{
    class 111thID
    {
        displayName = "111th Infantry Division";                                // Name displayed in Arsenal
        author = "Bohemia Interactive";                                            // Author displayed in Arsenal
        texture = "\A3\Ui_f\data\GUI\Cfg\UnitInsignia\111thID_ca.paa";            // Image path
        material = "\A3\Ui_f\data\GUI\Cfg\UnitInsignia\default_insignia.rvmat";    // .rvmat path
        textureVehicle = "";                                                    // Does nothing, reserved for future use
    };
};

Note

Insignia texture should ideally be 128x128px PAA file.

Objects

Objects like soldiers or cars must contain special selections on which insignia and clan logo can be displayed. Consider following these rules to make sure your addon is consistent with the official ones:

  1. To all playable vehicles (types listed in table below) of all factions, add following selections:
    • insignia - designers fills it with story-related unit insignia. Must be square.
    • clan - engine fills it with clan logo. Must be square.
    • clan_sign - engine fills it with clan name. Dimensions not specified, but should be short and wide.
  2. Map transparent texture "#(argb,8,8,3)color(0,0,0,0)" to all selections.
  3. When same selection is on both sides of a vehicle, none of them should be mirrored.
  4. Civilians characters and vehicles can be less unified, but must still contain all selections as military type (e.g. instead of shoulders, civilian character can have both selections on front and back side of his t-shirt).

Once the model is ready, list the selection in object's config. The order of selections is not important, BIS_fnc_setUnitInsignia is looking specifically for insignia.

class CfgVehicles
{
    class MyVehicle
    {
        hiddenSelections[] = { "someSelection", "anotherSelection", "insignia" }; // insignia selection has to be present
    };
};
Vehicle Insignia Clan Clan Text Preview Image
Character Left shoulder Right shoulder N/A
Car Both sides Front and back Optional above or below clan, if there is space
Armored Vehicle Both sides above wheels / tracks Both sides of the turret.
Front and back if turret is too small or missing completely.
Optional above or below clan, if there is space
Helicopter Left side near a cabin
Both sides when clan is on front
Right side near a cabin
Front on large helicopters. insignia is then on both sides near cabin
On tail
Plane Both sides near a cabin Both (outer) sides of vertical stabilizer(s) Above or below clan
Ship Both sides, anywhere where there is space Both sides, anywhere where there is space Optional above or below clan, if there is space N/A