xray16 1.0.8 → 1.0.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xray16",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "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/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_type.d.ts

@@ -58,6 +58,11 @@ declare module "xray16" {
    */
   type Maybe<T> = T | null | undefined;
 
+  /**
+   * @group xr_type
+   */
+  type AnyObject = Record<string, any>;
+
   /**
    * @group xr_type
    */

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

@@ -178,10 +178,10 @@ declare module "xray16" {
     /**
      * 2 todo;
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["trade_sell_buy_item"],
       cb?: ((this: void, item: game_object, money_direction: boolean, money: number) => void) | null,
-      object?: object_binder | null
+      object?: Maybe<T>
     ): void;
 
     // 3 todo: trade_perform_operation
@@ -189,19 +189,19 @@ declare module "xray16" {
     /**
      * 4 todo;
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["zone_enter"],
       cb?: ((this: void, zone: game_object, object: game_object) => void) | null,
-      object?: object_binder | null
+      object?: Maybe<T>
     ): void;
 
     /**
      * 4 todo;
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["zone_exit"],
       cb?: ((this: void, zone: game_object, object: game_object) => void) | null,
-      object?: object_binder | null
+      object?: Maybe<T>
     ): void;
 
     // 6 todo: level_border_exit
@@ -211,19 +211,19 @@ declare module "xray16" {
     /**
      * 8 todo;
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["death"],
       cb?: (this: void, target: game_object, killer: game_object) => void,
-      object?: object_binder
+      object?: Maybe<T>
     ): void;
 
     /**
      * 9 todo;
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["patrol_path_in_point"],
       cb?: ((this: void, object: game_object, action_type: number, point_index: number) => void) | null,
-      object?: object_binder | null
+      object?: Maybe<T>
     ): void;
 
     // 10 todo: inventory_pda
@@ -231,10 +231,10 @@ declare module "xray16" {
     /**
      * 11 todo:
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["inventory_info"],
       cb?: ((this: void, npc: game_object, info_id: string) => void) | null,
-      object?: object_binder | null
+      object?: Maybe<T>
     ): void;
 
     // 12 todo: article_info
@@ -242,10 +242,10 @@ declare module "xray16" {
     /**
      * 13 todo;
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["task_state"],
       cb?: ((this: void, task: CGameTask, state: TXR_TaskState) => void) | null,
-      object?: object_binder | null
+      object?: Maybe<T>
     ): void;
 
     // 14 todo: map_location_added
@@ -253,21 +253,21 @@ declare module "xray16" {
     /**
      * 15 Use some object.
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["use_object"],
       cb?: ((this: void, object: game_object) => void) | null,
-      object?: object_binder | null
+      object?: Maybe<T>
     ): void;
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["use_object"],
       cb?: ((this: void, object: game_object, who: game_object) => void) | null,
-      object?: object_binder | null
+      object?: Maybe<T>
     ): void;
 
     /**
      * 16 Entity got hit.
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["hit"],
       cb?:
         | ((
@@ -279,13 +279,13 @@ declare module "xray16" {
         bone_id: number
       ) => void)
         | null,
-      object?: object_binder | null
+      object?: Maybe<T>
     ): void;
 
     /**
      * 17 todo;
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["sound"],
       cb?:
         | ((
@@ -297,7 +297,7 @@ declare module "xray16" {
         sound_power: number
       ) => void)
         | null,
-      object?: object_binder | null
+      object?: Maybe<T>
     ): void;
 
     // 18 todo: action_movement
@@ -319,43 +319,43 @@ declare module "xray16" {
     /**
      * 26 todo;
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["helicopter_on_point"],
       cb?: ((this: void, distance: number, current_position: vector, vertex_id: number) => void) | null,
-      object?: object_binder | null
+      object?: Maybe<T>
     ): void;
 
     /**
      * 27 todo;
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["helicopter_on_hit"],
       cb?: ((this: void, damage: number, impulse: number, hit_type: number, who_id: number) => void) | null,
-      object?: object_binder | null
+      object?: Maybe<T>
     ): void;
 
     /**
      * 28 todo;
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["on_item_take"],
       cb?: ((this: void, object: game_object, item: game_object) => void) | null,
-      object?: object_binder | null
+      object?: Maybe<T>
     ): void;
 
     /**
      * 29 todo;
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["on_item_drop"],
       cb?: ((this: void, object: game_object, item: game_object) => void) | null,
-      object?: object_binder | null
+      object?: Maybe<T>
     ): void;
 
     /**
      * 30 todo;
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["script_animation"],
       cb?: ((this: void, skip_multi_anim_check?: boolean) => void) | null,
       object?: object | null
@@ -370,10 +370,10 @@ declare module "xray16" {
     /**
      * 34 todo;
      */
-    public set_callback(
+    public set_callback<T extends AnyObject>(
       type: TXR_callbacks["take_item_from_box"],
       cb?: ((this: void, object: game_object, box: game_object, item: game_object) => void) | null,
-      object?: object_binder | null
+      object?: Maybe<T>
     ): void;
 
     // 35 todo: weapon_no_ammo

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 {};