xray16 1.6.0 → 1.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/package.json +12 -6
  2. package/xray16.d.ts +30847 -0
  3. package/types/index.d.ts +0 -55
  4. package/types/internal.d.ts +0 -6
  5. package/types/xr_ai/xr_action.d.ts +0 -1803
  6. package/types/xr_ai/xr_alife.d.ts +0 -1872
  7. package/types/xr_ai/xr_enemy_evaluation.d.ts +0 -134
  8. package/types/xr_ai/xr_goap.d.ts +0 -1118
  9. package/types/xr_ai/xr_graph.d.ts +0 -135
  10. package/types/xr_ai/xr_memory.d.ts +0 -384
  11. package/types/xr_lib/xr_animation.d.ts +0 -252
  12. package/types/xr_lib/xr_bitwise.d.ts +0 -44
  13. package/types/xr_lib/xr_color.d.ts +0 -142
  14. package/types/xr_lib/xr_debug.d.ts +0 -183
  15. package/types/xr_lib/xr_dialog.d.ts +0 -132
  16. package/types/xr_lib/xr_flags.d.ts +0 -592
  17. package/types/xr_lib/xr_fs.d.ts +0 -617
  18. package/types/xr_lib/xr_game.d.ts +0 -362
  19. package/types/xr_lib/xr_hit.d.ts +0 -127
  20. package/types/xr_lib/xr_ini.d.ts +0 -475
  21. package/types/xr_lib/xr_level.d.ts +0 -797
  22. package/types/xr_lib/xr_luabind.d.ts +0 -90
  23. package/types/xr_lib/xr_map.d.ts +0 -194
  24. package/types/xr_lib/xr_math.d.ts +0 -871
  25. package/types/xr_lib/xr_multiplayer.d.ts +0 -1081
  26. package/types/xr_lib/xr_profile.d.ts +0 -272
  27. package/types/xr_lib/xr_properties.d.ts +0 -612
  28. package/types/xr_lib/xr_relation.d.ts +0 -231
  29. package/types/xr_lib/xr_render.d.ts +0 -167
  30. package/types/xr_lib/xr_save.d.ts +0 -835
  31. package/types/xr_lib/xr_sound.d.ts +0 -517
  32. package/types/xr_lib/xr_stats.ts +0 -51
  33. package/types/xr_lib/xr_task.d.ts +0 -390
  34. package/types/xr_lib/xr_time.d.ts +0 -177
  35. package/types/xr_lib/xr_type.d.ts +0 -70
  36. package/types/xr_object/client/xr_anomaly.d.ts +0 -70
  37. package/types/xr_object/client/xr_artefact.d.ts +0 -153
  38. package/types/xr_object/client/xr_client_object.d.ts +0 -207
  39. package/types/xr_object/client/xr_creature.d.ts +0 -243
  40. package/types/xr_object/client/xr_item.d.ts +0 -370
  41. package/types/xr_object/client/xr_level.d.ts +0 -755
  42. package/types/xr_object/client/xr_physic.d.ts +0 -644
  43. package/types/xr_object/client/xr_zone.d.ts +0 -85
  44. package/types/xr_object/script/xr_script_interface.d.ts +0 -1142
  45. package/types/xr_object/script/xr_script_object.d.ts +0 -5702
  46. package/types/xr_object/script/xr_script_trade.d.ts +0 -51
  47. package/types/xr_object/server/xr_server_object.d.ts +0 -1488
  48. package/types/xr_ui/xr_ui_asset.d.ts +0 -364
  49. package/types/xr_ui/xr_ui_core.d.ts +0 -426
  50. package/types/xr_ui/xr_ui_event.d.ts +0 -1449
  51. package/types/xr_ui/xr_ui_interface.d.ts +0 -2449
  52. package/types/xr_ui/xr_ui_menu.d.ts +0 -401
  53. package/types/xrf_plugin.d.ts +0 -111
@@ -1,1081 +0,0 @@
1
- import type { Nillable, Nullable } from "../internal";
2
-
3
- declare module "xray16" {
4
- /**
5
- * Metadata stored inside a recorded multiplayer demo.
6
- *
7
- * @source C++ class demo_info
8
- * @customConstructor demo_info
9
- * @group xr_multiplayer
10
- *
11
- * @remarks
12
- * Read-only metadata from a recorded multiplayer demo file.
13
- */
14
- export class demo_info {
15
- /**
16
- * Engine-created demo metadata.
17
- */
18
- protected constructor();
19
-
20
- /**
21
- * @returns Demo author name.
22
- */
23
- public get_author_name(): string;
24
-
25
- /**
26
- * @returns Saved game score string.
27
- */
28
- public get_game_score(): string;
29
-
30
- /**
31
- * @returns Multiplayer game type name.
32
- */
33
- public get_game_type(): string;
34
-
35
- /**
36
- * @returns Map name used by the demo.
37
- */
38
- public get_map_name(): string;
39
-
40
- /**
41
- * @returns Map version string.
42
- */
43
- public get_map_version(): string;
44
-
45
- /**
46
- * Get saved player stats by index.
47
- *
48
- * @remarks
49
- * Index must be lower than {@link demo_info.get_players_count}.
50
- *
51
- * @param value - Zero-based player index.
52
- * @returns Demo player info.
53
- */
54
- public get_player(value: u32): demo_player_info;
55
-
56
- /**
57
- * @returns Number of saved players.
58
- */
59
- public get_players_count(): u32;
60
- }
61
-
62
- /**
63
- * Player stats saved inside a recorded multiplayer demo.
64
- *
65
- * @source C++ class demo_player_info
66
- * @customConstructor demo_player_info
67
- * @group xr_multiplayer
68
- */
69
- export class demo_player_info {
70
- /**
71
- * @returns Captured artefact count.
72
- */
73
- public get_artefacts(): u16;
74
-
75
- /**
76
- * @returns Death count.
77
- */
78
- public get_deaths(): i16;
79
-
80
- /**
81
- * @returns Frag count.
82
- */
83
- public get_frags(): i16;
84
-
85
- /**
86
- * @returns Player name.
87
- */
88
- public get_name(): string;
89
-
90
- /**
91
- * @returns Player rank.
92
- */
93
- public get_rank(): u8;
94
-
95
- /**
96
- * @returns Score points.
97
- */
98
- public get_spots(): i16;
99
-
100
- /**
101
- * @returns Multiplayer team id.
102
- */
103
- public get_team(): u8;
104
- }
105
-
106
- /**
107
- * Server browser filters used by the multiplayer UI.
108
- *
109
- * @source C++ class SServerFilters
110
- * @customConstructor SServerFilters
111
- * @group xr_multiplayer
112
- */
113
- export class SServerFilters {
114
- /**
115
- * Include empty servers.
116
- */
117
- public empty: boolean;
118
-
119
- /**
120
- * Include full servers.
121
- */
122
- public full: boolean;
123
-
124
- /**
125
- * Include listen servers.
126
- */
127
- public listen_servers: boolean;
128
-
129
- /**
130
- * Include password-protected servers.
131
- */
132
- public with_pass: boolean;
133
-
134
- /**
135
- * Include servers without friendly fire.
136
- */
137
- public without_ff: boolean;
138
-
139
- /**
140
- * Include servers without a password.
141
- */
142
- public without_pass: boolean;
143
-
144
- /**
145
- * Create default server browser filters.
146
- */
147
- public constructor();
148
- }
149
-
150
- /**
151
- * GameSpy profile returned by login operations.
152
- *
153
- * @source C++ class profile
154
- * @customConstructor XR_profile
155
- * @group xr_multiplayer
156
- */
157
- export class profile {
158
- /**
159
- * @returns Unique GameSpy nick.
160
- */
161
- public unique_nick(): string;
162
-
163
- /**
164
- * @returns Whether the profile is online.
165
- */
166
- public online(): boolean;
167
- }
168
-
169
- /**
170
- * GameSpy account operations used by multiplayer menus.
171
- *
172
- * @source C++ class account_manager
173
- * @customConstructor account_manager
174
- * @group xr_multiplayer
175
- *
176
- * @remarks
177
- * Main-menu GameSpy account service. Requests are asynchronous, but validation errors may call the callback
178
- * immediately before any network work starts.
179
- */
180
- export class account_manager {
181
- /**
182
- * Engine-owned account manager singleton.
183
- */
184
- private constructor();
185
-
186
- /**
187
- * Create a GameSpy profile.
188
- *
189
- * @remarks
190
- * Validates nickname, unique nick, email, and password before sending the request. On validation failure the
191
- * callback receives a translated status key and no profile is created.
192
- *
193
- * @param acc - Account name.
194
- * @param nick - Public nickname.
195
- * @param mail - Account email.
196
- * @param password - Account password.
197
- * @param cb - Completion callback.
198
- */
199
- public create_profile(acc: string, nick: string, mail: string, password: string, cb: account_profiles_cb): void;
200
-
201
- /**
202
- * Delete the currently logged-in profile.
203
- *
204
- * @remarks
205
- * Requires an online current profile. Without one, the callback reports a not-logged-in status.
206
- *
207
- * @param operation - Completion callback.
208
- */
209
- public delete_profile(operation: account_operation_cb): void;
210
-
211
- /**
212
- * Fetch profiles registered for an account.
213
- *
214
- * @remarks
215
- * Clears previous profile-search results before starting the request. Use
216
- * {@link account_manager.get_found_profiles} after the completion callback.
217
- *
218
- * @param email - Account email.
219
- * @param password - Account password.
220
- * @param cb - Completion callback.
221
- */
222
- public get_account_profiles(email: string, password: string, cb: account_profiles_cb): unknown;
223
-
224
- /**
225
- * Get profiles found by the last email search.
226
- *
227
- * @remarks
228
- * Result list is replaced by each account-profile fetch.
229
- *
230
- * @returns Profiles found by the last email search.
231
- */
232
- public get_found_profiles(): LuaIterable<string>;
233
-
234
- /**
235
- * Get unique nick suggestions from the last request.
236
- *
237
- * @remarks
238
- * Result list is replaced by each suggestion request.
239
- *
240
- * @returns Unique nick suggestions from the last request.
241
- */
242
- public get_suggested_unicks(): LuaIterable<string>;
243
-
244
- /**
245
- * @returns Description of the last validation failure.
246
- */
247
- public get_verify_error_descr(): string;
248
-
249
- /**
250
- * Search for an account email.
251
- *
252
- * @remarks
253
- * Empty emails are rejected immediately through the callback.
254
- *
255
- * @param email - Email to search.
256
- * @param cb - Completion callback.
257
- */
258
- public search_for_email(email: string, cb: found_email_cb): void;
259
-
260
- /**
261
- * Stop the active profile fetch request.
262
- *
263
- * @remarks
264
- * Safe to call when no fetch is active.
265
- */
266
- public stop_fetching_account_profiles(): void;
267
-
268
- /**
269
- * Stop the active email search request.
270
- *
271
- * @remarks
272
- * Safe to call when no search is active.
273
- */
274
- public stop_searching_email(): void;
275
-
276
- /**
277
- * Stop the active nick suggestion request.
278
- *
279
- * @remarks
280
- * Safe to call when no suggestion request is active.
281
- */
282
- public stop_suggest_unique_nicks(): void;
283
-
284
- /**
285
- * Request unique nick suggestions.
286
- *
287
- * @remarks
288
- * Starts an asynchronous request and replaces the previous suggestion list when it completes.
289
- *
290
- * @param nick - Desired nick.
291
- * @param b - Completion callback.
292
- */
293
- public suggest_unique_nicks(nick: string, b: suggest_nicks_cb): void;
294
-
295
- /**
296
- * Validate email syntax.
297
- *
298
- * @param email - Email to validate.
299
- * @returns Whether the email is accepted.
300
- */
301
- public verify_email(email: string): boolean;
302
-
303
- /**
304
- * Validate password syntax.
305
- *
306
- * @param password - Password to validate.
307
- * @returns Whether the password is accepted.
308
- */
309
- public verify_password(password: string): boolean;
310
-
311
- /**
312
- * Validate unique nick syntax.
313
- *
314
- * @param nick - Nick to validate.
315
- * @returns Whether the nick is accepted.
316
- */
317
- public verify_unique_nick(nick: string): boolean;
318
-
319
- /**
320
- * @returns Whether profile fetching is active.
321
- */
322
- public is_get_account_profiles_active(): boolean;
323
-
324
- /**
325
- * @returns Whether email search is active.
326
- */
327
- public is_email_searching_active(): boolean;
328
- }
329
-
330
- /**
331
- * Multiplayer login and saved credential operations.
332
- *
333
- * @source C++ class login_manager
334
- * @customConstructor login_manager
335
- * @group xr_multiplayer
336
- *
337
- * @remarks
338
- * Main-menu login service with one current profile. Log out before starting another online login.
339
- */
340
- export class login_manager {
341
- /**
342
- * Engine-owned login manager singleton.
343
- */
344
- private constructor();
345
-
346
- /**
347
- * Open the password recovery URL through the engine.
348
- *
349
- * @param url - Recovery page URL.
350
- */
351
- public forgot_password(url: string): void;
352
-
353
- /**
354
- * Get the current logged-in profile.
355
- *
356
- * @remarks
357
- * Offline login also creates a profile object, but it is not an online GameSpy session.
358
- *
359
- * @returns Current logged-in profile, or null when offline.
360
- */
361
- public get_current_profile(): Nullable<profile>;
362
-
363
- /**
364
- * @returns Saved email from registry.
365
- */
366
- public get_email_from_registry(): string;
367
-
368
- /**
369
- * @returns Saved nick from registry.
370
- */
371
- public get_nick_from_registry(): string;
372
-
373
- /**
374
- * @returns Saved password from registry.
375
- */
376
- public get_password_from_registry(): string;
377
-
378
- /**
379
- * @returns Saved remember-me flag.
380
- */
381
- public get_remember_me_from_registry(): boolean;
382
-
383
- /**
384
- * Log in to a GameSpy account.
385
- *
386
- * @remarks
387
- * Starts an asynchronous login. If another profile is already active, native code reports that logout is needed
388
- * first.
389
- *
390
- * @param mail - Account email.
391
- * @param profile - Profile nick.
392
- * @param password - Account password.
393
- * @param cb - Completion callback.
394
- */
395
- public login(mail: string, profile: string, password: string, cb: login_operation_cb): void;
396
-
397
- /**
398
- * Create an offline login profile.
399
- *
400
- * @remarks
401
- * Rejects empty or whitespace-only nicknames. Does not contact GameSpy.
402
- *
403
- * @param nick - Offline nick.
404
- * @param cb - Completion callback.
405
- */
406
- public login_offline(nick: string, cb: login_operation_cb): void;
407
-
408
- /**
409
- * Log out and clear current profile state.
410
- *
411
- * @remarks
412
- * Online profiles disconnect from GameSpy. Any account-manager requests tied to the session may need to be
413
- * restarted afterward.
414
- */
415
- public logout(): void;
416
-
417
- /**
418
- * Save account email to registry.
419
- */
420
- public save_email_to_registry(email: string): void;
421
-
422
- /**
423
- * Save nick to registry.
424
- */
425
- public save_nick_to_registry(nick: string): void;
426
-
427
- /**
428
- * Save password to registry.
429
- */
430
- public save_password_to_registry(password: string): void;
431
-
432
- /**
433
- * Save remember-me flag to registry.
434
- */
435
- public save_remember_me_to_registry(remember_me: boolean): void;
436
-
437
- /**
438
- * Change the unique nick for the current profile.
439
- *
440
- * @remarks
441
- * Requires a current profile and a non-empty unique nick. Offline profiles update locally; online profiles send a
442
- * GameSpy request.
443
- *
444
- * @param nick - New unique nick.
445
- * @param cb - Completion callback.
446
- */
447
- public set_unique_nick(nick: string, cb: login_operation_cb): void;
448
-
449
- /**
450
- * Stop the active login request.
451
- *
452
- * @remarks
453
- * Safe to call when no login is active.
454
- */
455
- public stop_login(): void;
456
-
457
- /**
458
- * Stop the active unique-nick change request.
459
- *
460
- * @remarks
461
- * Safe to call when no unique-nick request is active.
462
- */
463
- public stop_setting_unique_nick(): void;
464
- }
465
-
466
- /**
467
- * Multiplayer data binding for `award_pair_t`.
468
- *
469
- * @source C++ class award_pair_t
470
- * @customConstructor award_pair_t
471
- * @group xr_multiplayer
472
- */
473
- export class award_pair_t {
474
- /**
475
- * Award id and value for the pair key.
476
- */
477
- public readonly first: award_data;
478
-
479
- /**
480
- * Award id and value for the pair payload.
481
- */
482
- public readonly second: award_data;
483
- }
484
-
485
- /**
486
- * Multiplayer data binding for `best_scores_pair_t`.
487
- *
488
- * @source C++ class best_scores_pair_t
489
- * @customConstructor best_scores_pair_t
490
- * @group xr_multiplayer
491
- */
492
- export class best_scores_pair_t {
493
- /**
494
- * Best-score id and value for the pair key.
495
- */
496
- public first: award_data;
497
-
498
- /**
499
- * Best-score id and value for the pair payload.
500
- */
501
- public second: award_data;
502
- }
503
-
504
- /**
505
- * Multiplayer callback binding for `account_profiles_cb`.
506
- *
507
- * @source C++ class account_profiles_cb
508
- * @customConstructor account_profiles_cb
509
- * @group xr_multiplayer
510
- *
511
- * @remarks
512
- * Keeps the Lua callback target and function together for asynchronous account requests.
513
- */
514
- export class account_profiles_cb {
515
- /**
516
- * @param object - Lua object used as callback `this`.
517
- * @param cb - Called with profile count and status description.
518
- */
519
- public constructor(object: object, cb: (this: object, code: number, description: string) => void);
520
-
521
- /**
522
- * Replace the bound callback.
523
- *
524
- * @param object - Lua object used as callback `this`.
525
- * @param cb - Called with profile count and status description.
526
- */
527
- public bind(object: object, cb: (this: object, code: number, description: string) => void): void;
528
-
529
- /**
530
- * Clear the bound callback.
531
- *
532
- * @remarks
533
- * After clearing, native completion has no Lua function to call.
534
- */
535
- public clear(): void;
536
- }
537
-
538
- /**
539
- * Multiplayer callback binding for `login_operation_cb`.
540
- *
541
- * @source C++ class login_operation_cb
542
- * @customConstructor login_operation_cb
543
- * @group xr_multiplayer
544
- *
545
- * @remarks
546
- * Keeps the Lua callback target and function together for asynchronous login requests.
547
- */
548
- export class login_operation_cb {
549
- /**
550
- * @param object - Lua object used as callback `this`.
551
- * @param cb - Called with login profile and status description.
552
- */
553
- public constructor(object: object, cb: (this: object, profile: Nillable<profile>, description: string) => void);
554
-
555
- /**
556
- * Replace the bound callback.
557
- *
558
- * @param object - Lua object used as callback `this`.
559
- * @param cb - Called with login profile and status description.
560
- */
561
- public bind(object: object, cb: (this: object, profile: Nillable<profile>, description: string) => void): void;
562
-
563
- /**
564
- * Clear the bound callback.
565
- *
566
- * @remarks
567
- * After clearing, native completion has no Lua function to call.
568
- */
569
- public clear(): void;
570
- }
571
-
572
- /**
573
- * Multiplayer callback binding for `connect_error_cb`.
574
- *
575
- * @source C++ class connect_error_cb
576
- * @customConstructor connect_error_cb
577
- * @group xr_multiplayer
578
- *
579
- * @remarks
580
- * Used by multiplayer server-list connection attempts.
581
- */
582
- export class connect_error_cb {
583
- /**
584
- * @param object - Lua object used as callback `this`.
585
- * @param cb - Called with error code and status description.
586
- */
587
- public constructor(object: object, cb: (this: object, code: number, description: string) => void);
588
-
589
- /**
590
- * Replace the bound callback.
591
- *
592
- * @param object - Lua object used as callback `this`.
593
- * @param cb - Called with error code and status description.
594
- */
595
- public bind(object: object, cb: (this: object, code: number, description: string) => void): void;
596
-
597
- /**
598
- * Clear the bound callback.
599
- *
600
- * @remarks
601
- * After clearing, native connection errors have no Lua function to call.
602
- */
603
- public clear(): void;
604
- }
605
-
606
- /**
607
- * Multiplayer callback binding for `account_operation_cb`.
608
- *
609
- * @source C++ class account_operation_cb
610
- * @customConstructor account_operation_cb
611
- * @group xr_multiplayer
612
- *
613
- * @remarks
614
- * Keeps the Lua callback target and function together for account operations with a status code.
615
- */
616
- export class account_operation_cb {
617
- /**
618
- * @param object - Lua object used as callback `this`.
619
- * @param cb - Called with result code and status description.
620
- */
621
- public constructor(object: object, cb: (this: object, code: number, description: string) => void);
622
-
623
- /**
624
- * Replace the bound callback.
625
- *
626
- * @param object - Lua object used as callback `this`.
627
- * @param cb - Called with result code and status description.
628
- */
629
- public bind(object: object, cb: (this: object, code: number, description: string) => void): void;
630
-
631
- /**
632
- * Clear the bound callback.
633
- *
634
- * @remarks
635
- * After clearing, native completion has no Lua function to call.
636
- */
637
- public clear(): void;
638
- }
639
-
640
- /**
641
- * Multiplayer callback binding for `found_email_cb`.
642
- *
643
- * @source C++ class found_email_cb
644
- * @customConstructor found_email_cb
645
- * @group xr_multiplayer
646
- *
647
- * @remarks
648
- * Used by account email lookup requests.
649
- */
650
- export class found_email_cb {
651
- /**
652
- * @param object - Lua object used as callback `this`.
653
- * @param cb - Called with search result and user name or description.
654
- */
655
- public constructor(object: object, cb: (this: object, found: boolean, description: string) => void);
656
-
657
- /**
658
- * Replace the bound callback.
659
- *
660
- * @param object - Lua object used as callback `this`.
661
- * @param cb - Called with search result and user name or description.
662
- */
663
- public bind(object: object, cb: (this: object, found: boolean, description: string) => void): void;
664
-
665
- /**
666
- * Clear the bound callback.
667
- *
668
- * @remarks
669
- * After clearing, native completion has no Lua function to call.
670
- */
671
- public clear(): void;
672
- }
673
-
674
- /**
675
- * Multiplayer callback binding for `store_operation_cb`.
676
- *
677
- * @source C++ class store_operation_cb
678
- * @customConstructor store_operation_cb
679
- * @group xr_multiplayer
680
- *
681
- * @remarks
682
- * Used by profile-store operations. Completion can report either numeric progress/status or boolean success.
683
- */
684
- export class store_operation_cb {
685
- /**
686
- * @param object - Lua object used as callback `this`.
687
- * @param cb - Called with progress/result code and status description.
688
- */
689
- public constructor(object: object, cb: (this: object, code: number | boolean, description: string) => void);
690
-
691
- /**
692
- * Replace the bound callback.
693
- *
694
- * @param object - Lua object used as callback `this`.
695
- * @param cb - Called with progress/result code and status description.
696
- */
697
- public bind(object: object, cb: (this: object, code: number, description: string) => void): void;
698
-
699
- /**
700
- * Clear the bound callback.
701
- *
702
- * @remarks
703
- * After clearing, native profile-store completion has no Lua function to call.
704
- */
705
- public clear(): void;
706
- }
707
-
708
- /**
709
- * Multiplayer callback binding for `suggest_nicks_cb`.
710
- *
711
- * @source C++ class suggest_nicks_cb
712
- * @customConstructor suggest_nicks_cb
713
- * @group xr_multiplayer
714
- *
715
- * @remarks
716
- * Used by unique-nick suggestion requests.
717
- */
718
- export class suggest_nicks_cb {
719
- /**
720
- * @param object - Lua object used as callback `this`.
721
- * @param cb - Called with suggestion count and status description.
722
- */
723
- public constructor(object: object, cb: (this: object, result: number, description: string) => void);
724
-
725
- /**
726
- * Replace the bound callback.
727
- *
728
- * @param object - Lua object used as callback `this`.
729
- * @param cb - Called with suggestion count and status description.
730
- */
731
- public bind(object: object, cb: (this: object, result: number, description: string) => void): void;
732
-
733
- /**
734
- * Clear the bound callback.
735
- *
736
- * @remarks
737
- * After clearing, native completion has no Lua function to call.
738
- */
739
- public clear(): void;
740
- }
741
-
742
- /**
743
- * Multiplayer patch download progress.
744
- *
745
- * @source C++ class Patch_Dawnload_Progress
746
- * @customConstructor Patch_Dawnload_Progress
747
- * @group xr_multiplayer
748
- *
749
- * @remarks
750
- * Name and `GetFlieName` spelling are preserved from the engine binding.
751
- */
752
- export class Patch_Dawnload_Progress {
753
- /**
754
- * @returns Download progress in range used by the patcher.
755
- */
756
- public GetProgress(): f32;
757
-
758
- /**
759
- * @returns Whether a patch download is active.
760
- */
761
- public GetInProgress(): boolean;
762
-
763
- /**
764
- * @returns Current download status text.
765
- */
766
- public GetStatus(): string;
767
-
768
- /**
769
- * @returns Current file name.
770
- */
771
- public GetFlieName(): string;
772
- }
773
-
774
- /**
775
- * GameSpy profile storage for awards and best scores.
776
- *
777
- * @source C++ class profile_store
778
- * @customConstructor profile_store
779
- * @group xr_multiplayer
780
- *
781
- * @remarks
782
- * Reads award and best-score data for the current online GameSpy profile.
783
- */
784
- export class profile_store {
785
- /**
786
- * Engine enum value for `profile_store.at_award_massacre`.
787
- */
788
- public static readonly at_award_massacre: 0;
789
- /**
790
- * Engine enum value for `profile_store.at_awards_count`.
791
- */
792
- public static readonly at_awards_count: 30;
793
- /**
794
- * Engine enum value for `profile_store.bst_backstabs_in_row`.
795
- */
796
- public static readonly bst_backstabs_in_row: 2;
797
- /**
798
- * Engine enum value for `profile_store.bst_bleed_kills_in_row`.
799
- */
800
- public static readonly bst_bleed_kills_in_row: 2;
801
- /**
802
- * Engine enum value for `profile_store.bst_explosive_kills_in_row`.
803
- */
804
- public static readonly bst_explosive_kills_in_row: 3;
805
- /**
806
- * Engine enum value for `profile_store.bst_eye_kills_in_row`.
807
- */
808
- public static readonly bst_eye_kills_in_row: 4;
809
- /**
810
- * Engine enum value for `profile_store.bst_head_shots_in_row`.
811
- */
812
- public static readonly bst_head_shots_in_row: 3;
813
- /**
814
- * Engine enum value for `profile_store.bst_kills_in_row`.
815
- */
816
- public static readonly bst_kills_in_row: 0;
817
- /**
818
- * Engine enum value for `profile_store.bst_kinife_kills_in_row`.
819
- */
820
- public static readonly bst_kinife_kills_in_row: 1;
821
- /**
822
- * Engine enum value for `profile_store.bst_score_types_count`.
823
- */
824
- public static readonly bst_score_types_count: 7;
825
-
826
- /**
827
- * Engine-created profile store.
828
- */
829
- protected constructor();
830
-
831
- /**
832
- * Get award counters for the current profile.
833
- *
834
- * @remarks
835
- * Values are meaningful after {@link profile_store.load_current_profile} completes successfully.
836
- *
837
- * @returns Award counters for the current profile.
838
- */
839
- public get_awards(): LuaIterable<award_pair_t>;
840
-
841
- /**
842
- * Get best score counters for the current profile.
843
- *
844
- * @remarks
845
- * Values are meaningful after {@link profile_store.load_current_profile} completes successfully.
846
- *
847
- * @returns Best score counters for the current profile.
848
- */
849
- public get_best_scores(): LuaIterable<best_scores_pair_t>;
850
-
851
- /**
852
- * Load awards and best scores for the current profile.
853
- *
854
- * @remarks
855
- * Requires a current online profile. The completion callback reports the final result; the progress callback is
856
- * accepted by the binding for profile-store operations.
857
- *
858
- * @param onProgress - Progress callback.
859
- * @param onComplete - Completion callback.
860
- */
861
- public load_current_profile(onProgress: store_operation_cb, onComplete: store_operation_cb): void;
862
-
863
- /**
864
- * Stop the active profile-store load request.
865
- *
866
- * @remarks
867
- * Safe to call when no profile-store load is active.
868
- */
869
- public stop_loading(): void;
870
- }
871
-
872
- /**
873
- * Award or best-score value with the last reward date.
874
- *
875
- * @source C++ class award_data
876
- * @customConstructor award_data
877
- * @group xr_multiplayer
878
- */
879
- export class award_data {
880
- /**
881
- * Award count or best-score value.
882
- */
883
- public m_count: u16;
884
-
885
- /**
886
- * Last reward date as stored by GameSpy.
887
- */
888
- public m_last_reward_date: u32;
889
- }
890
-
891
- /**
892
- * Multiplayer game event ids sent through game state messaging.
893
- *
894
- * @source C++ class game_messages
895
- * @customConstructor game_messages
896
- * @group xr_multiplayer
897
- */
898
- export class game_messages {
899
- /**
900
- * Engine enum value for `game_messages.GAME_EVENT_ARTEFACT_DESTROYED`.
901
- */
902
- public static GAME_EVENT_ARTEFACT_DESTROYED: 17;
903
- /**
904
- * Engine enum value for `game_messages.GAME_EVENT_ARTEFACT_DROPPED`.
905
- */
906
- public static GAME_EVENT_ARTEFACT_DROPPED: 19;
907
- /**
908
- * Engine enum value for `game_messages.GAME_EVENT_ARTEFACT_ONBASE`.
909
- */
910
- public static GAME_EVENT_ARTEFACT_ONBASE: 20;
911
- /**
912
- * Engine enum value for `game_messages.GAME_EVENT_ARTEFACT_SPAWNED`.
913
- */
914
- public static GAME_EVENT_ARTEFACT_SPAWNED: 16;
915
- /**
916
- * Engine enum value for `game_messages.GAME_EVENT_ARTEFACT_TAKEN`.
917
- */
918
- public static GAME_EVENT_ARTEFACT_TAKEN: 18;
919
- /**
920
- * Engine enum value for `game_messages.GAME_EVENT_BUY_MENU_CLOSED`.
921
- */
922
- public static GAME_EVENT_BUY_MENU_CLOSED: 23;
923
- /**
924
- * Engine enum value for `game_messages.GAME_EVENT_PLAYER_BUY_FINISHED`.
925
- */
926
- public static GAME_EVENT_PLAYER_BUY_FINISHED: 2;
927
- /**
928
- * Engine enum value for `game_messages.GAME_EVENT_PLAYER_CHANGE_SKIN`.
929
- */
930
- public static GAME_EVENT_PLAYER_CHANGE_SKIN: 6;
931
- /**
932
- * Engine enum value for `game_messages.GAME_EVENT_PLAYER_CHANGE_TEAM`.
933
- */
934
- public static GAME_EVENT_PLAYER_CHANGE_TEAM: 6;
935
- /**
936
- * Engine enum value for `game_messages.GAME_EVENT_PLAYER_CONNECTED`.
937
- */
938
- public static GAME_EVENT_PLAYER_CONNECTED: 8;
939
- /**
940
- * Engine enum value for `game_messages.GAME_EVENT_PLAYER_DISCONNECTED`.
941
- */
942
- public static GAME_EVENT_PLAYER_DISCONNECTED: 9;
943
- /**
944
- * Engine enum value for `game_messages.GAME_EVENT_PLAYER_ENTER_TEAM_BASE`.
945
- */
946
- public static GAME_EVENT_PLAYER_ENTER_TEAM_BASE: 21;
947
- /**
948
- * Engine enum value for `game_messages.GAME_EVENT_PLAYER_JOIN_TEAM`.
949
- */
950
- public static GAME_EVENT_PLAYER_JOIN_TEAM: 13;
951
- /**
952
- * Engine enum value for `game_messages.GAME_EVENT_PLAYER_KILL`.
953
- */
954
- public static GAME_EVENT_PLAYER_KILL: 1;
955
- /**
956
- * Engine enum value for `game_messages.GAME_EVENT_PLAYER_KILLED`.
957
- */
958
- public static GAME_EVENT_PLAYER_KILLED: 11;
959
- /**
960
- * Engine enum value for `game_messages.GAME_EVENT_PLAYER_LEAVE_TEAM_BASE`.
961
- */
962
- public static GAME_EVENT_PLAYER_LEAVE_TEAM_BASE: 22;
963
- /**
964
- * Engine enum value for `game_messages.GAME_EVENT_PLAYER_READY`.
965
- */
966
- public static GAME_EVENT_PLAYER_READY: 0;
967
- /**
968
- * Engine enum value for `game_messages.GAME_EVENT_ROUND_END`.
969
- */
970
- public static GAME_EVENT_ROUND_END: 15;
971
- /**
972
- * Engine enum value for `game_messages.GAME_EVENT_ROUND_STARTED`.
973
- */
974
- public static GAME_EVENT_ROUND_STARTED: 14;
975
- /**
976
- * Engine enum value for `game_messages.GAME_EVENT_SCRIPT_BEGINS_FROM`.
977
- */
978
- public static GAME_EVENT_SCRIPT_BEGINS_FROM: 46;
979
- /**
980
- * Engine enum value for `game_messages.GAME_EVENT_SKIN_MENU_CLOSED`.
981
- */
982
- public static GAME_EVENT_SKIN_MENU_CLOSED: 25;
983
- /**
984
- * Engine enum value for `game_messages.GAME_EVENT_TEAM_MENU_CLOSED`.
985
- */
986
- public static GAME_EVENT_TEAM_MENU_CLOSED: 24;
987
-
988
- /**
989
- * Engine-owned multiplayer event constants.
990
- */
991
- protected constructor();
992
- }
993
-
994
- /**
995
- * @group xr_multiplayer
996
- */
997
- export type TXR_game_message = EnumeratedStaticsValues<game_messages>;
998
-
999
- /**
1000
- * Current multiplayer game state.
1001
- *
1002
- * @source C++ class game_GameState : DLL_Pure
1003
- * @customConstructor game_GameState
1004
- * @group xr_multiplayer
1005
- *
1006
- * @remarks
1007
- * Multiplayer match state, not single-player task or story state. `type` uses raw engine `EGameIDs` values.
1008
- */
1009
- export class game_GameState extends DLL_Pure {
1010
- /**
1011
- * Current round number.
1012
- */
1013
- public round: i32;
1014
-
1015
- /**
1016
- * Round or match start time.
1017
- */
1018
- public start_time: u32;
1019
-
1020
- /**
1021
- * Multiplayer game type id.
1022
- */
1023
- public type: number; /* EGameIDs */
1024
-
1025
- /**
1026
- * Create an empty multiplayer game state.
1027
- */
1028
- public constructor();
1029
-
1030
- /**
1031
- * @returns Round or match start time.
1032
- */
1033
- public StartTime(): u32;
1034
-
1035
- /**
1036
- * @returns Current round number.
1037
- */
1038
- public Round(): i32;
1039
-
1040
- /**
1041
- * @returns Current game phase.
1042
- */
1043
- public Phase(): u16;
1044
-
1045
- /**
1046
- * @returns Multiplayer game type id.
1047
- */
1048
- public Type(): number; /* EGameIDs */
1049
- }
1050
-
1051
- /**
1052
- * Todo:
1053
- *
1054
- * class_<game_PlayerState, no_bases, default_holder, WrapType>("game_PlayerState")
1055
- * .def(constructor<>())
1056
- * .def_readwrite("team", &BaseType::team)
1057
- * .def_readwrite("kills", &BaseType::m_iRivalKills)
1058
- * .def_readwrite("deaths", &BaseType::m_iDeaths)
1059
- * .def_readwrite("money_for_round", &BaseType::money_for_round)
1060
- * .def_readwrite("flags", &BaseType::flags__)
1061
- * .def_readwrite("ping", &BaseType::ping)
1062
- * .def_readwrite("GameID", &BaseType::GameID)
1063
- * //.def_readwrite("Skip", &BaseType::Skip)
1064
- * .def_readwrite("lasthitter", &BaseType::lasthitter)
1065
- * .def_readwrite("lasthitweapon", &BaseType::lasthitweapon)
1066
- * .def_readwrite("skin", &BaseType::skin)
1067
- * .def_readwrite("RespawnTime", &BaseType::RespawnTime)
1068
- * .def_readwrite("money_delta", &BaseType::money_delta).
1069
- *
1070
- * .def_readwrite("pItemList", &BaseType::pItemList)
1071
- * .def_readwrite("LastBuyAcount", &BaseType::LastBuyAcount)
1072
- * .def("testFlag", &BaseType::testFlag)
1073
- * .def("setFlag", &BaseType::setFlag)
1074
- * .def("resetFlag", &BaseType::resetFlag)
1075
- * .def("getName", &BaseType::getName)
1076
- * .def("setName", &BaseType::setName)
1077
- * .def("clear", &BaseType::clear, &WrapType::clear_static)
1078
- * .def("net_Export", &BaseType::net_Export, &WrapType::net_Export_static)
1079
- * .def("net_Import", &BaseType::net_Import, &WrapType::net_Import_static).
1080
- */
1081
- }