Merge branch 'development' into browncoat-mission

Author: pawnishoovy

.github/workflows/ci.yml

@@ -19,9 +19,6 @@ concurrency:
 jobs:
   meson:
     uses: ./.github/workflows/meson.yml
-    
-  msbuild:
-    uses: ./.github/workflows/msbuild.yml
 
-  format:
-    uses: ./.github/workflows/clang-format.yml
+  msbuild:
+    uses: ./.github/workflows/msbuild.yml

CHANGELOG.md

@@ -16,6 +16,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 	New `Actor` Lua property `JumpHeight` (R) to estimate the jump height of the actor (in metres), based on the actor's jetpack and weight. Actors without a jetpack return 0.  
 	The new function `GetPathFindingFlyingJumpHeight()` can be used to get a jumpHeight that allows flying (i.e infinite jump height). This is also the value that `ACRocket`s and `ACDropships` return for `JumpHeight`.
 
+- Improved locomotion.
+	Added the ability to run. When running, you cannot sharpaim whatsoever.
+	Added the ability to manually crouch. When crouching, your sharpaim distance is slightly increased.
+	Players on PC can enable running by holding the shift key, or crouch by holding control. Players using the arrow keys can use right ctrl/shift. Controllers can run by clicking in the left stick, or crouch by holding the left stick down. Prone on controllers is now performed by clicking in the right stick. SNES/d-pad controllers run using the right bumper.
+	Prone input now immediately throws you to the ground instead of crouching first.
+	Added new `MovementState` type `RUN` for scripts.
+	Added new `Controller` state `WALKCROUCH` for crouching, and `PRONE` for prone. The existing `CROUCH` state has been deprecated, as it referred to PRONE.
+	Added new `Actor` INI and Lua (R/W) property `CanRun` which denotes whether the Actor can run or not.
+	Added new `Actor` INI and Lua (R/W) property `CrouchWalkSpeedMultiplier` which is a walking speed multiplier when at max crouch amount.
+
 - New music system, including a dynamic horizontal sequencing system, under the new music manager `MusicMan`.  
 	`PlayDynamicSong(string songName, string songSectionName, bool playImmediately, bool playTransition, bool smoothFade)` to play a new DynamicSong.
 	`SetNextDynamicSongSection(string songSectionName, bool playImmediately, bool playTransition, bool smoothFade)` to queue a new DynamicSongSection for the currently playing song.  
@@ -31,19 +41,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - New `SoundContainer` features.  
 	Lua property `Paused` (R/W) to pause or unpause all sounds of a SoundContainer. Newly played sounds will not begin playback until unpaused.  
 	Lua function `GetAudibleVolume` to get the real audible volume of a SoundContainer's sounds as a float from 0 to 1. This accounts for literally everything, including game volume.
-	
+
+- New `LimbPath` features.
+	New `LimbPath` INI and Lua (R/W) property `BaseTravelSpeedMultiplier` which is a multiplier on the TravelSpeed of that LimbPath, on top of any other gameplay multipliers like from crouching.
+	New `LimbPath` INI and Lua (R/W) property `BaseScaleMultiplier`, which is a vector. This will scale the X/Y axes of the limbpath accordingly, allowing for easily adjusting limbpaths to differently sized actors, on top of any other gameplay multipliers like from running.
+	New `LimbPath` INI property `SegmentEndedThreshold`, which defines the distance the limb must be from the end of the segment before it's considered complete. This defaults to 2.5.  
+	Exposed `LimbPath` properties `TravelSpeed` and `PushForce` to Lua (R/W).
+
 - New `AEmitter` and `PEmitter` INI and Lua (R/W) property `PlayBurstSound` which denotes whether the BurstSound should play when appropriate. This should not be confused for a trigger - it's just a enable/disable toggle to avoid having to remove and add BurstSound altogether.
 
 - Allow lua scripts to use LuaJIT's BitOp module (see https://bitop.luajit.org/api.html)
-  
+
 </details>
 
 <details><summary><b>Changed</b></summary>
 
-- Conquest activities will once again fall-back to using base dropships and rockets if a random selection of the selected tech's craft can't find one capable of carrying passengers and/or cargo.
-
-- All music-related functionality from AudioMan has been removed due to the addition of the MusicMan. Generic DynamicSongs have been put in to use instead.
-	Mod activities that used to queue up all the vanilla music should now instead call, for example, `MusicMan:PlayDynamicSong("Generic Battle Music")`
+- Improved navigation, making running and fast walkpaths much more consistent.
 
 - Increased fog-of-war resolution in all vanilla activities, and conquest, from 20x20 to 4x4.
 	The Ronin Scrambler, the basic scanner, and `SceneMan:CastUnseenRay` have been changed to accomodate fog-of-war resolutions as fine as 1x1 and as course as 20x20.
@@ -52,12 +65,24 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - All vanilla scenario activities have had their settings polished, respecting settings which make sense and disabling settings which don't.
 	You can now have fog of war in the test scene, and can no longer require path to orbit in Zero-G Diggers-Only One Man Army.
 
-- The Signal Hunt activity no longer has a preview image, as it was not formatted correctly and spoiled the interior structure of the cave.
+- Conquest activities will once again fall-back to using base dropships and rockets if a random selection of the selected tech's craft can't find one capable of carrying passengers and/or cargo.
 
 - `MovableMan:OpenAllDoors()`, when passed `NOTEAM`, will now open/close doors specifically for `NOTEAM` (instead of all doors).
 
 - MOs now only play the BurstSound of the first Wound they receive in a frame, which not only solves audio spam during e.g. explosions but also preserves intended audio when firing guns with a high ParticleCount at them.
 
+- Changed how Get and SetLimbPathSpeed/PushForce work for `AHuman` and `ACrab`. The functions are as following:
+	`GetLimbPathSpeed` has been renamed to `GetLimbPathTravelSpeed`.
+	`SetLimbPathSpeed` has been renamed to `SetLimbPathTravelSpeed`.
+	`GetLimbPathTravelSpeed(Actor.MovementState)` returns the FG/left side (for crabs) limb path travel speed for that specific movement state, instead of being hardcoded to walking only.
+	`SetLimbPathTravelSpeed(Actor.MovementState, float newValue)` sets the travel speed for all layers and sides of any particular movement state's limb paths, instead of being hardcoded to walking only.
+	`GetLimbPathPushForce(Actor.MovementState)` returns the FG/left side (for crabs) limb path push force for that specific movement state, instead of being hardcoded to walking only.
+	`SetLimbPathPushForce(Actor.MovementState, float newValue)` sets the push force for all layers and sides of any particular movement state's limb paths, instead of being hardcoded to walking only.
+	
+- The `LimbPath` property `NormalTravelSpeed` has been renamed to just `TravelSpeed`.
+
+- Almost all ctrl+* special inputs functionality (i.e restarting activity, world dumps, showing performance stats) are now mapped to right alt, to not interfere with default crouching inputs. The only exception is ctrl+arrow keys for changing console size.
+
 </details>
 
 <details><summary><b>Fixed</b></summary>
@@ -72,6 +97,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Fixed a bug in Harvester and Massacre where setting deploy units would auto-assign units of the wrong tech.
 
+- Fixed an issue where an `Actor`'s MovementState wasn't correctly accessible from script.
+
+</details>
+
+<details><summary><b>Removed</b></summary>
+
+- All music-related functionality from AudioMan has been removed due to the addition of the MusicMan. Generic DynamicSongs have been put in to use instead.
+	Mod activities that used to queue up all the vanilla music should now instead call, for example, `MusicMan:PlayDynamicSong("Generic Battle Music")`
+
+- The Signal Hunt activity no longer has a preview image, as it was not formatted correctly and spoiled the interior structure of the cave.
+
+- Removed `AHuman` property `MaxCrouchRotation`. `CrouchRotAngleTarget` is now used instead.
+
+- Deprecated `LimbPath` properties `SlowTravelSpeed`, `NormalTravelSpeed` and `FastTravelSpeed`. For the sake of backwards compatibility they will not crash the game and `NormalTravelSpeed` is a valid synonym for the new `TravelSpeed`.
+
 </details>
 
 ## [Release v6.2.2] - 2024/02/24

Data/Base.rte/AI/HumanBehaviors.lua

@@ -1223,7 +1223,7 @@ function HumanBehaviors.ShootTarget(AI, Owner, Abort)
 				AI.Ctrl.AnalogAim = SceneMan:ShortestDistance(Owner.Pos, AI.Target.Pos, false).Normalized;
 				if AI.lateralMoveState == Actor.LAT_STILL then
 					AI.proneState = AHuman.PRONE;
-					--AI.Ctrl:SetState(Controller.BODY_CROUCH, true);
+					--AI.Ctrl:SetState(Controller.BODY_PRONE, true);
 				end
 			elseif Owner:EquipFirearm(true) then
 				local _ai, _ownr, _abrt = coroutine.yield(); -- wait until next frame, just in case the magazine is replenished by another script

Data/Base.rte/AI/NativeHumanAI.lua

@@ -17,6 +17,7 @@ function NativeHumanAI:Create(Owner)
 	Members.fire = false;
 	Members.groundContact = 5;
 	Members.flying = false;
+	Members.running = false;
 
 	Members.squadShoot = false;
 	Members.useMedikit = false;
@@ -29,6 +30,9 @@ function NativeHumanAI:Create(Owner)
 	Members.SquadShootTimer = Timer();
 	Members.SquadShootDelay = math.random(50,100);
 
+	Members.RunStateTimer = Timer();
+	Members.RunStateTimer:SetSimTimeLimitMS(math.random(2000,5000));
+
 	Members.AlarmTimer = Timer();
 	Members.AlarmTimer:SetSimTimeLimitMS(400);
 
@@ -336,6 +340,18 @@ function NativeHumanAI:Update(Owner)
 		end
 	end
 
+	local AlarmPoint = Owner:GetAlarmPoint();
+
+	-- If we currently have a target or are alerted, we walk. Otherwise we run
+	-- We also have a small random chance to walk for a lil bit
+	local wasAlarmed = AlarmPoint.Largest > 0;
+	if wasAlarmed or self.RunStateTimer:IsPastSimTimeLimit() then
+		self.running = self.Target == nil and not wasAlarmed and math.random() < 0.6;
+		self.RunStateTimer:Reset();
+	end
+
+	self.Ctrl:SetState(Controller.MOVE_FAST, self.running);
+
 	self.squadShoot = false;
 	if Owner.MOMoveTarget then
 		-- make the last waypoint marker stick to the MO we are following
@@ -361,7 +377,7 @@ function NativeHumanAI:Update(Owner)
 						local dist = SceneMan:ShortestDistance(Owner.Pos, Leader.Pos, false).Largest;
 						local radius = (Leader.Height + Owner.Height) * 0.5;
 						if dist < radius then
-							local copyControls = {Controller.MOVE_LEFT, Controller.MOVE_RIGHT, Controller.BODY_JUMPSTART, Controller.BODY_JUMP, Controller.BODY_CROUCH};
+							local copyControls = {Controller.MOVE_LEFT, Controller.MOVE_RIGHT, Controller.BODY_JUMPSTART, Controller.BODY_JUMP, Controller.BODY_PRONE};
 							for _, control in pairs(copyControls) do
 								local state = Leader:GetController():IsState(control);
 								self.Ctrl:SetState(control, state);
@@ -547,7 +563,6 @@ function NativeHumanAI:Update(Owner)
 		end
 
 		-- listen and react to AlarmEvents and AlarmPoints
-		local AlarmPoint = Owner:GetAlarmPoint();
 		if AlarmPoint.Largest > 0 then
 			if not self.Target and not self.UnseenTarget then
 				self.AlarmPos = Vector(AlarmPoint.X, AlarmPoint.Y);
@@ -634,7 +649,7 @@ function NativeHumanAI:Update(Owner)
 	if self.proneState == AHuman.GOPRONE then
 		self.proneState = AHuman.PRONE;
 	elseif self.proneState == AHuman.PRONE then
-		self.Ctrl:SetState(Controller.BODY_CROUCH, true);
+		self.Ctrl:SetState(Controller.BODY_PRONE, true);
 	end
 
 	if self.lateralMoveState == Actor.LAT_LEFT then

Data/Base.rte/Actors/Brains/Brainbot/Brainbot.ini

@@ -688,9 +688,7 @@ AddActor = AHuman
 			X = 4
 			Y = 16
 		StartSegCount = 0
-		SlowTravelSpeed = 0.1
-		NormalTravelSpeed = 0.5
-		FastTravelSpeed = 1.5
+		TravelSpeed = 0.5
 		PushForce = 4000
 	StandLimbPathBG = LimbPath
 		CopyOf = Brainbot Stand Path
@@ -699,6 +697,10 @@ AddActor = AHuman
 			Y = 16
 	WalkLimbPath = LimbPath
 		CopyOf = Robot Walk Path
+	WalkRotAngleTarget = -0.05
+	RunLimbPath = LimbPath
+		CopyOf = Robot Run Path
+	RunRotAngleTarget = -0.07
 	CrouchLimbPath = LimbPath
 		CopyOf = Human Crouch Path
 	CrouchLimbPathBG = LimbPath
@@ -722,9 +724,7 @@ AddActor = AHuman
 		AddSegment = Vector
 			X = 0
 			Y = 10
-		SlowTravelSpeed = 1.5
-		NormalTravelSpeed = 1.8
-		FastTravelSpeed = 4.5
+		TravelSpeed = 1.8
 		PushForce = 8000
 	ArmCrawlLimbPath = LimbPath
 		PresetName = Brainbot Arm Crawl Path
@@ -747,9 +747,7 @@ AddActor = AHuman
 		AddSegment = Vector
 			X = 0
 			Y = 10
-		SlowTravelSpeed = 1.5
-		NormalTravelSpeed = 1.5
-		FastTravelSpeed = 4.5
+		TravelSpeed = 1.5
 		PushForce = 6000
 	ClimbLimbPath = LimbPath
 		CopyOf = Human Climb Path
@@ -771,9 +769,7 @@ AddActor = AHuman
 		AddSegment = Vector
 			X = -8
 			Y = 14
-		SlowTravelSpeed = 3
-		NormalTravelSpeed = 6
-		FastTravelSpeed = 7
+		TravelSpeed = 6
 		PushForce = 7000
 	DislodgeLimbPath = LimbPath
 		PresetName = Brainbot Dislodge Path
@@ -784,9 +780,7 @@ AddActor = AHuman
 		AddSegment = Vector
 			X = 0
 			Y = 6
-		SlowTravelSpeed = 1.5
-		NormalTravelSpeed = 2.5
-		FastTravelSpeed = 4.5
+		TravelSpeed = 2.5
 		PushForce = 10000
 	AddGib = Gib
 		GibParticle = MOPixel

Data/Base.rte/Actors/Infantry/GreenDummy/GreenDummy.ini

@@ -675,7 +675,7 @@ AddActor = AHuman
 		ParticlesPerMinute = 8400
 		JumpTime = 1.5
 		JumpReplenishRate = 1.5
-		JumpAngleRange = 0.2
+		JumpAngleRange = 0.16
 	FGArm = Arm
 		CopyOf = Green Dummy Arm FG
 		ParentOffset = Vector
@@ -710,9 +710,7 @@ AddActor = AHuman
 			X = 0
 			Y = 17
 		StartSegCount = 0
-		SlowTravelSpeed = 0.1
-		NormalTravelSpeed = 0.5
-		FastTravelSpeed = 1.5
+		TravelSpeed = 0.5
 		PushForce = 1800
 	StandLimbPathBG = LimbPath
 		CopyOf = Green Dummy Stand Path
@@ -726,7 +724,12 @@ AddActor = AHuman
 		StartOffset = Vector
 			X = 10
 			Y = -3
-		NormalTravelSpeed = 3.4
+		TravelSpeed = 2.6
+	WalkRotAngleTarget = -0.05
+	RunLimbPath = LimbPath
+		CopyOf = Human Run Path
+		TravelSpeed = 4.0
+	RunRotAngleTarget = -0.07
 	CrouchLimbPath = LimbPath
 		CopyOf = Human Crouch Path
 	CrouchLimbPathBG = LimbPath

Data/Base.rte/Actors/Mecha/AADrone/Drone.ini

@@ -421,9 +421,7 @@ AddActor = ACrab
 			X = -6
 			Y = 6
 		StartSegCount = 0
-		SlowTravelSpeed = 0.4
-		NormalTravelSpeed = 0.8
-		FastTravelSpeed = 1.8
+		TravelSpeed = 0.8
 		PushForce = 2200
 	LeftWalkLimbPath = LimbPath
 		PresetName = AA Drone Walk Path Left
@@ -452,9 +450,7 @@ AddActor = ACrab
 		AddSegment = Vector
 			X = -13
 			Y = 0
-		SlowTravelSpeed = 2.5
-		NormalTravelSpeed = 3.5
-		FastTravelSpeed = 5.5
+		TravelSpeed = 3.5
 		PushForce = 6000
 	LeftDislodgeLimbPath = LimbPath
 		PresetName = AA Drone Dislodge Path Left
@@ -465,9 +461,7 @@ AddActor = ACrab
 		AddSegment = Vector
 			X = 0
 			Y = 6
-		SlowTravelSpeed = 2.5
-		NormalTravelSpeed = 3.5
-		FastTravelSpeed = 4.5
+		TravelSpeed = 3.5
 		PushForce = 12000
 	RightStandLimbPath = LimbPath
 		CopyOf = AA Drone Stand Path Left

Data/Base.rte/Actors/Mecha/AIBox/AIBox.ini

@@ -274,9 +274,7 @@ AddActor = ACrab
 			X = -6
 			Y = 6
 		StartSegCount = 0
-		SlowTravelSpeed = 0.4
-		NormalTravelSpeed = 0.8
-		FastTravelSpeed = 1.8
+		TravelSpeed = 0.8
 		PushForce = 2200
 	LWalkLimbPath = LimbPath
 		CopyOf = Crab Drone Walk Path
@@ -289,9 +287,7 @@ AddActor = ACrab
 		AddSegment = Vector
 			X = 0
 			Y = 6
-		SlowTravelSpeed = 2.5
-		NormalTravelSpeed = 3.5
-		FastTravelSpeed = 4.5
+		TravelSpeed = 3.5
 		PushForce = 12000
 	RStandLimbPath = LimbPath
 		CopyOf = AI Box Stand Path Left

Data/Base.rte/Actors/Mecha/Medic/MedicDrone.ini

@@ -273,16 +273,12 @@ AddActor = ACrab
 			X = -6
 			Y = 6
 		StartSegCount = 0
-		SlowTravelSpeed = 0.4
-		NormalTravelSpeed = 0.8
-		FastTravelSpeed = 1.8
+		TravelSpeed = 0.8
 		PushForce = 2200
 	LWalkLimbPath = LimbPath
 		CopyOf = Crab Drone Walk Path
 		PresetName = Medic Drone Walk Path
-		SlowTravelSpeed = 2.4
-		NormalTravelSpeed = 3.4
-		FastTravelSpeed = 4.4
+		TravelSpeed = 3.4
 	LDislodgeLimbPath = LimbPath
 		PresetName = Medic Drone Dislodge Path Left
 		StartOffset = Vector
@@ -292,9 +288,7 @@ AddActor = ACrab
 		AddSegment = Vector
 			X = 0
 			Y = 6
-		SlowTravelSpeed = 2.5
-		NormalTravelSpeed = 3.5
-		FastTravelSpeed = 4.5
+		TravelSpeed = 3.5
 		PushForce = 12000
 	RStandLimbPath = LimbPath
 		CopyOf = Medic Drone Stand Path Left