xray16 1.0.5 → 1.0.8

package/README.md

@@ -1,5 +1,8 @@
 # [📡 XRay-16 engine typescript definitions](https://github.com/xray-forge/xray-16-types)
 
+[![types](https://img.shields.io/badge/docs-types-blue.svg?style=flat)](https://xray-forge.github.io/xray-16-types/index.html)
+[![book](https://img.shields.io/badge/docs-book-blue.svg?style=flat)](https://xray-forge.github.io/stalker-xrf-book)
+<br/>
 [![Node.js CI](https://github.com/xray-forge/xray-16-types/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/xray-forge/xray-16-types/actions/workflows/build_and_test.yml)
 
 X-Ray16 engine bindings documentation and types. <br/>
@@ -19,7 +22,7 @@ Types documentation can be checked [here](https://xray-forge.github.io/xray-16-t
 
 ## 🧱 Usage
 
-Types are used with [xrf template](https://github.com/xray-forge/stalker-xrf-template) and can be referenced as an example.
+Types are used with [xrf template](https://github.com/xray-forge/stalker-xrf-engine) and can be referenced as an example.
 
 ## 🎮 Updating types
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xray16",
-  "version": "1.0.5",
+  "version": "1.0.8",
   "author": "Neloreck",
   "repository": "https://github.com/stalker-xrts/xray-16-types",
   "private": false,
@@ -23,10 +23,11 @@
     "@typescript-eslint/eslint-plugin": "^5.54.0",
     "@typescript-eslint/parser": "^5.54.0",
     "@typescript-to-lua/language-extensions": "1.0.0",
-    "eslint": "^8.35.0",
+    "eslint": "^8.49.0",
     "eslint-config-standard-with-typescript": "^34.0.0",
-    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-jsdoc": "^46.8.0",
     "eslint-plugin-sort-keys-fix": "^1.1.2",
     "prettier": "^3.0.1",
     "typedoc": "^0.24.8",

package/types/index.d.ts

@@ -1,28 +1,52 @@
+import "./xr_ai/xr_action";
+import "./xr_ai/xr_alife";
+import "./xr_ai/xr_enemy_evaluation";
+import "./xr_ai/xr_goap";
+import "./xr_ai/xr_graph";
+import "./xr_ai/xr_memory";
+
+import "./xr_lib/xr_animation";
+import "./xr_lib/xr_bitwise";
+import "./xr_lib/xr_color";
+import "./xr_lib/xr_debug";
+import "./xr_lib/xr_dialog";
+import "./xr_lib/xr_flags";
 import "./xr_lib/xr_fs";
+import "./xr_lib/xr_game";
+import "./xr_lib/xr_hit";
+import "./xr_lib/xr_ini";
+import "./xr_lib/xr_level";
+import "./xr_lib/xr_luabind";
+import "./xr_lib/xr_map";
 import "./xr_lib/xr_math";
-import "./xr_lib/xr_utils";
-import "./xr_map/xr_map";
-import "./xr_object/xr_action";
-import "./xr_object/xr_alife";
-import "./xr_object/xr_anomaly";
-import "./xr_object/xr_artefact";
-import "./xr_object/xr_client_object";
-import "./xr_object/xr_creature";
-import "./xr_object/xr_dialog";
-import "./xr_object/xr_item";
-import "./xr_object/xr_level";
-import "./xr_object/xr_physic";
-import "./xr_object/xr_quest";
-import "./xr_object/xr_server_object";
-import "./xr_online/xr_multiplayer";
-import "./xr_sound/xr_sound";
-import "./xr_type/xr_enums";
-import "./xr_type/xr_type";
+import "./xr_lib/xr_multiplayer";
+import "./xr_lib/xr_properties";
+import "./xr_lib/xr_relation";
+import "./xr_lib/xr_render";
+import "./xr_lib/xr_save";
+import "./xr_lib/xr_sound";
+import "./xr_lib/xr_stats";
+import "./xr_lib/xr_task";
+import "./xr_lib/xr_time";
+import "./xr_lib/xr_type";
+
+import "./xr_object/client/xr_anomaly";
+import "./xr_object/client/xr_artefact";
+import "./xr_object/client/xr_client_object";
+import "./xr_object/client/xr_creature";
+import "./xr_object/client/xr_item";
+import "./xr_object/client/xr_level";
+import "./xr_object/client/xr_physic";
+import "./xr_object/client/xr_zone";
+import "./xr_object/script/xr_script_interface";
+import "./xr_object/script/xr_script_object";
+import "./xr_object/script/xr_script_trade";
+import "./xr_object/server/xr_server_object";
+
+import "./xr_ui/xr_ui_asset";
 import "./xr_ui/xr_ui_core";
+import "./xr_ui/xr_ui_event";
 import "./xr_ui/xr_ui_interface";
-import "./xr_constant";
-import "./xr_core";
-import "./xr_luabind";
-import "./xr_global";
+import "./xr_ui/xr_ui_menu";
 
 declare module "xray16" {}

package/types/{xr_object → xr_ai}/xr_action.d.ts

@@ -1,20 +1,27 @@
 declare module "xray16" {
   /**
-   * @source C++ class world_state
-   * @customConstructor world_state
+   * @source C++ class MonsterSpace
+   * @customConstructor MonsterSpace
    * @group xr_action
    */
-  export class world_state extends EngineBinding {
-    public constructor();
-    public constructor(world_state: world_state);
-
-    public add_property(world_property: world_property): void;
-    public clear(): void;
-    public includes(world_state: world_state): boolean;
-    public property(value: u32): world_property;
-    public remove_property(value: u32): void;
+  export class MonsterSpace {
+    public static readonly head_anim_angry: 1;
+    public static readonly head_anim_glad: 2;
+    public static readonly head_anim_kind: 3;
+    public static readonly head_anim_normal: 0;
+    public static readonly sound_script: 128;
   }
 
+  /**
+   * @group xr_action
+   */
+  export type TXR_MonsterBodyStateKey = EnumeratedStaticsKeys<typeof MonsterSpace>;
+
+  /**
+   * @group xr_action
+   */
+  export type TXR_MonsterBodyState = EnumeratedStaticsValues<typeof MonsterSpace>;
+
   /**
    * @source C++ class entity_action
    * @customConstructor entity_action
@@ -22,24 +29,38 @@ declare module "xray16" {
    */
   export class entity_action extends EngineBinding {
     public constructor();
-    public constructor(entity: entity_action);
+    public constructor(action: entity_action);
 
     public set_action(move: move): void;
+
     public set_action(look: look): void;
+
     public set_action(anim: anim): void;
+
     public set_action(sound: sound): void;
+
     public set_action(particle: particle): void;
+
     public set_action(objec: XR_object): void;
+
     public set_action(cond: cond): void;
 
     public move(): boolean;
+
     public particle(): boolean;
+
     public completed(): boolean;
+
     public object(): boolean;
+
     public all(): boolean;
+
     public time(): boolean;
+
     public look(): boolean;
+
     public sound(): boolean;
+
     public anim(): boolean;
   }
 
@@ -48,6 +69,55 @@ declare module "xray16" {
    */
   export type TXR_entity_action = move | look | anim | sound | particle | XR_object | cond;
 
+  /**
+   * @source C++ class object
+   * @customConstructor object
+   * @group xr_action
+   */
+  export class XR_object extends EngineBinding {
+    public static readonly activate: 16;
+    public static readonly aim1: 4;
+    public static readonly aim2: 5;
+    public static readonly deactivate: 17;
+    public static readonly drop: 11;
+    public static readonly dummy: -1;
+    public static readonly fire1: 6;
+    public static readonly fire2: 8;
+    public static readonly hide: 22;
+    public static readonly idle: 9;
+    public static readonly reload: 2;
+    public static readonly reload1: 2;
+    public static readonly reload2: 3;
+    public static readonly show: 21;
+    public static readonly strap: 10;
+    public static readonly switch1: 0;
+    public static readonly switch2: 1;
+    public static readonly take: 23;
+    public static readonly turn_off: 20;
+    public static readonly turn_on: 19;
+    public static readonly use: 18;
+
+    public constructor(value: string);
+    public constructor(value: string, type: number /* MonsterSpace::EObjectAction */);
+    public constructor(game_object: game_object);
+
+    public action(space: unknown /** enum MonsterSpace::EObjectAction */): void;
+
+    public completed(): boolean;
+  }
+
+  /**
+   * @group xr_action
+   */
+  export type TXR_object_action = EnumeratedStaticsValues<typeof XR_object>;
+
+  /**
+   * Note: typescript workaround since global type `object` is reserved.
+   *
+   * @group xr_global_declaration
+   */
+  export const object: typeof XR_object;
+
   /**
    * @source C++ class move
    * @customConstructor move
@@ -127,12 +197,19 @@ declare module "xray16" {
     public constructor(moveAction: TXR_move, game_object: game_object, value: number, speedParam: unknown);
 
     public completed(): boolean;
+
     public path(EDetailPathType: number): void;
+
     public move(EMovementType: number): void;
+
     public position(vector: vector): void;
+
     public input(EInputKeys: number): void;
+
     public patrol(patrolPath: unknown, shared_str: string): void;
+
     public object(game_object: game_object): void;
+
     public body(EBodyState: number): void;
   }
 
@@ -159,12 +236,13 @@ declare module "xray16" {
     public static readonly next: 4;
     public static readonly dummy: -1;
 
-    public constructor(name: string);
-    public constructor(name: string);
-    public constructor(name: string, startType: TXR_patrol_type);
-    public constructor(name: string, startType: TXR_patrol_type, routeType: TXR_patrol_type);
-    public constructor(name: string, startType: TXR_patrol_type, routeType: TXR_patrol_type, bool: boolean);
-    public constructor(name: string, startType: TXR_patrol_type, routeType: TXR_patrol_type, bool: boolean, int: u32);
+    public constructor(
+      name?: string,
+      startType?: TXR_patrol_type,
+      routeType?: TXR_patrol_type,
+      bool?: boolean,
+      int?: u32
+    );
 
     public count(): u32;
     public flag(value1: u32, value2: u8): boolean;
@@ -184,6 +262,38 @@ declare module "xray16" {
    */
   export type TXR_patrol_type = EnumeratedStaticsValues<typeof patrol>;
 
+  /**
+   * @source C++ class CSightParams
+   * @customConstructor XR_CSightParams
+   * @group xr_action
+   */
+  export class CSightParams {
+    public static readonly eSightTypeDummy: -1;
+    public static readonly eSightTypeCurrentDirection: 0;
+    public static readonly eSightTypePathDirection: 1;
+    public static readonly eSightTypeDirection: 2;
+    public static readonly eSightTypePosition: 3;
+    public static readonly eSightTypeObject: 4;
+    public static readonly eSightTypeCover: 5;
+    public static readonly eSightTypeSearch: 6;
+    public static readonly eSightTypeLookOver: 7;
+    public static readonly eSightTypeCoverLookOver: 8;
+    public static readonly eSightTypeFireObject: 9;
+    public static readonly eSightTypeFirePosition: 10;
+    public static readonly eSightTypeAnimationDirection: 11;
+
+    public readonly m_object: game_object;
+    public readonly m_sight_type: TXR_SightType;
+    public readonly m_vector: vector;
+
+    public constructor();
+  }
+
+  /**
+   * @group xr_action
+   */
+  export type TXR_SightType = EnumeratedStaticsValues<typeof CSightParams>;
+
   /**
    * @source C++ class look
    * @customConstructor look
@@ -297,11 +407,17 @@ declare module "xray16" {
     public constructor(value1: string, value2: string, type: unknown /* enum MonsterSpace::EMonsterHeadAnimType */);
 
     public set_sound(value: string): void;
+
     public set_sound(sound_object: sound_object): void;
+
     public set_position(vector: vector): void;
+
     public set_bone(value: string): void;
+
     public set_angles(vector: vector): void;
+
     public set_sound_type(type: unknown /* ESoundTypes */): void;
+
     public completed(): boolean;
   }
 
@@ -340,143 +456,55 @@ declare module "xray16" {
   export type TXR_cond = EnumeratedStaticsValues<typeof cond>;
 
   /**
-   * @source C++ class action_base
-   * @customConstructor action_base
+   * @source C++ class act
+   * @customConstructor act
    * @group xr_action
    */
-  export class action_base extends EngineBinding {
-    public readonly object: game_object;
-    public readonly storage: property_storage;
+  export class act {
+    public static readonly attack: 2;
+    public static readonly eat: 1;
+    public static readonly panic: 3;
+    public static readonly rest: 0;
 
     public constructor();
-    public constructor(object: game_object | null);
-    public constructor(object: game_object | null, value: string);
-
-    public finalize(): void;
-    public add_precondition(world_property: world_property): void;
-    public execute(): void;
-    public remove_precondition(id: u32): void;
-    public setup(object: game_object, property_storage: property_storage): void;
-    public set_weight(weight: u16): void;
-    public add_effect(world_property: world_property): void;
-
-    /**
-     * With mixed / debug build allows investigation of evaluators and actions matches.
-     * Helps to debug custom actions and actions pre-conditions with state printing in log files.
-     *
-     * Note: Available only in mixed / debug engine builds, not for direct usage from lua.
-     */
-    public show(value?: string): void;
-    public initialize(): void;
-    public remove_effect(id: u32): void;
+    public constructor(EScriptMonsterGlobalAction: number);
+    public constructor(EScriptMonsterGlobalAction: number, game_object: game_object);
   }
 
   /**
-   * @source C++ class action_planner
-   * @customConstructor action_planner
+   * @source C++ class particle_params
+   * @customConstructor particle_params
    * @group xr_action
    */
-  export class action_planner extends EngineBinding {
-    public readonly object: game_object;
-    public readonly storage: property_storage;
-
+  export class particle_params {
     public constructor();
-
-    /**
-     * @returns whether object action planner is already initialized
-     */
-    public initialized(): boolean;
-    public remove_action(value: u32): void;
-    public action(value: u32): action_base;
-    public add_action(value: u64, action_base: action_base): void;
-    public update(): void;
-    public clear(): void;
-    public evaluator(value: u32): property_evaluator;
-    public setup(game_object: game_object): void;
-    public set_goal_world_state(world_state: world_state): void;
-    public current_action(): action_base;
-    public add_evaluator(id: u32, property_evaluator: property_evaluator): void;
-    public remove_evaluator(value: u32): void;
-    public current_action_id(): u32;
-    public actual(): boolean;
-
-    public show(char: string): void;
-  }
-
-  /**
-   * @source C++ class planner_action : action_planner,action_base
-   * @customConstructor planner_action
-   * @group xr_action
-   */
-  export class planner_action extends action_planner {
-    public constructor(game_object?: game_object, value?: string);
-
-    public add_effect(world_property: world_property): unknown;
-    public add_precondition(world_property: world_property): void;
-    public execute(): unknown;
-    public finalize(): void;
-    public initialize(): void;
-    public remove_effect(id: number): void;
-    public remove_precondition(id: number): unknown;
-    public set_weight(weight: number): unknown;
-    public weight(world_state1: world_state, world_state2: world_state): u16;
+    public constructor(first?: vector, second?: vector, third?: vector);
   }
 
   /**
-   * Storage of object evaluators cached state for handling of in-game logic.
-   *
-   * @source C++ class property_storage
-   * @customConstructor property_storage
+   * @source C++ class particle
+   * @customConstructor particle
    * @group xr_action
    */
-  export class property_storage extends EngineBinding {
-    /**
-     * Get property evaluator value by ID.
-     *
-     * @param value - evaluator property ID
-     * @returns evaluation value
-     * @throws if property is not declared in storage
-     */
-    public property(value: u32): boolean;
-
-    public set_property(value1: u32, value2: boolean): void;
-  }
+  export class particle extends EngineBinding {
+    public constructor(particle_to_run: string, particle_params?: particle_params, auto_remove?: boolean);
+    public constructor(
+      particle_to_run: string,
+      bone_name: string,
+      particle_params: particle_params,
+      auto_remove: boolean
+    );
 
-  /**
-   * @source C++ class property_evaluator
-   * @customConstructor property_evaluator
-   * @group xr_action
-   */
-  export class property_evaluator extends EngineBinding {
-    public readonly object: game_object;
-    public readonly storage: property_storage;
+    public completed(): boolean;
 
-    public constructor();
-    public constructor(game_object: game_object | null);
-    public constructor(game_object: game_object | null, name: string);
+    public set_angles(vector: vector): void;
 
-    public evaluate(): boolean;
-    public setup(game_object: game_object, property_storage: property_storage): void;
-  }
+    public set_bone(bone_id: string): void;
 
-  /**
-   * @source C++ class property_evaluator_const : property_evaluator
-   * @customConstructor property_evaluator_const
-   * @group xr_action
-   */
-  export class property_evaluator_const extends property_evaluator {
-    public constructor(value: boolean);
-  }
+    public set_particle(value1: string, value2: boolean): void;
 
-  /**
-   * @source C++ class world_property
-   * @customConstructor world_property
-   * @group xr_action
-   */
-  export class world_property extends EngineBinding {
-    public constructor(id: u32, enabled: boolean);
+    public set_position(vector: vector): void;
 
-    public value(): boolean;
-    public condition(): u32;
+    public set_velocity(vector: vector): void;
   }
 }