com.maddox.sas1946.il2.util

Class AircraftTools

java.lang.Object

com.maddox.sas1946.il2.util.AircraftTools

public class AircraftTools
extends java.lang.Object

"AircraftTools" Class of the "SAS Common Utils"

This Class is used to provide helpers and missing functions for Aircrafts in IL-2 Sturmovik 1946.

Since:

1.0.4

Version:

1.1.3

Author:

SAS~Storebror

Method Summary

Modifier and Type	Method and Description
static void	updateExternalWeaponHooks(com.maddox.il2.objects.air.Aircraft aircraft) This method provides a simple means of keeping wing weapons visible and usable while an Aircraft is folding its wings.
static void	weaponsRegister(java.lang.Class airClass, java.lang.String slotName, java.lang.String[] theWeapons) This method provides support for creation of aircraft weapon slots with a single line of code.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

weaponsRegister

public static final void weaponsRegister(java.lang.Class airClass,
                                         java.lang.String slotName,
                                         java.lang.String[] theWeapons)

This method provides support for creation of aircraft weapon slots with a single line of code.
It provides the implementation of the missing method which is called by lines like this:

weaponsRegister(class1, "default", new String[] { "MGunBrowning50k 250", "MGunBrowning50k 250" });

The method "weaponsRegister" was part of former IL-2 versions (Pacific Fighters or earlier) but was removed and replaced by an empty method in IL-2 1946, therefore these lines in aircraft classes currently serve no purpose and weapon slots have to be either created manually by a lot of Java code lines or by providing the weapon slot declaration in a proprietary encrypted "cod" format.
This method brings back the old functionality so you can create weapon slots with a single line of code again.

Notice for the "theWeapons" Parameter:
This parameter holds an array of strings defining the weapons available in this slot.
Each string defines one weapon in the slot.
Each string consists of 2 or 3 parameters separated by spaces.
If the string consists of 3 parameters, then the first parameter defines the trigger index for this weapon, e.g. "0" for guns, "1" for cannons, "2" for rockets, "3" for bombs etc.
If the string consists of 2 parameters, then the trigger index for this weapon will be taken from the triggers defined in a previous call of the "weaponTriggersRegister" method.
The next parameter defines the weapon's class short name.
The last parameter defines the number of bullets for this weapon.

Parameters:

airClass - The aircraft's Class where you want to create a weapon slot for

slotName - The string defining the name of the weapon slot, e.g. "default", "empty", "2x100lb" etc.

theWeapons - The weapons available in this slot.

Since:

1.0.4

updateExternalWeaponHooks

public static final void updateExternalWeaponHooks(com.maddox.il2.objects.air.Aircraft aircraft)

This method provides a simple means of keeping wing weapons visible and usable while
an Aircraft is folding its wings.

In Stock game (and most mods up to the year 2021), weapons residing on wing stores become hidden
and unusable while wings are being folded.
This is the Java Code found in such Aircraft Classes, the responsible method is "moveWingFold":

public void moveWingFold(float f) {
if (f < 0.001F) {
this.setGunPodsOn(true);
this.hideWingWeapons(false);
} else {
this.setGunPodsOn(false);
this.FM.CT.WeaponControl[0] = false;
this.hideWingWeapons(true);
}
this.moveWingFold(this.hierMesh(), f);
}

Using this helper Method, the Code changes to:

public void moveWingFold(float f) {
this.moveWingFold(this.hierMesh(), f);
AircraftTools.updateExternalWeaponHooks(this);
}

This causes the wing weapons to remain visible and usable while wings are being folded/unfolded.

Parameters:

aircraft - The aircraft which needs to have its wing weapons updated while folding wings

Since:

1.1.3