feat: add jump tool for tas

Author: Krzyhau

src/Cheats.cpp

@@ -12,7 +12,7 @@
 #include "Features/Routing/EntityInspector.hpp"
 #include "Features/Speedrun/SpeedrunTimer.hpp"
 #include "Features/Tas/TasParser.hpp"
-#include "Features/Tas/TasTools/AutoJumpTool.hpp"
+#include "Features/Tas/TasTools/JumpTool.hpp"
 #include "Features/Tas/TasTools/StrafeTool.hpp"
 #include "Features/Timer/Timer.hpp"
 #include "Features/WorkshopList.hpp"

src/Features/Tas/TasPlayer.cpp

@@ -17,7 +17,7 @@
 
 #include <climits>
 #include <fstream>
-#include "TasTools/AutoJumpTool.hpp"
+#include "TasTools/JumpTool.hpp"
 
 Variable sar_tas_debug("sar_tas_debug", "0", 0, 2, "Debug TAS information. 0 - none, 1 - basic, 2 - all.\n");
 Variable sar_tas_dump_usercmd("sar_tas_dump_usercmd", "0", "Dump TAS-generated usercmds to a file.\n");
@@ -427,7 +427,7 @@ TasPlayerInfo TasPlayer::GetPlayerInfo(int slot, void *player, CUserCmd *cmd, bo
 
 	// predict the result of autojump tool so other tools can react appropriately.
 	FOR_TAS_SCRIPT_VERSIONS_SINCE(8) {
-		if (autoJumpTool[slot].GetCurrentParams().enabled && autoJumpTool[slot].ShouldJump(pi)) {
+		if (autoJumpTool[slot].WillJump(pi) || jumpTool[slot].WillJump(pi)) {
 			pi.willBeGrounded = false;
 		}
 	}

src/Features/Tas/TasTools/AutoJumpTool.cpp

@@ -0,0 +1,70 @@
+#include "JumpTool.hpp"
+
+#include "Modules/Engine.hpp"
+#include "Modules/Server.hpp"
+#include "Features/Tas/TasParser.hpp"
+#include "Features/Tas/TasPlayer.hpp"
+
+JumpTool autoJumpTool[2] = {{0, true}, {1, true}};
+JumpTool jumpTool[2] = {{0, false}, {1, false}};
+
+void JumpTool::Apply(TasFramebulk &bulk, const TasPlayerInfo &pInfo) {
+	if (this->updated) {
+		hasJumpedLastTick = false;
+	}
+
+	if (params.enabled) {
+		bool shouldJump;
+
+		if (this->automatic) {
+			shouldJump = ShouldJump(pInfo);
+		} else {
+			shouldJump = true;
+			params.enabled = false;
+		}
+
+		SetJumpInput(bulk, shouldJump);
+	} else {
+		hasJumpedLastTick = false;
+	}
+}
+
+bool JumpTool::WillJump(const TasPlayerInfo &pInfo) {
+	return params.enabled && ShouldJump(pInfo);
+}
+
+bool JumpTool::ShouldJump(const TasPlayerInfo &pInfo) {
+	return pInfo.grounded && !pInfo.ducked && !hasJumpedLastTick;
+}
+
+void JumpTool::SetJumpInput(TasFramebulk &bulk, bool jump) {
+	bulk.buttonStates[TasControllerInput::Jump] = jump;
+	if (params.ducked) {
+		bulk.buttonStates[TasControllerInput::Crouch] = jump;
+	}
+	hasJumpedLastTick = jump;
+}
+
+std::shared_ptr<TasToolParams> JumpTool::ParseParams(std::vector<std::string> vp) {
+	if (vp.size() == 0 && !this->automatic) {
+		// allow 0 parameters for non-automated jump tool
+		return std::make_shared<JumpToolsParams>(true, false);
+	}
+
+	if (vp.size() != 1)
+		throw TasParserException(Utils::ssprintf("Wrong argument count for tool %s: %d", this->GetName(), vp.size()));
+
+	bool ducked = false;
+	bool enabled = false;
+
+	if (vp[0] == "on" || vp[0] == "unducked" || vp[0] == "unduck") {
+		enabled = true;
+	} else if (vp[0] == "ducked" || vp[0] == "duck") {
+		enabled = true;
+		ducked = true;
+	} else if (vp[0] != "off") {
+		throw TasParserException(Utils::ssprintf("Bad parameter for tool %s: %s", this->GetName(), vp[0].c_str()));
+	}
+
+	return std::make_shared<JumpToolsParams>(enabled, ducked);
+}

src/Features/Tas/TasTools/AutoJumpTool.hpp

@@ -0,0 +1,37 @@
+#pragma once
+#include "../TasTool.hpp"
+
+struct JumpToolsParams : public TasToolParams {
+	JumpToolsParams()
+		: TasToolParams() {
+	}
+	JumpToolsParams(bool enabled, bool ducked)
+		: TasToolParams(enabled)
+		, ducked(ducked) {
+	}
+
+	bool ducked = false;
+};
+
+class JumpTool : public TasToolWithParams<JumpToolsParams> {
+public:
+	JumpTool(int slot, bool automatic)
+		: TasToolWithParams(automatic ? "autojump" : "jump", slot) 
+		, automatic(automatic) {
+	}
+
+	virtual std::shared_ptr<TasToolParams> ParseParams(std::vector<std::string>);
+	virtual void Apply(TasFramebulk &bulk, const TasPlayerInfo &pInfo);
+
+	bool WillJump(const TasPlayerInfo &pInfo);
+private:
+	bool ShouldJump(const TasPlayerInfo &pInfo);
+	void SetJumpInput(TasFramebulk &bulk, bool jump);
+
+private:
+	bool automatic;
+	bool hasJumpedLastTick = false;
+};
+
+extern JumpTool autoJumpTool[2];
+extern JumpTool jumpTool[2];

src/Features/Tas/TasTools/JumpTool.cpp

@@ -1,7 +1,7 @@
 #include "StrafeTool.hpp"
 
 #include "../TasParser.hpp"
-#include "AutoJumpTool.hpp"
+#include "JumpTool.hpp"
 #include "Modules/Client.hpp"
 #include "Modules/Console.hpp"
 #include "Modules/Engine.hpp"
@@ -23,7 +23,7 @@ void AutoStrafeTool::Apply(TasFramebulk &fb, const TasPlayerInfo &pInfo) {
 
 	FOR_TAS_SCRIPT_VERSIONS_UNTIL(7) {
 		// handled by TasPlayer in newer versions
-		if (autoJumpTool[this->slot].GetCurrentParams().enabled) {
+		if (autoJumpTool[this->slot].GetCurrentParams().enabled || jumpTool[this->slot].GetCurrentParams().enabled) {
 			// if autojump is enabled, we're never grounded.
 			fakePlayerInfo.willBeGrounded = false;
 		}