xray16 1.0.5 → 1.0.7

package/package.json

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

package/types/xr_constant.d.ts

@@ -64,6 +64,9 @@ declare module "xray16" {
     public static readonly detect_anomaly: 11;
     public static readonly get_out_of_anomaly: 10;
     public static readonly property_alife: 3;
+    /**
+     * Whether object is alive.
+     */
     public static readonly property_alive: 0;
     public static readonly property_already_dead: 2;
     public static readonly property_anomaly: 46;
@@ -76,6 +79,9 @@ declare module "xray16" {
     public static readonly property_danger_in_direction: 39;
     public static readonly property_danger_unknown: 38;
     public static readonly property_dead: 1;
+    /**
+     * Whether object has any enemy.
+     */
     public static readonly property_enemy: 7;
     public static readonly property_enemy_critically_wounded: 30;
     public static readonly property_enemy_detoured: 21;
@@ -86,16 +92,30 @@ declare module "xray16" {
     public static readonly property_inside_anomaly: 47;
     public static readonly property_item_can_kill: 11;
     public static readonly property_item_to_kill: 9;
+    /**
+     * Whether object has valuable items to be looted after death.
+     */
     public static readonly property_items: 6;
     public static readonly property_looked_around: 44;
     public static readonly property_looked_out: 19;
+    /**
+     * Whether object should panic.
+     */
     public static readonly property_panic: 17;
     public static readonly property_position_holded: 20;
     public static readonly property_pure_enemy: 23;
+    /**
+     * Whether object has solved zone puzzle.
+     * Originally alife was different and it was end goal of each stalker.
+     * To solve zone puzzle stalkers collected artefacts, did quests etc.
+     */
     public static readonly property_puzzle_solved: 4;
     public static readonly property_ready_to_detour: 14;
     public static readonly property_ready_to_kill: 13;
     public static readonly property_script: 74;
+    /**
+     * Whether object see enemy.
+     */
     public static readonly property_see_enemy: 15;
     public static readonly property_smart_terrain_task: 5;
     public static readonly property_use_crouch_to_look_out: 24;

package/types/xr_global.d.ts

@@ -457,8 +457,23 @@ declare module "xray16" {
     map_add_object_spot(this: void, id: u16, selector: string, hint: string): void;
     map_add_object_spot_ser(this: void, id: u16, str1: string, str2: string): void;
     map_change_spot_hint(this: void, num: u16, selector: string, hint: string): void;
-    map_has_object_spot(this: void, object_id: u16, selector: string): number;
-    map_remove_object_spot(this: void, id: u16, selector: string): void;
+    /**
+     * Checks if object has map spot registered with provided selector.
+     *
+     * @param object_id - game object id to check map spot
+     * @param spot_type - map spot type (icon type to display for the object)
+     * @returns whether object map spot with provided selector is registered
+     */
+    map_has_object_spot(this: void, object_id: u16, spot_type: string): u16;
+    /**
+     * Remove object map spot if it exists.
+     * Checks if map spot is registered and then removes it in such case.
+     * There is no sense in checking object spot before calling removal since action will be duplicated.
+     *
+     * @param object_id - game object id to check map spot
+     * @param spot_type - map spot type (icon type to display for the object)
+     */
+    map_remove_object_spot(this: void, object_id: u16, spot_type: string): void;
     name<T extends string = string>(this: void): T;
     object_by_id(this: void, object_id: u16): game_object | null;
     patrol_path_exists(this: void, path_name: string): boolean;

package/types/xr_lib/xr_fs.d.ts

@@ -206,7 +206,11 @@ declare module "xray16" {
     public w_string(section: string, field: string, string: string, comment?: string): void;
 
     /**
-     * Get file name of ini file.
+     * Get file name and path of ini file.
+     *
+     * @example `f:\applications\steam\steamapps\common\stalker call of pripyat\gamedata\configs\misc\task_manager.ltx`
+     *
+     * @returns full path to ini file
      */
     public fname(): string;
     public set_readonly(is_readonly: boolean): void;

package/types/xr_lib/xr_utils.d.ts

@@ -219,6 +219,11 @@ declare module "xray16" {
     public accessible(value: u32): boolean;
     public accessible(value1: u32, value2: boolean): void;
 
+    /**
+     * Method to iterate over game levels registered in `all.spawn`.
+     *
+     * @returns level abstract object with every iteration
+     */
     public levels(): LuaIterable<cse_abstract>;
   }
 

package/types/xr_object/xr_alife.d.ts

@@ -20,7 +20,14 @@ declare module "xray16" {
     public has_info(object_id: u16, info_id: string): boolean;
     public iterate_objects(cb: (this: void, object: cse_alife_object) => boolean | void): void;
     public level_id(): u32;
-    public level_name<T extends string = string>(value: i32): T;
+    /**
+     * Method to get level name based on level ID.
+     * Easy way to get level is to get it by game vertex ID graph or iterate over all levels in graphs.
+     *
+     * @param level_id - ID of the level
+     * @returns level name based on level ID provided
+     */
+    public level_name<T extends string = string>(level_id: i32): T;
     public release(cse_abstract: cse_alife_object | null, flag: boolean): void;
     public remove_all_restrictions(value: u16, type: i32 /* enum RestrictionSpace::ERestrictorTypes */): void;
     public remove_in_restriction(monster: cse_alife_monster_abstract, value: u16): void;

package/types/xr_object/xr_client_object.d.ts

@@ -923,7 +923,7 @@ declare module "xray16" {
     public section<T extends string = string>(): T;
     public see(game_object: game_object): boolean;
     public see(value: string): boolean;
-    public sell_condition(ini_file: ini_file, value: string): void;
+    public sell_condition(ini_file: ini_file, section: string): void;
     public sell_condition(value1: f32, value2: f32): void;
     public set__force(vector: vector, value1: number, value2: number): void;
     public set_actor_relation_flags(value: flags32): void;
@@ -991,7 +991,7 @@ declare module "xray16" {
     public attachable_item_enabled(): boolean;
     public burer_get_force_gravi_attack(): boolean;
     public burer_get_force_anti_aim(): boolean;
-    public buy_condition(ini_file: ini_file, value: string): void;
+    public buy_condition(ini_file: ini_file, section: string): void;
     public buy_condition(value1: f32, value2: f32): void;
     public change_character_reputation(value: i32): void;
     public change_goodwill(delta_goodwill: i32, to_object: game_object): void;
@@ -1002,7 +1002,13 @@ declare module "xray16" {
     public detail_path_type(): unknown;
     public disable_show_hide_sounds(value: boolean): void;
     public enable_anomaly(): void;
-    public enable_attachable_item(value: boolean): void;
+    /**
+     * Method for inventory items to set them enabled / disabled for stalkers.
+     * As result, medkit or detector can be activated by stalker.
+     *
+     * @param is_enabled - whether item should be enabled for usage by owning object
+     */
+    public enable_attachable_item(is_enabled: boolean): void;
     public enable_talk(): void;
     public enable_trade(): void;
     public enable_vision(value: boolean): void;
@@ -1137,6 +1143,12 @@ declare module "xray16" {
     public set_smart_cover_target_fire_no_lookout(): unknown;
     public set_sound_mask(value: u32): void;
     public set_start_dialog(value: string): void;
+    /**
+     * Set tip text when actor is near and hovering aim over target.
+     * As example, `talk`, `loot` and other kind of labels is possible when using this method.
+     *
+     * @param text - text to set as tip
+     */
     public set_tip_text(text: string): void;
     public set_tip_text_default(): void;
     public set_trader_global_anim(value: string): void;
@@ -1217,8 +1229,16 @@ declare module "xray16" {
     public command(entity_action: entity_action, is_high_priority: boolean): void;
     public hit(hit: hit): void;
     public inactualize_patrol_path(): void;
+    /**
+     * Iterate over game object inventory.
+     * Runs supplied callback for each item in inventory of the object.
+     * If callback returns `true`, the cycle breaks.
+     *
+     * @param cb - callback to run for each item
+     * @param object - target object to run callback for (actually unused by the engine)
+     */
     public iterate_inventory(
-      cb: (this: void, owner: game_object, item: game_object) => void,
+      cb: (this: void, owner: game_object, item: game_object) => void | boolean,
       object: game_object
     ): void;
     public movement_enabled(): boolean;

package/types/xr_object/xr_server_object.d.ts

@@ -238,7 +238,7 @@ declare module "xray16" {
     public g_group(): u8;
     public g_squad(): u8;
     public o_torso(): rotation;
-    public on_death(killer: cse_alife_creature_abstract): void;
+    public on_death(killer: cse_alife_object): void;
     public smart_terrain_id(): u16;
     public kill(): void;
     public force_set_goodwill(goodwill: number, npc_id: number): void;