xray16 1.0.1 → 1.0.3

package/README.md

@@ -41,7 +41,7 @@ Class declaration registers table as userdata and adds constructor/destructor me
 ### Typescript
 
 <p>
-In TS codebase '@LuabindClass' decorator can be used to modify transformation and enable virtual calls. <br/>
+In TS codebase 'LuabindClass' decorator can be used to modify transformation and enable virtual calls. <br/>
 Separate transformer is needed to build luabind classes instead of table-based classes.
 </p>
 
@@ -61,7 +61,7 @@ Separate transformer is needed to build luabind classes instead of table-based c
 Package includes plugins for typescript-to-lua for easier work with xray16 typings. <br/>
 Following ones are available:
 
-- transform_luabind_class - transforms @LuaBind declared classes in a specific way
+- transform_luabind_class - transforms LuaBind decorated classes in a specific way
 - built_at_info - adds build information in resulting files
 - from_cast_utils - additional utils that should be removed in runtime
 - global_declarations_transform - transforms xray16 imports and removes them from runtime
@@ -74,12 +74,12 @@ Plugins can be included in tsconfig file as following:
 {
   "tstl": {
     "luaPlugins": [
-      { "name": "xray16/plugins/transform_luabind_class/plugin.ts" },
-      { "name": "xray16/plugins/global_declarations_transform.ts" },
-      { "name": "xray16/plugins/built_at_info.ts" },
-      { "name": "xray16/plugins/strip_lua_logger.ts" },
-      { "name": "xray16/plugins/inject_filename.ts" },
-      { "name": "xray16/plugins/from_cast_utils.ts" }
+      { "name": "xray16/plugins/transform_luabind_class/plugin" },
+      { "name": "xray16/plugins/global_declarations_transform" },
+      { "name": "xray16/plugins/built_at_info" },
+      { "name": "xray16/plugins/strip_lua_logger" },
+      { "name": "xray16/plugins/inject_filename" },
+      { "name": "xray16/plugins/from_cast_utils" }
     ]
   }
 }

package/package.json

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

package/types/index.d.ts

@@ -25,39 +25,4 @@ import "./xr_core";
 import "./xr_luabind";
 import "./xr_global";
 
-declare module "xray16" {
-  /**
-   * @group export
-   */
-  export const actor_stats: IXR_actor_stats;
-
-  /**
-   * @group export
-   */
-  export const ActorMenu: IXR_ActorMenu;
-
-  /**
-   * @group export
-   */
-  export const game: IXR_game;
-
-  /**
-   * @group export
-   */
-  export const level: IXR_level;
-
-  /**
-   * @group export
-   */
-  export const main_menu: IXR_main_menu;
-
-  /**
-   * @group export
-   */
-  export const object: typeof XR_object;
-
-  /**
-   * @group export
-   */
-  export const relation_registry: IXR_relation_registry;
-}
+declare module "xray16" {}

package/types/xr_global.d.ts

@@ -610,4 +610,39 @@ declare module "xray16" {
     active_tutorial_name(this: void): string;
     stop_tutorial(this: void): void;
   }
+
+  /**
+   * @group xr_global
+   */
+  export const actor_stats: IXR_actor_stats;
+
+  /**
+   * @group xr_global
+   */
+  export const ActorMenu: IXR_ActorMenu;
+
+  /**
+   * @group xr_global
+   */
+  export const game: IXR_game;
+
+  /**
+   * @group xr_global
+   */
+  export const level: IXR_level;
+
+  /**
+   * @group xr_global
+   */
+  export const main_menu: IXR_main_menu;
+
+  /**
+   * @group xr_global
+   */
+  export const object: typeof XR_object;
+
+  /**
+   * @group xr_global
+   */
+  export const relation_registry: IXR_relation_registry;
 }

package/types/xr_lib/xr_fs.d.ts

@@ -219,7 +219,14 @@ declare module "xray16" {
      * @param should_save - whether ini file should be saved when destructor is called
      */
     public save_at_end(should_save: boolean): void;
-    public section_for_each(cb: (name: string) => void): void;
+
+    /**
+     * Iterate over ini file sections.
+     * Calls provided callback for each ini section in file.
+     *
+     * @param cb - callback to call on each ini file section, where name is section name
+     */
+    public section_for_each(cb: (this: void, name: string) => void): void;
   }
 
   /**

package/types/xr_object/xr_client_object.d.ts

@@ -26,6 +26,8 @@ declare module "xray16" {
   }
 
   /**
+   * Class to link client side object implementation and wrap it with custom lua side logics.
+   *
    * @source C++ class object_binder
    * @customConstructor object_binder
    * @group xr_client_object
@@ -253,7 +255,7 @@ declare module "xray16" {
      */
     public set_callback(
       type: TXR_callbacks["trade_sell_buy_item"],
-      cb?: ((item: game_object, money_direction: boolean, money: number) => void) | null,
+      cb?: ((this: void, item: game_object, money_direction: boolean, money: number) => void) | null,
       object?: object_binder | null
     ): void;
 
@@ -264,7 +266,7 @@ declare module "xray16" {
      */
     public set_callback(
       type: TXR_callbacks["zone_enter"],
-      cb?: ((zone: game_object, object: game_object) => void) | null,
+      cb?: ((this: void, zone: game_object, object: game_object) => void) | null,
       object?: object_binder | null
     ): void;
 
@@ -273,7 +275,7 @@ declare module "xray16" {
      */
     public set_callback(
       type: TXR_callbacks["zone_exit"],
-      cb?: ((zone: game_object, object: game_object) => void) | null,
+      cb?: ((this: void, zone: game_object, object: game_object) => void) | null,
       object?: object_binder | null
     ): void;
 
@@ -286,7 +288,7 @@ declare module "xray16" {
      */
     public set_callback(
       type: TXR_callbacks["death"],
-      cb?: (target: game_object, killer: game_object) => void,
+      cb?: (this: void, target: game_object, killer: game_object) => void,
       object?: object_binder
     ): void;
 
@@ -295,7 +297,7 @@ declare module "xray16" {
      */
     public set_callback(
       type: TXR_callbacks["patrol_path_in_point"],
-      cb?: ((object: game_object, action_type: number, point_index: number) => void) | null,
+      cb?: ((this: void, object: game_object, action_type: number, point_index: number) => void) | null,
       object?: object_binder | null
     ): void;
 
@@ -306,7 +308,7 @@ declare module "xray16" {
      */
     public set_callback(
       type: TXR_callbacks["inventory_info"],
-      cb?: ((npc: game_object, info_id: string) => void) | null,
+      cb?: ((this: void, npc: game_object, info_id: string) => void) | null,
       object?: object_binder | null
     ): void;
 
@@ -317,7 +319,7 @@ declare module "xray16" {
      */
     public set_callback(
       type: TXR_callbacks["task_state"],
-      cb?: ((task: CGameTask, state: TXR_TaskState) => void) | null,
+      cb?: ((this: void, task: CGameTask, state: TXR_TaskState) => void) | null,
       object?: object_binder | null
     ): void;
 
@@ -328,12 +330,12 @@ declare module "xray16" {
      */
     public set_callback(
       type: TXR_callbacks["use_object"],
-      cb?: ((object: game_object) => void) | null,
+      cb?: ((this: void, object: game_object) => void) | null,
       object?: object_binder | null
     ): void;
     public set_callback(
       type: TXR_callbacks["use_object"],
-      cb?: ((object: game_object, who: game_object) => void) | null,
+      cb?: ((this: void, object: game_object, who: game_object) => void) | null,
       object?: object_binder | null
     ): void;
 
@@ -342,7 +344,16 @@ declare module "xray16" {
      */
     public set_callback(
       type: TXR_callbacks["hit"],
-      cb?: ((object: game_object, damage: number, direction: vector, who: game_object, bone_id: number) => void) | null,
+      cb?:
+        | ((
+            this: void,
+            object: game_object,
+            damage: number,
+            direction: vector,
+            who: game_object,
+            bone_id: number
+          ) => void)
+        | null,
       object?: object_binder | null
     ): void;
 
@@ -385,7 +396,7 @@ declare module "xray16" {
      */
     public set_callback(
       type: TXR_callbacks["helicopter_on_point"],
-      cb?: ((distance: number, current_position: vector, vertex_id: number) => void) | null,
+      cb?: ((this: void, distance: number, current_position: vector, vertex_id: number) => void) | null,
       object?: object_binder | null
     ): void;
 
@@ -394,7 +405,7 @@ declare module "xray16" {
      */
     public set_callback(
       type: TXR_callbacks["helicopter_on_hit"],
-      cb?: ((damage: number, impulse: number, hit_type: number, who_id: number) => void) | null,
+      cb?: ((this: void, damage: number, impulse: number, hit_type: number, who_id: number) => void) | null,
       object?: object_binder | null
     ): void;
 
@@ -403,7 +414,7 @@ declare module "xray16" {
      */
     public set_callback(
       type: TXR_callbacks["on_item_take"],
-      cb?: ((npc: game_object, item: game_object) => void) | null,
+      cb?: ((this: void, object: game_object, item: game_object) => void) | null,
       object?: object_binder | null
     ): void;
 
@@ -412,7 +423,7 @@ declare module "xray16" {
      */
     public set_callback(
       type: TXR_callbacks["on_item_drop"],
-      cb?: ((npc: game_object, item: game_object) => void) | null,
+      cb?: ((this: void, object: game_object, item: game_object) => void) | null,
       object?: object_binder | null
     ): void;
 
@@ -421,7 +432,7 @@ declare module "xray16" {
      */
     public set_callback(
       type: TXR_callbacks["script_animation"],
-      cb?: ((skip_multi_anim_check?: boolean) => void) | null,
+      cb?: ((this: void, skip_multi_anim_check?: boolean) => void) | null,
       object?: object | null
     ): void;
 
@@ -436,7 +447,7 @@ declare module "xray16" {
      */
     public set_callback(
       type: TXR_callbacks["take_item_from_box"],
-      cb?: ((npc: game_object, box: game_object, item: game_object) => void) | null,
+      cb?: ((this: void, object: game_object, box: game_object, item: game_object) => void) | null,
       object?: object_binder | null
     ): void;
 

package/types/xr_object/xr_server_object.d.ts

@@ -329,6 +329,8 @@ declare module "xray16" {
   export class cse_alife_item_weapon_magazined extends cse_alife_item_weapon {}
 
   /**
+   * Base class for magazined weapons with grenade launcher.
+   *
    * @source C++ class cse_alife_item_weapon_magazined_w_gl : cse_alife_item_weapon_magazined
    * @customConstructor cse_alife_item_weapon_magazined_w_gl
    * @group xr_server_object