Make X2SoldierClassTemplate::IsWeaponAllowedByClass() more flexible

[Iridar]

Closes #1057

This replaces all instances of IsWeaponAllowedByClass() with a new wrapper in existing CHL and base game code.

I've tested the PR and it works as intended, e.g. if a Pistol weapon category is added to soldier class' AllowedWeapons, then the event listener for OverrideShowItemInLockerList is all that's required to equip it in-game.

static function EventListenerReturn OnOverrideShowItemInLockerList(Object EventData, Object EventSource, XComGameState GameState, Name EventID, Object CallbackObject)
{
    local XComGameState_Item ItemState;
    local XComLWTuple Tuple;
    local bool bSlotShowItemInLockerList;
    local EInventorySlot Slot;
    local XComGameState_Unit UnitState;

    ItemState = XComGameState_Item(EventSource);
    Tuple = XComLWTuple(EventData);

    bSlotShowItemInLockerList = Tuple.Data[0].b;
    Slot = EInventorySlot(Tuple.Data[1].i);
    UnitState = XComGameState_Unit(Tuple.Data[2].o);

    // Your code here
    if (Slot == eInvSlot_PrimaryWeapon && ItemState.GetWeaponCategory() == 'Pistol'
      //&& UnitState.GetSoldierClassTemplate().IsWeaponAllowedByClass_CH(X2WeaponTemplate(ItemState.GetMyTemplate()), eInvSlot_PrimaryWeapon)
        )
	{
		bSlotShowItemInLockerList = true;
	}

    Tuple.Data[0].b = bSlotShowItemInLockerList;

    return ELR_NoInterrupt;
}

The IsWeaponAllowedByClass_CH() in this listener itself is optional; if omitted then pistols will show up for all soldier classes, but the in-game UI will forbid equipping them, mentioning that they are "sharpshooter only", or whichever soldier class is found by GetAllowedClassForWeapon_CH() first.

Note: the HeavyWeaponTemplate.InventorySlot == eInvSlot_HeavyWeapon check in XCGS_Unit::GetBestHeavyWeaponTemplates() is not useless, even though the original X2SoldierClassTemplate::IsWeaponAllowedByClass() allows any weapons that are not primary or secondary weapons, nothing is stopping mods from creating their own soldier classes that would restrict the use of heavy weapons.

[Xymanek]

Please add HL-Docs: ref: to the changed calls

[Iridar]

Doneso.

[Xymanek]

Better compare: 0518418...5d6bfce

[Xymanek]

Something went quite wrong with the generated docs:

@robojumper any ideas?

[robojumper]

Something went quite wrong with the generated docs:

what would you expect given the documentation comments? the body of ref items is appended to the body of the main feature item

[Xymanek]

the body of ref items is appended to the body of the main feature item

I see (wasn't aware of that behaviour). @Iridar mind adjusting so that the generated docs page is sanely readable?

[Iridar]

the body of ref items is appended to the body of the main feature item

I see (wasn't aware of that behaviour). @Iridar mind adjusting so that the generated docs page is sanely readable?

Sure, I'll try.

[Iridar]

Do you mind giving me a link where I can preview the docs?

[Xymanek]

Better compare: 0518418...cfcc538

[Iridar]

Adjusted based on feedback and discord conversation, rebased to have just two commits.