hltas 0.9.0

Reading and writing Half-Life TAS scripts (`.hltas`).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258

#define CATCH_CONFIG_MAIN
#include "catch.hpp"

#include <array>
#include <string>
#include <utility>

#include "hltas.hpp"

const std::array<const char*, 23> parse_files = {
	"bhop_20fps.hltas",
	"bhop.hltas",
	"bkz_goldbhop.hltas",
	"blolly.hltas",
	"change.hltas",
	"cs_estate.hltas",
	"destructo-hops.hltas",
	"extra-letters.hltas",
	"goldbhop.hltas",
	"halflife.hltas",
	"kz_synergy_x.hltas",
	"load_command.hltas",
	"mirror.hltas",
	"nuker.hltas",
	"render_yaw_override.hltas",
	"rng.hltas",
	"strafe.hltas",
	"target_yaw_override.hltas",
	"tas-hazard course-1.32,669.hltas",
	"tas-kz_summercliff2-1.14.060.hltas",
	"triggertest.hltas",
	"tripminetest.hltas",
	"vectorial.hltas"
};

TEST_CASE("Parse") {
	HLTAS::Input input;

	for (const auto file : parse_files) {
		SECTION(file) {
			const auto path = std::string("../test-data/parse/") + file;
			const auto err = input.Open(path);
			CHECK(err.Code == HLTAS::ErrorCode::OK);
		}
	}
}

TEST_CASE("Parse, write, parse") {
	HLTAS::Input input;

	for (const auto file : parse_files) {
		SECTION(file) {
			auto path = std::string("../test-data/parse/") + file;
			REQUIRE(input.Open(path).Code == HLTAS::ErrorCode::OK);
			path = std::string("../test-data/write-output/") + file;
			REQUIRE(input.Save(path).Code == HLTAS::ErrorCode::OK);
			REQUIRE(input.Open(path).Code == HLTAS::ErrorCode::OK);
		}
	}
}

TEST_CASE("Error") {
	const std::array<std::pair<const char*, HLTAS::ErrorCode>, 14> files = {
		std::make_pair("does-not-exist.hltas", HLTAS::ErrorCode::FAILOPEN),
		std::make_pair("no-version.hltas", HLTAS::ErrorCode::FAILVER),
		std::make_pair("too-high-version.hltas", HLTAS::ErrorCode::NOTSUPPORTED),
		std::make_pair("no-save-name.hltas", HLTAS::ErrorCode::NOSAVENAME),
		std::make_pair("too-few-dashes-field-0.hltas", HLTAS::ErrorCode::FAILFRAME),
		std::make_pair("no-seed.hltas", HLTAS::ErrorCode::NOSEED),
		std::make_pair("no-yaw.hltas", HLTAS::ErrorCode::NOYAW),
		std::make_pair("no-buttons.hltas", HLTAS::ErrorCode::NOBUTTONS),
		std::make_pair("both-j-d.hltas", HLTAS::ErrorCode::BOTHAJDT),
		std::make_pair("no-lgagst-action.hltas", HLTAS::ErrorCode::NOLGAGSTACTION),
		std::make_pair("no-lgagst-min-speed.hltas", HLTAS::ErrorCode::NOLGAGSTMINSPEED),
		std::make_pair("lgagst-action-times.hltas", HLTAS::ErrorCode::LGAGSTACTIONTIMES),
		std::make_pair("no-reset-seed.hltas", HLTAS::ErrorCode::NORESETSEED),
		std::make_pair("no-plus-minus-before-tolerance.hltas", HLTAS::ErrorCode::NO_PM_IN_TOLERANCE),
	};

	HLTAS::Input input;

	for (const auto& test : files) {
		const auto file = test.first;
		const auto code = test.second;

		SECTION(file) {
			const auto path = std::string("../test-data/error/") + file;
			const auto err = input.Open(path);
			CHECK(err.Code == code);
		}
	}
}

void validate(const HLTAS::Input& input) {
	CHECK(input.GetVersion() == 1);

	const auto& properties = input.GetProperties();
	CHECK(properties.size() == 3);
	CHECK(properties.at("demo") == "bhop");
	CHECK(properties.at("frametime0ms") == "0.0000001");
	CHECK(properties.at("hlstrafe_version") == "1");

	const auto& frames = input.GetFrames();
	REQUIRE(frames.size() == 7);

	SECTION("Frame 0") {
		const auto& frame = frames[0];
		CHECK(frame.Frametime == "0.001");
		CHECK(frame.GetRepeats() == 1);
		CHECK(frame.Commands == "sensitivity 0;bxt_timer_reset;bxt_taslog");
	}
	SECTION("Frame 1") {
		const auto& frame = frames[1];
		CHECK(frame.Frametime == "0.001");
		CHECK(frame.GetRepeats() == 5);
	}
	SECTION("Frame 2") {
		const auto& frame = frames[2];
		CHECK(frame.GetType() == HLTAS::StrafeType::MAXACCEL);
		CHECK(frame.GetDir() == HLTAS::StrafeDir::YAW);
		CHECK(frame.GetYaw() == 170);
		CHECK(frame.GetPitch() == 0);
		CHECK(frame.Frametime == "0.001");
		CHECK(frame.GetRepeats() == 400);
	}
	SECTION("Frame 3") {
		const auto& frame = frames[3];
		CHECK(frame.Frametime == "0.001");
		CHECK(frame.GetRepeats() == 2951);
	}
	SECTION("Frame 4") {
		const auto& frame = frames[4];
		CHECK(frame.GetType() == HLTAS::StrafeType::MAXACCEL);
		CHECK(frame.GetDir() == HLTAS::StrafeDir::YAW);
		CHECK(frame.GetYaw() == 90);
		CHECK(frame.Frametime == "0.001");
		CHECK(frame.GetRepeats() == 1);
		CHECK(frame.Commands == "bxt_timer_start");
	}
	SECTION("Frame 5") {
		const auto& frame = frames[5];
		CHECK(frame.GetType() == HLTAS::StrafeType::MAXACCEL);
		CHECK(frame.GetDir() == HLTAS::StrafeDir::YAW);
		CHECK(frame.Lgagst == true);
		CHECK(frame.GetDucktap0ms() == true);
		CHECK(frame.GetYaw() == 90);
		CHECK(frame.Frametime == "0.001");
		CHECK(frame.GetRepeats() == 5315);
		CHECK(frame.Comments == " More frames because some of them get converted to 0ms\n");
	}
	SECTION("Frame 6") {
		const auto& frame = frames[6];
		CHECK(frame.Frametime == "0.001");
		CHECK(frame.GetRepeats() == 1);
		CHECK(frame.Commands == "stop;bxt_timer_stop;pause;sensitivity 1;_bxt_taslog 0;bxt_taslog;//condebug");
	}
}

TEST_CASE("Parse and validate") {
	HLTAS::Input input;
	REQUIRE(input.Open("../test-data/parse/bhop.hltas").Code == HLTAS::ErrorCode::OK);

	validate(input);
}

TEST_CASE("Parse, write, parse and validate") {
	HLTAS::Input input;
	REQUIRE(input.Open("../test-data/parse/bhop.hltas").Code == HLTAS::ErrorCode::OK);
	REQUIRE(input.Save("../test-data/write-output/bhop.hltas").Code == HLTAS::ErrorCode::OK);
	REQUIRE(input.Open("../test-data/write-output/bhop.hltas").Code == HLTAS::ErrorCode::OK);

	validate(input);
}

TEST_CASE("Parse from string and validate") {
	const char *script = "version 1\n\
demo bhop\n\
frametime0ms 0.0000001\n\
hlstrafe_version 1\n\
frames\n\
----------|------|------|0.001|-|-|1|sensitivity 0;bxt_timer_reset;bxt_taslog\n\
----------|------|------|0.001|-|-|5\n\
\n\
s03-------|------|------|0.001|170|0|400\n\
----------|------|------|0.001|-|-|2951\n\
\n\
s03-------|------|------|0.001|90|-|1|bxt_timer_start\n\
\n\
// More frames because some of them get converted to 0ms\n\
s03l-D----|------|------|0.001|90|-|5315\n\
\n\
----------|------|------|0.001|-|-|1|stop;bxt_timer_stop;pause;sensitivity 1;_bxt_taslog 0;bxt_taslog;//condebug\n\
";

	HLTAS::Input input;
	REQUIRE(input.FromString(script).Code == HLTAS::ErrorCode::OK);

	validate(input);
}

TEST_CASE("Parse, write, parse and validate using strings") {
	const char *script = "version 1\n\
demo bhop\n\
frametime0ms 0.0000001\n\
hlstrafe_version 1\n\
frames\n\
----------|------|------|0.001|-|-|1|sensitivity 0;bxt_timer_reset;bxt_taslog\n\
----------|------|------|0.001|-|-|5\n\
\n\
s03-------|------|------|0.001|170|0|400\n\
----------|------|------|0.001|-|-|2951\n\
\n\
s03-------|------|------|0.001|90|-|1|bxt_timer_start\n\
\n\
// More frames because some of them get converted to 0ms\n\
s03l-D----|------|------|0.001|90|-|5315\n\
\n\
----------|------|------|0.001|-|-|1|stop;bxt_timer_stop;pause;sensitivity 1;_bxt_taslog 0;bxt_taslog;//condebug\n\
";

	char buffer[1024] = {};
	memset(buffer, 1, 1024); // Fill with ones to test NULL termination.

	HLTAS::Input input;
	REQUIRE(input.FromString(script).Code == HLTAS::ErrorCode::OK);
	REQUIRE(input.ToString(buffer, sizeof(buffer)).Code == HLTAS::ErrorCode::OK);
	REQUIRE(input.FromString(buffer).Code == HLTAS::ErrorCode::OK);

	validate(input);
}

TEST_CASE("Max accel yaw offset yaw strafing") {
	const char *script = "version 1\n\
hlstrafe_version 5\n\
frames\n\
s53-j-----|------|------|0.010000001|177 -1 2 3|-|158\n\
";

	char buffer[1024] = {};
	memset(buffer, 1, 1024); // Fill with ones to test NULL termination.

	HLTAS::Input input;
	REQUIRE(input.FromString(script).Code == HLTAS::ErrorCode::OK);

	const auto& frames = input.GetFrames();
	REQUIRE(frames.size() == 1);

	SECTION("Frame 3") {
		const auto& frame = frames[0];
		CHECK(frame.Frametime == "0.010000001");
		CHECK(frame.GetRepeats() == 158);
		CHECK(frame.GetYawPresent());
		CHECK(frame.GetYaw() == 177);
		CHECK(frame.GetMaxAccelYawOffsetStart() == -1);
		CHECK(frame.GetMaxAccelYawOffsetTarget() == 2);
		CHECK(frame.GetMaxAccelYawOffsetAccel() == 3);
	}
}