xray16 1.6.3 → 1.6.4
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.
- package/README.md +12 -15
- package/package.json +1 -1
- package/plugins/inline_constants/plugin.d.ts +12 -5
- package/plugins/inline_constants/plugin.js +20 -6
- package/plugins/inline_constants/transformation/ast.d.ts +25 -16
- package/plugins/inline_constants/transformation/ast.js +58 -24
- package/plugins/inline_constants/transformation/constants.d.ts +62 -4
- package/plugins/inline_constants/transformation/constants.js +35 -4
- package/plugins/inline_constants/transformation/errors.d.ts +6 -0
- package/plugins/inline_constants/transformation/errors.js +6 -2
- package/plugins/inline_constants/transformation/evaluation.d.ts +58 -28
- package/plugins/inline_constants/transformation/evaluation.js +130 -33
- package/plugins/inline_constants/transformation/index.d.ts +1 -0
- package/plugins/inline_constants/transformation/index.js +1 -0
- package/plugins/inline_constants/transformation/transformers.d.ts +24 -10
- package/plugins/inline_constants/transformation/transformers.js +225 -17
- package/plugins/inline_constants/transformation/validation.d.ts +2 -1
- package/plugins/inline_constants/transformation/validation.js +3 -2
- package/plugins/inline_constants/transformation/virtual.d.ts +74 -0
- package/plugins/inline_constants/transformation/virtual.js +340 -0
- package/xray16.d.ts +877 -366
package/xray16.d.ts
CHANGED
|
@@ -559,7 +559,12 @@ declare module "xray16" {
|
|
|
559
559
|
* @param pathType - Detail path type id.
|
|
560
560
|
* @param game_object - Target object.
|
|
561
561
|
*/
|
|
562
|
-
public constructor(
|
|
562
|
+
public constructor(
|
|
563
|
+
bodyState: TXR_body_state,
|
|
564
|
+
movementType: TXR_movement_type,
|
|
565
|
+
pathType: TXR_detail_path_type,
|
|
566
|
+
game_object: game_object
|
|
567
|
+
);
|
|
563
568
|
|
|
564
569
|
/**
|
|
565
570
|
* Move toward an object with a speed value.
|
|
@@ -586,7 +591,12 @@ declare module "xray16" {
|
|
|
586
591
|
* @param pathType - Detail path type id.
|
|
587
592
|
* @param patrol - Patrol path parameters.
|
|
588
593
|
*/
|
|
589
|
-
public constructor(
|
|
594
|
+
public constructor(
|
|
595
|
+
bodyState: TXR_body_state,
|
|
596
|
+
movementType: TXR_movement_type,
|
|
597
|
+
pathType: TXR_detail_path_type,
|
|
598
|
+
patrol: patrol
|
|
599
|
+
);
|
|
590
600
|
|
|
591
601
|
/**
|
|
592
602
|
* Move along a patrol path with a speed value.
|
|
@@ -597,7 +607,13 @@ declare module "xray16" {
|
|
|
597
607
|
* @param patrol - Patrol path parameters.
|
|
598
608
|
* @param value - Speed or distance value.
|
|
599
609
|
*/
|
|
600
|
-
public constructor(
|
|
610
|
+
public constructor(
|
|
611
|
+
bodyState: TXR_body_state,
|
|
612
|
+
movementType: TXR_movement_type,
|
|
613
|
+
pathType: TXR_detail_path_type,
|
|
614
|
+
patrol: patrol,
|
|
615
|
+
value: f32
|
|
616
|
+
);
|
|
601
617
|
|
|
602
618
|
/**
|
|
603
619
|
* Move toward a position.
|
|
@@ -607,7 +623,12 @@ declare module "xray16" {
|
|
|
607
623
|
* @param pathType - Detail path type id.
|
|
608
624
|
* @param vector - Target position.
|
|
609
625
|
*/
|
|
610
|
-
public constructor(
|
|
626
|
+
public constructor(
|
|
627
|
+
bodyState: TXR_body_state,
|
|
628
|
+
movementType: TXR_movement_type,
|
|
629
|
+
pathType: TXR_detail_path_type,
|
|
630
|
+
vector: vector
|
|
631
|
+
);
|
|
611
632
|
|
|
612
633
|
/**
|
|
613
634
|
* Move toward a position with a speed value.
|
|
@@ -618,7 +639,13 @@ declare module "xray16" {
|
|
|
618
639
|
* @param vector - Target position.
|
|
619
640
|
* @param value - Speed or distance value.
|
|
620
641
|
*/
|
|
621
|
-
public constructor(
|
|
642
|
+
public constructor(
|
|
643
|
+
bodyState: TXR_body_state,
|
|
644
|
+
movementType: TXR_movement_type,
|
|
645
|
+
pathType: TXR_detail_path_type,
|
|
646
|
+
vector: vector,
|
|
647
|
+
value: f32
|
|
648
|
+
);
|
|
622
649
|
|
|
623
650
|
/**
|
|
624
651
|
* Move toward a position with distance.
|
|
@@ -3764,11 +3791,15 @@ declare module "xray16" {
|
|
|
3764
3791
|
}
|
|
3765
3792
|
|
|
3766
3793
|
/**
|
|
3794
|
+
* Script-visible class id constant names from `clsid`.
|
|
3795
|
+
*
|
|
3767
3796
|
* @group xr_alife
|
|
3768
3797
|
*/
|
|
3769
3798
|
export type TXR_class_key = EnumeratedStaticsKeys<typeof clsid>;
|
|
3770
3799
|
|
|
3771
3800
|
/**
|
|
3801
|
+
* Numeric engine class id values from `clsid`.
|
|
3802
|
+
*
|
|
3772
3803
|
* @group xr_alife
|
|
3773
3804
|
*/
|
|
3774
3805
|
export type TXR_class_id = EnumeratedStaticsValues<typeof clsid>;
|
|
@@ -5501,47 +5532,47 @@ declare module "xray16" {
|
|
|
5501
5532
|
/**
|
|
5502
5533
|
* Engine enum value for `danger_object.attack_sound`.
|
|
5503
5534
|
*/
|
|
5504
|
-
public static attack_sound: 1;
|
|
5535
|
+
public static readonly attack_sound: 1;
|
|
5505
5536
|
/**
|
|
5506
5537
|
* Engine enum value for `danger_object.attacked`.
|
|
5507
5538
|
*/
|
|
5508
|
-
public static attacked: 5;
|
|
5539
|
+
public static readonly attacked: 5;
|
|
5509
5540
|
/**
|
|
5510
5541
|
* Engine enum value for `danger_object.bullet_ricochet`.
|
|
5511
5542
|
*/
|
|
5512
|
-
public static bullet_ricochet: 0;
|
|
5543
|
+
public static readonly bullet_ricochet: 0;
|
|
5513
5544
|
/**
|
|
5514
5545
|
* Engine enum value for `danger_object.enemy_sound`.
|
|
5515
5546
|
*/
|
|
5516
|
-
public static enemy_sound: 7;
|
|
5547
|
+
public static readonly enemy_sound: 7;
|
|
5517
5548
|
/**
|
|
5518
5549
|
* Engine enum value for `danger_object.entity_attacked`.
|
|
5519
5550
|
*/
|
|
5520
|
-
public static entity_attacked: 2;
|
|
5551
|
+
public static readonly entity_attacked: 2;
|
|
5521
5552
|
/**
|
|
5522
5553
|
* Engine enum value for `danger_object.entity_corpse`.
|
|
5523
5554
|
*/
|
|
5524
|
-
public static entity_corpse: 4;
|
|
5555
|
+
public static readonly entity_corpse: 4;
|
|
5525
5556
|
/**
|
|
5526
5557
|
* Engine enum value for `danger_object.entity_death`.
|
|
5527
5558
|
*/
|
|
5528
|
-
public static entity_death: 3;
|
|
5559
|
+
public static readonly entity_death: 3;
|
|
5529
5560
|
/**
|
|
5530
5561
|
* Engine enum value for `danger_object.grenade`.
|
|
5531
5562
|
*/
|
|
5532
|
-
public static grenade: 6;
|
|
5563
|
+
public static readonly grenade: 6;
|
|
5533
5564
|
/**
|
|
5534
5565
|
* Engine enum value for `danger_object.hit`.
|
|
5535
5566
|
*/
|
|
5536
|
-
public static hit: 2;
|
|
5567
|
+
public static readonly hit: 2;
|
|
5537
5568
|
/**
|
|
5538
5569
|
* Engine enum value for `danger_object.sound`.
|
|
5539
5570
|
*/
|
|
5540
|
-
public static sound: 1;
|
|
5571
|
+
public static readonly sound: 1;
|
|
5541
5572
|
/**
|
|
5542
5573
|
* Engine enum value for `danger_object.visual`.
|
|
5543
5574
|
*/
|
|
5544
|
-
public static visual: 0;
|
|
5575
|
+
public static readonly visual: 0;
|
|
5545
5576
|
|
|
5546
5577
|
/**
|
|
5547
5578
|
* @returns Danger type.
|
|
@@ -5590,7 +5621,8 @@ declare module "xray16" {
|
|
|
5590
5621
|
* @source C++ enum CDangerObject::EDangerPerceiveType
|
|
5591
5622
|
* @group xr_memory
|
|
5592
5623
|
*/
|
|
5593
|
-
export type TXR_danger_perceive_type =
|
|
5624
|
+
export type TXR_danger_perceive_type =
|
|
5625
|
+
typeof danger_object.visual | typeof danger_object.sound | typeof danger_object.hit;
|
|
5594
5626
|
/**
|
|
5595
5627
|
* @group xr_memory
|
|
5596
5628
|
*/
|
|
@@ -7212,67 +7244,67 @@ declare module "xray16" {
|
|
|
7212
7244
|
/**
|
|
7213
7245
|
* Clamp listed paths by extension.
|
|
7214
7246
|
*/
|
|
7215
|
-
public static FS_ClampExt: 4;
|
|
7247
|
+
public static readonly FS_ClampExt: 4;
|
|
7216
7248
|
|
|
7217
7249
|
/**
|
|
7218
7250
|
* List files.
|
|
7219
7251
|
*/
|
|
7220
|
-
public static FS_ListFiles: 1;
|
|
7252
|
+
public static readonly FS_ListFiles: 1;
|
|
7221
7253
|
|
|
7222
7254
|
/**
|
|
7223
7255
|
* List folders.
|
|
7224
7256
|
*/
|
|
7225
|
-
public static FS_ListFolders: 2;
|
|
7257
|
+
public static readonly FS_ListFolders: 2;
|
|
7226
7258
|
|
|
7227
7259
|
/**
|
|
7228
7260
|
* Do not recurse into subfolders.
|
|
7229
7261
|
*/
|
|
7230
|
-
public static FS_RootOnly: 8;
|
|
7262
|
+
public static readonly FS_RootOnly: 8;
|
|
7231
7263
|
|
|
7232
7264
|
/**
|
|
7233
7265
|
* Sort by modification time, newest first.
|
|
7234
7266
|
*/
|
|
7235
|
-
public static FS_sort_by_modif_down: 5;
|
|
7267
|
+
public static readonly FS_sort_by_modif_down: 5;
|
|
7236
7268
|
|
|
7237
7269
|
/**
|
|
7238
7270
|
* Sort by modification time, oldest first.
|
|
7239
7271
|
*/
|
|
7240
|
-
public static FS_sort_by_modif_up: 4;
|
|
7272
|
+
public static readonly FS_sort_by_modif_up: 4;
|
|
7241
7273
|
|
|
7242
7274
|
/**
|
|
7243
7275
|
* Sort by name descending.
|
|
7244
7276
|
*/
|
|
7245
|
-
public static FS_sort_by_name_down: 1;
|
|
7277
|
+
public static readonly FS_sort_by_name_down: 1;
|
|
7246
7278
|
|
|
7247
7279
|
/**
|
|
7248
7280
|
* Sort by name ascending.
|
|
7249
7281
|
*/
|
|
7250
|
-
public static FS_sort_by_name_up: 0;
|
|
7282
|
+
public static readonly FS_sort_by_name_up: 0;
|
|
7251
7283
|
|
|
7252
7284
|
/**
|
|
7253
7285
|
* Sort by size descending.
|
|
7254
7286
|
*/
|
|
7255
|
-
public static FS_sort_by_size_down: 3;
|
|
7287
|
+
public static readonly FS_sort_by_size_down: 3;
|
|
7256
7288
|
|
|
7257
7289
|
/**
|
|
7258
7290
|
* Sort by size ascending.
|
|
7259
7291
|
*/
|
|
7260
|
-
public static FS_sort_by_size_up: 2;
|
|
7292
|
+
public static readonly FS_sort_by_size_up: 2;
|
|
7261
7293
|
|
|
7262
7294
|
/**
|
|
7263
7295
|
* Search virtual registered files only.
|
|
7264
7296
|
*/
|
|
7265
|
-
public static FSType_Virtual: 1;
|
|
7297
|
+
public static readonly FSType_Virtual: 1;
|
|
7266
7298
|
|
|
7267
7299
|
/**
|
|
7268
7300
|
* Search external files only.
|
|
7269
7301
|
*/
|
|
7270
|
-
public static FSType_External: 2;
|
|
7302
|
+
public static readonly FSType_External: 2;
|
|
7271
7303
|
|
|
7272
7304
|
/**
|
|
7273
7305
|
* Search virtual and external files.
|
|
7274
7306
|
*/
|
|
7275
|
-
public static FSType_Any: 3;
|
|
7307
|
+
public static readonly FSType_Any: 3;
|
|
7276
7308
|
|
|
7277
7309
|
/**
|
|
7278
7310
|
* Delete a directory below a path alias.
|
|
@@ -7542,9 +7574,14 @@ declare module "xray16" {
|
|
|
7542
7574
|
}
|
|
7543
7575
|
|
|
7544
7576
|
/**
|
|
7545
|
-
* Filesystem
|
|
7577
|
+
* Filesystem scope accepted by `FS.exist()` and related path queries.
|
|
7546
7578
|
*
|
|
7579
|
+
* @source `src/xrGame/fs_registrator_script.cpp`, `FS.FSType` enum.
|
|
7547
7580
|
* @group xr_fs
|
|
7581
|
+
*
|
|
7582
|
+
* @remarks
|
|
7583
|
+
* `FSType_Virtual` searches mounted game paths, `FSType_External` searches external filesystem paths, and
|
|
7584
|
+
* `FSType_Any` allows either source.
|
|
7548
7585
|
*/
|
|
7549
7586
|
export type TXR_fs_type = typeof FS.FSType_Virtual | typeof FS.FSType_External | typeof FS.FSType_Any;
|
|
7550
7587
|
|
|
@@ -7579,7 +7616,7 @@ declare module "xray16" {
|
|
|
7579
7616
|
* - eGameIDArtefactHunt = u32(1) << 3,
|
|
7580
7617
|
* - eGameIDCaptureTheArtefact = u32(1) << 4,
|
|
7581
7618
|
* - eGameIDDominationZone = u32(1) << 5,
|
|
7582
|
-
* - eGameIDTeamDominationZone = u32(1) << 6
|
|
7619
|
+
* - eGameIDTeamDominationZone = u32(1) << 6.
|
|
7583
7620
|
*
|
|
7584
7621
|
* @source C++ enum EGameIDs
|
|
7585
7622
|
* @group xr_game
|
|
@@ -7655,7 +7692,13 @@ declare module "xray16" {
|
|
|
7655
7692
|
}
|
|
7656
7693
|
|
|
7657
7694
|
/**
|
|
7695
|
+
* Legacy game type constants exposed through the `GAME_TYPE` Lua class.
|
|
7696
|
+
*
|
|
7658
7697
|
* @group xr_game
|
|
7698
|
+
*
|
|
7699
|
+
* @remarks
|
|
7700
|
+
* `GAME_TYPE.GAME_*` values are UI/menu constants and are not the same set as the `EGameIDs` bitmask values returned
|
|
7701
|
+
* by `level.game_id()`.
|
|
7659
7702
|
*/
|
|
7660
7703
|
export type TXR_GAME_TYPE = EnumeratedStaticsValues<typeof GAME_TYPE>;
|
|
7661
7704
|
|
|
@@ -8576,9 +8619,14 @@ declare module "xray16" {
|
|
|
8576
8619
|
}
|
|
8577
8620
|
|
|
8578
8621
|
/**
|
|
8579
|
-
* Ray query target bitmask
|
|
8622
|
+
* Ray query target bitmask accepted by `level.ray_pick()` and `ray_pick.set_flags()`.
|
|
8580
8623
|
*
|
|
8624
|
+
* @source `src/xrGame/level_script.cpp`, `rq_target` binding.
|
|
8581
8625
|
* @group xr_level
|
|
8626
|
+
*
|
|
8627
|
+
* @remarks
|
|
8628
|
+
* Values are bit flags from `collide::rq_target`. Combined constants such as `rqtBoth` and `rqtDyn` are precomputed
|
|
8629
|
+
* masks exported by the engine, not separate target categories.
|
|
8582
8630
|
*/
|
|
8583
8631
|
export type TXR_rq_target = EnumeratedStaticsValues<typeof rq_target>;
|
|
8584
8632
|
|
|
@@ -8756,6 +8804,7 @@ declare module "xray16" {
|
|
|
8756
8804
|
*/
|
|
8757
8805
|
public get_element(): i32;
|
|
8758
8806
|
}
|
|
8807
|
+
|
|
8759
8808
|
/**
|
|
8760
8809
|
* Global helpers for the currently loaded level.
|
|
8761
8810
|
*
|
|
@@ -11656,91 +11705,91 @@ declare module "xray16" {
|
|
|
11656
11705
|
/**
|
|
11657
11706
|
* Engine enum value for `game_messages.GAME_EVENT_ARTEFACT_DESTROYED`.
|
|
11658
11707
|
*/
|
|
11659
|
-
public static GAME_EVENT_ARTEFACT_DESTROYED: 17;
|
|
11708
|
+
public static readonly GAME_EVENT_ARTEFACT_DESTROYED: 17;
|
|
11660
11709
|
/**
|
|
11661
11710
|
* Engine enum value for `game_messages.GAME_EVENT_ARTEFACT_DROPPED`.
|
|
11662
11711
|
*/
|
|
11663
|
-
public static GAME_EVENT_ARTEFACT_DROPPED: 19;
|
|
11712
|
+
public static readonly GAME_EVENT_ARTEFACT_DROPPED: 19;
|
|
11664
11713
|
/**
|
|
11665
11714
|
* Engine enum value for `game_messages.GAME_EVENT_ARTEFACT_ONBASE`.
|
|
11666
11715
|
*/
|
|
11667
|
-
public static GAME_EVENT_ARTEFACT_ONBASE: 20;
|
|
11716
|
+
public static readonly GAME_EVENT_ARTEFACT_ONBASE: 20;
|
|
11668
11717
|
/**
|
|
11669
11718
|
* Engine enum value for `game_messages.GAME_EVENT_ARTEFACT_SPAWNED`.
|
|
11670
11719
|
*/
|
|
11671
|
-
public static GAME_EVENT_ARTEFACT_SPAWNED: 16;
|
|
11720
|
+
public static readonly GAME_EVENT_ARTEFACT_SPAWNED: 16;
|
|
11672
11721
|
/**
|
|
11673
11722
|
* Engine enum value for `game_messages.GAME_EVENT_ARTEFACT_TAKEN`.
|
|
11674
11723
|
*/
|
|
11675
|
-
public static GAME_EVENT_ARTEFACT_TAKEN: 18;
|
|
11724
|
+
public static readonly GAME_EVENT_ARTEFACT_TAKEN: 18;
|
|
11676
11725
|
/**
|
|
11677
11726
|
* Engine enum value for `game_messages.GAME_EVENT_BUY_MENU_CLOSED`.
|
|
11678
11727
|
*/
|
|
11679
|
-
public static GAME_EVENT_BUY_MENU_CLOSED: 23;
|
|
11728
|
+
public static readonly GAME_EVENT_BUY_MENU_CLOSED: 23;
|
|
11680
11729
|
/**
|
|
11681
11730
|
* Engine enum value for `game_messages.GAME_EVENT_PLAYER_BUY_FINISHED`.
|
|
11682
11731
|
*/
|
|
11683
|
-
public static GAME_EVENT_PLAYER_BUY_FINISHED: 2;
|
|
11732
|
+
public static readonly GAME_EVENT_PLAYER_BUY_FINISHED: 2;
|
|
11684
11733
|
/**
|
|
11685
11734
|
* Engine enum value for `game_messages.GAME_EVENT_PLAYER_CHANGE_SKIN`.
|
|
11686
11735
|
*/
|
|
11687
|
-
public static GAME_EVENT_PLAYER_CHANGE_SKIN: 6;
|
|
11736
|
+
public static readonly GAME_EVENT_PLAYER_CHANGE_SKIN: 6;
|
|
11688
11737
|
/**
|
|
11689
11738
|
* Engine enum value for `game_messages.GAME_EVENT_PLAYER_CHANGE_TEAM`.
|
|
11690
11739
|
*/
|
|
11691
|
-
public static GAME_EVENT_PLAYER_CHANGE_TEAM: 6;
|
|
11740
|
+
public static readonly GAME_EVENT_PLAYER_CHANGE_TEAM: 6;
|
|
11692
11741
|
/**
|
|
11693
11742
|
* Engine enum value for `game_messages.GAME_EVENT_PLAYER_CONNECTED`.
|
|
11694
11743
|
*/
|
|
11695
|
-
public static GAME_EVENT_PLAYER_CONNECTED: 8;
|
|
11744
|
+
public static readonly GAME_EVENT_PLAYER_CONNECTED: 8;
|
|
11696
11745
|
/**
|
|
11697
11746
|
* Engine enum value for `game_messages.GAME_EVENT_PLAYER_DISCONNECTED`.
|
|
11698
11747
|
*/
|
|
11699
|
-
public static GAME_EVENT_PLAYER_DISCONNECTED: 9;
|
|
11748
|
+
public static readonly GAME_EVENT_PLAYER_DISCONNECTED: 9;
|
|
11700
11749
|
/**
|
|
11701
11750
|
* Engine enum value for `game_messages.GAME_EVENT_PLAYER_ENTER_TEAM_BASE`.
|
|
11702
11751
|
*/
|
|
11703
|
-
public static GAME_EVENT_PLAYER_ENTER_TEAM_BASE: 21;
|
|
11752
|
+
public static readonly GAME_EVENT_PLAYER_ENTER_TEAM_BASE: 21;
|
|
11704
11753
|
/**
|
|
11705
11754
|
* Engine enum value for `game_messages.GAME_EVENT_PLAYER_JOIN_TEAM`.
|
|
11706
11755
|
*/
|
|
11707
|
-
public static GAME_EVENT_PLAYER_JOIN_TEAM: 13;
|
|
11756
|
+
public static readonly GAME_EVENT_PLAYER_JOIN_TEAM: 13;
|
|
11708
11757
|
/**
|
|
11709
11758
|
* Engine enum value for `game_messages.GAME_EVENT_PLAYER_KILL`.
|
|
11710
11759
|
*/
|
|
11711
|
-
public static GAME_EVENT_PLAYER_KILL: 1;
|
|
11760
|
+
public static readonly GAME_EVENT_PLAYER_KILL: 1;
|
|
11712
11761
|
/**
|
|
11713
11762
|
* Engine enum value for `game_messages.GAME_EVENT_PLAYER_KILLED`.
|
|
11714
11763
|
*/
|
|
11715
|
-
public static GAME_EVENT_PLAYER_KILLED: 11;
|
|
11764
|
+
public static readonly GAME_EVENT_PLAYER_KILLED: 11;
|
|
11716
11765
|
/**
|
|
11717
11766
|
* Engine enum value for `game_messages.GAME_EVENT_PLAYER_LEAVE_TEAM_BASE`.
|
|
11718
11767
|
*/
|
|
11719
|
-
public static GAME_EVENT_PLAYER_LEAVE_TEAM_BASE: 22;
|
|
11768
|
+
public static readonly GAME_EVENT_PLAYER_LEAVE_TEAM_BASE: 22;
|
|
11720
11769
|
/**
|
|
11721
11770
|
* Engine enum value for `game_messages.GAME_EVENT_PLAYER_READY`.
|
|
11722
11771
|
*/
|
|
11723
|
-
public static GAME_EVENT_PLAYER_READY: 0;
|
|
11772
|
+
public static readonly GAME_EVENT_PLAYER_READY: 0;
|
|
11724
11773
|
/**
|
|
11725
11774
|
* Engine enum value for `game_messages.GAME_EVENT_ROUND_END`.
|
|
11726
11775
|
*/
|
|
11727
|
-
public static GAME_EVENT_ROUND_END: 15;
|
|
11776
|
+
public static readonly GAME_EVENT_ROUND_END: 15;
|
|
11728
11777
|
/**
|
|
11729
11778
|
* Engine enum value for `game_messages.GAME_EVENT_ROUND_STARTED`.
|
|
11730
11779
|
*/
|
|
11731
|
-
public static GAME_EVENT_ROUND_STARTED: 14;
|
|
11780
|
+
public static readonly GAME_EVENT_ROUND_STARTED: 14;
|
|
11732
11781
|
/**
|
|
11733
11782
|
* Engine enum value for `game_messages.GAME_EVENT_SCRIPT_BEGINS_FROM`.
|
|
11734
11783
|
*/
|
|
11735
|
-
public static GAME_EVENT_SCRIPT_BEGINS_FROM: 46;
|
|
11784
|
+
public static readonly GAME_EVENT_SCRIPT_BEGINS_FROM: 46;
|
|
11736
11785
|
/**
|
|
11737
11786
|
* Engine enum value for `game_messages.GAME_EVENT_SKIN_MENU_CLOSED`.
|
|
11738
11787
|
*/
|
|
11739
|
-
public static GAME_EVENT_SKIN_MENU_CLOSED: 25;
|
|
11788
|
+
public static readonly GAME_EVENT_SKIN_MENU_CLOSED: 25;
|
|
11740
11789
|
/**
|
|
11741
11790
|
* Engine enum value for `game_messages.GAME_EVENT_TEAM_MENU_CLOSED`.
|
|
11742
11791
|
*/
|
|
11743
|
-
public static GAME_EVENT_TEAM_MENU_CLOSED: 24;
|
|
11792
|
+
public static readonly GAME_EVENT_TEAM_MENU_CLOSED: 24;
|
|
11744
11793
|
|
|
11745
11794
|
/**
|
|
11746
11795
|
* Engine-owned multiplayer event constants.
|
|
@@ -11995,10 +12044,14 @@ declare module "xray16" {
|
|
|
11995
12044
|
export const PROFILER_TYPE_SAMPLING: 2;
|
|
11996
12045
|
|
|
11997
12046
|
/**
|
|
11998
|
-
* Lua profiler mode accepted by `profiler.start`.
|
|
12047
|
+
* Lua profiler mode accepted by `profiler.start()`.
|
|
11999
12048
|
*
|
|
12000
12049
|
* @source C++ enum CScriptProfilerType
|
|
12001
12050
|
* @group xr_profiler
|
|
12051
|
+
*
|
|
12052
|
+
* @remarks
|
|
12053
|
+
* Hook mode records Lua call/return events. Sampling mode uses the LuaJIT profiler. `PROFILER_TYPE_NONE` is exposed
|
|
12054
|
+
* for status reporting and does not start profiling.
|
|
12002
12055
|
*/
|
|
12003
12056
|
export type TXR_ProfilerType = typeof PROFILER_TYPE_NONE | typeof PROFILER_TYPE_HOOK | typeof PROFILER_TYPE_SAMPLING;
|
|
12004
12057
|
|
|
@@ -12548,14 +12601,38 @@ declare module "xray16" {
|
|
|
12548
12601
|
/**
|
|
12549
12602
|
* Create a runtime token list property bound to a string field.
|
|
12550
12603
|
*/
|
|
12551
|
-
public create_list(
|
|
12604
|
+
public create_list(
|
|
12605
|
+
items: prop_item_vec,
|
|
12606
|
+
key: string,
|
|
12607
|
+
object: object,
|
|
12608
|
+
name: string,
|
|
12609
|
+
tokens: rtoken_list
|
|
12610
|
+
): list_value;
|
|
12552
12611
|
|
|
12553
12612
|
/**
|
|
12554
12613
|
* Create token properties bound to integer fields.
|
|
12555
12614
|
*/
|
|
12556
|
-
public create_token8(
|
|
12557
|
-
|
|
12558
|
-
|
|
12615
|
+
public create_token8(
|
|
12616
|
+
items: prop_item_vec,
|
|
12617
|
+
key: string,
|
|
12618
|
+
object: object,
|
|
12619
|
+
name: string,
|
|
12620
|
+
tokens: token_list
|
|
12621
|
+
): token8_value;
|
|
12622
|
+
public create_token16(
|
|
12623
|
+
items: prop_item_vec,
|
|
12624
|
+
key: string,
|
|
12625
|
+
object: object,
|
|
12626
|
+
name: string,
|
|
12627
|
+
tokens: token_list
|
|
12628
|
+
): token16_value;
|
|
12629
|
+
public create_token32(
|
|
12630
|
+
items: prop_item_vec,
|
|
12631
|
+
key: string,
|
|
12632
|
+
object: object,
|
|
12633
|
+
name: string,
|
|
12634
|
+
tokens: token_list
|
|
12635
|
+
): token32_value;
|
|
12559
12636
|
|
|
12560
12637
|
/**
|
|
12561
12638
|
* Create flag properties bound to integer flag fields.
|
|
@@ -12623,7 +12700,15 @@ declare module "xray16" {
|
|
|
12623
12700
|
increment?: f32,
|
|
12624
12701
|
decimals?: i32
|
|
12625
12702
|
): float_value;
|
|
12626
|
-
public create_u8(
|
|
12703
|
+
public create_u8(
|
|
12704
|
+
items: prop_item_vec,
|
|
12705
|
+
key: string,
|
|
12706
|
+
object: object,
|
|
12707
|
+
name: string,
|
|
12708
|
+
min?: u8,
|
|
12709
|
+
max?: u8,
|
|
12710
|
+
increment?: u8
|
|
12711
|
+
): u8_value;
|
|
12627
12712
|
public create_u16(
|
|
12628
12713
|
items: prop_item_vec,
|
|
12629
12714
|
key: string,
|
|
@@ -13062,11 +13147,8 @@ declare module "xray16" {
|
|
|
13062
13147
|
* `3` is the native `eRelationTypeWorstEnemy` value; it is not exported as a named Lua enum member.
|
|
13063
13148
|
*/
|
|
13064
13149
|
export type TXR_relation =
|
|
13065
|
-
| typeof game_object.
|
|
13066
|
-
|
|
13067
|
-
| typeof game_object.neutral
|
|
13068
|
-
| typeof game_object.enemy
|
|
13069
|
-
| 3;}
|
|
13150
|
+
typeof game_object.dummy | typeof game_object.friend | typeof game_object.neutral | typeof game_object.enemy | 3;
|
|
13151
|
+
}
|
|
13070
13152
|
|
|
13071
13153
|
declare module "xray16" {
|
|
13072
13154
|
/**
|
|
@@ -14125,17 +14207,17 @@ declare module "xray16" {
|
|
|
14125
14207
|
/**
|
|
14126
14208
|
* Spatial 3D playback.
|
|
14127
14209
|
*/
|
|
14128
|
-
public static s3d: 0;
|
|
14210
|
+
public static readonly s3d: 0;
|
|
14129
14211
|
|
|
14130
14212
|
/**
|
|
14131
14213
|
* Keep playing until stopped.
|
|
14132
14214
|
*/
|
|
14133
|
-
public static looped: 1;
|
|
14215
|
+
public static readonly looped: 1;
|
|
14134
14216
|
|
|
14135
14217
|
/**
|
|
14136
14218
|
* Screen-space 2D playback.
|
|
14137
14219
|
*/
|
|
14138
|
-
public static s2d: 2;
|
|
14220
|
+
public static readonly s2d: 2;
|
|
14139
14221
|
|
|
14140
14222
|
/**
|
|
14141
14223
|
* Playback frequency multiplier.
|
|
@@ -14338,7 +14420,14 @@ declare module "xray16" {
|
|
|
14338
14420
|
}
|
|
14339
14421
|
|
|
14340
14422
|
/**
|
|
14423
|
+
* Playback mode flag accepted by `sound_object.play()` and `play_at_pos()`.
|
|
14424
|
+
*
|
|
14425
|
+
* @source `src/xrGame/script_sound_script.cpp`, `sound_object.sound_play_type` enum.
|
|
14341
14426
|
* @group xr_sound
|
|
14427
|
+
*
|
|
14428
|
+
* @remarks
|
|
14429
|
+
* `sound_object.looped` keeps playback active until stopped, `sound_object.s2d` plays in screen space, and
|
|
14430
|
+
* `sound_object.s3d` leaves playback spatial.
|
|
14342
14431
|
*/
|
|
14343
14432
|
export type TXR_sound_object_type = EnumeratedStaticsValues<typeof sound_object>;
|
|
14344
14433
|
|
|
@@ -14353,187 +14442,187 @@ declare module "xray16" {
|
|
|
14353
14442
|
/**
|
|
14354
14443
|
* Engine enum value for `snd_type.ambient`.
|
|
14355
14444
|
*/
|
|
14356
|
-
public static ambient: 128;
|
|
14445
|
+
public static readonly ambient: 128;
|
|
14357
14446
|
/**
|
|
14358
14447
|
* Engine enum value for `snd_type.anomaly`.
|
|
14359
14448
|
*/
|
|
14360
|
-
public static anomaly: 268435456;
|
|
14449
|
+
public static readonly anomaly: 268435456;
|
|
14361
14450
|
/**
|
|
14362
14451
|
* Engine enum value for `snd_type.anomaly_idle`.
|
|
14363
14452
|
*/
|
|
14364
|
-
public static anomaly_idle: 268437504;
|
|
14453
|
+
public static readonly anomaly_idle: 268437504;
|
|
14365
14454
|
/**
|
|
14366
14455
|
* Engine enum value for `snd_type.attack`.
|
|
14367
14456
|
*/
|
|
14368
|
-
public static attack: 8192;
|
|
14457
|
+
public static readonly attack: 8192;
|
|
14369
14458
|
/**
|
|
14370
14459
|
* Engine enum value for `snd_type.bullet_hit`.
|
|
14371
14460
|
*/
|
|
14372
|
-
public static bullet_hit: 524288;
|
|
14461
|
+
public static readonly bullet_hit: 524288;
|
|
14373
14462
|
/**
|
|
14374
14463
|
* Engine enum value for `snd_type.die`.
|
|
14375
14464
|
*/
|
|
14376
|
-
public static die: 131072;
|
|
14465
|
+
public static readonly die: 131072;
|
|
14377
14466
|
/**
|
|
14378
14467
|
* Engine enum value for `snd_type.drop`.
|
|
14379
14468
|
*/
|
|
14380
|
-
public static drop: 33554432;
|
|
14469
|
+
public static readonly drop: 33554432;
|
|
14381
14470
|
/**
|
|
14382
14471
|
* Engine enum value for `snd_type.eat`.
|
|
14383
14472
|
*/
|
|
14384
|
-
public static eat: 4096;
|
|
14473
|
+
public static readonly eat: 4096;
|
|
14385
14474
|
/**
|
|
14386
14475
|
* Engine enum value for `snd_type.empty`.
|
|
14387
14476
|
*/
|
|
14388
|
-
public static empty: 1048576;
|
|
14477
|
+
public static readonly empty: 1048576;
|
|
14389
14478
|
/**
|
|
14390
14479
|
* Engine enum value for `snd_type.hide`.
|
|
14391
14480
|
*/
|
|
14392
|
-
public static hide: 16777216;
|
|
14481
|
+
public static readonly hide: 16777216;
|
|
14393
14482
|
/**
|
|
14394
14483
|
* Engine enum value for `snd_type.idle`.
|
|
14395
14484
|
*/
|
|
14396
|
-
public static idle: 2048;
|
|
14485
|
+
public static readonly idle: 2048;
|
|
14397
14486
|
/**
|
|
14398
14487
|
* Engine enum value for `snd_type.injure`.
|
|
14399
14488
|
*/
|
|
14400
|
-
public static injure: 65536;
|
|
14489
|
+
public static readonly injure: 65536;
|
|
14401
14490
|
/**
|
|
14402
14491
|
* Engine enum value for `snd_type.item`.
|
|
14403
14492
|
*/
|
|
14404
|
-
public static item: 1073741824;
|
|
14493
|
+
public static readonly item: 1073741824;
|
|
14405
14494
|
/**
|
|
14406
14495
|
* Engine enum value for `snd_type.item_drop`.
|
|
14407
14496
|
*/
|
|
14408
|
-
public static item_drop: 1107296256;
|
|
14497
|
+
public static readonly item_drop: 1107296256;
|
|
14409
14498
|
/**
|
|
14410
14499
|
* Engine enum value for `snd_type.item_hide`.
|
|
14411
14500
|
*/
|
|
14412
|
-
public static item_hide: 1090519040;
|
|
14501
|
+
public static readonly item_hide: 1090519040;
|
|
14413
14502
|
/**
|
|
14414
14503
|
* Engine enum value for `snd_type.item_pick_up`.
|
|
14415
14504
|
*/
|
|
14416
|
-
public static item_pick_up: 1140850688;
|
|
14505
|
+
public static readonly item_pick_up: 1140850688;
|
|
14417
14506
|
/**
|
|
14418
14507
|
* Engine enum value for `snd_type.item_take`.
|
|
14419
14508
|
*/
|
|
14420
|
-
public static item_take: 1082130432;
|
|
14509
|
+
public static readonly item_take: 1082130432;
|
|
14421
14510
|
/**
|
|
14422
14511
|
* Engine enum value for `snd_type.item_use`.
|
|
14423
14512
|
*/
|
|
14424
|
-
public static item_use: 1077936128;
|
|
14513
|
+
public static readonly item_use: 1077936128;
|
|
14425
14514
|
/**
|
|
14426
14515
|
* Engine enum value for `snd_type.monster`.
|
|
14427
14516
|
*/
|
|
14428
|
-
public static monster: 536870912;
|
|
14517
|
+
public static readonly monster: 536870912;
|
|
14429
14518
|
/**
|
|
14430
14519
|
* Engine enum value for `snd_type.monster_attack`.
|
|
14431
14520
|
*/
|
|
14432
|
-
public static monster_attack: 536879104;
|
|
14521
|
+
public static readonly monster_attack: 536879104;
|
|
14433
14522
|
/**
|
|
14434
14523
|
* Engine enum value for `snd_type.monster_die`.
|
|
14435
14524
|
*/
|
|
14436
|
-
public static monster_die: 537001984;
|
|
14525
|
+
public static readonly monster_die: 537001984;
|
|
14437
14526
|
/**
|
|
14438
14527
|
* Engine enum value for `snd_type.monster_eat`.
|
|
14439
14528
|
*/
|
|
14440
|
-
public static monster_eat: 536875008;
|
|
14529
|
+
public static readonly monster_eat: 536875008;
|
|
14441
14530
|
/**
|
|
14442
14531
|
* Engine enum value for `snd_type.monster_injure`.
|
|
14443
14532
|
*/
|
|
14444
|
-
public static monster_injure: 536936448;
|
|
14533
|
+
public static readonly monster_injure: 536936448;
|
|
14445
14534
|
/**
|
|
14446
14535
|
* Engine enum value for `snd_type.monster_step`.
|
|
14447
14536
|
*/
|
|
14448
|
-
public static monster_step: 536903680;
|
|
14537
|
+
public static readonly monster_step: 536903680;
|
|
14449
14538
|
/**
|
|
14450
14539
|
* Engine enum value for `snd_type.monster_talk`.
|
|
14451
14540
|
*/
|
|
14452
|
-
public static monster_talk: 536887296;
|
|
14541
|
+
public static readonly monster_talk: 536887296;
|
|
14453
14542
|
/**
|
|
14454
14543
|
* Engine enum value for `snd_type.no_sound`.
|
|
14455
14544
|
*/
|
|
14456
|
-
public static no_sound: 0;
|
|
14545
|
+
public static readonly no_sound: 0;
|
|
14457
14546
|
/**
|
|
14458
14547
|
* Engine enum value for `snd_type.object_break`.
|
|
14459
14548
|
*/
|
|
14460
|
-
public static object_break: 1024;
|
|
14549
|
+
public static readonly object_break: 1024;
|
|
14461
14550
|
/**
|
|
14462
14551
|
* Engine enum value for `snd_type.object_collide`.
|
|
14463
14552
|
*/
|
|
14464
|
-
public static object_collide: 512;
|
|
14553
|
+
public static readonly object_collide: 512;
|
|
14465
14554
|
/**
|
|
14466
14555
|
* Engine enum value for `snd_type.object_explode`.
|
|
14467
14556
|
*/
|
|
14468
|
-
public static object_explode: 256;
|
|
14557
|
+
public static readonly object_explode: 256;
|
|
14469
14558
|
/**
|
|
14470
14559
|
* Engine enum value for `snd_type.pick_up`.
|
|
14471
14560
|
*/
|
|
14472
|
-
public static pick_up: 67108864;
|
|
14561
|
+
public static readonly pick_up: 67108864;
|
|
14473
14562
|
/**
|
|
14474
14563
|
* Engine enum value for `snd_type.reload`.
|
|
14475
14564
|
*/
|
|
14476
|
-
public static reload: 262144;
|
|
14565
|
+
public static readonly reload: 262144;
|
|
14477
14566
|
/**
|
|
14478
14567
|
* Engine enum value for `snd_type.shoot`.
|
|
14479
14568
|
*/
|
|
14480
|
-
public static shoot: 2097152;
|
|
14569
|
+
public static readonly shoot: 2097152;
|
|
14481
14570
|
/**
|
|
14482
14571
|
* Engine enum value for `snd_type.step`.
|
|
14483
14572
|
*/
|
|
14484
|
-
public static step: 32768;
|
|
14573
|
+
public static readonly step: 32768;
|
|
14485
14574
|
/**
|
|
14486
14575
|
* Engine enum value for `snd_type.take`.
|
|
14487
14576
|
*/
|
|
14488
|
-
public static take: 8388608;
|
|
14577
|
+
public static readonly take: 8388608;
|
|
14489
14578
|
/**
|
|
14490
14579
|
* Engine enum value for `snd_type.talk`.
|
|
14491
14580
|
*/
|
|
14492
|
-
public static talk: 16384;
|
|
14581
|
+
public static readonly talk: 16384;
|
|
14493
14582
|
/**
|
|
14494
14583
|
* Engine enum value for `snd_type.use`.
|
|
14495
14584
|
*/
|
|
14496
|
-
public static use: 4194304;
|
|
14585
|
+
public static readonly use: 4194304;
|
|
14497
14586
|
/**
|
|
14498
14587
|
* Engine enum value for `snd_type.weapon`.
|
|
14499
14588
|
*/
|
|
14500
|
-
public static weapon: -2147483648;
|
|
14589
|
+
public static readonly weapon: -2147483648;
|
|
14501
14590
|
/**
|
|
14502
14591
|
* Engine enum value for `snd_type.weapon_bullet_hit`.
|
|
14503
14592
|
*/
|
|
14504
|
-
public static weapon_bullet_hit: -2146959360;
|
|
14593
|
+
public static readonly weapon_bullet_hit: -2146959360;
|
|
14505
14594
|
/**
|
|
14506
14595
|
* Engine enum value for `snd_type.weapon_empty`.
|
|
14507
14596
|
*/
|
|
14508
|
-
public static weapon_empty: -2146435072;
|
|
14597
|
+
public static readonly weapon_empty: -2146435072;
|
|
14509
14598
|
/**
|
|
14510
14599
|
* Engine enum value for `snd_type.weapon_reload`.
|
|
14511
14600
|
*/
|
|
14512
|
-
public static weapon_reload: -2147221504;
|
|
14601
|
+
public static readonly weapon_reload: -2147221504;
|
|
14513
14602
|
/**
|
|
14514
14603
|
* Engine enum value for `snd_type.weapon_shoot`.
|
|
14515
14604
|
*/
|
|
14516
|
-
public static weapon_shoot: -2145386496;
|
|
14605
|
+
public static readonly weapon_shoot: -2145386496;
|
|
14517
14606
|
/**
|
|
14518
14607
|
* Engine enum value for `snd_type.world`.
|
|
14519
14608
|
*/
|
|
14520
|
-
public static world: 134217728;
|
|
14609
|
+
public static readonly world: 134217728;
|
|
14521
14610
|
/**
|
|
14522
14611
|
* Engine enum value for `snd_type.world_ambient`.
|
|
14523
14612
|
*/
|
|
14524
|
-
public static world_ambient: 134217856;
|
|
14613
|
+
public static readonly world_ambient: 134217856;
|
|
14525
14614
|
/**
|
|
14526
14615
|
* Engine enum value for `snd_type.world_object_break`.
|
|
14527
14616
|
*/
|
|
14528
|
-
public static world_object_break: 134218752;
|
|
14617
|
+
public static readonly world_object_break: 134218752;
|
|
14529
14618
|
/**
|
|
14530
14619
|
* Engine enum value for `snd_type.world_object_collide`.
|
|
14531
14620
|
*/
|
|
14532
|
-
public static world_object_collide: 134218240;
|
|
14621
|
+
public static readonly world_object_collide: 134218240;
|
|
14533
14622
|
/**
|
|
14534
14623
|
* Engine enum value for `snd_type.world_object_explode`.
|
|
14535
14624
|
*/
|
|
14536
|
-
public static world_object_explode: 134217984;
|
|
14625
|
+
public static readonly world_object_explode: 134217984;
|
|
14537
14626
|
|
|
14538
14627
|
/**
|
|
14539
14628
|
* Engine-owned sound category constants.
|
|
@@ -14542,7 +14631,14 @@ declare module "xray16" {
|
|
|
14542
14631
|
}
|
|
14543
14632
|
|
|
14544
14633
|
/**
|
|
14634
|
+
* AI sound category bitmask used by sound memory, callbacks, and sound actions.
|
|
14635
|
+
*
|
|
14636
|
+
* @source `src/xrGame/script_sound_action_script.cpp`, `snd_type.sound_types` enum.
|
|
14545
14637
|
* @group xr_sound
|
|
14638
|
+
*
|
|
14639
|
+
* @remarks
|
|
14640
|
+
* Values combine a broad owner category such as `weapon`, `monster`, or `world` with a concrete event such as
|
|
14641
|
+
* `shoot`, `die`, or `object_collide`. Use `snd_type.no_sound` when no AI sound category should be emitted.
|
|
14546
14642
|
*/
|
|
14547
14643
|
export type TXR_snd_type = EnumeratedStaticsValues<typeof snd_type>;
|
|
14548
14644
|
|
|
@@ -14684,38 +14780,49 @@ declare module "xray16" {
|
|
|
14684
14780
|
}
|
|
14685
14781
|
|
|
14686
14782
|
/**
|
|
14783
|
+
* Script-visible task state constant names from the `task.task_state` enum.
|
|
14784
|
+
*
|
|
14785
|
+
* @source `src/xrGame/GameTask_script.cpp`, `task.task_state` enum.
|
|
14687
14786
|
* @group xr_task
|
|
14688
14787
|
*/
|
|
14689
14788
|
export type TXR_TaskStateName = "fail" | "in_progress" | "completed" | "task_dummy";
|
|
14690
14789
|
|
|
14691
14790
|
/**
|
|
14692
|
-
*
|
|
14791
|
+
* Runtime task state returned by task and objective state APIs.
|
|
14693
14792
|
*
|
|
14793
|
+
* @source C++ enum ETaskState
|
|
14694
14794
|
* @group xr_task
|
|
14795
|
+
*
|
|
14796
|
+
* @remarks
|
|
14797
|
+
* `task.task_dummy` is returned for missing tasks or objects that cannot expose task state.
|
|
14695
14798
|
*/
|
|
14696
14799
|
export type TXR_TaskState =
|
|
14697
|
-
| typeof task.
|
|
14698
|
-
| typeof task.in_progress
|
|
14699
|
-
| typeof task.completed
|
|
14700
|
-
| typeof task.task_dummy;
|
|
14800
|
+
typeof task.fail | typeof task.in_progress | typeof task.completed | typeof task.task_dummy;
|
|
14701
14801
|
|
|
14702
14802
|
/**
|
|
14703
|
-
*
|
|
14803
|
+
* Task type constant names, including the shared native dummy sentinel.
|
|
14704
14804
|
*
|
|
14805
|
+
* @source `src/xrGame/GameTask_script.cpp`, `task.task_type` enum and `task.task_state` dummy export.
|
|
14705
14806
|
* @group xr_task
|
|
14807
|
+
*
|
|
14808
|
+
* @remarks
|
|
14809
|
+
* `storyline`, `additional`, and `insignificant` are exported by the task type enum. `task_dummy` is exported
|
|
14810
|
+
* by the same `task` class and has the native `ETaskTypeDummy` sentinel value.
|
|
14706
14811
|
*/
|
|
14707
14812
|
export type TXR_TaskTypeName = "storyline" | "additional" | "insignificant" | "task_dummy";
|
|
14708
14813
|
|
|
14709
14814
|
/**
|
|
14710
|
-
*
|
|
14815
|
+
* Task category used by `SGameTaskObjective.get_type()` and `set_type()`.
|
|
14711
14816
|
*
|
|
14817
|
+
* @source C++ enum ETaskType
|
|
14712
14818
|
* @group xr_task
|
|
14819
|
+
*
|
|
14820
|
+
* @remarks
|
|
14821
|
+
* `storyline`, `additional`, and `insignificant` are the script-exposed categories. `task.task_dummy` is kept
|
|
14822
|
+
* in the type because native task APIs can use the dummy sentinel value.
|
|
14713
14823
|
*/
|
|
14714
14824
|
export type TXR_TaskType =
|
|
14715
|
-
| typeof task.
|
|
14716
|
-
| typeof task.additional
|
|
14717
|
-
| typeof task.insignificant
|
|
14718
|
-
| typeof task.task_dummy;
|
|
14825
|
+
typeof task.storyline | typeof task.additional | typeof task.insignificant | typeof task.task_dummy;
|
|
14719
14826
|
|
|
14720
14827
|
/**
|
|
14721
14828
|
* One objective inside a game task.
|
|
@@ -15063,37 +15170,37 @@ declare module "xray16" {
|
|
|
15063
15170
|
/**
|
|
15064
15171
|
* Date formatting mode: day.
|
|
15065
15172
|
*/
|
|
15066
|
-
public static DateToDay: 0;
|
|
15173
|
+
public static readonly DateToDay: 0;
|
|
15067
15174
|
|
|
15068
15175
|
/**
|
|
15069
15176
|
* Date formatting mode: month.
|
|
15070
15177
|
*/
|
|
15071
|
-
public static DateToMonth: 1;
|
|
15178
|
+
public static readonly DateToMonth: 1;
|
|
15072
15179
|
|
|
15073
15180
|
/**
|
|
15074
15181
|
* Date formatting mode: year.
|
|
15075
15182
|
*/
|
|
15076
|
-
public static DateToYear: 2;
|
|
15183
|
+
public static readonly DateToYear: 2;
|
|
15077
15184
|
|
|
15078
15185
|
/**
|
|
15079
15186
|
* Time formatting mode: hours.
|
|
15080
15187
|
*/
|
|
15081
|
-
public static TimeToHours: 0;
|
|
15188
|
+
public static readonly TimeToHours: 0;
|
|
15082
15189
|
|
|
15083
15190
|
/**
|
|
15084
15191
|
* Time formatting mode: milliseconds.
|
|
15085
15192
|
*/
|
|
15086
|
-
public static TimeToMilisecs: 3;
|
|
15193
|
+
public static readonly TimeToMilisecs: 3;
|
|
15087
15194
|
|
|
15088
15195
|
/**
|
|
15089
15196
|
* Time formatting mode: minutes.
|
|
15090
15197
|
*/
|
|
15091
|
-
public static TimeToMinutes: 1;
|
|
15198
|
+
public static readonly TimeToMinutes: 1;
|
|
15092
15199
|
|
|
15093
15200
|
/**
|
|
15094
15201
|
* Time formatting mode: seconds.
|
|
15095
15202
|
*/
|
|
15096
|
-
public static TimeToSeconds: 2;
|
|
15203
|
+
public static readonly TimeToSeconds: 2;
|
|
15097
15204
|
|
|
15098
15205
|
/**
|
|
15099
15206
|
* Create an empty time value.
|
|
@@ -15300,7 +15407,7 @@ declare module "xray16" {
|
|
|
15300
15407
|
/**
|
|
15301
15408
|
* Client object binding for `CMosquitoBald` anomaly objects.
|
|
15302
15409
|
*
|
|
15303
|
-
* @source
|
|
15410
|
+
* @source `src/xrGame/MosquitoBald_script.cpp`, `CMosquitoBald` binding.
|
|
15304
15411
|
* @customConstructor CMosquitoBald
|
|
15305
15412
|
* @group xr_anomaly
|
|
15306
15413
|
*
|
|
@@ -15312,7 +15419,7 @@ declare module "xray16" {
|
|
|
15312
15419
|
/**
|
|
15313
15420
|
* Client object binding for torch items.
|
|
15314
15421
|
*
|
|
15315
|
-
* @source
|
|
15422
|
+
* @source `src/xrGame/torch_script.cpp`, `CTorch` binding.
|
|
15316
15423
|
* @customConstructor CTorch
|
|
15317
15424
|
* @group xr_anomaly
|
|
15318
15425
|
*
|
|
@@ -15324,7 +15431,7 @@ declare module "xray16" {
|
|
|
15324
15431
|
/**
|
|
15325
15432
|
* Client object binding for `CTorridZone` anomaly objects.
|
|
15326
15433
|
*
|
|
15327
|
-
* @source
|
|
15434
|
+
* @source `src/xrGame/MosquitoBald_script.cpp`, `CTorridZone` binding.
|
|
15328
15435
|
* @customConstructor CTorridZone
|
|
15329
15436
|
* @group xr_anomaly
|
|
15330
15437
|
*/
|
|
@@ -15333,7 +15440,7 @@ declare module "xray16" {
|
|
|
15333
15440
|
/**
|
|
15334
15441
|
* Client object binding for `CRadioactiveZone` anomaly objects.
|
|
15335
15442
|
*
|
|
15336
|
-
* @source
|
|
15443
|
+
* @source `src/xrGame/mincer_script.cpp`, `CRadioactiveZone` binding.
|
|
15337
15444
|
* @customConstructor CRadioactiveZone
|
|
15338
15445
|
* @group xr_anomaly
|
|
15339
15446
|
*/
|
|
@@ -15342,7 +15449,7 @@ declare module "xray16" {
|
|
|
15342
15449
|
/**
|
|
15343
15450
|
* Client object binding for `CMincer` anomaly objects.
|
|
15344
15451
|
*
|
|
15345
|
-
* @source
|
|
15452
|
+
* @source `src/xrGame/mincer_script.cpp`, `CMincer` binding.
|
|
15346
15453
|
* @customConstructor CMincer
|
|
15347
15454
|
* @group xr_anomaly
|
|
15348
15455
|
*/
|
|
@@ -15351,7 +15458,7 @@ declare module "xray16" {
|
|
|
15351
15458
|
/**
|
|
15352
15459
|
* Client object binding for `CFracture` anomaly objects.
|
|
15353
15460
|
*
|
|
15354
|
-
* @source
|
|
15461
|
+
* @source `src/xrGame/ai/monsters/fracture/fracture_script.cpp`, `CFracture` binding.
|
|
15355
15462
|
* @customConstructor CFracture
|
|
15356
15463
|
* @group xr_anomaly
|
|
15357
15464
|
*/
|
|
@@ -15360,23 +15467,49 @@ declare module "xray16" {
|
|
|
15360
15467
|
/**
|
|
15361
15468
|
* Client object binding for `CHairsZone` anomaly objects.
|
|
15362
15469
|
*
|
|
15363
|
-
* @source
|
|
15470
|
+
* @source `src/xrGame/HairsZone_script.cpp`, `CHairsZone` binding.
|
|
15364
15471
|
* @customConstructor CHairsZone
|
|
15365
15472
|
* @group xr_anomaly
|
|
15366
15473
|
*/
|
|
15367
15474
|
export class CHairsZone extends CGameObject {}
|
|
15475
|
+
|
|
15476
|
+
/**
|
|
15477
|
+
* Client object binding for `CAmebaZone` anomaly objects.
|
|
15478
|
+
*
|
|
15479
|
+
* @source `src/xrGame/HairsZone_script.cpp`, `CAmebaZone` binding.
|
|
15480
|
+
* @customConstructor CAmebaZone
|
|
15481
|
+
* @group xr_anomaly
|
|
15482
|
+
*
|
|
15483
|
+
* @remarks
|
|
15484
|
+
* Registered together with hair and no-gravity anomaly zones. Generic anomaly helpers are available through
|
|
15485
|
+
* `CCustomZone`/`game_object` after checking the runtime class.
|
|
15486
|
+
*/
|
|
15487
|
+
export class CAmebaZone extends CGameObject {}
|
|
15488
|
+
|
|
15489
|
+
/**
|
|
15490
|
+
* Client object binding for `CNoGravityZone` anomaly objects.
|
|
15491
|
+
*
|
|
15492
|
+
* @source `src/xrGame/HairsZone_script.cpp`, `CNoGravityZone` binding.
|
|
15493
|
+
* @customConstructor CNoGravityZone
|
|
15494
|
+
* @group xr_anomaly
|
|
15495
|
+
*
|
|
15496
|
+
* @remarks
|
|
15497
|
+
* Registered by the hair-zone script binding as a concrete anomaly wrapper.
|
|
15498
|
+
*/
|
|
15499
|
+
export class CNoGravityZone extends CGameObject {}
|
|
15368
15500
|
}
|
|
15369
15501
|
|
|
15370
15502
|
declare module "xray16" {
|
|
15371
15503
|
/**
|
|
15372
15504
|
* Client-side artefact object.
|
|
15373
15505
|
*
|
|
15374
|
-
* @source
|
|
15506
|
+
* @source `src/xrGame/artefact_script.cpp`, `CArtefact` binding.
|
|
15375
15507
|
* @customConstructor CArtefact
|
|
15376
15508
|
* @group xr_artefact
|
|
15377
15509
|
*
|
|
15378
15510
|
* @remarks
|
|
15379
|
-
* Scripts usually reach this wrapper through `game_object.cast_Artefact()` after checking `is_artefact()`.
|
|
15511
|
+
* Scripts usually reach this wrapper through `game_object.cast_Artefact()` after checking `is_artefact()`. Path and
|
|
15512
|
+
* visibility helpers only affect artefacts with detector support.
|
|
15380
15513
|
*/
|
|
15381
15514
|
export class CArtefact extends CGameObject {
|
|
15382
15515
|
/**
|
|
@@ -15385,14 +15518,15 @@ declare module "xray16" {
|
|
|
15385
15518
|
public constructor();
|
|
15386
15519
|
|
|
15387
15520
|
/**
|
|
15388
|
-
* Move the artefact along a patrol path.
|
|
15521
|
+
* Move the artefact detector helper along a patrol path.
|
|
15389
15522
|
*
|
|
15390
15523
|
* @remarks
|
|
15391
|
-
*
|
|
15524
|
+
* Native code delegates to detector support when it exists. Missing detector support makes this a no-op. The vector
|
|
15525
|
+
* parameter is stored as movement force, not as an initial world position.
|
|
15392
15526
|
*
|
|
15393
15527
|
* @param path_name - Patrol path name.
|
|
15394
15528
|
* @param point_index - Starting path point index.
|
|
15395
|
-
* @param position -
|
|
15529
|
+
* @param position - Movement force used by detector support.
|
|
15396
15530
|
*/
|
|
15397
15531
|
public FollowByPath(path_name: string, point_index: i32, position: vector): void;
|
|
15398
15532
|
|
|
@@ -15402,10 +15536,11 @@ declare module "xray16" {
|
|
|
15402
15536
|
public GetAfRank(): u8;
|
|
15403
15537
|
|
|
15404
15538
|
/**
|
|
15405
|
-
* Show or hide the artefact.
|
|
15539
|
+
* Show or hide the artefact detector helper.
|
|
15406
15540
|
*
|
|
15407
15541
|
* @remarks
|
|
15408
|
-
*
|
|
15542
|
+
* Native code delegates to detector support when it exists. Missing detector support makes this a no-op; it does
|
|
15543
|
+
* not spawn or destroy the artefact object.
|
|
15409
15544
|
*
|
|
15410
15545
|
* @param is_visible - New visibility state.
|
|
15411
15546
|
*/
|
|
@@ -15415,7 +15550,7 @@ declare module "xray16" {
|
|
|
15415
15550
|
/**
|
|
15416
15551
|
* Client object binding for `CZudaArtefact` artefacts.
|
|
15417
15552
|
*
|
|
15418
|
-
* @source
|
|
15553
|
+
* @source `src/xrGame/artefact_script.cpp`, `CZudaArtefact` binding.
|
|
15419
15554
|
* @customConstructor CZudaArtefact
|
|
15420
15555
|
* @group xr_artefact
|
|
15421
15556
|
*/
|
|
@@ -15424,7 +15559,7 @@ declare module "xray16" {
|
|
|
15424
15559
|
/**
|
|
15425
15560
|
* Client object binding for `CThornArtefact` artefacts.
|
|
15426
15561
|
*
|
|
15427
|
-
* @source
|
|
15562
|
+
* @source `src/xrGame/artefact_script.cpp`, `CThornArtefact` binding.
|
|
15428
15563
|
* @customConstructor CThornArtefact
|
|
15429
15564
|
* @group xr_artefact
|
|
15430
15565
|
*/
|
|
@@ -15433,7 +15568,7 @@ declare module "xray16" {
|
|
|
15433
15568
|
/**
|
|
15434
15569
|
* Client object binding for `CBastArtefact` artefacts.
|
|
15435
15570
|
*
|
|
15436
|
-
* @source
|
|
15571
|
+
* @source `src/xrGame/artefact_script.cpp`, `CBastArtefact` binding.
|
|
15437
15572
|
* @customConstructor CBastArtefact
|
|
15438
15573
|
* @group xr_artefact
|
|
15439
15574
|
*/
|
|
@@ -15442,7 +15577,7 @@ declare module "xray16" {
|
|
|
15442
15577
|
/**
|
|
15443
15578
|
* Client object binding for `CBlackDrops` artefacts.
|
|
15444
15579
|
*
|
|
15445
|
-
* @source
|
|
15580
|
+
* @source `src/xrGame/artefact_script.cpp`, `CBlackDrops` binding.
|
|
15446
15581
|
* @customConstructor CBlackDrops
|
|
15447
15582
|
* @group xr_artefact
|
|
15448
15583
|
*/
|
|
@@ -15451,7 +15586,7 @@ declare module "xray16" {
|
|
|
15451
15586
|
/**
|
|
15452
15587
|
* Client object binding for `CBlackGraviArtefact` artefacts.
|
|
15453
15588
|
*
|
|
15454
|
-
* @source
|
|
15589
|
+
* @source `src/xrGame/artefact_script.cpp`, `CBlackGraviArtefact` binding.
|
|
15455
15590
|
* @customConstructor CBlackGraviArtefact
|
|
15456
15591
|
* @group xr_artefact
|
|
15457
15592
|
*/
|
|
@@ -15460,7 +15595,7 @@ declare module "xray16" {
|
|
|
15460
15595
|
/**
|
|
15461
15596
|
* Client object binding for `CDummyArtefact` artefacts.
|
|
15462
15597
|
*
|
|
15463
|
-
* @source
|
|
15598
|
+
* @source `src/xrGame/artefact_script.cpp`, `CDummyArtefact` binding.
|
|
15464
15599
|
* @customConstructor CDummyArtefact
|
|
15465
15600
|
* @group xr_artefact
|
|
15466
15601
|
*/
|
|
@@ -15469,7 +15604,7 @@ declare module "xray16" {
|
|
|
15469
15604
|
/**
|
|
15470
15605
|
* Client object binding for `CElectricBall` artefacts.
|
|
15471
15606
|
*
|
|
15472
|
-
* @source
|
|
15607
|
+
* @source `src/xrGame/artefact_script.cpp`, `CElectricBall` binding.
|
|
15473
15608
|
* @customConstructor CElectricBall
|
|
15474
15609
|
* @group xr_artefact
|
|
15475
15610
|
*/
|
|
@@ -15478,7 +15613,7 @@ declare module "xray16" {
|
|
|
15478
15613
|
/**
|
|
15479
15614
|
* Client object binding for `CFadedBall` artefacts.
|
|
15480
15615
|
*
|
|
15481
|
-
* @source
|
|
15616
|
+
* @source `src/xrGame/artefact_script.cpp`, `CFadedBall` binding.
|
|
15482
15617
|
* @customConstructor CFadedBall
|
|
15483
15618
|
* @group xr_artefact
|
|
15484
15619
|
*/
|
|
@@ -15487,7 +15622,7 @@ declare module "xray16" {
|
|
|
15487
15622
|
/**
|
|
15488
15623
|
* Client object binding for `CGalantineArtefact` artefacts.
|
|
15489
15624
|
*
|
|
15490
|
-
* @source
|
|
15625
|
+
* @source `src/xrGame/artefact_script.cpp`, `CGalantineArtefact` binding.
|
|
15491
15626
|
* @customConstructor CGalantineArtefact
|
|
15492
15627
|
* @group xr_artefact
|
|
15493
15628
|
*/
|
|
@@ -15496,7 +15631,7 @@ declare module "xray16" {
|
|
|
15496
15631
|
/**
|
|
15497
15632
|
* Client object binding for `CGraviArtefact` artefacts.
|
|
15498
15633
|
*
|
|
15499
|
-
* @source
|
|
15634
|
+
* @source `src/xrGame/artefact_script.cpp`, `CGraviArtefact` binding.
|
|
15500
15635
|
* @customConstructor CGraviArtefact
|
|
15501
15636
|
* @group xr_artefact
|
|
15502
15637
|
*/
|
|
@@ -15505,7 +15640,7 @@ declare module "xray16" {
|
|
|
15505
15640
|
/**
|
|
15506
15641
|
* Client object binding for `CMercuryBall` artefacts.
|
|
15507
15642
|
*
|
|
15508
|
-
* @source
|
|
15643
|
+
* @source `src/xrGame/artefact_script.cpp`, `CMercuryBall` binding.
|
|
15509
15644
|
* @customConstructor CMercuryBall
|
|
15510
15645
|
* @group xr_artefact
|
|
15511
15646
|
*/
|
|
@@ -15514,7 +15649,7 @@ declare module "xray16" {
|
|
|
15514
15649
|
/**
|
|
15515
15650
|
* Client object binding for `CRustyHairArtefact` artefacts.
|
|
15516
15651
|
*
|
|
15517
|
-
* @source
|
|
15652
|
+
* @source `src/xrGame/artefact_script.cpp`, `CRustyHairArtefact` binding.
|
|
15518
15653
|
* @customConstructor CRustyHairArtefact
|
|
15519
15654
|
* @group xr_artefact
|
|
15520
15655
|
*/
|
|
@@ -15525,12 +15660,13 @@ declare module "xray16" {
|
|
|
15525
15660
|
/**
|
|
15526
15661
|
* Base engine object exposed for compatibility with script binders.
|
|
15527
15662
|
*
|
|
15528
|
-
* @source
|
|
15663
|
+
* @source `src/xrGame/base_client_classes_script.cpp`, `DLL_Pure` binding.
|
|
15529
15664
|
* @customConstructor DLL_Pure
|
|
15530
15665
|
* @group xr_core
|
|
15531
15666
|
*
|
|
15532
15667
|
* @remarks
|
|
15533
|
-
*
|
|
15668
|
+
* Backward-compatible script name for the native `IFactoryObject` base. It is exposed as `DLL_Pure` for existing mod
|
|
15669
|
+
* scripts, while most gameplay code receives derived client objects from engine callbacks or casts.
|
|
15534
15670
|
*/
|
|
15535
15671
|
export class DLL_Pure extends EngineBinding {
|
|
15536
15672
|
/**
|
|
@@ -15542,34 +15678,35 @@ declare module "xray16" {
|
|
|
15542
15678
|
/**
|
|
15543
15679
|
* Render visual handle for client objects.
|
|
15544
15680
|
*
|
|
15545
|
-
* @source
|
|
15681
|
+
* @source `src/xrGame/base_client_classes_script.cpp`, `IRender_Visual` binding.
|
|
15546
15682
|
* @group xr_client_object
|
|
15547
15683
|
*
|
|
15548
15684
|
* @remarks
|
|
15549
|
-
* Visual handles are owned by the object.
|
|
15685
|
+
* Visual handles are owned by the object. Cast helpers return borrowed engine interfaces and can return `null` when
|
|
15686
|
+
* the underlying visual does not implement the requested interface.
|
|
15550
15687
|
*/
|
|
15551
15688
|
export interface IXR_IRender_Visual {
|
|
15552
15689
|
/**
|
|
15553
15690
|
* Cast the visual to animated kinematics when supported.
|
|
15554
15691
|
*
|
|
15555
15692
|
* @remarks
|
|
15556
|
-
*
|
|
15693
|
+
* Returns `null` when the visual is not animated. The native default implementation returns `nullptr`.
|
|
15557
15694
|
*
|
|
15558
15695
|
* @returns Animated kinematics interface.
|
|
15559
15696
|
*/
|
|
15560
|
-
dcast_PKinematicsAnimated(): IKinematicsAnimated
|
|
15697
|
+
dcast_PKinematicsAnimated(): Nullable<IKinematicsAnimated>;
|
|
15561
15698
|
}
|
|
15562
15699
|
|
|
15563
15700
|
/**
|
|
15564
15701
|
* Base client-side game object.
|
|
15565
15702
|
*
|
|
15566
|
-
* @source
|
|
15703
|
+
* @source `src/xrGame/base_client_classes_script.cpp`, `CGameObject` binding.
|
|
15567
15704
|
* @customConstructor CGameObject
|
|
15568
15705
|
* @group xr_client_object
|
|
15569
15706
|
*
|
|
15570
15707
|
* @remarks
|
|
15571
|
-
* Client-side object state is engine-owned.
|
|
15572
|
-
* work with `game_object` instead.
|
|
15708
|
+
* Client-side object state is engine-owned. The binding exposes low-level lifecycle hooks used by custom client
|
|
15709
|
+
* subclasses; ordinary gameplay scripts usually work with the higher-level `game_object` wrapper instead.
|
|
15573
15710
|
*/
|
|
15574
15711
|
export class CGameObject extends DLL_Pure {
|
|
15575
15712
|
/**
|
|
@@ -15634,21 +15771,27 @@ declare module "xray16" {
|
|
|
15634
15771
|
/**
|
|
15635
15772
|
* Class to link client side object with script object entity.
|
|
15636
15773
|
*
|
|
15637
|
-
* @source
|
|
15774
|
+
* @source `src/xrGame/script_binder_object_script.cpp`, `object_binder` binding.
|
|
15638
15775
|
* @customConstructor object_binder
|
|
15639
15776
|
* @group xr_client_object
|
|
15640
15777
|
*
|
|
15641
15778
|
* @remarks
|
|
15642
|
-
* Script binders are callbacks attached to a `game_object`. The engine calls lifecycle methods
|
|
15643
|
-
*
|
|
15779
|
+
* Script binders are callbacks attached to a `game_object`. The engine calls lifecycle methods through wrapper
|
|
15780
|
+
* fallbacks, so script subclasses can override these methods and call `super` when they need base behavior.
|
|
15644
15781
|
*/
|
|
15645
15782
|
export class object_binder<T = game_object> extends EngineBinding {
|
|
15646
15783
|
/**
|
|
15647
15784
|
* Script game object controlled by this binder.
|
|
15785
|
+
*
|
|
15786
|
+
* @remarks
|
|
15787
|
+
* Bound through luabind `def_readwrite`, but consumers should normally treat the binder target as stable after
|
|
15788
|
+
* construction.
|
|
15648
15789
|
*/
|
|
15649
15790
|
public readonly object: T;
|
|
15650
15791
|
|
|
15651
15792
|
/**
|
|
15793
|
+
* Create a binder for a script game object.
|
|
15794
|
+
*
|
|
15652
15795
|
* @param object - Script game object controlled by this binder.
|
|
15653
15796
|
*/
|
|
15654
15797
|
public constructor(object: T);
|
|
@@ -15731,22 +15874,27 @@ declare module "xray16" {
|
|
|
15731
15874
|
|
|
15732
15875
|
declare module "xray16" {
|
|
15733
15876
|
/**
|
|
15734
|
-
*
|
|
15877
|
+
* Runtime family wrapper for alive entities returned by `game_object.cast_EntityAlive()`.
|
|
15735
15878
|
*
|
|
15736
|
-
* @source
|
|
15879
|
+
* @source `src/xrGame/script_game_object_script3.cpp`, `cast_EntityAlive` binding.
|
|
15737
15880
|
* @customConstructor CEntityAlive
|
|
15738
15881
|
* @group xr_creature
|
|
15739
15882
|
*
|
|
15740
15883
|
* @remarks
|
|
15741
|
-
*
|
|
15742
|
-
* alive-object methods from the shared `game_object` surface.
|
|
15884
|
+
* This is a cast target, not a directly registered script constructor. Use `game_object.is_entity_alive()` or a
|
|
15885
|
+
* narrower predicate before calling alive-object methods from the shared `game_object` surface.
|
|
15743
15886
|
*/
|
|
15744
|
-
export class CEntityAlive extends CGameObject {
|
|
15887
|
+
export class CEntityAlive extends CGameObject {
|
|
15888
|
+
/**
|
|
15889
|
+
* Cast-only runtime wrapper.
|
|
15890
|
+
*/
|
|
15891
|
+
protected constructor();
|
|
15892
|
+
}
|
|
15745
15893
|
|
|
15746
15894
|
/**
|
|
15747
15895
|
* Client object binding for `CActor`.
|
|
15748
15896
|
*
|
|
15749
|
-
* @source
|
|
15897
|
+
* @source `src/xrGame/actor_script.cpp`, `CActor` binding.
|
|
15750
15898
|
* @customConstructor CActor
|
|
15751
15899
|
* @group xr_creature
|
|
15752
15900
|
*
|
|
@@ -15756,22 +15904,27 @@ declare module "xray16" {
|
|
|
15756
15904
|
export class CActor extends CGameObject {}
|
|
15757
15905
|
|
|
15758
15906
|
/**
|
|
15759
|
-
*
|
|
15907
|
+
* Runtime family wrapper for custom monsters returned by `game_object.cast_Monster()`.
|
|
15760
15908
|
*
|
|
15761
|
-
* @source
|
|
15909
|
+
* @source `src/xrGame/script_game_object_script3.cpp`, `cast_Monster` binding.
|
|
15762
15910
|
* @customConstructor CCustomMonster
|
|
15763
15911
|
* @group xr_creature
|
|
15764
15912
|
*
|
|
15765
15913
|
* @remarks
|
|
15766
|
-
*
|
|
15767
|
-
* family or one of its
|
|
15914
|
+
* This is a cast target for monster-specific helpers. Sound, range, memory, home, and enemy-transfer helpers require
|
|
15915
|
+
* this family or one of its concrete runtime classes.
|
|
15768
15916
|
*/
|
|
15769
|
-
export class CCustomMonster extends CGameObject {
|
|
15917
|
+
export class CCustomMonster extends CGameObject {
|
|
15918
|
+
/**
|
|
15919
|
+
* Cast-only runtime wrapper.
|
|
15920
|
+
*/
|
|
15921
|
+
protected constructor();
|
|
15922
|
+
}
|
|
15770
15923
|
|
|
15771
15924
|
/**
|
|
15772
|
-
*
|
|
15925
|
+
* Runtime family wrapper for inventory owners returned by `game_object.cast_InventoryOwner()`.
|
|
15773
15926
|
*
|
|
15774
|
-
* @source
|
|
15927
|
+
* @source `src/xrGame/script_game_object_script3.cpp`, `cast_InventoryOwner` binding.
|
|
15775
15928
|
* @customConstructor CInventoryOwner
|
|
15776
15929
|
* @group xr_creature
|
|
15777
15930
|
*
|
|
@@ -15779,12 +15932,17 @@ declare module "xray16" {
|
|
|
15779
15932
|
* Inventory-owner APIs cover NPCs, traders, corpses, boxes, and the actor depending on runtime class. Check the
|
|
15780
15933
|
* object kind before assuming dialog, trade, belt, or inventory-box behavior exists.
|
|
15781
15934
|
*/
|
|
15782
|
-
export class CInventoryOwner extends CGameObject {
|
|
15935
|
+
export class CInventoryOwner extends CGameObject {
|
|
15936
|
+
/**
|
|
15937
|
+
* Cast-only runtime wrapper.
|
|
15938
|
+
*/
|
|
15939
|
+
protected constructor();
|
|
15940
|
+
}
|
|
15783
15941
|
|
|
15784
15942
|
/**
|
|
15785
|
-
*
|
|
15943
|
+
* Runtime family wrapper for inventory items returned by `game_object.cast_InventoryItem()`.
|
|
15786
15944
|
*
|
|
15787
|
-
* @source
|
|
15945
|
+
* @source `src/xrGame/script_game_object_script3.cpp`, `cast_InventoryItem` binding.
|
|
15788
15946
|
* @customConstructor CInventoryItem
|
|
15789
15947
|
* @group xr_creature
|
|
15790
15948
|
*
|
|
@@ -15792,12 +15950,17 @@ declare module "xray16" {
|
|
|
15792
15950
|
* Base wrapper for inventory items. Item condition, cost, upgrades, and slot behavior depend on the concrete item
|
|
15793
15951
|
* class.
|
|
15794
15952
|
*/
|
|
15795
|
-
export class CInventoryItem extends CGameObject {
|
|
15953
|
+
export class CInventoryItem extends CGameObject {
|
|
15954
|
+
/**
|
|
15955
|
+
* Cast-only runtime wrapper.
|
|
15956
|
+
*/
|
|
15957
|
+
protected constructor();
|
|
15958
|
+
}
|
|
15796
15959
|
|
|
15797
15960
|
/**
|
|
15798
15961
|
* Client object binding for `CZombie`.
|
|
15799
15962
|
*
|
|
15800
|
-
* @source
|
|
15963
|
+
* @source `src/xrGame/ai/monsters/zombie/zombie_script.cpp`, `CZombie` binding.
|
|
15801
15964
|
* @customConstructor CZombie
|
|
15802
15965
|
* @group xr_creature
|
|
15803
15966
|
*/
|
|
@@ -15806,7 +15969,7 @@ declare module "xray16" {
|
|
|
15806
15969
|
/**
|
|
15807
15970
|
* Client object binding for `CController`.
|
|
15808
15971
|
*
|
|
15809
|
-
* @source
|
|
15972
|
+
* @source `src/xrGame/ai/monsters/controller/controller_script.cpp`, `CController` binding.
|
|
15810
15973
|
* @customConstructor CController
|
|
15811
15974
|
* @group xr_creature
|
|
15812
15975
|
*/
|
|
@@ -15815,7 +15978,7 @@ declare module "xray16" {
|
|
|
15815
15978
|
/**
|
|
15816
15979
|
* Client object binding for `CTushkano`.
|
|
15817
15980
|
*
|
|
15818
|
-
* @source
|
|
15981
|
+
* @source `src/xrGame/ai/monsters/tushkano/tushkano_script.cpp`, `CTushkano` binding.
|
|
15819
15982
|
* @customConstructor CTushkano
|
|
15820
15983
|
* @group xr_creature
|
|
15821
15984
|
*/
|
|
@@ -15824,7 +15987,7 @@ declare module "xray16" {
|
|
|
15824
15987
|
/**
|
|
15825
15988
|
* Client object binding for `CBurer`.
|
|
15826
15989
|
*
|
|
15827
|
-
* @source
|
|
15990
|
+
* @source `src/xrGame/ai/monsters/burer/burer_script.cpp`, `CBurer` binding.
|
|
15828
15991
|
* @customConstructor CBurer
|
|
15829
15992
|
* @group xr_creature
|
|
15830
15993
|
*/
|
|
@@ -15833,7 +15996,7 @@ declare module "xray16" {
|
|
|
15833
15996
|
/**
|
|
15834
15997
|
* Client object binding for `CCat`.
|
|
15835
15998
|
*
|
|
15836
|
-
* @source
|
|
15999
|
+
* @source `src/xrGame/ai/monsters/cat/cat_script.cpp`, `CCat` binding.
|
|
15837
16000
|
* @customConstructor CCat
|
|
15838
16001
|
* @group xr_creature
|
|
15839
16002
|
*/
|
|
@@ -15842,7 +16005,7 @@ declare module "xray16" {
|
|
|
15842
16005
|
/**
|
|
15843
16006
|
* Client object binding for `CChimera`.
|
|
15844
16007
|
*
|
|
15845
|
-
* @source
|
|
16008
|
+
* @source `src/xrGame/ai/monsters/chimera/chimera_script.cpp`, `CChimera` binding.
|
|
15846
16009
|
* @customConstructor CChimera
|
|
15847
16010
|
* @group xr_creature
|
|
15848
16011
|
*/
|
|
@@ -15851,7 +16014,7 @@ declare module "xray16" {
|
|
|
15851
16014
|
/**
|
|
15852
16015
|
* Client object binding for `CPoltergeist`.
|
|
15853
16016
|
*
|
|
15854
|
-
* @source
|
|
16017
|
+
* @source `src/xrGame/ai/monsters/poltergeist/poltergeist_script.cpp`, `CPoltergeist` binding.
|
|
15855
16018
|
* @customConstructor CPoltergeist
|
|
15856
16019
|
* @group xr_creature
|
|
15857
16020
|
*/
|
|
@@ -15860,7 +16023,7 @@ declare module "xray16" {
|
|
|
15860
16023
|
/**
|
|
15861
16024
|
* Client object binding for `CPseudoGigant`.
|
|
15862
16025
|
*
|
|
15863
|
-
* @source
|
|
16026
|
+
* @source `src/xrGame/ai/monsters/pseudogigant/pseudogigant_script.cpp`, `CPseudoGigant` binding.
|
|
15864
16027
|
* @customConstructor CPseudoGigant
|
|
15865
16028
|
* @group xr_creature
|
|
15866
16029
|
*/
|
|
@@ -15869,7 +16032,7 @@ declare module "xray16" {
|
|
|
15869
16032
|
/**
|
|
15870
16033
|
* Client object binding for `CPsyDog`.
|
|
15871
16034
|
*
|
|
15872
|
-
* @source
|
|
16035
|
+
* @source `src/xrGame/ai/monsters/pseudodog/pseudodog_script.cpp`, `CPsyDog` binding.
|
|
15873
16036
|
* @customConstructor CPsyDog
|
|
15874
16037
|
* @group xr_creature
|
|
15875
16038
|
*/
|
|
@@ -15878,7 +16041,7 @@ declare module "xray16" {
|
|
|
15878
16041
|
/**
|
|
15879
16042
|
* Client object binding for `CPsyDogPhantom`.
|
|
15880
16043
|
*
|
|
15881
|
-
* @source
|
|
16044
|
+
* @source `src/xrGame/ai/monsters/pseudodog/pseudodog_script.cpp`, `CPsyDogPhantom` binding.
|
|
15882
16045
|
* @customConstructor CPsyDogPhantom
|
|
15883
16046
|
* @group xr_creature
|
|
15884
16047
|
*/
|
|
@@ -15887,12 +16050,13 @@ declare module "xray16" {
|
|
|
15887
16050
|
/**
|
|
15888
16051
|
* Client object binding for `CAI_Bloodsucker`.
|
|
15889
16052
|
*
|
|
15890
|
-
* @source
|
|
16053
|
+
* @source `src/xrGame/ai/monsters/bloodsucker/bloodsucker_script.cpp`, `CAI_Bloodsucker` binding.
|
|
15891
16054
|
* @customConstructor CAI_Bloodsucker
|
|
15892
16055
|
* @group xr_creature
|
|
15893
16056
|
*
|
|
15894
16057
|
* @remarks
|
|
15895
|
-
* Bloodsucker-specific visibility helpers are not valid for other custom monsters.
|
|
16058
|
+
* Bloodsucker-specific visibility helpers are not valid for other custom monsters. The shared `game_object` wrapper
|
|
16059
|
+
* also exposes this helper and logs a script error when the object is not this runtime class.
|
|
15896
16060
|
*/
|
|
15897
16061
|
export class CAI_Bloodsucker extends CGameObject {
|
|
15898
16062
|
/**
|
|
@@ -15906,7 +16070,7 @@ declare module "xray16" {
|
|
|
15906
16070
|
/**
|
|
15907
16071
|
* Client object binding for `CAI_Boar`.
|
|
15908
16072
|
*
|
|
15909
|
-
* @source
|
|
16073
|
+
* @source `src/xrGame/ai/monsters/boar/boar_script.cpp`, `CAI_Boar` binding.
|
|
15910
16074
|
* @customConstructor CAI_Boar
|
|
15911
16075
|
* @group xr_creature
|
|
15912
16076
|
*/
|
|
@@ -15915,7 +16079,7 @@ declare module "xray16" {
|
|
|
15915
16079
|
/**
|
|
15916
16080
|
* Client object binding for `CAI_Dog`.
|
|
15917
16081
|
*
|
|
15918
|
-
* @source
|
|
16082
|
+
* @source `src/xrGame/ai/monsters/dog/dog_script.cpp`, `CAI_Dog` binding.
|
|
15919
16083
|
* @customConstructor CAI_Dog
|
|
15920
16084
|
* @group xr_creature
|
|
15921
16085
|
*/
|
|
@@ -15924,7 +16088,7 @@ declare module "xray16" {
|
|
|
15924
16088
|
/**
|
|
15925
16089
|
* Client object binding for `CAI_Flesh`.
|
|
15926
16090
|
*
|
|
15927
|
-
* @source
|
|
16091
|
+
* @source `src/xrGame/ai/monsters/flesh/flesh_script.cpp`, `CAI_Flesh` binding.
|
|
15928
16092
|
* @customConstructor CAI_Flesh
|
|
15929
16093
|
* @group xr_creature
|
|
15930
16094
|
*/
|
|
@@ -15933,7 +16097,7 @@ declare module "xray16" {
|
|
|
15933
16097
|
/**
|
|
15934
16098
|
* Client object binding for `CAI_PseudoDog`.
|
|
15935
16099
|
*
|
|
15936
|
-
* @source
|
|
16100
|
+
* @source `src/xrGame/ai/monsters/pseudodog/pseudodog_script.cpp`, `CAI_PseudoDog` binding.
|
|
15937
16101
|
* @customConstructor CAI_PseudoDog
|
|
15938
16102
|
* @group xr_creature
|
|
15939
16103
|
*/
|
|
@@ -15942,7 +16106,7 @@ declare module "xray16" {
|
|
|
15942
16106
|
/**
|
|
15943
16107
|
* Client object binding for `CAI_Stalker`.
|
|
15944
16108
|
*
|
|
15945
|
-
* @source
|
|
16109
|
+
* @source `src/xrGame/ai/stalker/ai_stalker_script.cpp`, `CAI_Stalker` binding.
|
|
15946
16110
|
* @customConstructor CAI_Stalker
|
|
15947
16111
|
* @group xr_creature
|
|
15948
16112
|
*
|
|
@@ -15954,7 +16118,7 @@ declare module "xray16" {
|
|
|
15954
16118
|
/**
|
|
15955
16119
|
* Client object binding for `CAI_Trader`.
|
|
15956
16120
|
*
|
|
15957
|
-
* @source
|
|
16121
|
+
* @source `src/xrGame/ai/trader/ai_trader_script.cpp`, `CAI_Trader` binding.
|
|
15958
16122
|
* @customConstructor CAI_Trader
|
|
15959
16123
|
* @group xr_creature
|
|
15960
16124
|
*
|
|
@@ -15966,7 +16130,7 @@ declare module "xray16" {
|
|
|
15966
16130
|
/**
|
|
15967
16131
|
* Client object binding for `CSnork`.
|
|
15968
16132
|
*
|
|
15969
|
-
* @source
|
|
16133
|
+
* @source `src/xrGame/ai/monsters/snork/snork_script.cpp`, `CSnork` binding.
|
|
15970
16134
|
* @customConstructor CSnork
|
|
15971
16135
|
* @group xr_creature
|
|
15972
16136
|
*/
|
|
@@ -15977,7 +16141,7 @@ declare module "xray16" {
|
|
|
15977
16141
|
/**
|
|
15978
16142
|
* Explosive component shared by grenade and explosive item classes.
|
|
15979
16143
|
*
|
|
15980
|
-
* @source
|
|
16144
|
+
* @source `src/xrGame/WeaponScript.cpp`, `explosive` binding.
|
|
15981
16145
|
* @customConstructor explosive
|
|
15982
16146
|
* @group xr_item
|
|
15983
16147
|
*
|
|
@@ -16002,104 +16166,126 @@ declare module "xray16" {
|
|
|
16002
16166
|
/**
|
|
16003
16167
|
* Client object binding for `CAntirad` inventory items.
|
|
16004
16168
|
*
|
|
16005
|
-
* @source
|
|
16169
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CAntirad` binding.
|
|
16006
16170
|
* @customConstructor CAntirad
|
|
16007
16171
|
* @group xr_item
|
|
16172
|
+
*
|
|
16173
|
+
* @remarks
|
|
16174
|
+
* Antirad objects are registered as plain `CGameObject` wrappers. Use shared inventory item/game object APIs for
|
|
16175
|
+
* ownership, condition, and activation checks.
|
|
16008
16176
|
*/
|
|
16009
16177
|
export class CAntirad extends CGameObject {}
|
|
16010
16178
|
|
|
16011
16179
|
/**
|
|
16012
16180
|
* Client object binding for `CStalkerOutfit` inventory items.
|
|
16013
16181
|
*
|
|
16014
|
-
* @source
|
|
16182
|
+
* @source `src/xrGame/StalkerOutfit.cpp`, `CStalkerOutfit` binding.
|
|
16015
16183
|
* @customConstructor CStalkerOutfit
|
|
16016
16184
|
* @group xr_item
|
|
16185
|
+
*
|
|
16186
|
+
* @remarks
|
|
16187
|
+
* Stalker outfit objects are registered separately from generic custom outfits. Script-visible behavior is exposed
|
|
16188
|
+
* through the shared game-object and inventory-item helpers.
|
|
16017
16189
|
*/
|
|
16018
16190
|
export class CStalkerOutfit extends CGameObject {}
|
|
16019
16191
|
|
|
16020
16192
|
/**
|
|
16021
16193
|
* Client object binding for `CInventoryBox` inventory items.
|
|
16022
16194
|
*
|
|
16023
|
-
* @source
|
|
16195
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CInventoryBox` binding.
|
|
16024
16196
|
* @customConstructor CInventoryBox
|
|
16025
16197
|
* @group xr_item
|
|
16026
16198
|
*
|
|
16027
16199
|
* @remarks
|
|
16028
|
-
* Inventory box helpers on `game_object` require this runtime class, not any inventory owner.
|
|
16200
|
+
* Inventory box helpers on `game_object` require this runtime class, not any inventory owner. The object itself is
|
|
16201
|
+
* still exposed as a client `CGameObject` wrapper.
|
|
16029
16202
|
*/
|
|
16030
16203
|
export class CInventoryBox extends CGameObject {}
|
|
16031
16204
|
|
|
16032
16205
|
/**
|
|
16033
16206
|
* Client object binding for `CBottleItem` inventory items.
|
|
16034
16207
|
*
|
|
16035
|
-
* @source
|
|
16208
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CBottleItem` binding.
|
|
16036
16209
|
* @customConstructor CBottleItem
|
|
16037
16210
|
* @group xr_item
|
|
16211
|
+
*
|
|
16212
|
+
* @remarks
|
|
16213
|
+
* Bottle items are consumable inventory objects with no direct script-only methods in this binding.
|
|
16038
16214
|
*/
|
|
16039
16215
|
export class CBottleItem extends CGameObject {}
|
|
16040
16216
|
|
|
16041
16217
|
/**
|
|
16042
16218
|
* Client object binding for `CFoodItem` inventory items.
|
|
16043
16219
|
*
|
|
16044
|
-
* @source
|
|
16220
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CFoodItem` binding.
|
|
16045
16221
|
* @customConstructor CFoodItem
|
|
16046
16222
|
* @group xr_item
|
|
16223
|
+
*
|
|
16224
|
+
* @remarks
|
|
16225
|
+
* Food items are consumable inventory objects with no direct script-only methods in this binding.
|
|
16047
16226
|
*/
|
|
16048
16227
|
export class CFoodItem extends CGameObject {}
|
|
16049
16228
|
|
|
16050
16229
|
/**
|
|
16051
16230
|
* Client object binding for `CMedkit` inventory items.
|
|
16052
16231
|
*
|
|
16053
|
-
* @source
|
|
16232
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CMedkit` binding.
|
|
16054
16233
|
* @customConstructor CMedkit
|
|
16055
16234
|
* @group xr_item
|
|
16235
|
+
*
|
|
16236
|
+
* @remarks
|
|
16237
|
+
* Medkit items are consumable inventory objects with no direct script-only methods in this binding.
|
|
16056
16238
|
*/
|
|
16057
16239
|
export class CMedkit extends CGameObject {}
|
|
16058
16240
|
|
|
16059
16241
|
/**
|
|
16060
|
-
* Client object binding for
|
|
16242
|
+
* Client object binding for explosive inventory items.
|
|
16061
16243
|
*
|
|
16062
|
-
* @source
|
|
16244
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CExplosiveItem` binding.
|
|
16063
16245
|
* @customConstructor CExplosiveItem
|
|
16064
16246
|
* @group xr_item
|
|
16065
|
-
*/
|
|
16066
|
-
export class CExplosiveItem extends CGameObject {}
|
|
16067
|
-
|
|
16068
|
-
/**
|
|
16069
|
-
* Client object binding for `CCWeaponAK74` inventory items.
|
|
16070
16247
|
*
|
|
16071
|
-
* @
|
|
16072
|
-
*
|
|
16073
|
-
* @group xr_item
|
|
16248
|
+
* @remarks
|
|
16249
|
+
* The script binding exposes both `CGameObject` and `explosive` bases for this class.
|
|
16074
16250
|
*/
|
|
16075
|
-
export class
|
|
16251
|
+
export class CExplosiveItem extends CGameObject {
|
|
16252
|
+
/**
|
|
16253
|
+
* Trigger the item's explosive component immediately.
|
|
16254
|
+
*/
|
|
16255
|
+
public explode(): void;
|
|
16256
|
+
}
|
|
16076
16257
|
|
|
16077
16258
|
/**
|
|
16078
16259
|
* Client object binding for `CGrenadeLauncher` inventory items.
|
|
16079
16260
|
*
|
|
16080
|
-
* @source
|
|
16261
|
+
* @source `src/xrGame/Scope.cpp`, `CGrenadeLauncher` binding.
|
|
16081
16262
|
* @customConstructor CGrenadeLauncher
|
|
16082
16263
|
* @group xr_item
|
|
16264
|
+
*
|
|
16265
|
+
* @remarks
|
|
16266
|
+
* Weapon addon wrapper registered together with scopes and silencers. It is an inventory object, not a weapon
|
|
16267
|
+
* subclass, so weapon-only methods are not available on this type.
|
|
16083
16268
|
*/
|
|
16084
16269
|
export class CGrenadeLauncher extends CGameObject {}
|
|
16085
16270
|
|
|
16086
16271
|
/**
|
|
16087
16272
|
* Client object binding for `CWeaponAmmo` inventory items.
|
|
16088
16273
|
*
|
|
16089
|
-
* @source
|
|
16274
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponAmmo` binding.
|
|
16090
16275
|
* @customConstructor CWeaponAmmo
|
|
16091
16276
|
* @group xr_item
|
|
16092
16277
|
*
|
|
16093
16278
|
* @remarks
|
|
16094
|
-
* Ammo-count helpers on `game_object` require this runtime class.
|
|
16279
|
+
* Ammo-count helpers on `game_object` require this runtime class. The Lua class itself exposes only the common
|
|
16280
|
+
* game-object surface.
|
|
16095
16281
|
*/
|
|
16096
16282
|
export class CWeaponAmmo extends CGameObject {}
|
|
16097
16283
|
|
|
16098
16284
|
/**
|
|
16099
16285
|
* Client object binding for `CWeapon` inventory items.
|
|
16100
16286
|
*
|
|
16101
|
-
* @source
|
|
16102
|
-
* @customConstructor
|
|
16287
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeapon` binding.
|
|
16288
|
+
* @customConstructor CWeapon
|
|
16103
16289
|
* @group xr_item
|
|
16104
16290
|
*
|
|
16105
16291
|
* @remarks
|
|
@@ -16111,7 +16297,8 @@ declare module "xray16" {
|
|
|
16111
16297
|
* Check whether the weapon can currently fire a lethal shot.
|
|
16112
16298
|
*
|
|
16113
16299
|
* @remarks
|
|
16114
|
-
*
|
|
16300
|
+
* Returns true when the weapon has suitable ammo available or does not use ammo. This is the same predicate used by
|
|
16301
|
+
* actor and stalker weapon selection before considering an item lethal.
|
|
16115
16302
|
*
|
|
16116
16303
|
* @returns Whether the weapon can kill.
|
|
16117
16304
|
*/
|
|
@@ -16119,18 +16306,40 @@ declare module "xray16" {
|
|
|
16119
16306
|
}
|
|
16120
16307
|
|
|
16121
16308
|
/**
|
|
16122
|
-
* Client object binding for
|
|
16309
|
+
* Client object binding for magazine-fed weapons.
|
|
16123
16310
|
*
|
|
16124
|
-
* @source
|
|
16311
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponMagazined` binding.
|
|
16125
16312
|
* @customConstructor CWeaponMagazined
|
|
16126
16313
|
* @group xr_item
|
|
16314
|
+
*
|
|
16315
|
+
* @remarks
|
|
16316
|
+
* Base class for most firearms exposed to scripts. The binding inherits `CWeapon`, so `can_kill()` is available on
|
|
16317
|
+
* all subclasses declared under this family.
|
|
16127
16318
|
*/
|
|
16128
16319
|
export class CWeaponMagazined extends CWeapon {}
|
|
16129
16320
|
|
|
16321
|
+
/**
|
|
16322
|
+
* Client object binding for magazine-fed weapons with grenade-launcher support.
|
|
16323
|
+
*
|
|
16324
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponMagazinedWGrenade` binding.
|
|
16325
|
+
* @customConstructor CWeaponMagazinedWGrenade
|
|
16326
|
+
* @group xr_item
|
|
16327
|
+
*/
|
|
16328
|
+
export class CWeaponMagazinedWGrenade extends CWeaponMagazined {}
|
|
16329
|
+
|
|
16330
|
+
/**
|
|
16331
|
+
* Client object binding for `CWeaponAK74` inventory items.
|
|
16332
|
+
*
|
|
16333
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponAK74` binding.
|
|
16334
|
+
* @customConstructor CWeaponAK74
|
|
16335
|
+
* @group xr_item
|
|
16336
|
+
*/
|
|
16337
|
+
export class CWeaponAK74 extends CWeaponMagazinedWGrenade {}
|
|
16338
|
+
|
|
16130
16339
|
/**
|
|
16131
16340
|
* Client object binding for `CWeaponAutomaticShotgun` inventory items.
|
|
16132
16341
|
*
|
|
16133
|
-
* @source
|
|
16342
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponAutomaticShotgun` binding.
|
|
16134
16343
|
* @customConstructor CWeaponAutomaticShotgun
|
|
16135
16344
|
* @group xr_item
|
|
16136
16345
|
*/
|
|
@@ -16139,7 +16348,7 @@ declare module "xray16" {
|
|
|
16139
16348
|
/**
|
|
16140
16349
|
* Client object binding for `CWeaponBM16` inventory items.
|
|
16141
16350
|
*
|
|
16142
|
-
* @source
|
|
16351
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponBM16` binding.
|
|
16143
16352
|
* @customConstructor CWeaponBM16
|
|
16144
16353
|
* @group xr_item
|
|
16145
16354
|
*/
|
|
@@ -16148,160 +16357,160 @@ declare module "xray16" {
|
|
|
16148
16357
|
/**
|
|
16149
16358
|
* Client object binding for `CWeaponBinoculars` inventory items.
|
|
16150
16359
|
*
|
|
16151
|
-
* @source
|
|
16360
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponBinoculars` binding.
|
|
16152
16361
|
* @customConstructor CWeaponBinoculars
|
|
16153
16362
|
* @group xr_item
|
|
16154
16363
|
*/
|
|
16155
|
-
export class CWeaponBinoculars extends
|
|
16364
|
+
export class CWeaponBinoculars extends CWeaponMagazined {}
|
|
16156
16365
|
|
|
16157
16366
|
/**
|
|
16158
16367
|
* Client object binding for `CWeaponFN2000` inventory items.
|
|
16159
16368
|
*
|
|
16160
|
-
* @source
|
|
16369
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponFN2000` binding.
|
|
16161
16370
|
* @customConstructor CWeaponFN2000
|
|
16162
16371
|
* @group xr_item
|
|
16163
16372
|
*/
|
|
16164
|
-
export class CWeaponFN2000 extends
|
|
16373
|
+
export class CWeaponFN2000 extends CWeaponMagazined {}
|
|
16165
16374
|
|
|
16166
16375
|
/**
|
|
16167
16376
|
* Client object binding for `CWeaponFORT` inventory items.
|
|
16168
16377
|
*
|
|
16169
|
-
* @source
|
|
16378
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponFORT` binding.
|
|
16170
16379
|
* @customConstructor CWeaponFORT
|
|
16171
16380
|
* @group xr_item
|
|
16172
16381
|
*/
|
|
16173
|
-
export class CWeaponFORT extends
|
|
16382
|
+
export class CWeaponFORT extends CWeaponMagazined {}
|
|
16174
16383
|
|
|
16175
16384
|
/**
|
|
16176
16385
|
* Client object binding for `CWeaponGroza` inventory items.
|
|
16177
16386
|
*
|
|
16178
|
-
* @source
|
|
16387
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponGroza` binding.
|
|
16179
16388
|
* @customConstructor CWeaponGroza
|
|
16180
16389
|
* @group xr_item
|
|
16181
16390
|
*/
|
|
16182
|
-
export class CWeaponGroza extends
|
|
16391
|
+
export class CWeaponGroza extends CWeaponMagazinedWGrenade {}
|
|
16183
16392
|
|
|
16184
16393
|
/**
|
|
16185
16394
|
* Client object binding for `CWeaponHPSA` inventory items.
|
|
16186
16395
|
*
|
|
16187
|
-
* @source
|
|
16396
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponHPSA` binding.
|
|
16188
16397
|
* @customConstructor CWeaponHPSA
|
|
16189
16398
|
* @group xr_item
|
|
16190
16399
|
*/
|
|
16191
|
-
export class CWeaponHPSA extends
|
|
16400
|
+
export class CWeaponHPSA extends CWeaponMagazined {}
|
|
16192
16401
|
|
|
16193
16402
|
/**
|
|
16194
16403
|
* Client object binding for `CWeaponKnife` inventory items.
|
|
16195
16404
|
*
|
|
16196
|
-
* @source
|
|
16405
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponKnife` binding.
|
|
16197
16406
|
* @customConstructor CWeaponKnife
|
|
16198
16407
|
* @group xr_item
|
|
16199
16408
|
*/
|
|
16200
|
-
export class CWeaponKnife extends
|
|
16409
|
+
export class CWeaponKnife extends CWeapon {}
|
|
16201
16410
|
|
|
16202
16411
|
/**
|
|
16203
16412
|
* Client object binding for `CWeaponLR300` inventory items.
|
|
16204
16413
|
*
|
|
16205
|
-
* @source
|
|
16414
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponLR300` binding.
|
|
16206
16415
|
* @customConstructor CWeaponLR300
|
|
16207
16416
|
* @group xr_item
|
|
16208
16417
|
*/
|
|
16209
|
-
export class CWeaponLR300 extends
|
|
16418
|
+
export class CWeaponLR300 extends CWeaponMagazined {}
|
|
16210
16419
|
|
|
16211
16420
|
/**
|
|
16212
16421
|
* Client object binding for `CWeaponPM` inventory items.
|
|
16213
16422
|
*
|
|
16214
|
-
* @source
|
|
16423
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponPM` binding.
|
|
16215
16424
|
* @customConstructor CWeaponPM
|
|
16216
16425
|
* @group xr_item
|
|
16217
16426
|
*/
|
|
16218
|
-
export class CWeaponPM extends
|
|
16427
|
+
export class CWeaponPM extends CWeaponMagazined {}
|
|
16219
16428
|
|
|
16220
16429
|
/**
|
|
16221
16430
|
* Client object binding for `CWeaponRG6` inventory items.
|
|
16222
16431
|
*
|
|
16223
|
-
* @source
|
|
16432
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponRG6` binding.
|
|
16224
16433
|
* @customConstructor CWeaponRG6
|
|
16225
16434
|
* @group xr_item
|
|
16226
16435
|
*/
|
|
16227
|
-
export class CWeaponRG6 extends
|
|
16436
|
+
export class CWeaponRG6 extends CWeaponShotgun {}
|
|
16228
16437
|
|
|
16229
16438
|
/**
|
|
16230
16439
|
* Client object binding for `CWeaponRPG7` inventory items.
|
|
16231
16440
|
*
|
|
16232
|
-
* @source
|
|
16441
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponRPG7` binding.
|
|
16233
16442
|
* @customConstructor CWeaponRPG7
|
|
16234
16443
|
* @group xr_item
|
|
16235
16444
|
*/
|
|
16236
|
-
export class CWeaponRPG7 extends
|
|
16445
|
+
export class CWeaponRPG7 extends CWeaponMagazined {}
|
|
16237
16446
|
|
|
16238
16447
|
/**
|
|
16239
16448
|
* Client object binding for `CWeaponSVD` inventory items.
|
|
16240
16449
|
*
|
|
16241
|
-
* @source
|
|
16450
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponSVD` binding.
|
|
16242
16451
|
* @customConstructor CWeaponSVD
|
|
16243
16452
|
* @group xr_item
|
|
16244
16453
|
*/
|
|
16245
|
-
export class CWeaponSVD extends
|
|
16454
|
+
export class CWeaponSVD extends CWeaponMagazined {}
|
|
16246
16455
|
|
|
16247
16456
|
/**
|
|
16248
16457
|
* Client object binding for `CWeaponSVU` inventory items.
|
|
16249
16458
|
*
|
|
16250
|
-
* @source
|
|
16459
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponSVU` binding.
|
|
16251
16460
|
* @customConstructor CWeaponSVU
|
|
16252
16461
|
* @group xr_item
|
|
16253
16462
|
*/
|
|
16254
|
-
export class CWeaponSVU extends
|
|
16463
|
+
export class CWeaponSVU extends CWeaponMagazined {}
|
|
16255
16464
|
|
|
16256
16465
|
/**
|
|
16257
16466
|
* Client object binding for `CWeaponShotgun` inventory items.
|
|
16258
16467
|
*
|
|
16259
|
-
* @source
|
|
16468
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponShotgun` binding.
|
|
16260
16469
|
* @customConstructor CWeaponShotgun
|
|
16261
16470
|
* @group xr_item
|
|
16262
16471
|
*/
|
|
16263
|
-
export class CWeaponShotgun extends
|
|
16472
|
+
export class CWeaponShotgun extends CWeaponMagazined {}
|
|
16264
16473
|
|
|
16265
16474
|
/**
|
|
16266
16475
|
* Client object binding for `CWeaponUSP45` inventory items.
|
|
16267
16476
|
*
|
|
16268
|
-
* @source
|
|
16477
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponUSP45` binding.
|
|
16269
16478
|
* @customConstructor CWeaponUSP45
|
|
16270
16479
|
* @group xr_item
|
|
16271
16480
|
*/
|
|
16272
|
-
export class CWeaponUSP45 extends
|
|
16481
|
+
export class CWeaponUSP45 extends CWeaponMagazined {}
|
|
16273
16482
|
|
|
16274
16483
|
/**
|
|
16275
16484
|
* Client object binding for `CWeaponVal` inventory items.
|
|
16276
16485
|
*
|
|
16277
|
-
* @source
|
|
16486
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponVal` binding.
|
|
16278
16487
|
* @customConstructor CWeaponVal
|
|
16279
16488
|
* @group xr_item
|
|
16280
16489
|
*/
|
|
16281
|
-
export class CWeaponVal extends
|
|
16490
|
+
export class CWeaponVal extends CWeaponMagazined {}
|
|
16282
16491
|
|
|
16283
16492
|
/**
|
|
16284
16493
|
* Client object binding for `CWeaponVintorez` inventory items.
|
|
16285
16494
|
*
|
|
16286
|
-
* @source
|
|
16495
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponVintorez` binding.
|
|
16287
16496
|
* @customConstructor CWeaponVintorez
|
|
16288
16497
|
* @group xr_item
|
|
16289
16498
|
*/
|
|
16290
|
-
export class CWeaponVintorez extends
|
|
16499
|
+
export class CWeaponVintorez extends CWeaponMagazined {}
|
|
16291
16500
|
|
|
16292
16501
|
/**
|
|
16293
16502
|
* Client object binding for `CWeaponWalther` inventory items.
|
|
16294
16503
|
*
|
|
16295
|
-
* @source
|
|
16504
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CWeaponWalther` binding.
|
|
16296
16505
|
* @customConstructor CWeaponWalther
|
|
16297
16506
|
* @group xr_item
|
|
16298
16507
|
*/
|
|
16299
|
-
export class CWeaponWalther extends
|
|
16508
|
+
export class CWeaponWalther extends CWeaponMagazined {}
|
|
16300
16509
|
|
|
16301
16510
|
/**
|
|
16302
16511
|
* Client object binding for `CSilencer` inventory items.
|
|
16303
16512
|
*
|
|
16304
|
-
* @source
|
|
16513
|
+
* @source `src/xrGame/Scope.cpp`, `CSilencer` binding.
|
|
16305
16514
|
* @customConstructor CSilencer
|
|
16306
16515
|
* @group xr_item
|
|
16307
16516
|
*/
|
|
@@ -16310,50 +16519,122 @@ declare module "xray16" {
|
|
|
16310
16519
|
/**
|
|
16311
16520
|
* Client object binding for `CScope` inventory items.
|
|
16312
16521
|
*
|
|
16313
|
-
* @source
|
|
16522
|
+
* @source `src/xrGame/Scope.cpp`, `CScope` binding.
|
|
16314
16523
|
* @customConstructor CScope
|
|
16315
16524
|
* @group xr_item
|
|
16316
16525
|
*/
|
|
16317
16526
|
export class CScope extends CGameObject {}
|
|
16318
16527
|
|
|
16319
16528
|
/**
|
|
16320
|
-
* Client object binding for `CRGD5`
|
|
16529
|
+
* Client object binding for `CRGD5` grenade items.
|
|
16321
16530
|
*
|
|
16322
|
-
* @source
|
|
16531
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CRGD5` binding.
|
|
16323
16532
|
* @customConstructor CRGD5
|
|
16324
16533
|
* @group xr_item
|
|
16534
|
+
*
|
|
16535
|
+
* @remarks
|
|
16536
|
+
* The script binding exposes both `CGameObject` and `explosive` bases for this class.
|
|
16325
16537
|
*/
|
|
16326
|
-
export class CRGD5 extends CGameObject {
|
|
16538
|
+
export class CRGD5 extends CGameObject {
|
|
16539
|
+
/**
|
|
16540
|
+
* Trigger the grenade's explosive component immediately.
|
|
16541
|
+
*/
|
|
16542
|
+
public explode(): void;
|
|
16543
|
+
}
|
|
16327
16544
|
|
|
16328
16545
|
/**
|
|
16329
|
-
* Client object binding for `CF1`
|
|
16546
|
+
* Client object binding for `CF1` grenade items.
|
|
16330
16547
|
*
|
|
16331
|
-
* @source
|
|
16548
|
+
* @source `src/xrGame/WeaponScript.cpp`, `CF1` binding.
|
|
16332
16549
|
* @customConstructor CF1
|
|
16333
16550
|
* @group xr_item
|
|
16551
|
+
*
|
|
16552
|
+
* @remarks
|
|
16553
|
+
* The script binding exposes both `CGameObject` and `explosive` bases for this class.
|
|
16334
16554
|
*/
|
|
16335
|
-
export class CF1 extends CGameObject {
|
|
16555
|
+
export class CF1 extends CGameObject {
|
|
16556
|
+
/**
|
|
16557
|
+
* Trigger the grenade's explosive component immediately.
|
|
16558
|
+
*/
|
|
16559
|
+
public explode(): void;
|
|
16560
|
+
}
|
|
16336
16561
|
|
|
16337
16562
|
/**
|
|
16338
16563
|
* Client object binding for `CPda` inventory items.
|
|
16339
16564
|
*
|
|
16340
|
-
* @source
|
|
16565
|
+
* @source `src/xrGame/torch_script.cpp`, `CPda` binding.
|
|
16341
16566
|
* @customConstructor CPda
|
|
16342
16567
|
* @group xr_item
|
|
16568
|
+
*
|
|
16569
|
+
* @remarks
|
|
16570
|
+
* PDA objects are inventory items exposed through the torch binding file. Runtime PDA ownership and contact logic are
|
|
16571
|
+
* handled by native inventory-owner code, not by script-visible PDA methods.
|
|
16343
16572
|
*/
|
|
16344
16573
|
export class CPda extends CGameObject {}
|
|
16574
|
+
|
|
16575
|
+
/**
|
|
16576
|
+
* Client object binding for simple artefact detectors.
|
|
16577
|
+
*
|
|
16578
|
+
* @source `src/xrGame/torch_script.cpp`, `CSimpleDetector` binding.
|
|
16579
|
+
* @customConstructor CSimpleDetector
|
|
16580
|
+
* @group xr_item
|
|
16581
|
+
*
|
|
16582
|
+
* @remarks
|
|
16583
|
+
* The native detector rank is 1. The binding exposes the object as a `CGameObject`; detector UI and artefact search
|
|
16584
|
+
* logic are handled internally by the engine.
|
|
16585
|
+
*/
|
|
16586
|
+
export class CSimpleDetector extends CGameObject {}
|
|
16587
|
+
|
|
16588
|
+
/**
|
|
16589
|
+
* Client object binding for advanced artefact detectors.
|
|
16590
|
+
*
|
|
16591
|
+
* @source `src/xrGame/torch_script.cpp`, `CAdvancedDetector` binding.
|
|
16592
|
+
* @customConstructor CAdvancedDetector
|
|
16593
|
+
* @group xr_item
|
|
16594
|
+
*
|
|
16595
|
+
* @remarks
|
|
16596
|
+
* The native detector rank is 2. It is registered as a concrete `CGameObject` wrapper without extra script-visible
|
|
16597
|
+
* methods.
|
|
16598
|
+
*/
|
|
16599
|
+
export class CAdvancedDetector extends CGameObject {}
|
|
16600
|
+
|
|
16601
|
+
/**
|
|
16602
|
+
* Client object binding for elite artefact detectors.
|
|
16603
|
+
*
|
|
16604
|
+
* @source `src/xrGame/torch_script.cpp`, `CEliteDetector` binding.
|
|
16605
|
+
* @customConstructor CEliteDetector
|
|
16606
|
+
* @group xr_item
|
|
16607
|
+
*
|
|
16608
|
+
* @remarks
|
|
16609
|
+
* The native detector rank is 3. Use generic inventory-item and game-object APIs for script interaction.
|
|
16610
|
+
*/
|
|
16611
|
+
export class CEliteDetector extends CGameObject {}
|
|
16612
|
+
|
|
16613
|
+
/**
|
|
16614
|
+
* Client object binding for scientific artefact detectors.
|
|
16615
|
+
*
|
|
16616
|
+
* @source `src/xrGame/torch_script.cpp`, `CScientificDetector` binding.
|
|
16617
|
+
* @customConstructor CScientificDetector
|
|
16618
|
+
* @group xr_item
|
|
16619
|
+
*
|
|
16620
|
+
* @remarks
|
|
16621
|
+
* Scientific detectors use the elite-detector rank and add native anomaly-zone scanning, but the Lua binding exposes
|
|
16622
|
+
* no detector-specific methods beyond the game-object surface.
|
|
16623
|
+
*/
|
|
16624
|
+
export class CScientificDetector extends CGameObject {}
|
|
16345
16625
|
}
|
|
16346
16626
|
|
|
16347
16627
|
declare module "xray16" {
|
|
16348
16628
|
/**
|
|
16349
16629
|
* Campfire anomaly object.
|
|
16350
16630
|
*
|
|
16351
|
-
* @source
|
|
16631
|
+
* @source `src/xrGame/MosquitoBald_script.cpp`, `CZoneCampfire` binding.
|
|
16352
16632
|
* @customConstructor CZoneCampfire
|
|
16353
16633
|
* @group xr_level
|
|
16354
16634
|
*
|
|
16355
16635
|
* @remarks
|
|
16356
|
-
* Campfire controls require this runtime object.
|
|
16636
|
+
* Campfire controls require this runtime object. The binding is registered next to mosquito-bald anomalies and
|
|
16637
|
+
* exposes only on/off state controls; generic anomaly zones do not have these methods.
|
|
16357
16638
|
*/
|
|
16358
16639
|
export class CZoneCampfire extends CGameObject {
|
|
16359
16640
|
/**
|
|
@@ -16367,12 +16648,12 @@ declare module "xray16" {
|
|
|
16367
16648
|
public is_on(): boolean;
|
|
16368
16649
|
|
|
16369
16650
|
/**
|
|
16370
|
-
*
|
|
16651
|
+
* Switch the campfire into its enabled state and start native idle effects.
|
|
16371
16652
|
*/
|
|
16372
16653
|
public turn_on(): void;
|
|
16373
16654
|
|
|
16374
16655
|
/**
|
|
16375
|
-
*
|
|
16656
|
+
* Switch the campfire into its disabled state and stop native idle effects.
|
|
16376
16657
|
*/
|
|
16377
16658
|
public turn_off(): void;
|
|
16378
16659
|
}
|
|
@@ -16380,13 +16661,13 @@ declare module "xray16" {
|
|
|
16380
16661
|
/**
|
|
16381
16662
|
* Animated client physics object.
|
|
16382
16663
|
*
|
|
16383
|
-
* @source
|
|
16664
|
+
* @source `src/xrGame/PhysicObject_script.cpp`, `CPhysicObject` binding.
|
|
16384
16665
|
* @customConstructor CPhysicObject
|
|
16385
16666
|
* @group xr_level
|
|
16386
16667
|
*
|
|
16387
16668
|
* @remarks
|
|
16388
|
-
* Wrapper for animated physics props, especially door-like objects.
|
|
16389
|
-
*
|
|
16669
|
+
* Wrapper for animated physics props, especially door-like objects. The exposed methods control native object
|
|
16670
|
+
* animation time, bone-attached sounds, and temporary dynamic-collision ignoring.
|
|
16390
16671
|
*/
|
|
16391
16672
|
export class CPhysicObject extends CGameObject {
|
|
16392
16673
|
/**
|
|
@@ -16439,15 +16720,29 @@ declare module "xray16" {
|
|
|
16439
16720
|
public stop_bones_sound(): void;
|
|
16440
16721
|
}
|
|
16441
16722
|
|
|
16723
|
+
/**
|
|
16724
|
+
* Destroyable animated physics object.
|
|
16725
|
+
*
|
|
16726
|
+
* @source `src/xrGame/PhysicObject_script.cpp`, `CDestroyablePhysicsObject` binding.
|
|
16727
|
+
* @customConstructor CDestroyablePhysicsObject
|
|
16728
|
+
* @group xr_level
|
|
16729
|
+
*
|
|
16730
|
+
* @remarks
|
|
16731
|
+
* Registered as a `CPhysicObject` subclass. It inherits the animated physics helpers and participates in destroyable
|
|
16732
|
+
* object callbacks through the engine object lifecycle.
|
|
16733
|
+
*/
|
|
16734
|
+
export class CDestroyablePhysicsObject extends CPhysicObject {}
|
|
16735
|
+
|
|
16442
16736
|
/**
|
|
16443
16737
|
* Hanging lamp object controlled from scripts.
|
|
16444
16738
|
*
|
|
16445
|
-
* @source
|
|
16739
|
+
* @source `src/xrGame/HangingLamp.cpp`, `hanging_lamp` binding.
|
|
16446
16740
|
* @customConstructor hanging_lamp
|
|
16447
16741
|
* @group xr_level
|
|
16448
16742
|
*
|
|
16449
16743
|
* @remarks
|
|
16450
|
-
* Lamp controls require this runtime object.
|
|
16744
|
+
* Lamp controls require this runtime object. `turn_on()` activates render lights, glow/ambient light, visible light
|
|
16745
|
+
* bones, and processing; `turn_off()` disables those native lamp effects.
|
|
16451
16746
|
*/
|
|
16452
16747
|
export class hanging_lamp extends CGameObject {
|
|
16453
16748
|
/**
|
|
@@ -16469,7 +16764,7 @@ declare module "xray16" {
|
|
|
16469
16764
|
/**
|
|
16470
16765
|
* Driveable car and mounted weapon holder.
|
|
16471
16766
|
*
|
|
16472
|
-
* @source
|
|
16767
|
+
* @source `src/xrGame/CarScript.cpp`, `CCar` binding.
|
|
16473
16768
|
* @customConstructor CCar
|
|
16474
16769
|
* @group xr_level
|
|
16475
16770
|
*
|
|
@@ -16481,27 +16776,27 @@ declare module "xray16" {
|
|
|
16481
16776
|
/**
|
|
16482
16777
|
* Engine enum value for `CCar.eWpnActivate`.
|
|
16483
16778
|
*/
|
|
16484
|
-
public static eWpnActivate: 3;
|
|
16779
|
+
public static readonly eWpnActivate: 3;
|
|
16485
16780
|
/**
|
|
16486
16781
|
* Engine enum value for `CCar.eWpnAutoFire`.
|
|
16487
16782
|
*/
|
|
16488
|
-
public static eWpnAutoFire: 5;
|
|
16783
|
+
public static readonly eWpnAutoFire: 5;
|
|
16489
16784
|
/**
|
|
16490
16785
|
* Engine enum value for `CCar.eWpnDesiredDir`.
|
|
16491
16786
|
*/
|
|
16492
|
-
public static eWpnDesiredDir: 1;
|
|
16787
|
+
public static readonly eWpnDesiredDir: 1;
|
|
16493
16788
|
/**
|
|
16494
16789
|
* Engine enum value for `CCar.eWpnDesiredPos`.
|
|
16495
16790
|
*/
|
|
16496
|
-
public static eWpnDesiredPos: 2;
|
|
16791
|
+
public static readonly eWpnDesiredPos: 2;
|
|
16497
16792
|
/**
|
|
16498
16793
|
* Engine enum value for `CCar.eWpnFire`.
|
|
16499
16794
|
*/
|
|
16500
|
-
public static eWpnFire: 4;
|
|
16795
|
+
public static readonly eWpnFire: 4;
|
|
16501
16796
|
/**
|
|
16502
16797
|
* Engine enum value for `CCar.eWpnToDefaultDir`.
|
|
16503
16798
|
*/
|
|
16504
|
-
public static eWpnToDefaultDir: 6;
|
|
16799
|
+
public static readonly eWpnToDefaultDir: 6;
|
|
16505
16800
|
|
|
16506
16801
|
/**
|
|
16507
16802
|
* Create a car object wrapper.
|
|
@@ -16533,14 +16828,22 @@ declare module "xray16" {
|
|
|
16533
16828
|
public CarExplode(): void;
|
|
16534
16829
|
|
|
16535
16830
|
/**
|
|
16536
|
-
* Change fuel by a delta.
|
|
16831
|
+
* Change current fuel by a delta and clamp it to the tank range.
|
|
16832
|
+
*
|
|
16833
|
+
* @remarks
|
|
16834
|
+
* Negative deltas cannot reduce fuel below `0`; positive deltas cannot increase it above `GetfFuelTank()`.
|
|
16835
|
+
* Use `SetfFuel()` or `set_fuel()` when the script needs to assign an absolute fuel value.
|
|
16537
16836
|
*
|
|
16538
16837
|
* @param fuel - Fuel delta.
|
|
16539
16838
|
*/
|
|
16540
16839
|
public ChangefFuel(fuel: f32): void;
|
|
16541
16840
|
|
|
16542
16841
|
/**
|
|
16543
|
-
* Change vehicle health by a delta.
|
|
16842
|
+
* Change vehicle health by a delta and clamp it to the normalized health range.
|
|
16843
|
+
*
|
|
16844
|
+
* @remarks
|
|
16845
|
+
* The native implementation clamps the result to `0..1`. Use `SetfHealth()` when assigning an absolute health
|
|
16846
|
+
* value.
|
|
16544
16847
|
*
|
|
16545
16848
|
* @param value - Health delta.
|
|
16546
16849
|
*/
|
|
@@ -16552,7 +16855,7 @@ declare module "xray16" {
|
|
|
16552
16855
|
public CurrentVel(): vector;
|
|
16553
16856
|
|
|
16554
16857
|
/**
|
|
16555
|
-
* @returns Scheduled explosion time.
|
|
16858
|
+
* @returns Scheduled delayed-fuse explosion time in milliseconds, or `0` when no fuse was initialized.
|
|
16556
16859
|
*/
|
|
16557
16860
|
public ExplodeTime(): u32;
|
|
16558
16861
|
|
|
@@ -16615,21 +16918,30 @@ declare module "xray16" {
|
|
|
16615
16918
|
public PlayDamageParticles(): void;
|
|
16616
16919
|
|
|
16617
16920
|
/**
|
|
16618
|
-
* Set
|
|
16921
|
+
* Set delayed-fuse explosion time.
|
|
16619
16922
|
*
|
|
16620
|
-
* @
|
|
16923
|
+
* @remarks
|
|
16924
|
+
* The native method accepts milliseconds and converts them to the delayed action fuse timeout.
|
|
16925
|
+
*
|
|
16926
|
+
* @param time - Explosion time in milliseconds.
|
|
16621
16927
|
*/
|
|
16622
16928
|
public SetExplodeTime(time: u32): void;
|
|
16623
16929
|
|
|
16624
16930
|
/**
|
|
16625
|
-
* Set current fuel amount.
|
|
16931
|
+
* Set current fuel amount directly.
|
|
16932
|
+
*
|
|
16933
|
+
* @remarks
|
|
16934
|
+
* This is an absolute setter and does not clamp against tank capacity.
|
|
16626
16935
|
*
|
|
16627
16936
|
* @param fuel - Fuel amount.
|
|
16628
16937
|
*/
|
|
16629
16938
|
public SetfFuel(fuel: f32): void;
|
|
16630
16939
|
|
|
16631
16940
|
/**
|
|
16632
|
-
* Set current fuel amount.
|
|
16941
|
+
* Set current fuel amount directly.
|
|
16942
|
+
*
|
|
16943
|
+
* @remarks
|
|
16944
|
+
* Lowercase alias for `SetfFuel()`.
|
|
16633
16945
|
*
|
|
16634
16946
|
* @param fuel - Fuel amount.
|
|
16635
16947
|
*/
|
|
@@ -16664,11 +16976,16 @@ declare module "xray16" {
|
|
|
16664
16976
|
public set_fuel_tank(fuel: f32): void;
|
|
16665
16977
|
|
|
16666
16978
|
/**
|
|
16667
|
-
* Set vehicle health.
|
|
16979
|
+
* Set vehicle health directly.
|
|
16980
|
+
*
|
|
16981
|
+
* @remarks
|
|
16982
|
+
* This forwards to the entity health setter and returns the applied value. `ChangefHealth()` is the clamped delta
|
|
16983
|
+
* helper.
|
|
16668
16984
|
*
|
|
16669
16985
|
* @param health - New health value.
|
|
16986
|
+
* @returns Applied health value.
|
|
16670
16987
|
*/
|
|
16671
|
-
public SetfHealth(health: f32):
|
|
16988
|
+
public SetfHealth(health: f32): f32;
|
|
16672
16989
|
|
|
16673
16990
|
/**
|
|
16674
16991
|
* @returns Whether vehicle engine is active at the moment.
|
|
@@ -16718,15 +17035,23 @@ declare module "xray16" {
|
|
|
16718
17035
|
public engaged(): boolean;
|
|
16719
17036
|
|
|
16720
17037
|
/**
|
|
16721
|
-
* Send a
|
|
17038
|
+
* Send a mounted-weapon action.
|
|
16722
17039
|
*
|
|
16723
|
-
* @
|
|
17040
|
+
* @remarks
|
|
17041
|
+
* For `eWpnFire`, `eWpnActivate`, and `eWpnAutoFire`, native code treats `flags === 1` as enabled/start and any
|
|
17042
|
+
* other value as disabled/stop. `eWpnToDefaultDir` resets the weapon direction to its bind orientation.
|
|
17043
|
+
*
|
|
17044
|
+
* @param id - Weapon action id.
|
|
16724
17045
|
* @param flags - Action flags.
|
|
16725
17046
|
*/
|
|
16726
17047
|
public Action(id: u16, flags: u32): void;
|
|
16727
17048
|
|
|
16728
17049
|
/**
|
|
16729
|
-
* Set a mounted
|
|
17050
|
+
* Set a mounted-weapon vector parameter.
|
|
17051
|
+
*
|
|
17052
|
+
* @remarks
|
|
17053
|
+
* The script binding exposes the vector overload. Native code handles `eWpnDesiredPos` by aiming the weapon at the
|
|
17054
|
+
* provided world position; other ids are ignored by this overload.
|
|
16730
17055
|
*
|
|
16731
17056
|
* @param id - Weapon parameter id.
|
|
16732
17057
|
* @param vector - Parameter value.
|
|
@@ -16734,16 +17059,23 @@ declare module "xray16" {
|
|
|
16734
17059
|
public SetParam(id: i32, vector: vector): void;
|
|
16735
17060
|
|
|
16736
17061
|
/**
|
|
16737
|
-
* Set
|
|
17062
|
+
* Set mounted weapon desired target position.
|
|
16738
17063
|
*
|
|
16739
|
-
* @param id -
|
|
16740
|
-
* @param vector -
|
|
17064
|
+
* @param id - `CCar.eWpnDesiredPos`.
|
|
17065
|
+
* @param vector - Target world position.
|
|
16741
17066
|
*/
|
|
16742
|
-
public SetParam(id:
|
|
17067
|
+
public SetParam(id: typeof CCar.eWpnDesiredPos, vector: vector): void;
|
|
16743
17068
|
}
|
|
16744
17069
|
|
|
16745
17070
|
/**
|
|
17071
|
+
* Mounted-weapon action and parameter ids exported on `CCar`.
|
|
17072
|
+
*
|
|
17073
|
+
* @source `src/xrGame/CarScript.cpp`, `CCar.wpn_action` enum.
|
|
16746
17074
|
* @group xr_level
|
|
17075
|
+
*
|
|
17076
|
+
* @remarks
|
|
17077
|
+
* `eWpnFire`, `eWpnActivate`, `eWpnAutoFire`, and `eWpnToDefaultDir` are action ids for `CCar.Action()`.
|
|
17078
|
+
* `eWpnDesiredPos` is handled by the script-visible `CCar.SetParam()` vector overload.
|
|
16747
17079
|
*/
|
|
16748
17080
|
export type TXR_CCar_weapon_param = EnumeratedStaticsValues<typeof CCar>;
|
|
16749
17081
|
|
|
@@ -16784,14 +17116,12 @@ declare module "xray16" {
|
|
|
16784
17116
|
* @group xr_level
|
|
16785
17117
|
*/
|
|
16786
17118
|
export type TXR_helicopter_hunt_state =
|
|
16787
|
-
| typeof CHelicopter.
|
|
16788
|
-
| typeof CHelicopter.eEnemyPoint
|
|
16789
|
-
| typeof CHelicopter.eEnemyEntity;
|
|
17119
|
+
typeof CHelicopter.eEnemyNone | typeof CHelicopter.eEnemyPoint | typeof CHelicopter.eEnemyEntity;
|
|
16790
17120
|
|
|
16791
17121
|
/**
|
|
16792
17122
|
* Script-controlled helicopter object.
|
|
16793
17123
|
*
|
|
16794
|
-
* @source
|
|
17124
|
+
* @source `src/xrGame/helicopter_script.cpp`, `CHelicopter` binding.
|
|
16795
17125
|
* @customConstructor CHelicopter
|
|
16796
17126
|
* @group xr_level
|
|
16797
17127
|
*
|
|
@@ -16944,8 +17274,12 @@ declare module "xray16" {
|
|
|
16944
17274
|
/**
|
|
16945
17275
|
* Get desired speed near the destination point.
|
|
16946
17276
|
*
|
|
16947
|
-
* @
|
|
16948
|
-
*
|
|
17277
|
+
* @remarks
|
|
17278
|
+
* The native binding requires one numeric argument, but the implementation ignores it and returns the configured
|
|
17279
|
+
* destination speed.
|
|
17280
|
+
*
|
|
17281
|
+
* @param value - Ignored by native code.
|
|
17282
|
+
* @returns Speed used near the destination point.
|
|
16949
17283
|
*/
|
|
16950
17284
|
public GetSpeedInDestPoint(value: f32): f32;
|
|
16951
17285
|
|
|
@@ -16997,15 +17331,18 @@ declare module "xray16" {
|
|
|
16997
17331
|
/**
|
|
16998
17332
|
* Set desired speed near the destination point.
|
|
16999
17333
|
*
|
|
17334
|
+
* @remarks
|
|
17335
|
+
* Used by the movement manager while approaching the current destination or patrol point.
|
|
17336
|
+
*
|
|
17000
17337
|
* @param value - Speed value.
|
|
17001
17338
|
*/
|
|
17002
17339
|
public SetSpeedInDestPoint(value: f32): void;
|
|
17003
17340
|
|
|
17004
17341
|
/**
|
|
17005
|
-
* Set linear acceleration
|
|
17342
|
+
* Set forward and braking linear acceleration values.
|
|
17006
17343
|
*
|
|
17007
|
-
* @param min -
|
|
17008
|
-
* @param max -
|
|
17344
|
+
* @param min - Forward acceleration.
|
|
17345
|
+
* @param max - Braking acceleration.
|
|
17009
17346
|
*/
|
|
17010
17347
|
public SetLinearAcc(min: f32, max: f32): void;
|
|
17011
17348
|
|
|
@@ -17025,15 +17362,21 @@ declare module "xray16" {
|
|
|
17025
17362
|
public SetMaxVelocity(value: f32): void;
|
|
17026
17363
|
|
|
17027
17364
|
/**
|
|
17028
|
-
* Track an enemy object.
|
|
17365
|
+
* Track an enemy object by its engine id.
|
|
17366
|
+
*
|
|
17367
|
+
* @remarks
|
|
17368
|
+
* Passing nullish values is not safe for the native object overload. Use `ClearEnemy()` to clear the current enemy.
|
|
17029
17369
|
*
|
|
17030
|
-
* @param game_object - Enemy object
|
|
17370
|
+
* @param game_object - Enemy object to track.
|
|
17031
17371
|
*/
|
|
17032
|
-
public SetEnemy(game_object:
|
|
17372
|
+
public SetEnemy(game_object: game_object): void;
|
|
17033
17373
|
|
|
17034
17374
|
/**
|
|
17035
17375
|
* Track an enemy point.
|
|
17036
17376
|
*
|
|
17377
|
+
* @remarks
|
|
17378
|
+
* Sets the hunt state to `CHelicopter.eEnemyPoint` and stores the provided world position.
|
|
17379
|
+
*
|
|
17037
17380
|
* @param position - Enemy world position.
|
|
17038
17381
|
*/
|
|
17039
17382
|
public SetEnemy(position: vector): void;
|
|
@@ -17053,7 +17396,7 @@ declare module "xray16" {
|
|
|
17053
17396
|
public SetBarrelDirTolerance(value: f32): void;
|
|
17054
17397
|
|
|
17055
17398
|
/**
|
|
17056
|
-
* Set movement destination.
|
|
17399
|
+
* Set movement destination and switch movement state to `CHelicopter.eMovToPoint`.
|
|
17057
17400
|
*
|
|
17058
17401
|
* @param position - Destination world position.
|
|
17059
17402
|
*/
|
|
@@ -17067,18 +17410,22 @@ declare module "xray16" {
|
|
|
17067
17410
|
public SetOnPointRangeDist(distance: f32): void;
|
|
17068
17411
|
|
|
17069
17412
|
/**
|
|
17070
|
-
* Aim the helicopter body at a point.
|
|
17413
|
+
* Aim the helicopter body at a point or return aiming to path direction.
|
|
17071
17414
|
*
|
|
17072
|
-
* @
|
|
17073
|
-
*
|
|
17415
|
+
* @remarks
|
|
17416
|
+
* Native code treats the boolean as an enable flag: `true` switches body state to `eBodyToPoint`, while `false`
|
|
17417
|
+
* switches it back to `eBodyByPath`.
|
|
17418
|
+
*
|
|
17419
|
+
* @param position - Point to look at when enabled.
|
|
17420
|
+
* @param is_smooth - Whether point aiming is enabled.
|
|
17074
17421
|
*/
|
|
17075
17422
|
public LookAtPoint(position: vector, is_smooth: boolean): void;
|
|
17076
17423
|
|
|
17077
17424
|
/**
|
|
17078
|
-
* Move by a patrol path.
|
|
17425
|
+
* Move by a named patrol path and switch movement state to `CHelicopter.eMovPatrolPath`.
|
|
17079
17426
|
*
|
|
17080
17427
|
* @param path_name - Patrol path name.
|
|
17081
|
-
* @param start_point - Starting
|
|
17428
|
+
* @param start_point - Starting patrol vertex id.
|
|
17082
17429
|
*/
|
|
17083
17430
|
public GoPatrolByPatrolPath(path_name: string, start_point: i32): void;
|
|
17084
17431
|
|
|
@@ -17100,14 +17447,17 @@ declare module "xray16" {
|
|
|
17100
17447
|
public UseFireTrail(): boolean;
|
|
17101
17448
|
|
|
17102
17449
|
/**
|
|
17103
|
-
* Enable or disable fire trail rendering.
|
|
17450
|
+
* Enable or disable fire trail rendering and update fire dispersion settings.
|
|
17104
17451
|
*
|
|
17105
17452
|
* @param is_enabled - New fire trail state.
|
|
17106
17453
|
*/
|
|
17107
17454
|
public UseFireTrail(is_enabled: boolean): void;
|
|
17108
17455
|
|
|
17109
17456
|
/**
|
|
17110
|
-
* Move around a point by a round patrol path.
|
|
17457
|
+
* Move around a point by a generated round patrol path and switch movement state to `CHelicopter.eMovRoundPath`.
|
|
17458
|
+
*
|
|
17459
|
+
* @remarks
|
|
17460
|
+
* Native code refuses radii smaller than the current speed and angular-speed constraints allow.
|
|
17111
17461
|
*
|
|
17112
17462
|
* @param center - Round path center.
|
|
17113
17463
|
* @param radius - Path radius.
|
|
@@ -17116,12 +17466,15 @@ declare module "xray16" {
|
|
|
17116
17466
|
public GoPatrolByRoundPath(center: vector, radius: f32, clockwise: boolean): void;
|
|
17117
17467
|
|
|
17118
17468
|
/**
|
|
17119
|
-
*
|
|
17469
|
+
* Switch the helicopter to dead state and enable its falling physics.
|
|
17470
|
+
*
|
|
17471
|
+
* @remarks
|
|
17472
|
+
* This stops the engine sound and starts the broken-loop sound, but it is separate from `Explode()`.
|
|
17120
17473
|
*/
|
|
17121
17474
|
public Die(): void;
|
|
17122
17475
|
|
|
17123
17476
|
/**
|
|
17124
|
-
* Start flame effects.
|
|
17477
|
+
* Start smoke/flame particle effects if they are not already active.
|
|
17125
17478
|
*/
|
|
17126
17479
|
public StartFlame(): void;
|
|
17127
17480
|
|
|
@@ -17133,7 +17486,7 @@ declare module "xray16" {
|
|
|
17133
17486
|
public TurnEngineSound(enabled: boolean): void;
|
|
17134
17487
|
|
|
17135
17488
|
/**
|
|
17136
|
-
* Clear current enemy target.
|
|
17489
|
+
* Clear current enemy target and switch hunt state to `CHelicopter.eEnemyNone`.
|
|
17137
17490
|
*/
|
|
17138
17491
|
public ClearEnemy(): void;
|
|
17139
17492
|
}
|
|
@@ -17143,7 +17496,7 @@ declare module "xray16" {
|
|
|
17143
17496
|
/**
|
|
17144
17497
|
* One rigid body element inside a physics shell.
|
|
17145
17498
|
*
|
|
17146
|
-
* @source
|
|
17499
|
+
* @source `src/xrPhysics/PhysicsShellScript.cpp`, `physics_element` binding.
|
|
17147
17500
|
* @customConstructor physics_element
|
|
17148
17501
|
* @group xr_physic
|
|
17149
17502
|
*
|
|
@@ -17152,6 +17505,11 @@ declare module "xray16" {
|
|
|
17152
17505
|
* them only while the owning shell and object are alive.
|
|
17153
17506
|
*/
|
|
17154
17507
|
export class physics_element {
|
|
17508
|
+
/**
|
|
17509
|
+
* Engine-owned physics element.
|
|
17510
|
+
*/
|
|
17511
|
+
private constructor();
|
|
17512
|
+
|
|
17155
17513
|
/**
|
|
17156
17514
|
* Apply force to the element.
|
|
17157
17515
|
*
|
|
@@ -17225,7 +17583,7 @@ declare module "xray16" {
|
|
|
17225
17583
|
/**
|
|
17226
17584
|
* Script-controlled particle system.
|
|
17227
17585
|
*
|
|
17228
|
-
* @source
|
|
17586
|
+
* @source `src/xrGame/script_particles_script.cpp`, `particles_object` binding.
|
|
17229
17587
|
* @customConstructor particles_object
|
|
17230
17588
|
* @group xr_physic
|
|
17231
17589
|
*
|
|
@@ -17355,7 +17713,7 @@ declare module "xray16" {
|
|
|
17355
17713
|
/**
|
|
17356
17714
|
* Joint connecting two physics elements.
|
|
17357
17715
|
*
|
|
17358
|
-
* @source
|
|
17716
|
+
* @source `src/xrPhysics/PhysicsShellScript.cpp`, `physics_joint` binding.
|
|
17359
17717
|
* @customConstructor physics_joint
|
|
17360
17718
|
* @group xr_physic
|
|
17361
17719
|
*
|
|
@@ -17364,6 +17722,11 @@ declare module "xray16" {
|
|
|
17364
17722
|
* `get_axes_number()` before using indexed axis methods. Keep them only while the owning shell and object are alive.
|
|
17365
17723
|
*/
|
|
17366
17724
|
export class physics_joint {
|
|
17725
|
+
/**
|
|
17726
|
+
* Engine-owned physics joint.
|
|
17727
|
+
*/
|
|
17728
|
+
private constructor();
|
|
17729
|
+
|
|
17367
17730
|
/**
|
|
17368
17731
|
* Write the joint anchor into a vector.
|
|
17369
17732
|
*
|
|
@@ -17528,7 +17891,7 @@ declare module "xray16" {
|
|
|
17528
17891
|
/**
|
|
17529
17892
|
* Physics shell made of elements and joints.
|
|
17530
17893
|
*
|
|
17531
|
-
* @source
|
|
17894
|
+
* @source `src/xrPhysics/PhysicsShellScript.cpp`, `physics_shell` binding.
|
|
17532
17895
|
* @customConstructor physics_shell
|
|
17533
17896
|
* @group xr_physic
|
|
17534
17897
|
*
|
|
@@ -17672,7 +18035,7 @@ declare module "xray16" {
|
|
|
17672
18035
|
/**
|
|
17673
18036
|
* Opaque native physics condition handle.
|
|
17674
18037
|
*
|
|
17675
|
-
* @source
|
|
18038
|
+
* @source `src/xrPhysics/PHCommander.h`, `CPHCondition` binding.
|
|
17676
18039
|
* @customConstructor CPHCondition
|
|
17677
18040
|
* @group xr_physic
|
|
17678
18041
|
*
|
|
@@ -17681,13 +18044,13 @@ declare module "xray16" {
|
|
|
17681
18044
|
* calls that already have a C++ condition object.
|
|
17682
18045
|
*/
|
|
17683
18046
|
export class CPHCondition {
|
|
17684
|
-
|
|
18047
|
+
protected constructor();
|
|
17685
18048
|
}
|
|
17686
18049
|
|
|
17687
18050
|
/**
|
|
17688
18051
|
* Opaque native physics action handle.
|
|
17689
18052
|
*
|
|
17690
|
-
* @source
|
|
18053
|
+
* @source `src/xrPhysics/PHCommander.h`, `CPHAction` binding.
|
|
17691
18054
|
* @customConstructor CPHAction
|
|
17692
18055
|
* @group xr_physic
|
|
17693
18056
|
*
|
|
@@ -17696,13 +18059,113 @@ declare module "xray16" {
|
|
|
17696
18059
|
* that already have a C++ action object.
|
|
17697
18060
|
*/
|
|
17698
18061
|
export class CPHAction {
|
|
17699
|
-
|
|
18062
|
+
protected constructor();
|
|
18063
|
+
}
|
|
18064
|
+
|
|
18065
|
+
|
|
18066
|
+
/**
|
|
18067
|
+
* Physics condition that becomes true on or after a selected physics step/time.
|
|
18068
|
+
*
|
|
18069
|
+
* @source `src/xrPhysics/PHSimpleCallsScript.cpp`, `phcondition_callonstep` binding.
|
|
18070
|
+
* @customConstructor phcondition_callonstep
|
|
18071
|
+
* @group xr_physic
|
|
18072
|
+
*
|
|
18073
|
+
* @remarks
|
|
18074
|
+
* Use with `physics_world.add_call()` to schedule a physics action. Step and time interval setters compute the
|
|
18075
|
+
* target step from the current physics world state.
|
|
18076
|
+
*/
|
|
18077
|
+
export class phcondition_callonstep extends CPHCondition {
|
|
18078
|
+
/**
|
|
18079
|
+
* Create a physics step condition.
|
|
18080
|
+
*/
|
|
18081
|
+
public constructor();
|
|
18082
|
+
|
|
18083
|
+
/**
|
|
18084
|
+
* Set the absolute physics step that must be reached.
|
|
18085
|
+
*
|
|
18086
|
+
* @param step - Absolute physics step number.
|
|
18087
|
+
*/
|
|
18088
|
+
public set_step(step: u64): void;
|
|
18089
|
+
|
|
18090
|
+
/**
|
|
18091
|
+
* Set the condition to become true after a number of physics steps.
|
|
18092
|
+
*
|
|
18093
|
+
* @param steps - Step count from the current physics world step.
|
|
18094
|
+
*/
|
|
18095
|
+
public set_steps_interval(steps: u64): void;
|
|
18096
|
+
|
|
18097
|
+
/**
|
|
18098
|
+
* Set the absolute game time in milliseconds that must be reached.
|
|
18099
|
+
*
|
|
18100
|
+
* @param time - Absolute global time in milliseconds.
|
|
18101
|
+
*/
|
|
18102
|
+
public set_global_time_ms(time: u32): void;
|
|
18103
|
+
|
|
18104
|
+
/**
|
|
18105
|
+
* Set the absolute game time in seconds that must be reached.
|
|
18106
|
+
*
|
|
18107
|
+
* @param time - Absolute global time in seconds.
|
|
18108
|
+
*/
|
|
18109
|
+
public set_global_time_s(time: f32): void;
|
|
18110
|
+
|
|
18111
|
+
/**
|
|
18112
|
+
* Set the condition to become true after a millisecond interval.
|
|
18113
|
+
*
|
|
18114
|
+
* @param time - Interval in milliseconds.
|
|
18115
|
+
*/
|
|
18116
|
+
public set_time_interval_ms(time: u32): void;
|
|
18117
|
+
|
|
18118
|
+
/**
|
|
18119
|
+
* Set the condition to become true after a second interval.
|
|
18120
|
+
*
|
|
18121
|
+
* @param time - Interval in seconds.
|
|
18122
|
+
*/
|
|
18123
|
+
public set_time_interval_s(time: f32): void;
|
|
18124
|
+
}
|
|
18125
|
+
|
|
18126
|
+
/**
|
|
18127
|
+
* Physics condition that expires on the selected step.
|
|
18128
|
+
*
|
|
18129
|
+
* @source `src/xrPhysics/PHSimpleCallsScript.cpp`, `phcondition_expireonstep` binding.
|
|
18130
|
+
* @customConstructor phcondition_expireonstep
|
|
18131
|
+
* @group xr_physic
|
|
18132
|
+
*
|
|
18133
|
+
* @remarks
|
|
18134
|
+
* Subclass of `phcondition_callonstep` used by the physics commander for calls that should be considered true while
|
|
18135
|
+
* expiring on the configured step.
|
|
18136
|
+
*/
|
|
18137
|
+
export class phcondition_expireonstep extends phcondition_callonstep {
|
|
18138
|
+
/**
|
|
18139
|
+
* Create an expiring physics step condition.
|
|
18140
|
+
*/
|
|
18141
|
+
public constructor();
|
|
18142
|
+
}
|
|
18143
|
+
|
|
18144
|
+
/**
|
|
18145
|
+
* Physics action that applies a constant force to a shell when run.
|
|
18146
|
+
*
|
|
18147
|
+
* @source `src/xrPhysics/PHSimpleCallsScript.cpp`, `phaction_constforce` binding.
|
|
18148
|
+
* @customConstructor phaction_constforce
|
|
18149
|
+
* @group xr_physic
|
|
18150
|
+
*
|
|
18151
|
+
* @remarks
|
|
18152
|
+
* The action stores the target shell and force vector. The physics commander applies that force when the paired
|
|
18153
|
+
* condition becomes true.
|
|
18154
|
+
*/
|
|
18155
|
+
export class phaction_constforce extends CPHAction {
|
|
18156
|
+
/**
|
|
18157
|
+
* Create a constant-force physics action.
|
|
18158
|
+
*
|
|
18159
|
+
* @param shell - Target physics shell.
|
|
18160
|
+
* @param force - Force vector to apply.
|
|
18161
|
+
*/
|
|
18162
|
+
public constructor(shell: physics_shell, force: vector);
|
|
17700
18163
|
}
|
|
17701
18164
|
|
|
17702
18165
|
/**
|
|
17703
18166
|
* Global physics world controls.
|
|
17704
18167
|
*
|
|
17705
|
-
* @source
|
|
18168
|
+
* @source `src/xrPhysics/PHWorldScript.cpp`, `physics_world` binding.
|
|
17706
18169
|
* @customConstructor physics_world
|
|
17707
18170
|
* @group xr_physic
|
|
17708
18171
|
*
|
|
@@ -17710,6 +18173,11 @@ declare module "xray16" {
|
|
|
17710
18173
|
* Obtain the live world through `level.physics_world()`. Gravity changes affect the whole level.
|
|
17711
18174
|
*/
|
|
17712
18175
|
export class physics_world {
|
|
18176
|
+
/**
|
|
18177
|
+
* Live level physics world returned by `level.physics_world()` in the engine.
|
|
18178
|
+
*/
|
|
18179
|
+
private constructor();
|
|
18180
|
+
|
|
17713
18181
|
/**
|
|
17714
18182
|
* Set world gravity.
|
|
17715
18183
|
*
|
|
@@ -17738,11 +18206,16 @@ declare module "xray16" {
|
|
|
17738
18206
|
/**
|
|
17739
18207
|
* Animated model kinematics.
|
|
17740
18208
|
*
|
|
17741
|
-
* @source
|
|
18209
|
+
* @source `src/xrGame/base_client_classes_script.cpp`, `IKinematicsAnimated` binding.
|
|
17742
18210
|
* @customConstructor IKinematicsAnimated
|
|
17743
18211
|
* @group xr_physic
|
|
17744
18212
|
*/
|
|
17745
18213
|
export class IKinematicsAnimated {
|
|
18214
|
+
/**
|
|
18215
|
+
* Engine-owned animated kinematics interface.
|
|
18216
|
+
*/
|
|
18217
|
+
private constructor();
|
|
18218
|
+
|
|
17746
18219
|
/**
|
|
17747
18220
|
* Play an animation cycle by name.
|
|
17748
18221
|
*
|
|
@@ -17754,8 +18227,7 @@ declare module "xray16" {
|
|
|
17754
18227
|
/**
|
|
17755
18228
|
* Client object that owns a physics shell.
|
|
17756
18229
|
*
|
|
17757
|
-
* @source
|
|
17758
|
-
* IObjectPhysicsCollision, IPhysicsShellHolder
|
|
18230
|
+
* @source `src/xrGame/script_game_object_script3.cpp`, `cast_PhysicsShellHolder` binding.
|
|
17759
18231
|
* @customConstructor CPhysicsShellHolder
|
|
17760
18232
|
* @group xr_physic
|
|
17761
18233
|
*
|
|
@@ -17773,7 +18245,7 @@ declare module "xray16" {
|
|
|
17773
18245
|
/**
|
|
17774
18246
|
* Holder object that the actor can engage with.
|
|
17775
18247
|
*
|
|
17776
|
-
* @source
|
|
18248
|
+
* @source `src/xrGame/holder_custom_script.cpp`, `holder` binding.
|
|
17777
18249
|
* @customConstructor holder
|
|
17778
18250
|
* @group xr_physic
|
|
17779
18251
|
*
|
|
@@ -17781,6 +18253,11 @@ declare module "xray16" {
|
|
|
17781
18253
|
* Returned only for objects that implement holder controls, such as mounted weapons or vehicles.
|
|
17782
18254
|
*/
|
|
17783
18255
|
export class holder {
|
|
18256
|
+
/**
|
|
18257
|
+
* Engine-owned holder interface.
|
|
18258
|
+
*/
|
|
18259
|
+
private constructor();
|
|
18260
|
+
|
|
17784
18261
|
/**
|
|
17785
18262
|
* @returns Whether the actor is currently attached to the holder.
|
|
17786
18263
|
*/
|
|
@@ -17822,7 +18299,7 @@ declare module "xray16" {
|
|
|
17822
18299
|
/**
|
|
17823
18300
|
* Client object binding for `CSpaceRestrictor` zones.
|
|
17824
18301
|
*
|
|
17825
|
-
* @source
|
|
18302
|
+
* @source `src/xrGame/space_restrictor_script.cpp`, `CSpaceRestrictor` binding.
|
|
17826
18303
|
* @customConstructor CSpaceRestrictor
|
|
17827
18304
|
* @group xr_zone
|
|
17828
18305
|
*
|
|
@@ -17833,21 +18310,27 @@ declare module "xray16" {
|
|
|
17833
18310
|
export class CSpaceRestrictor extends CGameObject {}
|
|
17834
18311
|
|
|
17835
18312
|
/**
|
|
17836
|
-
*
|
|
18313
|
+
* Runtime family wrapper for custom anomaly zones returned by `game_object.cast_CustomZone()`.
|
|
17837
18314
|
*
|
|
17838
|
-
* @source
|
|
18315
|
+
* @source `src/xrGame/script_game_object_script3.cpp`, `cast_CustomZone` binding.
|
|
17839
18316
|
* @customConstructor CCustomZone
|
|
17840
18317
|
* @group xr_zone
|
|
17841
18318
|
*
|
|
17842
18319
|
* @remarks
|
|
17843
|
-
*
|
|
18320
|
+
* No direct `CCustomZone` class constructor is registered in the script binding; concrete zone classes are exported
|
|
18321
|
+
* separately. Anomaly power and activation helpers on `game_object` require this family.
|
|
17844
18322
|
*/
|
|
17845
|
-
export class CCustomZone extends CSpaceRestrictor {
|
|
18323
|
+
export class CCustomZone extends CSpaceRestrictor {
|
|
18324
|
+
/**
|
|
18325
|
+
* Cast-only runtime wrapper.
|
|
18326
|
+
*/
|
|
18327
|
+
protected constructor();
|
|
18328
|
+
}
|
|
17846
18329
|
|
|
17847
18330
|
/**
|
|
17848
18331
|
* Client object binding for `CLevelChanger` zones.
|
|
17849
18332
|
*
|
|
17850
|
-
* @source
|
|
18333
|
+
* @source `src/xrGame/actor_script.cpp`, `CLevelChanger` binding.
|
|
17851
18334
|
* @customConstructor CLevelChanger
|
|
17852
18335
|
* @group xr_zone
|
|
17853
18336
|
*
|
|
@@ -17859,7 +18342,7 @@ declare module "xray16" {
|
|
|
17859
18342
|
/**
|
|
17860
18343
|
* Client object binding for `smart_cover_object` zones.
|
|
17861
18344
|
*
|
|
17862
|
-
* @source
|
|
18345
|
+
* @source `src/xrGame/smart_cover_object_script.cpp`, `smart_cover_object` binding.
|
|
17863
18346
|
* @customConstructor smart_cover_object
|
|
17864
18347
|
* @group xr_zone
|
|
17865
18348
|
*
|
|
@@ -17869,9 +18352,9 @@ declare module "xray16" {
|
|
|
17869
18352
|
export class smart_cover_object extends CGameObject {}
|
|
17870
18353
|
|
|
17871
18354
|
/**
|
|
17872
|
-
*
|
|
18355
|
+
* Server object binding for script zone spawn entities.
|
|
17873
18356
|
*
|
|
17874
|
-
* @source
|
|
18357
|
+
* @source `src/xrGame/script_zone_script.cpp`, `ce_script_zone` binding.
|
|
17875
18358
|
* @customConstructor ce_script_zone
|
|
17876
18359
|
* @group xr_zone
|
|
17877
18360
|
*
|
|
@@ -17887,9 +18370,9 @@ declare module "xray16" {
|
|
|
17887
18370
|
}
|
|
17888
18371
|
|
|
17889
18372
|
/**
|
|
17890
|
-
*
|
|
18373
|
+
* Server object binding for smart-zone spawn entities.
|
|
17891
18374
|
*
|
|
17892
|
-
* @source
|
|
18375
|
+
* @source `src/xrGame/script_zone_script.cpp`, `ce_smart_zone` binding.
|
|
17893
18376
|
* @customConstructor ce_smart_zone
|
|
17894
18377
|
* @group xr_zone
|
|
17895
18378
|
*
|
|
@@ -17983,8 +18466,14 @@ declare module "xray16" {
|
|
|
17983
18466
|
export type TXR_bloodsucker_visibility_state = -1 | 0 | 1 | 2;
|
|
17984
18467
|
|
|
17985
18468
|
/**
|
|
18469
|
+
* Movement path type accepted by `game_object.set_path_type()` and returned by `game_object.path_type()`.
|
|
18470
|
+
*
|
|
17986
18471
|
* @source `src/xrGame/script_game_object_script2.cpp`, `game_object.EPathType` enum.
|
|
17987
18472
|
* @group xr_script_interface
|
|
18473
|
+
*
|
|
18474
|
+
* @remarks
|
|
18475
|
+
* The Lua binding exposes only the four named `MovementManager::EPathType` values. When mirroring these values in a
|
|
18476
|
+
* TypeScript enum, use literal numeric initializers (`0`, `1`, `2`, `3`) instead of runtime `game_object` lookups.
|
|
17988
18477
|
*/
|
|
17989
18478
|
export type TXR_game_object_path =
|
|
17990
18479
|
| typeof game_object.game_path
|
|
@@ -18005,6 +18494,10 @@ declare module "xray16" {
|
|
|
18005
18494
|
*
|
|
18006
18495
|
* @source C++ enum ScriptEntity::EActionType
|
|
18007
18496
|
* @group xr_script_interface
|
|
18497
|
+
*
|
|
18498
|
+
* @remarks
|
|
18499
|
+
* `7` is native `ScriptEntity::eActionTypeRemoved`. It is used by the action-removed callback but is not exported as
|
|
18500
|
+
* a named `game_object.action_types` enum member.
|
|
18008
18501
|
*/
|
|
18009
18502
|
export type TXR_action_type =
|
|
18010
18503
|
| typeof game_object.movement
|
|
@@ -18592,9 +19085,7 @@ declare module "xray16" {
|
|
|
18592
19085
|
*/
|
|
18593
19086
|
public set_callback<T extends AnyObject>(
|
|
18594
19087
|
type: TXR_callbacks["action_movement"],
|
|
18595
|
-
|
|
18596
|
-
(this: void, object: game_object, action_type: TXR_action_type, target_point_index: -1) => void
|
|
18597
|
-
>,
|
|
19088
|
+
cb?: Nillable<(this: void, object: game_object, action_type: TXR_action_type, target_point_index: -1) => void>,
|
|
18598
19089
|
object?: Nillable<T>
|
|
18599
19090
|
): void;
|
|
18600
19091
|
|
|
@@ -21409,7 +21900,12 @@ declare module "xray16" {
|
|
|
21409
21900
|
* @param route_type - Patrol route type.
|
|
21410
21901
|
* @param random - Whether path point selection is random.
|
|
21411
21902
|
*/
|
|
21412
|
-
public set_patrol_path(
|
|
21903
|
+
public set_patrol_path(
|
|
21904
|
+
path_name: string,
|
|
21905
|
+
start_type: TXR_patrol_start_type,
|
|
21906
|
+
route_type: TXR_patrol_route_type,
|
|
21907
|
+
random: boolean
|
|
21908
|
+
): void;
|
|
21413
21909
|
|
|
21414
21910
|
/**
|
|
21415
21911
|
* Make smart-cover target selection prefer idle positions.
|
|
@@ -21746,7 +22242,14 @@ declare module "xray16" {
|
|
|
21746
22242
|
* @param internal_type - Internal monster sound id.
|
|
21747
22243
|
* @returns Registered sound id, or `0` when this object is not a custom monster.
|
|
21748
22244
|
*/
|
|
21749
|
-
public add_sound(
|
|
22245
|
+
public add_sound(
|
|
22246
|
+
prefix: string,
|
|
22247
|
+
max_count: u32,
|
|
22248
|
+
type: TXR_snd_type,
|
|
22249
|
+
priority: u32,
|
|
22250
|
+
mask: u32,
|
|
22251
|
+
internal_type: u32
|
|
22252
|
+
): u32;
|
|
21750
22253
|
|
|
21751
22254
|
/**
|
|
21752
22255
|
* Register an NPC sound with a bone name.
|
|
@@ -27323,9 +27826,13 @@ declare module "xray16" {
|
|
|
27323
27826
|
}
|
|
27324
27827
|
|
|
27325
27828
|
/**
|
|
27326
|
-
* UI event id.
|
|
27829
|
+
* UI event id passed to window message handlers such as `CUIScriptWnd.OnKeyboard()`.
|
|
27327
27830
|
*
|
|
27831
|
+
* @source C++ class ui_events
|
|
27328
27832
|
* @group xr_ui_event
|
|
27833
|
+
*
|
|
27834
|
+
* @remarks
|
|
27835
|
+
* Values identify UI notifications, not keyboard or mouse button codes. For input key codes use `TXR_DIK_key`.
|
|
27329
27836
|
*/
|
|
27330
27837
|
export type TXR_ui_event = EnumeratedStaticsValues<typeof ui_events>;
|
|
27331
27838
|
|
|
@@ -28384,16 +28891,20 @@ declare module "xray16" {
|
|
|
28384
28891
|
}
|
|
28385
28892
|
|
|
28386
28893
|
/**
|
|
28387
|
-
* Static key name from `DIK_keys`.
|
|
28894
|
+
* Static key constant name from `DIK_keys`.
|
|
28388
28895
|
*
|
|
28389
28896
|
* @group xr_ui_event
|
|
28390
28897
|
*/
|
|
28391
28898
|
export type TXR_DIK_key_name = EnumeratedStaticsKeys<typeof DIK_keys>;
|
|
28392
28899
|
|
|
28393
28900
|
/**
|
|
28394
|
-
* DIK, mouse, or gamepad key code.
|
|
28901
|
+
* DIK, mouse, or gamepad key code passed to keyboard/input callbacks.
|
|
28395
28902
|
*
|
|
28903
|
+
* @source C++ class DIK_keys
|
|
28396
28904
|
* @group xr_ui_event
|
|
28905
|
+
*
|
|
28906
|
+
* @remarks
|
|
28907
|
+
* The binding keeps the legacy `DIK_*` names, but values come from SDL scancodes plus engine mouse/gamepad ranges.
|
|
28397
28908
|
*/
|
|
28398
28909
|
export type TXR_DIK_key = EnumeratedStaticsValues<typeof DIK_keys>;
|
|
28399
28910
|
|