This commit is the equivalent of a atomic bomb

braf_main/functions/README.md

@@ -0,0 +1,103 @@
+# braf_fnc_setFlightsuitInsignias
+
+**Params:**
+
+* unit - string
+* battalion/squadron - string
+* function - string (optional, "pilot" is the default)
+* rank - string (optional, "captain" is the default)
+
+Usage:
+insert it on the unit init or any script in your mission:
+
+```sqf
+[unit,battalion,function, rank] call braf_fnc_setFlightsuitInsignias;
+```
+
+set the player as flight mechanic from the 1st Army Aviation Battalion:
+
+```sqf
+[player,"1bavex","mechanic"] call braf_fnc_setFlightsuitInsignias;
+```
+
+set "this" (unit in init) as air force pilot
+
+```sqf
+[this,"vf1"] call braf_fnc_setFlightsuitInsignias;
+```
+
+## Battalion/Squadron Options
+
+### Army Aviation Battalions
+
+* "1bavex"
+* "2bavex"
+* "3bavex"
+* "4bavex"
+
+### Air Force Squadroons
+
+* "afa"
+* "1gda"/"jaguar"
+* "1-9gav"/"arara"
+* "3-10gav"/"centauro"
+* "1-3gav"/"escorpiao"
+* "3-3gav"/"flecha"
+* "1-1gt"/"gordo"
+* "2-3gav"/"grifo"
+* "7-8gav"/"harpia"
+* "1-12gav"/"horus"
+* "1-15gav"/"onca"
+* "5-8gav"/"pantera"
+* "1-10gav"/"poker"
+* "2-8gav"/"poti"
+* "3-8gav"/"puma"
+* "eda"/"fumaca"
+* "1-1gavca"/"jambock"
+* "2-5gav"/"joker"
+* "1-4gav"/"pacau"
+* "1-14gav"/"pampa"
+* "2-1gavca"/"pifpaf"
+* "2-10gav"/"pelicano"
+
+### Navy Squadroons
+
+* "hu1"/"aguia"
+* "hu2"/"pegasus"
+* "hu41"/"hipogrifo"
+* "hu51"/"albatroz"
+* "hu61"/"gaviao"
+* "hu91"/"tucano"
+* "hs1"/"guerreiro"
+* "ha1"/"lince"
+* "hi1"/"garça"
+* "qe1"/"harpia_drone"
+* "vf1"/"falcao"
+
+## Function Options
+
+* "pilot"/"piloto"/null
+* "mechanic"/"mecanico"/"mec" (Navy and Army only)
+* "observer"/"observador"/"obs" (Army only)
+
+## Rank Options
+
+As last optional paramether, you can customize the user rank on the flightsuit using this function:
+
+```sqf
+[this,"vf1","pilot", "major"] call braf_fnc_setFlightsuitInsignias;
+```
+
+You can also use the [vanilla rank function in Arma 3](https://community.bistudio.com/wiki/rank) to get the unit rank right on the function:
+
+```sqf
+[this,"vf1","pilot", rank this] call braf_fnc_setFlightsuitInsignias;
+```
+
+* "coronel"/"colonel"/"cel"
+* "tenentecoronel"/"lieutnantcolonel"/"tc"
+* "major"/"maj"
+* "capitao"/"captain"/"cap"
+* "1tenente/"lieutnant"/"1ten"
+* "2tenente"/"2ten"
+* "aspirante"/"aspirant"