Unit Insignia – Arma 3

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <nowiki>[</nowiki>" to " [<nowiki/>")
m (added missing insignias and some formatting)
Line 3: Line 3:


== Usage ==
== Usage ==
To add insignia to an unit, execute the following function:
See [[BIS_fnc_setUnitInsignia]].
[<nowiki/>[[this]],"111thID"] [[call]] [[BIS_fnc_setUnitInsignia]];


Once set, you can ask for which insignia is used using:
_insignia = player call [[BIS_fnc_getUnitInsignia]];


 
== Official Insignias ==
=== Official Insignias ===
The game contains several predefined insignias. You can preview them in-game in [[Arsenal]].
The game contains several predefined insignias. You can preview them in-game in [[Arsenal]].


{| class="wikitable sortable"
{| class="wikitable sortable"
! Img
! Img
! Code
! Code
! Note
! Note
|-
|-
| [[File:111thID ca.png|50px]]
| [[File:111thID ca.png|50px]]
| <code>[this,"111thID"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| <code>[this,"111thID"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| NATO division which dispatched one brigade to liberate Altis in Episode 3 - Win of the [http://arma3.com/features/campaign Arma 3 campaign].
| 111th Infantry Division
 
|-
| [[File:TFAegis ca.png|50px]]
| <code>[this,"TFAegis"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| Task Force Aegis
|-
|-
| [[File:bi ca.png|50px]]
| [[File:gryffinRegiment ca.png|50px]]
| <code>[this,"BI"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| <code>[this,"GryffinRegiment"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| [[Bohemia Interactive]] glyph
| Griffin Regiment
 
|-
|-
| [[File:curator ca.png|50px]]
| [[File:curator ca.png|50px]]
| <code>[this,"Curator"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| <code>[this,"Curator"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| [[Zeus]] eye
| Zeus
 
|-
|-
| [[File:gryffinRegiment ca.png|50px]]
| [[File:bi ca.png|50px]]
| <code>[this,"GryffinRegiment"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| <code>[this,"BI"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| CSAT regiment that occupied Altis in episodes 2 and 3 of the Arma 3 campaign.
| Bohemia Interactive
 
|-
|-
| [[File:manw ca.png|50px]]
| [[File:manw ca.png|50px]]
| <code>[this,"MANW"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| <code>[this,"MANW"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| [http://makearmanotwar.com/ Make Arma Not War] competition logo
| Make Arma Not War
 
|-
| [[File:CTRG15 ca.png|50px]]
| <code>[this,"CTRG15"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| CTRG 15 - NATO
|-
| [[File:CTRG14 ca.png|50px]]
| <code>[this,"CTRG14"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| CTRG 14 - NATO
|-
| [[File:CTRG ca.png|50px]]
| <code>[this,"CTRG"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| CTRG
|-
| [[File:Jets_ID ca.png|50px]]
| <code>[this,"Jets_ID"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| Carrier Strike Group 14
|-
| [[File:CombatPatrol ca.png|50px]]
| <code>[this,"CombatPatrol"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| Combat Patrol
|-
| [[File:IDAP ca.png|50px]]
| <code>[this,"IDAP"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| IDAP
|-
| [[File:AAF_3rdRegiment ca.png|50px]]
| <code>[this,"AAF_3rdRegiment"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| AAF 3rd Support Regiment
|-
| [[File:CSAT_ScimitarRegiment ca.png|50px]]
| <code>[this,"CSAT_ScimitarRegiment"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| Scimitar Regiment
|-
| [[File:AAF_1stRegiment ca.png|50px]]
| <code>[this,"AAF_1stRegiment"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| 1st Regiment
|-
| [[File:EAF_5thRegiment ca.png|50px]]
| <code>[this,"EAF_5thRegiment"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| 5th Regiment
|-
| [[File:EnochJointTraining ca.png|50px]]
| <code>[this,"EnochJointTraining"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| Exercise Electron
|-
| [[File:Spetsnaz223rdDetachment ca.png|50px]]
| <code>[this,"Spetsnaz223rdDetachment"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| Spetsnaz 223rd Special Purpose Detachment
|-
|-
| [[File:TFAegis ca.png|50px]]
| [[File:Astra ca.png|50px]]
| <code>[this,"TFAegis"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| <code>[this,"Astra"] [[call]] [[BIS_fnc_setUnitInsignia]];</code>
| Combined force of NATO and AAF which operated on Stratis and Altis at the beginning of Episode 1 and in the Bootcamp campaign.
| Astra
 
|}
|}


Line 54: Line 94:
=== Insignia ===
=== Insignia ===
You can add a new insignia in [[Config.cpp]] and [[Description.ext]].
You can add a new insignia in [[Config.cpp]] and [[Description.ext]].
class CfgUnitInsignia
<syntaxhighlight lang="cpp">class CfgUnitInsignia
  {
  {
  class 111thID
  class 111thID
  {
  {
  displayName = "111th Infantry Division"; {{codecomment|// Name displayed in [[Arsenal]]}}
  displayName = "111th Infantry Division";// Name displayed in [[Arsenal]]
  author = "Bohemia Interactive"; {{codecomment|// Author displayed in Arsenal}}
  author = "Bohemia Interactive";// Author displayed in Arsenal
  texture = "\A3\Ui_f\data\GUI\Cfg\UnitInsignia\111thID_ca.paa"; {{codecomment|// Image path}}
  texture = "\A3\Ui_f\data\GUI\Cfg\UnitInsignia\111thID_ca.paa";// Image path}}
  textureVehicle = ""; {{codecomment|// Does nothing currently, reserved for future use}}
  textureVehicle = "";// Does nothing, reserved for future use
  };
  };
};
};</syntaxhighlight>


Insignia texture should ideally be 128x128px [[PAA]] file.
Insignia texture should ideally be 128x128px [[PAA]] file.
Line 78: Line 118:


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''.
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
<syntaxhighlight lang="cpp">class CfgVehicles
  {
  {
  class myVehicle
  class myVehicle
  {
  {
  hiddenSelections[] = {"someSelection","anotherSelection","'''insignia'''"};
  hiddenSelections[] = {"someSelection","anotherSelection","insignia"};//insignia selection has to be present
  };
  };
};
};</syntaxhighlight>




Line 139: Line 179:
| style="text-align:center;" | Optional above or below ''clan'', if there's space
| style="text-align:center;" | Optional above or below ''clan'', if there's space
| style="text-align:center;" | N/A
| style="text-align:center;" | N/A
|}
|}




[[Category:Arma 3: Editing|Unit Insignia]]
[[Category:Arma 3: Editing|Unit Insignia]]

Revision as of 00:42, 23 March 2020

AAF soldier with TFAegis insignia

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's 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.

Img Code Note
111thID ca.png [this,"111thID"] call BIS_fnc_setUnitInsignia; 111th Infantry Division
TFAegis ca.png [this,"TFAegis"] call BIS_fnc_setUnitInsignia; Task Force Aegis
gryffinRegiment ca.png [this,"GryffinRegiment"] call BIS_fnc_setUnitInsignia; Griffin Regiment
curator ca.png [this,"Curator"] call BIS_fnc_setUnitInsignia; Zeus
bi ca.png [this,"BI"] call BIS_fnc_setUnitInsignia; Bohemia Interactive
manw ca.png [this,"MANW"] call BIS_fnc_setUnitInsignia; Make Arma Not War
CTRG15 ca.png [this,"CTRG15"] call BIS_fnc_setUnitInsignia; CTRG 15 - NATO
CTRG14 ca.png [this,"CTRG14"] call BIS_fnc_setUnitInsignia; CTRG 14 - NATO
CTRG ca.png [this,"CTRG"] call BIS_fnc_setUnitInsignia; CTRG
Jets ID ca.png [this,"Jets_ID"] call BIS_fnc_setUnitInsignia; Carrier Strike Group 14
CombatPatrol ca.png [this,"CombatPatrol"] call BIS_fnc_setUnitInsignia; Combat Patrol
IDAP ca.png [this,"IDAP"] call BIS_fnc_setUnitInsignia; IDAP
AAF 3rdRegiment ca.png [this,"AAF_3rdRegiment"] call BIS_fnc_setUnitInsignia; AAF 3rd Support Regiment
CSAT ScimitarRegiment ca.png [this,"CSAT_ScimitarRegiment"] call BIS_fnc_setUnitInsignia; Scimitar Regiment
AAF 1stRegiment ca.png [this,"AAF_1stRegiment"] call BIS_fnc_setUnitInsignia; 1st Regiment
EAF 5thRegiment ca.png [this,"EAF_5thRegiment"] call BIS_fnc_setUnitInsignia; 5th Regiment
EnochJointTraining ca.png [this,"EnochJointTraining"] call BIS_fnc_setUnitInsignia; Exercise Electron
File:Spetsnaz223rdDetachment ca.png [this,"Spetsnaz223rdDetachment"] call BIS_fnc_setUnitInsignia; Spetsnaz 223rd Special Purpose Detachment
Astra ca.png [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}}
 		textureVehicle = "";// Does nothing, reserved for future use
 	};
};

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 the 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 A3 insignia infantry.jpg
Car Both sides Front and back Optional above or below clan, if there's space A3 insignia car.jpg
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's space A3 insignia armor.jpg
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 A3 insignia heli.jpg
Plane Both sides near a cabin Both (outer) sides of vertical stabilizer(s) Above or below clan A3 insignia plane.jpg
Ship Both sides, anywhere where's space Both sides, anywhere where's space Optional above or below clan, if there's space N/A