Lua, INI bindings and changelog

Author: Causeless

CHANGELOG.md

@@ -84,6 +84,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - New `Actor` INI and Lua (R/W) property `PainThreshold`, which determines how much damage this actor must take in a frame to play their `PainSound`. This can be set to 0 to never manually play the sound. Defaults to 15.  
 
+- New `AHuman` INI and Lua (R/W) property `MaxWalkPathCrouchShift`, which determines how much the actor will automatically duck down to avoid low ceilings above them. This can be set to 0 to never duck. Defaults to 5.  
+
 - New `MOPixel` INI and Lua (R/W) property `Staininess`, which defines how likely a pixel is to stain a surface when it collides with it. Staining a surface changes that surface's `Color` to that of this `MOPixel`, without changing the underlying material. Value can be between 0 and 1. Defaults to 0 (never stain).  
 
 - New `Activity` INI and Lua (R/W) property `AllowsUserSaving`, which can be used to enable/disable manual user saving/loading. This defaults to true for all `GAScripted` with an `OnSave()` function, but false otherwise. Lua `ActivityMan::SaveGame()` function now forces a save even if `AllowsUserSaving` is disabled. This allows mods and scripted gamemodes to handle saving in their own way (for example, only allowing saving at set points).  

Entities/AHuman.cpp

@@ -209,6 +209,8 @@ int AHuman::Create(const AHuman &reference) {
     m_BackupBGFootGroup->SetOwner(this);
     m_BackupBGFootGroup->SetLimbPos(atomGroupToUseAsFootGroupBG->GetLimbPos());
 
+	m_MaxWalkPathCrouchShift = reference.m_MaxWalkPathCrouchShift;
+
 	if (reference.m_StrideSound) { m_StrideSound = dynamic_cast<SoundContainer*>(reference.m_StrideSound->Clone()); }
 
     m_ArmsState = reference.m_ArmsState;
@@ -285,6 +287,9 @@ int AHuman::ReadProperty(const std::string_view &propName, Reader &reader) {
         m_BackupBGFootGroup = new AtomGroup(*m_pBGFootGroup);
         m_BackupBGFootGroup->RemoveAllAtoms();
     });
+	MatchProperty("MaxWalkPathCrouchShift", {
+		reader >> m_MaxWalkPathCrouchShift;
+	});
     MatchProperty("StrideSound", {
 		m_StrideSound = new SoundContainer;
         reader >> m_StrideSound;
@@ -348,6 +353,8 @@ int AHuman::Save(Writer &writer) const
     writer << m_pFGFootGroup;
     writer.NewProperty("BGFootGroup");
     writer << m_pBGFootGroup;
+	writer.NewProperty("MaxWalkPathCrouchShift");
+	writer << m_MaxWalkPathCrouchShift;
     writer.NewProperty("StrideSound");
     writer << m_StrideSound;
 

Entities/AHuman.h

@@ -863,6 +863,18 @@ DefaultPieMenuNameGetter("Default Human Pie Menu");
 	/// <param name="newValue">The new device arm sway rate for this AHuman.</param>
 	void SetDeviceArmSwayRate(float newValue) { m_DeviceArmSwayRate = newValue; }
 
+    /// <summary>
+	/// Gets this AHuman's max walkpath adjustment upwards to crouch below low ceilings.
+	/// </summary>
+	/// <returns>This AHuman's max walkpath adjustment.</returns>
+	float GetMaxWalkPathCrouchShift() const { return m_MaxWalkPathCrouchShift; }
+
+	/// <summary>
+	/// Sets this AHuman's max walkpath adjustment upwards to crouch below low ceilings.
+	/// </summary>
+	/// <param name="newValue">The new value for this AHuman's max walkpath adjustment.</param>
+	void SetMaxWalkPathCrouchShift(float newValue) { m_MaxWalkPathCrouchShift = newValue; }
+
 	/// <summary>
 	/// Gets this AHuman's stride sound. Ownership is NOT transferred!
 	/// </summary>

Lua/LuaBindingsEntities.cpp

@@ -460,6 +460,7 @@ namespace RTE {
 		.property("BGLeg", &AHuman::GetBGLeg, &LuaAdaptersPropertyOwnershipSafetyFaker::AHumanSetBGLeg)
 		.property("FGFoot", &AHuman::GetFGFoot, &LuaAdaptersPropertyOwnershipSafetyFaker::AHumanSetFGFoot)
 		.property("BGFoot", &AHuman::GetBGFoot, &LuaAdaptersPropertyOwnershipSafetyFaker::AHumanSetBGFoot)
+		.property("MaxWalkPathCrouchShift", &AHuman::GetMaxWalkPathCrouchShift, &AHuman::SetMaxWalkPathCrouchShift)
 		.property("StrideSound", &AHuman::GetStrideSound, &LuaAdaptersPropertyOwnershipSafetyFaker::AHumanSetStrideSound)
 		.property("UpperBodyState", &AHuman::GetUpperBodyState, &AHuman::SetUpperBodyState)
 		.property("MovementState", &AHuman::GetMovementState, &AHuman::SetMovementState)