twgame-core 0.9.0

Game trait, helper types and helper functions for twgame
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
use twsnap::time::Duration;

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct FinishTee {
    // TODO: no allocation
    pub name: String,
    pub time: Duration,
}

impl FinishTee {
    pub fn new_from_str(name: &str, time: Duration) -> Self {
        // TODO: stack string somehow
        // let mut n = [0u8; 16];
        // name.bytes().zip(n.iter_mut()).for_each(|(b, ptr)| *ptr = b);
        Self {
            name: name.to_owned(),
            time,
        }
    }
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct FinishTeam {
    pub team: i32,
    pub names: Vec<String>,
    pub time: Duration,
}

#[derive(Clone, Debug)]
pub struct SaveTeam {
    buf: String,
}

impl SaveTeam {
    pub fn compat_eq(&self, expected_compat: &Self) -> bool {
        let mut got = self.buf.split('\n');
        let mut expected = expected_compat.buf.split('\n');

        let (g, e) = match (got.next(), expected.next()) {
            (Some(g), Some(e)) => (g, e),
            (None, None) => return true,
            _ => return false,
        };
        SaveTeam::compare_variables("header", 0, g, e, &TEAM_DESC);
        let (g_tees, g_switchers) = SaveTeam::parse_head(g);
        let (e_tees, e_switchers) = SaveTeam::parse_head(e);
        if g_tees != e_tees || g_switchers != e_switchers {
            return false;
        }
        for _ in 0..g_tees {
            let g = got.next().unwrap_or("");
            let e = expected.next().unwrap_or("");
            if !SaveTeam::are_tees_same_compat(g, e) {
                return false;
            }
        }
        for _ in 0..g_switchers {
            let g = got.next().unwrap_or("");
            let e = expected.next().unwrap_or("");
            if !SaveTeam::are_switchers_same_compat(g, e) {
                return false;
            }
        }
        true
    }
}

impl SaveTeam {
    pub fn buf(&self) -> &str {
        &self.buf
    }
}

#[derive(Clone, Debug)]
pub enum DatabaseWrite {
    FinishTee(FinishTee),
    FinishTeam(FinishTeam),
    // TODO: send out and receive TeamId
    Save(i32, SaveTeam),
    Load(i32),
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum Finishes {
    FinishTee(FinishTee),
    // team_id and tees
    FinishTeam(FinishTeam),
}

const TEAM_DESC: [&str; 5] = [
    "m_TeamState",
    "m_MembersCount",
    "m_HighestSwitchNumber",
    "m_TeamLocked",
    "m_Practice",
];

const TEE_DESC: [&str; 115] = [
    "m_aName",
    "m_Alive",
    "m_Paused",
    "m_NeededFaketuning",
    "m_TeeFinished",
    "m_IsSolo",
    "m_aWeapons[0].m_AmmoRegenStart",
    "m_aWeapons[0].m_Ammo",
    "m_aWeapons[0].m_Ammocost",
    "m_aWeapons[0].m_Got",
    "m_aWeapons[1].m_AmmoRegenStart",
    "m_aWeapons[1].m_Ammo",
    "m_aWeapons[1].m_Ammocost",
    "m_aWeapons[1].m_Got",
    "m_aWeapons[2].m_AmmoRegenStart",
    "m_aWeapons[2].m_Ammo",
    "m_aWeapons[2].m_Ammocost",
    "m_aWeapons[2].m_Got",
    "m_aWeapons[3].m_AmmoRegenStart",
    "m_aWeapons[3].m_Ammo",
    "m_aWeapons[3].m_Ammocost",
    "m_aWeapons[3].m_Got",
    "m_aWeapons[4].m_AmmoRegenStart",
    "m_aWeapons[4].m_Ammo",
    "m_aWeapons[4].m_Ammocost",
    "m_aWeapons[4].m_Got",
    "m_aWeapons[5].m_AmmoRegenStart",
    "m_aWeapons[5].m_Ammo",
    "m_aWeapons[5].m_Ammocost",
    "m_aWeapons[5].m_Got",
    "m_LastWeapon",
    "m_QueuedWeapon",
    // tee states
    "m_EndlessJump",
    "m_Jetpack",
    "m_NinjaJetpack",
    "m_FreezeTime",
    "m_FreezeStart",
    "m_DeepFrozen",
    "m_EndlessHook",
    "m_DDRaceState",
    "m_HitDisabledFlags",
    "m_CollisionEnabled",
    "m_TuneZone",
    "m_TuneZoneOld",
    "m_HookHitEnabled",
    "m_Time",
    "(int)m_Pos.x",
    "(int)m_Pos.y",
    "(int)m_PrevPos.x",
    "(int)m_PrevPos.y",
    "m_TeleCheckpoint",
    "m_LastPenalty",
    "(int)m_CorePos.x",
    "(int)m_CorePos.y",
    "m_Vel.x",
    "m_Vel.y",
    "m_ActiveWeapon",
    "m_Jumped",
    "m_JumpedTotal",
    "m_Jumps",
    "(int)m_HookPos.x",
    "(int)m_HookPos.y",
    "m_HookDir.x",
    "m_HookDir.y",
    "(int)m_HookTeleBase.x",
    "(int)m_HookTeleBase.y",
    "m_HookTick",
    "m_HookState",
    "m_TimeCpBroadcastEndTime",
    "m_LastTimeCp",
    "m_LastTimeCpBroadcasted",
    "m_aCurrentTimeCp[0]",
    "m_aCurrentTimeCp[1]",
    "m_aCurrentTimeCp[2]",
    "m_aCurrentTimeCp[3]",
    "m_aCurrentTimeCp[4]",
    "m_aCurrentTimeCp[5]",
    "m_aCurrentTimeCp[6]",
    "m_aCurrentTimeCp[7]",
    "m_aCurrentTimeCp[8]",
    "m_aCurrentTimeCp[9]",
    "m_aCurrentTimeCp[10]",
    "m_aCurrentTimeCp[11]",
    "m_aCurrentTimeCp[12]",
    "m_aCurrentTimeCp[13]",
    "m_aCurrentTimeCp[14]",
    "m_aCurrentTimeCp[15]",
    "m_aCurrentTimeCp[16]",
    "m_aCurrentTimeCp[17]",
    "m_aCurrentTimeCp[18]",
    "m_aCurrentTimeCp[19]",
    "m_aCurrentTimeCp[20]",
    "m_aCurrentTimeCp[21]",
    "m_aCurrentTimeCp[22]",
    "m_aCurrentTimeCp[23]",
    "m_aCurrentTimeCp[24]",
    "m_NotEligibleForFinish",
    "m_HasTelegunGun",
    "m_HasTelegunLaser",
    "m_HasTelegunGrenade",
    "m_aGameUuid",
    "HookedPlayer",
    "m_NewHook",
    "m_InputDirection",
    "m_InputJump",
    "m_InputFire",
    "m_InputHook",
    "m_ReloadTimer",
    "m_TeeStarted",
    "m_LiveFrozen",
    "m_Ninja.m_ActivationDir.x",
    "m_Ninja.m_ActivationDir.y",
    "m_Ninja.m_ActivationTick",
    "m_Ninja.m_CurrentMoveTime",
    "m_Ninja.m_OldVelAmount",
];

const SWITCHER_DESC: [&str; 3] = [
    "m_pSwitchers[i].m_Status",
    "m_pSwitchers[i].m_EndTime",
    "m_pSwitchers[i].m_Type",
];

impl SaveTeam {
    pub fn from_buf(buf: &[u8]) -> Self {
        Self {
            buf: String::from_utf8_lossy(buf).to_string(),
        }
    }

    pub fn from_string(buf: String) -> Self {
        Self { buf }
    }

    fn print_variables(part: &str, id: u32, values: &str, variables: &[&str]) {
        let mut vals = values.split('\t');
        for (i, var) in variables.iter().enumerate() {
            let v = vals.next();
            println!("{part}[{id}] {var} ({i}): {v:?}");
        }
    }

    fn compare_format_variables(
        part: &str,
        id: u32,
        got: &str,
        expected: &str,
        variables: &[&str],
    ) -> Vec<String> {
        let mut strings = Vec::new();
        let mut got = got.split('\t');
        let mut expected = expected.split('\t');
        for (i, var) in variables.iter().enumerate() {
            let g = got.next();
            let e = expected.next();
            if g != e {
                strings.push(format!(
                    "{part}[{id}] {var} ({i}): (got) {g:?} != {e:?} (expected)"
                ));
            }
        }
        strings
    }

    fn compare_variables(part: &str, id: u32, got: &str, expected: &str, variables: &[&str]) {
        for msg in Self::compare_format_variables(part, id, got, expected, variables) {
            println!("{msg}");
        }
    }

    fn are_tees_same_compat(got: &str, expected: &str) -> bool {
        // whether this is relevant is decided later by HookState and HookedPlayer
        let mut hook_tick_correct = true;
        let mut got = got.split('\t');
        let expected = expected.split('\t');
        for (el, e) in expected.enumerate() {
            let g = got.next();
            if matches!(
                el,
                3 // matches m_NeededFakeTuning
                    | 7 | 11 | 15 | 19 | 23 | 27 // ammo
                    | 68 // m_TimeCpBroadcastEndTime
            ) {
                continue;
            }
            if el == 67 && !hook_tick_correct && e == "4" {
                // m_HookState == HOOK_FLYING
                return false;
            }
            if el == 101 && !hook_tick_correct && e != "-1" {
                // HookedPlayer != -1
                return false;
            }
            if g.map(|g| g != e).unwrap_or(true) {
                // m_HookTick
                if el == 66 {
                    // store that hook tick is incorrect whether that is relevant depends on whether
                    // the hook is currently flying or attached to a Tee
                    hook_tick_correct = false;
                    continue;
                }
                return false;
            }
        }
        true
    }

    fn are_switchers_same_compat(got: &str, expected: &str) -> bool {
        let mut got = got.split('\t');
        let expected = expected.split('\t');
        for e in expected {
            let g = got.next();
            if g.map(|g| g != e).unwrap_or(true) {
                return false;
            }
        }
        true
    }

    fn parse_head(head: &str) -> (u32, u32) {
        let mut head = head.split('\t');
        let _ = head.next();
        let num_tees = head
            .next()
            .map(|el| el.parse::<u32>().unwrap_or(0))
            .unwrap_or(0);
        let num_switchers = head
            .next()
            .map(|el| el.parse::<u32>().unwrap_or(0))
            .unwrap_or(0);
        (num_tees, num_switchers)
    }

    pub fn format_diff(&self, expected: &Self) -> Vec<String> {
        let mut diffs = Vec::new();
        let mut got = self.buf.split('\n');
        let mut expected = expected.buf.split('\n');

        let (g, e) = match (got.next(), expected.next()) {
            (Some(g), Some(e)) => (g, e),
            (Some(g), None) => {
                diffs.push(format!("expected no header got {g}"));
                return diffs;
            }
            (None, Some(e)) => {
                diffs.push(format!("expected header {e}, got nothing"));
                return diffs;
            }
            (None, None) => {
                return diffs;
            }
        };
        diffs.extend(SaveTeam::compare_format_variables(
            "header", 0, g, e, &TEAM_DESC,
        ));
        let (mut g_tees, mut g_switchers) = SaveTeam::parse_head(g);
        let (mut e_tees, mut e_switchers) = SaveTeam::parse_head(e);
        let mut tee = 0;
        while g_tees > 0 || e_tees > 0 {
            let g = if g_tees > 0 {
                let g = got.next().unwrap_or("");
                g_tees -= 1;
                g
            } else {
                ""
            };
            let e = if e_tees > 0 {
                let e = expected.next().unwrap_or("");
                e_tees -= 1;
                e
            } else {
                ""
            };
            diffs.extend(SaveTeam::compare_format_variables(
                "tee", tee, g, e, &TEE_DESC,
            ));
            tee += 1;
        }
        let mut switchers = 0;
        while g_switchers > 0 || e_switchers > 0 {
            let g = if g_switchers > 0 {
                let g = got.next().unwrap_or("");
                g_switchers -= 1;
                g
            } else {
                ""
            };
            let e = if e_switchers > 0 {
                let e = expected.next().unwrap_or("");
                e_switchers -= 1;
                e
            } else {
                ""
            };
            diffs.extend(SaveTeam::compare_format_variables(
                "switcher",
                switchers,
                g,
                e,
                &SWITCHER_DESC,
            ));
            switchers += 1;
        }
        if let Some(remaining) = expected.next() {
            diffs.push(format!(
                "unexpected remaining line(s) in expected: {remaining}"
            ));
        }
        if let Some(remaining) = got.next() {
            diffs.push(format!("unexpected remaining line(s) in got: {remaining}"));
        }
        diffs
    }

    pub fn print_diff(&self, expected: &Self) {
        for diff in self.format_diff(expected) {
            println!("{diff}");
        }
    }

    pub fn pretty_print(&self) {
        let mut parts = self.buf.split('\n');
        let Some(header) = parts.next() else {
            return;
        };
        SaveTeam::print_variables("header", 0, header, &TEAM_DESC);
        let (num_tees, num_switchers) = SaveTeam::parse_head(header);
        for tee_id in 0..num_tees {
            SaveTeam::print_variables("tee", tee_id, parts.next().unwrap_or(""), &TEE_DESC);
        }
        for switch_id in 0..num_switchers {
            SaveTeam::print_variables(
                "switcher",
                switch_id,
                parts.next().unwrap_or(""),
                &SWITCHER_DESC,
            );
        }
    }
}

#[derive(Clone, Debug)]
pub enum DatabaseResult {
    LoadSuccess(i32, SaveTeam),
    LoadFailure(i32),
    SaveSuccess(i32),
    SaveFailure(i32),
}

impl DatabaseResult {
    pub fn team(&self) -> i32 {
        match self {
            DatabaseResult::LoadSuccess(team, _) => *team,
            DatabaseResult::LoadFailure(team) => *team,
            DatabaseResult::SaveSuccess(team) => *team,
            DatabaseResult::SaveFailure(team) => *team,
        }
    }
}

impl DatabaseWrite {
    pub fn finish_tee(name: &str, time: Duration) -> Self {
        Self::FinishTee(FinishTee::new_from_str(name, time))
    }
}