xray16 1.0.9 → 1.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xray16",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "author": "Neloreck",
   "repository": "https://github.com/stalker-xrts/xray-16-types",
   "private": false,

package/plugins/inline.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const typescript_1 = require("typescript");
+const typescript_to_lua_1 = require("typescript-to-lua");
+const diagnostics_1 = require("./utils/diagnostics");
+const INLINE_MACROS = "$inline";
+const expectedFunctionExpressionInInline = (0, diagnostics_1.createErrorDiagnosticFactory)("Expected a function expression in '__inline'.");
+/**
+ * Plugin for transformation of casting methods.
+ * Simplifies TS/Lua testing and interoperation.
+ *
+ * Reference: https://gist.github.com/Cheatoid/ea4573c6bd1992fc4940090543ec9380
+ */
+const plugin = {
+    visitors: {
+        [typescript_1.SyntaxKind.ExpressionStatement]: (node, context) => {
+            const result = context.superTransformStatements(node);
+            if ((0, typescript_1.isExpressionStatement)(node)) {
+                const expr = node.expression;
+                if ((0, typescript_1.isCallExpression)(expr) && (0, typescript_1.isIdentifier)(expr.expression)) {
+                    switch (expr.expression.text) {
+                        case INLINE_MACROS: {
+                            if (expr.arguments.length > 0) {
+                                let bodyArg = expr.arguments[0];
+                                if ((0, typescript_1.isIdentifier)(bodyArg)) {
+                                    try {
+                                        bodyArg = context.checker.getSymbolAtLocation(bodyArg).getDeclarations()[0];
+                                    }
+                                    catch (error) {
+                                        context.diagnostics.push(expectedFunctionExpressionInInline(node));
+                                        break;
+                                    }
+                                    if (!bodyArg) {
+                                        context.diagnostics.push(expectedFunctionExpressionInInline(node));
+                                        break;
+                                    }
+                                }
+                                const paramNames = [];
+                                let funcExpr;
+                                if ((0, typescript_1.isFunctionLike)(bodyArg)) {
+                                    const bodyNode = context.transformNode(bodyArg)[0];
+                                    if (!bodyNode) {
+                                        context.diagnostics.push(expectedFunctionExpressionInInline(node));
+                                        break;
+                                    }
+                                    if ((0, typescript_to_lua_1.isVariableDeclarationStatement)(bodyNode) && bodyNode.right) {
+                                        if ((0, typescript_to_lua_1.isFunctionExpression)(bodyNode.right[0])) {
+                                            funcExpr = bodyNode.right[0];
+                                        }
+                                    }
+                                    paramNames.push(...bodyArg.parameters.map((p) => p.name.getText()));
+                                }
+                                for (const stmt of result) {
+                                    if ((0, typescript_to_lua_1.isExpressionStatement)(stmt)) {
+                                        const callExpr = stmt.expression;
+                                        if ((0, typescript_to_lua_1.isCallExpression)(callExpr) &&
+                                            (0, typescript_to_lua_1.isIdentifier)(callExpr.expression) &&
+                                            callExpr.expression.text === expr.expression.text) {
+                                            const paramCount = callExpr.params.length;
+                                            if (paramCount > 0) {
+                                                let body = callExpr.params[0];
+                                                if ((0, typescript_to_lua_1.isIdentifier)(body)) {
+                                                    body = funcExpr;
+                                                }
+                                                if (body && (0, typescript_to_lua_1.isFunctionExpression)(body)) {
+                                                    const statements = body.body.statements;
+                                                    for (let index = 1; index < paramCount; ++index) {
+                                                        // Skip the body parameter.
+                                                        const param = callExpr.params[index];
+                                                        statements.unshift((0, typescript_to_lua_1.createVariableDeclarationStatement)([(0, typescript_to_lua_1.createIdentifier)(paramNames[index - 1])], [param]));
+                                                    }
+                                                    return (0, typescript_to_lua_1.createDoStatement)(statements, node);
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                            context.diagnostics.push(expectedFunctionExpressionInInline(node));
+                            break;
+                        }
+                    }
+                }
+            }
+            return result;
+        },
+    },
+};
+exports.default = plugin;

package/plugins/strip_lua_logger.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const typescript_1 = require("typescript");
 const LUA_LOGGER_STRIP_TARGET = "LuaLogger";
-const IS_LUA_LOGGER_DISABLED = process.argv.includes("--no-lua-logs");
+const IS_LUA_LOGGER_DISABLED = process.argv.includes("--no-lua-logs") || process.env.NO_LUA_LOGS === "true";
 /**
  * Plugin that removes all LuaLogger instance creations and calls when possible.
  */

package/types/index.d.ts

@@ -49,4 +49,6 @@ import "./xr_ui/xr_ui_event";
 import "./xr_ui/xr_ui_interface";
 import "./xr_ui/xr_ui_menu";
 
+import "./xrf_plugin";
+
 declare module "xray16" {}

package/types/xr_lib/xr_luabind.d.ts

@@ -40,8 +40,8 @@ declare module "xray16" {
    * @group xr_luabind
    */
   export class class_info_data extends EngineBinding {
-    public readonly methods: object;
-    public readonly attributes: object;
+    public readonly methods: LuaTable<string, (...args: Array<unknown>) => unknown>;
+    public readonly attributes: LuaTable<number, string>;
     public readonly name: string;
 
     private constructor();
@@ -50,7 +50,7 @@ declare module "xray16" {
   /**
    * @group xr_luabind
    */
-  export function class_names(this: void, lua_state: unknown /* lua_State*/): object;
+  export function class_names(this: void, lua_state: unknown /* lua_State*/): LuaTable<number, string>;
 
   /**
    * @group xr_luabind

package/types/xr_object/client/xr_creature.d.ts

@@ -1,4 +1,11 @@
 declare module "xray16" {
+  /**
+   * @source C++ class CEntityAlive : public CEntity
+   * @customConstructor CEntityAlive
+   * @group xr_creature
+   */
+  export class CEntityAlive extends CGameObject {}
+
   /**
    * @source C++ class CActor : CGameObject
    * @customConstructor CActor

package/types/xr_object/client/xr_item.d.ts

@@ -1,4 +1,15 @@
 declare module "xray16" {
+  /**
+   * @source C++ class explosive
+   * @customConstructor explosive
+   * @group xr_item
+   */
+  export class explosive extends EngineBinding {
+    protected constructor();
+
+    public explode(): void;
+  }
+
   /**
    * @source C++ class CAntirad : CGameObject
    * @customConstructor CAntirad
@@ -69,19 +80,33 @@ declare module "xray16" {
    */
   export class CWeaponAmmo extends CGameObject {}
 
+  /**
+   * @source C++ class CWeapon : public CHudItemObject, public CShootingObject
+   * @customConstructor CWeaponAmmo
+   * @group xr_item
+   */
+  export class CWeapon extends CInventoryItem {}
+
+  /**
+   * @source C++ class CWeaponMagazined : public CWeapon
+   * @customConstructor CWeaponMagazined
+   * @group xr_item
+   */
+  export class CWeaponMagazined extends CWeapon {}
+
   /**
    * @source C++ class CWeaponAutomaticShotgun : CGameObject
    * @customConstructor CWeaponAutomaticShotgun
    * @group xr_item
    */
-  export class CWeaponAutomaticShotgun extends CGameObject {}
+  export class CWeaponAutomaticShotgun extends CWeaponMagazined {}
 
   /**
    * @source C++ class CWeaponBM16 : CGameObject
    * @customConstructor CWeaponBM16
    * @group xr_item
    */
-  export class CWeaponBM16 extends CGameObject {}
+  export class CWeaponBM16 extends CWeaponShotgun {}
 
   /**
    * @source C++ class CWeaponBinoculars : CGameObject

package/types/xr_object/client/xr_physic.d.ts

@@ -1,3 +1,4 @@
+
 declare module "xray16" {
   /**
    * @source C++ class physics_element
@@ -174,4 +175,27 @@ declare module "xray16" {
   export class IKinematicsAnimated {
     public PlayCycle(value: string): void;
   }
+
+  /**
+   * @source C++ class CPhysicsShellHolder : public CGameObject, CParticlesPlayer,
+   *   IObjectPhysicsCollision, IPhysicsShellHolder
+   * @customConstructor CPhysicsShellHolder
+   * @group xr_physic
+   */
+  export class CPhysicsShellHolder extends EngineBinding {
+    protected constructor();
+  }
+
+  /**
+   * @source C++ class holder
+   * @customConstructor holder
+   * @group xr_physic
+   */
+  export class holder {
+    public engaged(): boolean;
+
+    public Action(value1: u16, value2: u32): void;
+
+    public SetParam(value: i32, vector: vector): void;
+  }
 }

package/types/xr_object/client/xr_zone.d.ts

@@ -6,6 +6,13 @@ declare module "xray16" {
    */
   export class CSpaceRestrictor extends CGameObject {}
 
+  /**
+   * @source C++ class CCustomZone : public CSpaceRestrictor, public Feel::Touch
+   * @customConstructor CCustomZone
+   * @group xr_zone
+   */
+  export class CCustomZone extends CSpaceRestrictor {}
+
   /**
    * @source C++ class CLevelChanger : CGameObject
    * @customConstructor CLevelChanger

package/types/xr_object/script/xr_script_interface.d.ts

@@ -29,30 +29,6 @@ declare module "xray16" {
     public who: game_object;
   }
 
-  /**
-   * @source C++ class explosive
-   * @customConstructor explosive
-   * @group xr_script_interface
-   */
-  export class explosive extends EngineBinding {
-    protected constructor();
-
-    public explode(): void;
-  }
-
-  /**
-   * @source C++ class holder
-   * @customConstructor holder
-   * @group xr_script_interface
-   */
-  export class holder {
-    public engaged(): boolean;
-
-    public Action(value1: u16, value2: u32): void;
-
-    public SetParam(value: i32, vector: vector): void;
-  }
-
   /**
    * Visibility state of bloodsucker.
    * Possible values are:

package/types/xr_object/script/xr_script_object.d.ts

@@ -1,121 +1,4 @@
 declare module "xray16" {
-  /*
-   *  CAI_Stalker* cast_Stalker();
-   *  CArtefact* cast_Artefact();
-   *  CCar* cast_Car();
-   *  CGameObject* cast_GameObject();
-   *  CHelicopter* cast_Heli();
-   *  CSpaceRestrictor* cast_SpaceRestrictor();
-   *  CWeapon* cast_Weapon();
-   *  CWeaponAmmo* cast_Ammo();
-   *  CWeaponMagazined* cast_WeaponMagazined();
-   *  ce_script_zone* cast_ScriptZone();
-   *  class CCustomZone* cast_CustomZone();
-   *  class CEntityAlive* cast_EntityAlive();
-   *  class CPhysicsShellHolder* cast_PhysicsShellHolder();
-   *  explosive* cast_Explosive();
-   *
-   *  CTime get_info_time(char const*);
-   *  bool bone_visible(char const*);
-   *  bool has_ammo_type(unsigned char)
-
-   *  bool is_on_belt(game_object*);
-   *  bool use(game_object*);
-   *
-   *  vector<MemorySpace::CNotYetVisibleObject,xalloc<MemorySpace::CNotYetVisibleObject> > not_yet_visible_objects();
-   *  vector<MemorySpace::CSoundObject,xalloc<MemorySpace::CSoundObject>> memory_sound_objects();
-
-   *  enum DetailPathManager::EDetailPathType detail_path_type();
-   *  enum ETaskState get_task_state(char const*);
-   *  enum MonsterSpace::EBodyState body_state();
-   *  enum MonsterSpace::EBodyState target_body_state();
-   *  enum MonsterSpace::EMentalState mental_state();
-   *  enum MonsterSpace::EMentalState target_mental_state();
-   *  enum MonsterSpace::EMovementType movement_type();
-   *  enum MovementManager::EPathType path_type();
-   *
-   *  float get_actor_jump_speed();
-   *  float get_actor_max_walk_weight();
-   *  float get_actor_max_weight();
-   *  float get_actor_run_coef();
-   *  float get_actor_runback_coef();
-   *  float get_actor_sprint_koef();
-   *  float get_additional_max_walk_weight();
-   *  float get_additional_max_weight();
-   *  float get_anomaly_power();
-   *  float get_artefact_bleeding();
-   *  float get_artefact_health();
-   *  float get_artefact_power();
-   *  float get_artefact_radiation();
-   *  float get_artefact_satiety();
-   *  float get_luminocity();
-   *  float get_luminocity_hemi();
-   *  float get_total_weight();
-   *
-
-   *  game_object* get_attached_vehicle();
-   *
-   *  holder* cast_HolderCustom();
-   *  int get_ammo_count_for_type(unsigned char);
-   *
-   *  unsigned char get_max_uses();
-   *  unsigned char get_remaining_uses();
-   *  unsigned char get_restrictor_type();
-   *  unsigned char get_weapon_substate();
-   *
-   *  unsigned int belt_count();
-   *  unsigned int get_main_weapon_type();
-   *  unsigned int get_spatial_type();
-   *  remove_danger();
-   *  remove_memory_sound_object();
-   *  remove_memory_visible_object();
-   *  remove_memory_hit_object();
-   *  unsigned int get_state();
-   *  unsigned int get_weapon_type();
-   *  unsigned int play_hud_motion(char const*,bool,unsigned int);
-   *
-   *  void attach_vehicle(game_object*);
-   *  void clear_game_news();
-   *  void detach_vehicle();
-   *  void force_set_position(vector,bool);
-   *
-   *  void iterate_feel_touch(function<void>);
-
-   *  void phantom_set_enemy(game_object*);
-   *  void set_actor_jump_speed(float);
-   *  void set_actor_max_walk_weight(float);
-   *  void set_actor_max_weight(float);
-   *  void set_actor_run_coef(float);
-   *  void set_actor_runback_coef(float);
-   *  void set_actor_sprint_koef(float);
-   *  void set_additional_max_walk_weight(float);
-   *  void set_additional_max_weight(float);
-   *  void set_alien_control(bool);
-   *  void set_ammo_type(unsigned char);
-   *
-   *  void set_artefact_bleeding(float);
-   *  void set_artefact_health(float);
-   *  void set_artefact_power(float);
-   *  void set_artefact_radiation(float);
-   *  void set_artefact_satiety(float);
-   *
-   *  void set_bone_visible(char const*,bool,bool);
-   *  void set_character_icon(char const*);
-   *  void set_health_ex(float);
-   *  void set_main_weapon_type(unsigned int);
-
-   *
-   *  void set_remaining_uses(unsigned char);
-   *  void set_restrictor_type(unsigned char);
-   *  void set_spatial_type(unsigned int);
-   *  void set_weapon_type(unsigned int);
-
-   *  void start_trade(game_object*);
-   *  void start_upgrade(game_object*);
-   *  void switch_state(unsigned int);
-   * }
-   */
-
   /**
    * Client object base presentation as script object.
    * Generic in-game entities from items to mutants and stalkers wrapped with luabind export.
@@ -430,10 +313,7 @@ declare module "xray16" {
 
     public buy_item_condition_factor(value: f32): void;
 
-    /**
-     * Change object squad/faction?
-     */
-    public change_team(community_id: u8, squad_id: u8, group_id: u8): void;
+    public change_team(team_id: u8, squad_id: u8, group_id: u8): void;
 
     public character_icon<T extends string>(): T;
 
@@ -605,7 +485,7 @@ declare module "xray16" {
 
     public set_actor_relation_flags(value: flags32): void;
 
-    public set_alien_control(value: boolean): void;
+    public set_alien_control(is_enabled: boolean): void;
 
     public set_body_state(state: TXR_MonsterBodyState): void;
 
@@ -772,7 +652,7 @@ declare module "xray16" {
 
     /**
      * Return formula: `personal_goodwill + reputation_goodwill + rank_goodwill +
-     *   community_goodwill + community_to_community`
+     *  community_goodwill + community_to_community`
      *
      * @param target - target client object
      * @returns goodwill level from object to target
@@ -783,8 +663,6 @@ declare module "xray16" {
 
     public get_ammo_in_magazine(): u32;
 
-    public get_anomaly_power(): unknown;
-
     public get_car(): CCar;
 
     public get_corpse(): game_object | null;
@@ -1098,6 +976,10 @@ declare module "xray16" {
 
     public inactualize_patrol_path(): void;
 
+    public inactualize_level_path(): void;
+
+    public inactualize_game_path(): void;
+
     /**
      * Iterate over game object inventory.
      * Runs supplied callback for each item in inventory of the object.
@@ -1195,5 +1077,187 @@ declare module "xray16" {
     public ammo_set_count(count: u16): void;
 
     public ammo_box_size(): u16;
+
+    public cast_Stalker(): CAI_Stalker;
+
+    public cast_Artefact(): CArtefact;
+
+    public cast_Car(): CCar;
+
+    public cast_GameObject(): CGameObject;
+
+    public cast_Heli(): CHelicopter;
+
+    public cast_SpaceRestrictor(): CSpaceRestrictor;
+
+    public cast_HolderCustom(): holder;
+
+    public cast_Weapon(): CWeapon;
+
+    public cast_Ammo(): CWeaponAmmo;
+
+    public cast_WeaponMagazined(): CWeaponMagazined;
+
+    public cast_ScriptZone(): ce_script_zone;
+
+    public cast_CustomZone(): CCustomZone;
+
+    public cast_EntityAlive(): CEntityAlive;
+
+    public cast_Explosive(): explosive;
+
+    public cast_PhysicsShellHolder(): CPhysicsShellHolder;
+
+    public get_info_time(info: string): CTime;
+
+    public bone_visible(bone: string): boolean;
+
+    public has_ammo_type(type: string): boolean;
+
+    public is_on_belt(object: game_object): boolean;
+
+    public use(object: game_object): void;
+
+    /**
+     * Set remaining item uses count.
+     *
+     * @param remaining - count of remaining uses for item before destroy
+     */
+    public set_remaining_uses(remaining: u8): void;
+
+    public get_max_uses(): u8;
+
+    public get_remaining_uses(): u8;
+
+    public set_restrictor_type(type: u8): void;
+
+    public get_restrictor_type(): u8;
+
+    public set_spatial_type(type: u8): void;
+
+    public set_weapon_type(type: u8): void;
+
+    public get_weapon_substate(): u8;
+
+    public start_trade(object: game_object): void;
+
+    public start_upgrade(object: game_object): void;
+
+    public switch_state(state: u32): void;
+
+    public phantom_set_enemy(object: game_object): void;
+
+    public set_actor_jump_speed(speed: f32): void;
+
+    public set_actor_max_walk_weight(weight: f32): void;
+
+    public set_actor_max_weight(weight: f32): void;
+
+    public set_actor_run_coef(coef: f32): void;
+
+    public set_actor_runback_coef(coef: f32): void;
+
+    public set_actor_sprint_koef(coef: f32): void;
+
+    public set_additional_max_walk_weight(weight: f32): void;
+
+    public set_additional_max_weight(weight: f32): void;
+
+    public set_ammo_type(type: u8): void;
+
+    public set_artefact_bleeding(rate: f32): void;
+
+    public set_artefact_health(rate: f32): void;
+
+    public set_artefact_power(rate: f32): void;
+
+    public set_artefact_radiation(rate: f32): void;
+
+    public set_artefact_satiety(rate: f32): void;
+
+    public set_bone_visible(name: string, a: boolean, b: boolean): void;
+
+    public set_character_icon(icon: string): void;
+
+    public set_health_ex(value: f32): void;
+
+    public set_main_weapon_type(type: u32): void;
+
+    public get_actor_jump_speed(): f32;
+
+    public get_actor_max_walk_weight(): f32;
+
+    public get_actor_max_weight(): f32;
+
+    public get_actor_run_coef(): f32;
+
+    public get_actor_runback_coef(): f32;
+
+    public get_actor_sprint_koef(): f32;
+
+    public get_additional_max_walk_weight(): f32;
+
+    public get_additional_max_weight(): f32;
+
+    public get_anomaly_power(): f32;
+
+    public get_artefact_bleeding(): f32;
+
+    public get_artefact_health(): f32;
+
+    public get_artefact_power(): f32;
+
+    public get_artefact_radiation(): f32;
+
+    public get_artefact_satiety(): f32;
+
+    public get_luminocity(): f32;
+
+    public get_luminocity_hemi(): f32;
+
+    public get_total_weight(): f32;
+
+    public get_attached_vehicle(): game_object;
+
+    public belt_count(): u32;
+
+    public get_main_weapon_type(): u32;
+
+    public get_spatial_type(): u32;
+
+    public get_state(): u32;
+
+    public get_weapon_type(): u32;
+
+    public play_hud_motion(chat: string, bool: boolean, int: u32): u32;
+
+    public attach_vehicle(vehicle: game_object): void;
+
+    public clear_game_news(): void;
+
+    public detach_vehicle(): void;
+
+    public force_set_position(position: vector, bool: boolean): void;
+
+    public get_ammo_count_for_type(type: u8): i32;
   }
+
+  /*
+  * vector<MemorySpace::CNotYetVisibleObject,xalloc<MemorySpace::CNotYetVisibleObject> > not_yet_visible_objects();
+  * vector<MemorySpace::CSoundObject,xalloc<MemorySpace::CSoundObject>> memory_sound_objects();
+  * enum DetailPathManager::EDetailPathType detail_path_type();
+  * enum ETaskState get_task_state(char const*);
+  * enum MonsterSpace::EBodyState body_state();
+  * enum MonsterSpace::EBodyState target_body_state();
+  * enum MonsterSpace::EMentalState mental_state();
+  * enum MonsterSpace::EMentalState target_mental_state();
+  * enum MonsterSpace::EMovementType movement_type();
+  * enum MovementManager::EPathType path_type();
+  * remove_danger();
+  * remove_memory_sound_object();
+  * remove_memory_visible_object();
+  * remove_memory_hit_object();
+  * void iterate_feel_touch(function<void>);
+  * }
+  */
 }

package/types/xr_object/server/xr_server_object.d.ts

@@ -249,9 +249,21 @@ declare module "xray16" {
    * @group xr_object_server
    */
   export class cse_alife_creature_abstract extends cse_alife_dynamic_object_visual {
-    public group: u8;
+    /**
+     * Squad identifier that links squad and parent smart terrain.
+     */
     public squad: u8;
+
+    /**
+     * Team (community) of the object.
+     * Defined in game_relations.ltx -> [game_relations] -> [communities].
+     *
+     * Example: 8 is monster, 9 is stalker, 0 is actor, 4 is freedom
+     */
     public team: u8;
+
+    public group: u8;
+
     /**
      * Object squad id, maximal u16 (65535) if no squad assigned.
      */

package/types/xrf_plugin.d.ts

@@ -0,0 +1,44 @@
+declare global {
+  /**
+   * Utility to get current filename, similar to __filename in nodejs.
+   *
+   * @group xrf_plugin
+   */
+  const $filename: string;
+
+  /**
+   * Utility to transform TS provided array to a lua one.
+   * Just wrapper that is stripped compile time, but simplifies unit testing with TS.
+   *
+   * @group xrf_plugin
+   */
+  function $fromArray<T>(array: Array<T>): LuaTable<number, T>;
+
+  /**
+   * Utility to transform LUA array to JS array.
+   * Just wrapper that is stripped compile time, but simplifies unit testing with TS.
+   *
+   * @group xrf_plugin
+   */
+  function $fromLuaArray<T>(array: LuaTable<number, T>): Array<T>;
+
+  /**
+   * Utility to transform TS provided object to a lua table.
+   * Just wrapper that is stripped compile time, but simplifies unit testing with TS.
+   *
+   * @group xrf_plugin
+   */
+  function $fromObject<K extends string | number, T>(object: Record<K, T>): LuaTable<K, T>;
+  function $fromObject<D>(object: D): LuaTable<keyof D, D[keyof D]>;
+
+  /**
+   * Utility to transform LUA provided table to a TS one.
+   * Just wrapper that is stripped compile time, but simplifies unit testing with TS.
+   *
+   * @group xrf_plugin
+   */
+  function $fromLuaTable<K extends string | number, T>(object: LuaTable<K, T>): Record<K, T>;
+  function $fromLuaTable<D>(object: LuaTable<keyof D, D[keyof D]>): D;
+}
+
+export {};