xray16 1.0.7 → 1.0.8

package/types/xr_lib/xr_ini.d.ts

@@ -0,0 +1,176 @@
+declare module "xray16" {
+  /**
+   * Implementation of streaming ini file container.
+   * Allows reading / writing field in file by section/field.
+   *
+   * Supports custom extension with section overriding and custom `#include` statements.
+   *
+   * @source C++ class ini_file
+   * @customConstructor ini_file
+   * @group xr_ini
+   */
+  export class ini_file {
+    public constructor();
+    /**
+     * Create ini file representation based on file name.
+     * Full path is limited to 520 chars.
+     *
+     * @param path - file name and relative path to gamedata configs folder
+     */
+    public constructor(path: string);
+    /**
+     * Create ini file representation based on file name.
+     * Full path is limited to 520 chars.
+     *
+     * @param initial - base to count relative path from, `$game_data$` is an example
+     * @param path - file name and relative path from initial entrypoint
+     */
+    public constructor(initial: string, path: string);
+
+    /**
+     * @param section - target section to check lines count
+     * @returns count of lines for provided section
+     */
+    public line_count(section: string): u32;
+
+    /**
+     * @returns sections count for ini file
+     */
+    public section_count(): u32;
+
+    /**
+     * Remove ini file section field.
+     *
+     * @param section - target section to modify
+     * @param field - target section field to remove
+     */
+    public remove_line(section: string, field: string): void;
+
+    public r_bool(section: string, field: string): boolean;
+
+    public section_exist(section: string | null): boolean;
+
+    public r_float(section: string, field: string): f32;
+
+    public r_clsid(section: string, field: string): i32;
+
+    public r_s32(section: string, field: string): i32;
+
+    /**
+     * Read text line from ini config file.
+     *
+     * @returns tuple with three elements, where first is success status, second is key, third is value.
+     */
+    public r_line<T extends string = string, P extends string = string>(
+      section: string,
+      line_number: i32,
+      c: string,
+      d: string
+    ): LuaMultiReturn<[boolean, T, P]>;
+
+    public r_token(section: string, field: string, list: token_list): i32;
+
+    public r_vector(section: string, field: string): vector;
+
+    public r_u32(section: string, field: string): u32;
+
+    public r_string_wq(section: string, field: string): string;
+
+    public r_string(section: string, field: string): string;
+
+    /**
+     * Check if line exists in the file by section and field.
+     *
+     * @param section - target section to check
+     * @param field - section field to check
+     * @returns whether line exists
+     */
+    public line_exist(section: string | null, field: string): boolean;
+
+    public w_fvector2(section: string, field: string, vector: vector2, comment?: string): void;
+
+    public w_fvector3(section: string, field: string, vector: vector, comment?: string): void;
+
+    public w_fvector4(section: string, field: string, vector: never, comment?: string): void; // struct _vector4<float>
+
+    public w_fcolor(section: string, field: string, color: fcolor, comment?: string): void;
+
+    public w_color(section: string, field: string, color: u32, comment?: string): void;
+
+    public w_bool(section: string, field: string, bool: boolean, comment?: string): void;
+
+    public w_s8(section: string, field: string, uchar: u8, comment?: string): void;
+
+    public w_u8(section: string, field: string, uchar: u8, comment?: string): void;
+
+    public w_s16(section: string, field: string, sshort: i16, comment?: string): void;
+
+    public w_u16(section: string, field: string, ushort: u16, comment?: string): void;
+
+    public w_s32(section: string, field: string, sint: i32, comment?: string): void;
+
+    public w_u32(section: string, field: string, uint: u32, comment?: string): void;
+
+    public w_s64(section: string, field: string, sint: i64, comment?: string): void;
+
+    public w_u64(section: string, field: string, uint: u64, comment?: string): void;
+
+    public w_float(section: string, field: string, float: f32, comment?: string): void;
+
+    public w_string(section: string, field: string, string: string, comment?: string): void;
+
+    /**
+     * 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;
+
+    public set_override_names(override: boolean): void;
+
+    public save_as(path: string): boolean;
+
+    /**
+     * Adjust saving on file closing/destructor calls.
+     *
+     * @param should_save - whether ini file should be saved when destructor is called
+     */
+    public save_at_end(should_save: boolean): 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;
+  }
+
+  /**
+   * Create ini file instance based on provided string content.
+   *
+   * @group xr_ini
+   * @param content - string value to be read as ini file
+   * @returns new ini file instance based on provided content
+   */
+  export function create_ini_file(this: void, content: string): ini_file;
+
+  /**
+   * @group xr_ini
+   */
+  export function game_ini(this: void): ini_file;
+
+  /**
+   * @group xr_ini
+   */
+  export function system_ini(this: void): ini_file;
+
+  /**
+   * @group xr_ini
+   */
+  export function reload_system_ini(this: void): ini_file;
+}

package/types/xr_lib/xr_level.d.ts

@@ -0,0 +1,225 @@
+declare module "xray16" {
+  /**
+   * @source namespace level
+   * @group xr_level
+   */
+  export interface IXR_level {
+    add_call(this: void, cb1: (this: void) => boolean, cb2: (this: void) => boolean): void;
+
+    add_call(this: void, object: object, cb1: (this: void) => boolean, cb2: (this: void) => boolean): void;
+
+    add_call(this: void, object: object, str1: string, str2: string): void;
+
+    add_cam_effector(this: void, effect: string, id: i32, is_cyclic: boolean, callback: string): void;
+
+    add_cam_effector2(this: void, effect: string, id: i32, is_cyclic: boolean, callback: string, camera_fov: f32): void;
+
+    add_complex_effector(this: void, section: string, id: i32): void;
+
+    add_dialog_to_render(this: void, window: CUIDialogWnd): void;
+
+    add_pp_effector(this: void, fn: string, id: i32, is_cyclic: boolean): void;
+
+    /**
+     * Move time forward based on provided parameters.
+     *
+     * @param days - days to move forward
+     * @param hours - hours to move forward
+     * @param minutes - minutes to move forward
+     */
+    change_game_time(this: void, days: u32, hours: u32, minutes: u32): void;
+
+    check_object(this: void, object: game_object): void;
+
+    client_spawn_manager(this: void): client_spawn_manager;
+
+    debug_actor(this: void): game_object;
+
+    debug_object(this: void, str: string): game_object;
+
+    disable_input(this: void): void;
+
+    enable_input(this: void): void;
+
+    environment(this: void): unknown /* XR_CEnvironment */;
+
+    /**
+     * @returns current game state ID.
+     */
+    game_id(this: void): TXR_EGameID;
+
+    get_active_cam(this: void): u8;
+
+    get_bounding_volume(this: void): Fbox;
+
+    get_game_difficulty(this: void): TXR_game_difficulty;
+
+    get_snd_volume(this: void): f32;
+
+    /**
+     * Get object target distance aimed by crosshair.
+     */
+    get_target_dist(this: void): f32;
+
+    get_target_element(this: void): u32;
+
+    /**
+     * Get object target aimed by crosshair.
+     */
+    get_target_obj(this: void): game_object | null;
+
+    get_time_days(this: void): u32;
+
+    get_time_factor(this: void): f32;
+
+    /**
+     * @returns current hours time number
+     */
+    get_time_hours(this: void): u32;
+
+    /**
+     * @returns current minutes time number
+     */
+    get_time_minutes(this: void): u32;
+
+    get_weather(this: void): string;
+
+    get_wfx_time(this: void): f32;
+
+    hide_indicators(this: void): void;
+
+    hide_indicators_safe(this: void): void;
+
+    high_cover_in_direction(this: void, num: u32, vector: vector): f32;
+
+    is_wfx_playing(this: void): boolean;
+
+    iterate_online_objects(this: void, cb: (this: void, object: game_object) => void | boolean): void;
+
+    iterate_sounds(this: void, str: string, num: u32, cb: (this: void) => void): void;
+
+    iterate_sounds(this: void, str: string, num: u32, object: object, cb: (this: void) => void): void;
+
+    low_cover_in_direction(this: void, num: u32, vector: vector): f32;
+
+    main_input_receiver(this: void): CUIDialogWnd;
+
+    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;
+
+    /**
+     * 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;
+
+    physics_world(this: void): physics_world;
+
+    prefetch_sound(this: void, str: string): void;
+
+    /**
+     * @returns whether game level is loaded
+     */
+    present(this: void): boolean;
+
+    /**
+     * @returns intensity of rain, 0 if no rain active
+     */
+    rain_factor(this: void): f32;
+
+    remove_call(this: void, cb1: (this: void) => boolean, cb2: (this: void) => void): void;
+
+    remove_call(this: void, object: object, cb1: (this: void) => boolean, cb2: (this: void) => void): void;
+
+    remove_call(this: void, object: object, str1: string, str2: string): void;
+
+    remove_calls_for_object(this: void, object: object): void;
+
+    remove_cam_effector(this: void, id: i32): void;
+
+    remove_complex_effector(this: void, id: i32): void;
+
+    remove_dialog_to_render(this: void, window: CUIDialogWnd): void;
+
+    remove_pp_effector(this: void, id: i32): void;
+
+    send(net_packet: net_packet, bool1: boolean, bool2: boolean, bool3: boolean, bool4: boolean): void;
+
+    set_active_cam(this: void, id: u8): void;
+
+    set_game_difficulty(this: void, difficulty: unknown /* enum ESingleGameDifficulty */): void;
+
+    set_pp_effector_factor(this: void, id: i32, f: f32, f_sp?: f32): void;
+
+    set_snd_volume(this: void, num: f32): void;
+
+    set_time_factor(this: void, factor: f32): void;
+
+    /**
+     * Change active game weather.
+     *
+     * @param weather_name - name of weather config to apply (gamedata\configs\environment\weathers)
+     * @param is_forced - whether weather change should be forced
+     */
+    set_weather(this: void, weather_name: string, is_forced: boolean): void;
+
+    set_weather_fx(this: void, weather_fs_name: string): boolean;
+
+    show_indicators(this: void): void;
+
+    show_weapon(this: void, val: boolean): void;
+
+    spawn_item(this: void, str: string, vector: vector, uint: u32, ushort: u16, bool: boolean): void;
+
+    spawn_phantom(this: void, vector: vector): void;
+
+    start_stop_menu(this: void, dialog: CUIDialogWnd, bool: boolean): void;
+
+    start_weather_fx_from_time(this: void, str: string, num: f32): boolean;
+
+    stop_weather_fx(this: void): void;
+
+    vertex_id(this: void, vector: vector): u32;
+
+    vertex_in_direction(this: void, num1: u32, vector: vector, num2: f32): u32;
+
+    vertex_position(this: void, id: u32): vector;
+
+    ray_pick(
+      this: void,
+      vec: vector,
+      vec2: vector,
+      fl: f32,
+      enumc: unknown,
+      rqres: unknown,
+      gobj: game_object
+    ): boolean;
+  }
+
+  /**
+   * @group xr_level
+   */
+  export const level: IXR_level;
+}

package/types/xr_lib/xr_luabind.d.ts

@@ -0,0 +1,59 @@
+declare module "xray16" {
+  /**
+   * Base for bindings brought from LuaBind library.
+   * Includes base methods implemented with @LuabindClass decorator and overriding of operators.
+   *
+   * @source luabind
+   * @group xr_luabind
+   */
+  export class EngineBinding {
+    /**
+     * Name of luabind class constructor.
+     */
+    public static readonly __name: string;
+
+    /**
+     * Name of luabind class instance constructor.
+     */
+    public readonly __name: string;
+  }
+
+  /**
+   * @group xr_luabind
+   */
+  type TEngineBindingStaticMethods = keyof typeof EngineBinding;
+
+  /**
+   * Decorator to mark classes as luabind transformed.
+   * Marked classes will be declared using luabind tools instead of default typescript-to-lua approach.
+   * Luabind variant is less flexible and has many limitations,
+   * but allows extension of engine exported classes and virtual methods.
+   *
+   * @group xr_luabind
+   * @returns class decorator to mark class as luabind implementation
+   */
+  export function LuabindClass(): ClassDecorator;
+
+  /**
+   * @source C++ class class_info_data
+   * @customConstructor class_info_data
+   * @group xr_luabind
+   */
+  export class class_info_data extends EngineBinding {
+    public readonly methods: object;
+    public readonly attributes: object;
+    public readonly name: string;
+
+    private constructor();
+  }
+
+  /**
+   * @group xr_luabind
+   */
+  export function class_names(this: void, lua_state: unknown /* lua_State*/): object;
+
+  /**
+   * @group xr_luabind
+   */
+  export function class_info(this: void, target: unknown): class_info_data;
+}

package/types/{xr_map → xr_lib}/xr_map.d.ts

@@ -8,7 +8,9 @@ declare module "xray16" {
     public constructor();
 
     public RemoveMapLocationByObjectID(id: u16): void;
+
     public RemoveMapLocation(spot_type: string, id: u16): void;
+
     public DisableAllPointers(): void;
   }
 
@@ -21,22 +23,39 @@ declare module "xray16" {
     public constructor();
 
     public Collidable(): boolean;
+
     public DisablePointer(): void;
+
     public DisableSpot(): void;
+
     public EnablePointer(): void;
+
     public EnableSpot(): void;
+
     public GetHint(): string;
+
     public GetLastPosition(): vector2;
+
     public GetLevelName(): string;
+
     public GetPosition(): vector2;
+
     public HighlightSpot(state: boolean, color: fcolor): void;
+
     public HintEnabled(): boolean;
+
     public IsUserDefined(): boolean;
+
     public ObjectID(): u16;
+
     public PointerEnabled(): boolean;
+
     public SetHint(hint: string): void;
+
     public SetUserDefinedFlag(state: boolean): void;
+
     public SpotEnabled(): boolean;
+
     public SpotSize(): vector2;
   }
 }

package/types/xr_lib/xr_math.d.ts

@@ -51,6 +51,7 @@ declare module "xray16" {
     public y: f32;
 
     public set(x: f32, y: f32): vector2;
+
     public set(vector: vector2): vector2;
   }
 
@@ -65,57 +66,109 @@ declare module "xray16" {
     public z: f32;
 
     public abs(vector: Readonly<vector>): vector;
+
     public add(val: f32): vector;
+
     public add(vector1: Readonly<vector>, vector2: Readonly<vector>): vector;
+
     public add(vector: Readonly<vector>): vector;
+
     public add(vector: Readonly<vector>, val: f32): vector;
+
     public align(): vector;
+
     public average(vector1: Readonly<vector>, vector2: Readonly<vector>): vector;
+
     public average(vector: Readonly<vector>): vector;
+
     public clamp(vector1: Readonly<vector>, vector2: Readonly<vector>): vector;
+
     public clamp(vector: Readonly<vector>): vector;
+
     public crossproduct(vector1: Readonly<vector>, vector2: Readonly<vector>): vector;
+
     public distance_to(vector: Readonly<vector>): f32;
+
     public distance_to_sqr(vector: Readonly<vector>): f32;
+
     public distance_to_xz(vector: Readonly<vector>): f32;
+
     public div(val: f32): vector;
+
     public div(vector1: Readonly<vector>, vector2: Readonly<vector>): vector;
+
     public div(vector: Readonly<vector>): vector;
+
     public div(vector: Readonly<vector>, val: f32): vector;
+
     public dotproduct(vector: Readonly<vector>): f32;
+
     public getH(): f32;
+
     public getP(): f32;
+
     public inertion(vector: Readonly<vector>, val: f32): vector;
+
     public invert(): vector;
+
     public invert(vector: Readonly<vector>): vector;
+
     public lerp(vector1: Readonly<vector>, vector2: Readonly<vector>, val: f32): vector;
+
     public mad(vector1: Readonly<vector>, vector2: Readonly<vector>): vector;
+
     public mad(vector1: Readonly<vector>, vector2: Readonly<vector>, val: f32): vector;
+
     public mad(vector1: Readonly<vector>, vector2: Readonly<vector>, vector3: Readonly<vector>): vector;
+
     public mad(vector: Readonly<vector>, val: f32): vector;
+
     public magnitude(): f32;
+
     public max(vector1: Readonly<vector>, vector2: Readonly<vector>): vector;
+
     public max(vector: Readonly<vector>): vector;
+
     public min(vector1: Readonly<vector>, vector2: Readonly<vector>): vector;
+
     public min(vector: Readonly<vector>): vector;
+
     public mul(val: f32): vector;
+
     public mul(vector1: Readonly<vector>, vector2: Readonly<vector>): vector;
+
     public mul(vector: Readonly<vector>): vector;
+
     public mul(vector: Readonly<vector>, val: f32): vector;
+
     public normalize(): vector;
+
     public normalize(vector: Readonly<vector>): vector;
+
     public normalize_safe(): vector;
+
     public normalize_safe(vector: Readonly<vector>): vector;
+
     public reflect(vector1: Readonly<vector>, vector2: Readonly<vector>): vector;
+
     public set(vector: Readonly<vector>): vector;
+
     public set(x: f32, y: f32, z: f32): vector;
+
     public setHP(val1: f32, val2: f32): vector;
+
     public set_length(val: f32): vector;
+
     public similar(vector: Readonly<vector>, val: f32): boolean;
+
     public slide(vector1: Readonly<vector>, vector2: Readonly<vector>): vector;
+
     public sub(val: f32): vector;
+
     public sub(vector1: Readonly<vector>, vector2: Readonly<vector>): vector;
+
     public sub(vector: Readonly<vector>): vector;
+
     public sub(vector: Readonly<vector>, val: f32): vector;
   }
 
@@ -149,17 +202,29 @@ declare module "xray16" {
     public constructor();
 
     public mk_xform(x: unknown /* _quaternion<float> */, vector: vector): matrix;
+
     public set(matix: matrix): matrix;
+
     public set(vector1: vector, vector2: vector, vector3: vector, vector4: vector): matrix;
+
     public div(matix: matrix, number: f32): matrix;
+
     public div(number: f32): matrix;
+
     public identity(): matrix;
+
     public setHPB(number1: f32, number2: f32, number3: f32): matrix;
+
     public setXYZ(x: f32, y: f32, z: f32): matrix;
+
     public getHPB(matrix: matrix, number1: f32, number2: f32, number3: f32): matrix;
+
     public mul(matix1: matrix, matix2: matrix): matrix;
+
     public mul(matix: matrix, number: f32): matrix;
+
     public mul(number: f32): matrix;
+
     public setXYZi(number1: f32, number2: f32, number3: f32): matrix;
   }
 }