Added a few handy Lua functions for AHuman + mild refactor in weapon switching logic

Author: fourZK

CHANGELOG.md

@@ -260,6 +260,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - New `Attachable` Lua (R) property `JointPos`, which gets the position of the object's joint in scene coordinates.
 
+- New `AHuman` Lua (R) Property `IsClimbing`, which indicates whether the actor is currently climbing using either of the arms.
+
+- New `AHuman` Lua functions `UnequipFGArm()` and `UnequipArms()` which unequip the currently held item(s) and put them into the actor's inventory.
+
 </details>
 
 <details><summary><b>Changed</b></summary>

Entities/AHuman.cpp

@@ -1416,6 +1416,7 @@ bool AHuman::UnequipFGArm() {
 	if (m_pFGArm && m_pFGArm->HoldsSomething()) {
 		m_pFGArm->GetHeldDevice()->Deactivate();
 		m_Inventory.push_back(m_pFGArm->ReleaseHeldMO());
+		m_pFGArm->SetHandPos(m_Pos + RotateOffset(m_HolsterOffset));
 		return true;
 	}
 	return false;
@@ -1427,6 +1428,7 @@ bool AHuman::UnequipBGArm() {
 	if (m_pBGArm && m_pBGArm->HoldsSomething()) {
 		m_pBGArm->GetHeldDevice()->Deactivate();
 		m_Inventory.push_back(m_pBGArm->ReleaseHeldMO());
+		m_pBGArm->SetHandPos(m_Pos + RotateOffset(m_HolsterOffset));
 		return true;
 	}
 	return false;
@@ -3258,20 +3260,20 @@ void AHuman::Update()
 		bool changeNext = m_Controller.IsState(WEAPON_CHANGE_NEXT);
 		bool changePrev = m_Controller.IsState(WEAPON_CHANGE_PREV);
 		HDFirearm * pFireArm = dynamic_cast<HDFirearm *>(m_pFGArm->GetHeldMO());
-		if ((changeNext || changePrev) && (!m_Inventory.empty() || UnequipBGArm())) {
+		if (changeNext || changePrev) {
 			if (changeNext && changePrev) {
-				UnequipFGArm();
-			} else {
+				UnequipArms();
+			} else if (!m_Inventory.empty() || UnequipBGArm()) {
 				if (pFireArm) { pFireArm->StopActivationSound(); }
 				if (changeNext) {
 					m_pFGArm->SetHeldMO(SwapNextInventory(m_pFGArm->ReleaseHeldMO()));
 				} else {
 					m_pFGArm->SetHeldMO(SwapPrevInventory(m_pFGArm->ReleaseHeldMO()));
 				}
 				EquipShieldInBGArm();
+				m_pFGArm->SetHandPos(m_Pos + RotateOffset(m_HolsterOffset));
 			}
 			m_EquipHUDTimer.Reset();
-			m_pFGArm->SetHandPos(m_Pos + m_HolsterOffset.GetXFlipped(m_HFlipped));
 			m_PieNeedsUpdate = true;
 			m_SharpAimProgress = 0;
         }

Entities/AHuman.h

@@ -591,6 +591,11 @@ ClassInfoGetters;
 	/// <returns>Whether there was anything to unequip.</returns>
 	bool UnequipBGArm();
 
+	/// <summary>
+	/// Unequips whatever is in either of the arms and puts them into the inventory.
+	/// </summary>
+	void UnequipArms() { UnequipFGArm(); UnequipBGArm(); }
+
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Method:  GetEquippedItem
@@ -791,6 +796,12 @@ ClassInfoGetters;
 	/// <param name="angle">The angle to set.</param>
 	void SetWalkAngle(AHuman::Layer whichLayer, float angle) { m_WalkAngle[whichLayer] = Matrix(angle); }
 
+	/// <summary>
+	/// Gets whether this AHuman is currently attempting to climb something, using arms.
+	/// </summary>
+	/// <returns>Whether this AHuman is currently climbing or not.</returns>
+	bool IsClimbing() const { return m_ArmClimbing[FGROUND] || m_ArmClimbing[BGROUND]; }
+
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Virtual method:  UpdateAI

Lua/LuaBindingsEntities.cpp

@@ -424,6 +424,7 @@ namespace RTE {
 		.property("FirearmIsSemiAuto", &AHuman::FirearmIsSemiAuto)
 		.property("FirearmActivationDelay", &AHuman::FirearmActivationDelay)
 		.property("LimbPathPushForce", &AHuman::GetLimbPathPushForce, &AHuman::SetLimbPathPushForce)
+		.property("IsClimbing", &AHuman::IsClimbing)
 		.property("ArmSwingRate", &AHuman::GetArmSwingRate, &AHuman::SetArmSwingRate)
 
 		.def("EquipFirearm", &AHuman::EquipFirearm)
@@ -434,7 +435,9 @@ namespace RTE {
 		.def("EquipDeviceInGroup", &AHuman::EquipDeviceInGroup)
 		.def("EquipNamedDevice", &AHuman::EquipNamedDevice)
 		.def("EquipLoadedFirearmInGroup", &AHuman::EquipLoadedFirearmInGroup)
+		.def("UnequipFGArm", &AHuman::UnequipFGArm)
 		.def("UnequipBGArm", &AHuman::UnequipBGArm)
+		.def("UnequipArms", &AHuman::UnequipArms)
 		.def("ReloadFirearms", &AHuman::ReloadFirearms)
 		.def("IsWithinRange", &AHuman::IsWithinRange)
 		.def("Look", &AHuman::Look)