Unit Insignia – Arma 3

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Fix icons)
 
(35 intermediate revisions by 11 users not shown)
Line 1: Line 1:
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 [http://en.wikipedia.org/wiki/Shoulder_sleeve_insignia shoulder sleeve insignia].
[[File:a3 insignia.png|thumb|{{Link|https://twitter.com/KarelMoricky/status/469814986471403520|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 is based on real life {{Link|https://en.wikipedia.org/wiki/Shoulder_sleeve_insignia|shoulder sleeve insignia}}.
 


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


Once set, you can ask for which insignia is used using:
See [[BIS_fnc_setUnitInsignia]].
_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 align-center"
 
! Image
! Img
! Code
! Code
! Name
 
! Introduced with
|-
| [[File:111thID ca.png|75px]]
| <sqf>[this, "111thID"] call BIS_fnc_setUnitInsignia;</sqf>
| 111th Infantry Division
| {{Icon|arma3}}
|-
| [[File:TFAegis ca.png|75px]]
| <sqf>[this, "TFAegis"] call BIS_fnc_setUnitInsignia;</sqf>
| Task Force Aegis
| {{Icon|arma3}}
|-
| [[File:gryffinRegiment ca.png|75px]]
| <sqf>[this, "GryffinRegiment"] call BIS_fnc_setUnitInsignia;</sqf>
| Griffin Regiment
| {{Icon|arma3}}
|-
| [[File:curator ca.png|75px]]
| <sqf>[this, "Curator"] call BIS_fnc_setUnitInsignia;</sqf>
| Zeus
| {{Icon|arma3}}
|-
| [[File:bi ca.png|75px]]
| <sqf>[this, "BI"] call BIS_fnc_setUnitInsignia;</sqf>
| {{Name|bi}}
| {{Icon|arma3}}
|-
| [[File:manw ca.png|75px]]
| <sqf>[this, "MANW"] call BIS_fnc_setUnitInsignia;</sqf>
| Make Arma Not War
| {{Icon|arma3}}
|-
| [[File:CTRG15 ca.png|75px]]
| <sqf>[this, "CTRG15"] call BIS_fnc_setUnitInsignia;</sqf>
| CTRG 15 - NATO
| {{Icon|arma3apex}}
|-
| [[File:CTRG14 ca.png|75px]]
| <sqf>[this, "CTRG14"] call BIS_fnc_setUnitInsignia;</sqf>
| CTRG 14 - NATO
| {{Icon|arma3apex}}
|-
| [[File:CTRG ca.png|75px]]
| <sqf>[this, "CTRG"] call BIS_fnc_setUnitInsignia;</sqf>
| CTRG
| {{Icon|arma3apex}}
|-
| [[File:Jets_ID ca.png|75px]]
| <sqf>[this, "Jets_ID"] call BIS_fnc_setUnitInsignia;</sqf>
| Carrier Strike Group 14
| {{Icon|arma3jets}}
|-
| [[File:CombatPatrol ca.png|75px]]
| <sqf>[this, "CombatPatrol"] call BIS_fnc_setUnitInsignia;</sqf>
| Combat Patrol
| {{Icon|arma3malden}}
|-
| [[File:IDAP ca.png|75px]]
| <sqf>[this, "IDAP"] call BIS_fnc_setUnitInsignia;</sqf>
| IDAP
| {{Icon|arma3lawsofwar}}
|-
| [[File:AAF_3rdRegiment ca.png|75px]]
| <sqf>[this, "AAF_3rdRegiment"] call BIS_fnc_setUnitInsignia;</sqf>
| AAF 3rd Support Regiment
| {{Icon|arma3lawsofwar}}
|-
|-
| [[File:111thID ca.png|50px]]
| [[File:CSAT_ScimitarRegiment ca.png|75px]]
| <code>[this,"111thID"] call BIS_fnc_setUnitInsignia;</code>
| <sqf>[this, "CSAT_ScimitarRegiment"] call BIS_fnc_setUnitInsignia;</sqf>
 
| Scimitar Regiment
| {{Icon|arma3tacops}}
|-
|-
| [[File:bi ca.png|50px]]
| [[File:AAF_1stRegiment ca.png|75px]]
| <code>[this,"BI"] call BIS_fnc_setUnitInsignia;</code>
| <sqf>[this, "AAF_1stRegiment"] call BIS_fnc_setUnitInsignia;</sqf>
 
| 1st Regiment
| {{Icon|arma3tanks}}
|-
|-
| [[File:curator ca.png|50px]]
| [[File:EAF_5thRegiment ca.png|75px]]
| <code>[this,"Curator"] call BIS_fnc_setUnitInsignia;</code>
| <sqf>[this, "EAF_5thRegiment"] call BIS_fnc_setUnitInsignia;</sqf>
 
| 5th Regiment
| {{Icon|arma3contact}}
|-
|-
| [[File:gryffinRegiment ca.png|50px]]
| [[File:EnochJointTraining ca.png|75px]]
| <code>[this,"GryffinRegiment"] call BIS_fnc_setUnitInsignia;</code>
| <sqf>[this, "EnochJointTraining"] call BIS_fnc_setUnitInsignia;</sqf>
 
| Exercise Electron
| {{Icon|arma3contact}}
|-
|-
| [[File:manw ca.png|50px]]
| [[File:Spetsnaz ca.png|75px]]
| <code>[this,"MANW"] call BIS_fnc_setUnitInsignia;</code>
| <sqf>[this, "Spetsnaz223rdDetachment"] call BIS_fnc_setUnitInsignia;</sqf>
 
| Spetsnaz 223rd Special Purpose Detachment
| {{Icon|arma3contact}}
|-
|-
| [[File:TFAegis ca.png|50px]]
| [[File:Astra ca.png|75px]]
| <code>[this,"TFAegis"] call BIS_fnc_setUnitInsignia;</code>
| <sqf>[this, "Astra"] call BIS_fnc_setUnitInsignia;</sqf>
| Astra
| {{Icon|arma3contact}}
|}


|}


== Configuration ==
== Configuration ==
=== Insignia ===
=== Insignia ===
You can add a new insignia in [[Config.cpp]] or [[description.ext]]
 
class CfgUnitInsignia
You can add a new insignia in [[Config.cpp]] and [[Description.ext]].
{
<syntaxhighlight lang="cpp">
class 111thID
class CfgUnitInsignia
{
{
displayName = "111th Infantry Division"; {{codecomment|// Name displayed in [[Arsenal]]}}
class 111thID
author = "Bohemia Interactive"; {{codecomment|// Author displayed in Arsenal}}
{
texture = "\a3\UI_F_Bootcamp\Data\CfgUnitInsignia\B_111thID_texture_ca.paa"; {{codecomment|// Image path}}
displayName = "111th Infantry Division"; // Name displayed in Arsenal
textureVehicle = ""; {{codecomment|// Does nothing currently, reserved for future use}}
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
};
};
</syntaxhighlight>
 
{{Feature|informative|Insignia texture should ideally be 128x128px [[PAA File Format|PAA]] file.}}


=== Objects ===
=== 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:
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:
# To all playable vehicles (types listed in table below) of all factions, add following selections:
# To all playable vehicles (types listed in table below) of all factions, add following selections:
Line 63: Line 143:
#* ''clan'' - engine fills it with clan logo. '''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'''.  
#* ''clan_sign'' - engine fills it with clan name. Dimensions not specified, but should be '''short and wide'''.  
# Map transparent texture <code>#(argb,8,8,3)color(0,0,0,0)</code> to all selections.
# Map transparent texture <sqf inline>"#(argb,8,8,3)color(0,0,0,0)"</sqf> to all selections.
# When same selection is on both sides of a vehicle, none of the should be mirrored.
# When same selection is on both sides of a vehicle, none of them should be mirrored.
# 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).
# 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''.
<syntaxhighlight lang="cpp">
class CfgVehicles
{
class MyVehicle
{
hiddenSelections[] = { "someSelection", "anotherSelection", "insignia" }; // insignia selection has to be present
};
};
</syntaxhighlight>


{| border="1" width="100%" style="border-collapse:collapse" cellpadding="3px"
 
! style="background-color:khaki; width:0;" | Vehicle
{| class="wikitable" style="text-align: center; width: 100%" cellpadding="0.25em"
! style="background-color:khaki;" | insignia
! style="width: 0" | Vehicle
! style="background-color:khaki;" | clan
! Insignia
! style="background-color:khaki;" | clan_text
! Clan
! style="background-color:khaki; width:0;" | Preview Image
! Clan Text
! style="width: 0" | Preview Image


|-
|-
| style="background-color:khaki;" | '''Character'''
| '''Character'''
| style="text-align:center;" | '''Left''' shoulder
| '''Left''' shoulder
| style="text-align:center;" | '''Right''' shoulder
| '''Right''' shoulder
| style="text-align:center;" | N/A
| {{n/a}}
| style="text-align:center;" | [[Image:A3 insignia infantry.jpg|200px]]
| [[File:A3 insignia infantry.jpg|200px]]
|-
|-
| style="background-color:khaki;" | '''Car'''
| '''Car'''
| style="text-align:center;" | '''Both''' sides
| '''Both''' sides
| style="text-align:center;" | '''Front''' and '''back'''
| '''Front''' and '''back'''
| style="text-align:center;" | Optional above or below ''clan'', if there's space
| Optional above or below ''clan'', if there is space
| style="text-align:center;" | [[Image:A3 insignia car.jpg|200px]]
| [[File:A3 insignia car.jpg|200px]]


|-
|-
| style="background-color:khaki;" | '''Armored&nbsp;Vehicle'''
| '''Armored&nbsp;Vehicle'''
| style="text-align:center;" | '''Both''' sides above wheels&nbsp;/&nbsp;tracks
| '''Both''' sides above wheels&nbsp;/&nbsp;tracks
| style="text-align:center;" | '''Both''' sides of the turret.  
| '''Both''' sides of the turret.  


Front and back if turret is too small or missing completely.
Front and back if turret is too small or missing completely.
| style="text-align:center;" | Optional above or below ''clan'', if there's space
| Optional above or below ''clan'', if there is space
| style="text-align:center;" | [[Image:A3 insignia armor.jpg|200px]]
| [[File:A3 insignia armor.jpg|200px]]


|-
|-
| style="background-color:khaki;" | '''Helicopter'''
| '''Helicopter'''
| style="text-align:center;" | '''Left''' side near a cabin
| '''Left''' side near a cabin


'''Both''' sides when ''clan'' is on front
'''Both''' sides when ''clan'' is on front
| style="text-align:center;" | '''Right''' side near a cabin
| '''Right''' side near a cabin
Front on large helicopters. ''insignia'' is then on both sides near cabin
Front on large helicopters. ''insignia'' is then on both sides near cabin
| style="text-align:center;" | On tail
| On tail
| style="text-align:center;" | [[Image:A3 insignia heli.jpg|200px]]
| [[File:A3 insignia heli.jpg|200px]]


|-
|-
| style="background-color:khaki;" | '''Plane'''
| '''Plane'''
| style="text-align:center;" | '''Both''' sides near a cabin
| '''Both''' sides near a cabin
| style="text-align:center;" | '''Both''' (outer) sides of vertical stabilizer(s)
| '''Both''' (outer) sides of vertical stabilizer(s)
| style="text-align:center;" | Above or below ''clan''
| Above or below ''clan''
| style="text-align:center;" | [[Image:A3 insignia plane.jpg|200px]]
| [[File:A3 insignia plane.jpg|200px]]


|-
|-
| style="background-color:khaki;" | '''Ship'''
| <br>'''Ship'''<br><br>
| style="text-align:center;" | '''Both''' sides, anywhere where's space
| '''Both''' sides, anywhere where there is space
| style="text-align:center;" | '''Both''' sides, anywhere where's space
| '''Both''' sides, anywhere where there is space
| style="text-align:center;" | Optional above or below ''clan'', if there's space
| Optional above or below ''clan'', if there is space
| style="text-align:center;" | N/A
| {{n/a}}
|}


|}


[[Category:Arma 3: Editing|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma3|Editing}}

Latest revision as of 13:48, 7 December 2023

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
111thID ca.png 111th Infantry Division Arma 3
TFAegis ca.png Task Force Aegis Arma 3
gryffinRegiment ca.png
[this, "GryffinRegiment"] call BIS_fnc_setUnitInsignia;
Griffin Regiment Arma 3
curator ca.png Zeus Arma 3
bi ca.png Bohemia Interactive Arma 3
manw ca.png Make Arma Not War Arma 3
CTRG15 ca.png CTRG 15 - NATO apex icon ca.png
CTRG14 ca.png CTRG 14 - NATO apex icon ca.png
CTRG ca.png CTRG apex icon ca.png
Jets ID ca.png Carrier Strike Group 14 jets icon ca.png
CombatPatrol ca.png
[this, "CombatPatrol"] call BIS_fnc_setUnitInsignia;
Combat Patrol malden icon ca.png
IDAP ca.png IDAP orange icon ca.png
AAF 3rdRegiment ca.png
[this, "AAF_3rdRegiment"] call BIS_fnc_setUnitInsignia;
AAF 3rd Support Regiment orange icon ca.png
CSAT ScimitarRegiment ca.png
[this, "CSAT_ScimitarRegiment"] call BIS_fnc_setUnitInsignia;
Scimitar Regiment tacops icon ca.png
AAF 1stRegiment ca.png
[this, "AAF_1stRegiment"] call BIS_fnc_setUnitInsignia;
1st Regiment tank icon ca.png
EAF 5thRegiment ca.png
[this, "EAF_5thRegiment"] call BIS_fnc_setUnitInsignia;
5th Regiment enoch icon ca.png
EnochJointTraining ca.png
[this, "EnochJointTraining"] call BIS_fnc_setUnitInsignia;
Exercise Electron enoch icon ca.png
Spetsnaz ca.png
[this, "Spetsnaz223rdDetachment"] call BIS_fnc_setUnitInsignia;
Spetsnaz 223rd Special Purpose Detachment enoch icon ca.png
Astra ca.png Astra enoch icon ca.png


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
	};
};
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 A3 insignia infantry.jpg
Car Both sides Front and back Optional above or below clan, if there is 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 is 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 there is space Both sides, anywhere where there is space Optional above or below clan, if there is space N/A