TF999 Docs

Aircraft customization by script

There is no customization menu for aircraft yet. Until Zeus modules exist, mission makers change an aircraft's look with the script functions below. They come from the Air Weapon Systems addon (vehicles_air_main).

This guide covers skin, emblems, plate text and kill marks. The tail (serial) number on the F-16s is a separate editor setting on the aircraft, so it is not covered here.

How to use them

  • Call them from an aircraft's init field, from a mission script, or from the debug console.
  • Run each function on the machine that owns the aircraft. If it runs anywhere else it does nothing and returns false. In multiplayer, send it to the owner with remoteExec, for example [_plane, "plate_name_1", "SMITH"] remoteExec ["FIR_fnc_ADES_ChangeText", _plane];.
  • Each function returns true when it changed something and false when it did not.
  • They only work on aircraft that are set up for customization (see the table further down).
  • The changes are shared with everyone in the mission.

The functions

Skin

[_plane, "SkinClass"] call FIR_fnc_ADES_ChangeSkin;
Parameter What it is
Aircraft The aircraft.
Skin The class name of a skin. For the F-16s this is the class name of one of the F-16 paint-scheme entries (the ones listed under the F-16 in the editor).

Returns false if the class does not exist. Some aircraft also add their extra parts (pylons, tanks) for the chosen skin.

Emblem or insignia

[_plane, "decal_tail", "Roundel_RAF"] call FIR_fnc_ADES_ChangeEmblem;
[_plane, "decal_tail", ""] call FIR_fnc_ADES_ChangeEmblem;   // clears it
Parameter What it is
Aircraft The aircraft.
Position Where to put it. F-16 positions: decal_nose, decal_wing, decal_tail, insignia.
Emblem A class name from the insignia list (names starting Decal_ and Roundel_, for example Decal_noseart1, Roundel_RAF). An empty text clears the position. Default: empty.

Text on a plate (name, rank or number)

[_plane, "plate_name_1", "CAPT SMITH", "FIR_Bahnschrift_Font", 0.12, [1,1,1]] call FIR_fnc_ADES_ChangeText;
[_plane, "plate_number", "042"] call FIR_fnc_ADES_ChangeText;
[_plane, "plate_name_1", ""] call FIR_fnc_ADES_ChangeText;   // clears the plate
Parameter What it is
Aircraft The aircraft.
Plate Which plate. F-16C: plate_name_1 (left canopy), plate_name_2 (right canopy), plate_number. The two-seat F-16D also has plate_name_3 and plate_name_4 for the rear seat.
Text The text. An empty text clears the plate.
Font A font family. Default FIR_Bahnschrift_Font.
Size Text size. Default 0.12.
Colour Red, green and blue from 0 to 1. Default [1,1,1] (white).

Kill marks

[_plane, "aaaa", "CSAT_Killmark", 0.12, [1,0,0]] call FIR_fnc_ADES_ChangeKillmark;
Parameter What it is
Aircraft The aircraft.
Text The kill-mark characters. An empty text clears the plate.
Style A kill-mark style. Default CSAT_Killmark.
Size Default 0.12.
Colour Red, green, blue from 0 to 1. Default [1,1,1].

The F-16s have their kill-mark plate switched off, so this returns false on them.

Name and rank tag (older function)

[_plane, "Name", "Rank", "white", "Name back", "Rank back", "single"] call FIR_fnc_AWS_SetRankName;

Writes a pilot name (up to 10 letters or numbers) and a rank, using picture-based lettering (fonts such as white, black, brush_black, brush_white). Use "dual" as the last value for a two-seater to fill the rear-seat name too. Ranks it knows: 2LT, CAPT, MAJ, COL, LTJG, LCDR. It needs an aircraft model that has the name and rank selections. I have not checked whether the F-16 models have them; for the F-16s use the plate text function above.

What each aircraft accepts

Aircraft Skin Emblems Plate text Kill marks
F-16C yes yes yes no (switched off)
F-16D yes yes yes no (switched off)
Rafale, stock jets no no no no

Finding the names to use

Paste these in the debug console. They only read information.

The emblem classes:

copyToClipboard ((configProperties [configFile >> "CfgUnitInsignia", "isClass _x"] apply {configName _x}) joinString endl);

The positions and plates of the aircraft you are sitting in:

private _c = configOf vehicle player >> "ADESData";
copyToClipboard (str (getArray (_c >> "EmblemPosName")) + endl + str (getArray (_c >> "PlateName")) + endl + str (getText (_c >> "PlateKillmark")));