xray16 1.0.5 → 1.0.8

package/types/xr_lib/xr_fs.d.ts

@@ -6,7 +6,9 @@ declare module "xray16" {
    */
   export class FS_file_list {
     public Free(): void;
+
     public GetAt(number: u32): FS_item;
+
     public Size(): u32;
   }
 
@@ -17,7 +19,9 @@ declare module "xray16" {
    */
   export class FS_file_list_ex {
     public Sort(number: u32): void;
+
     public GetAt(index: u32): FS_item;
+
     public Size(): u32;
   }
 
@@ -28,24 +32,14 @@ declare module "xray16" {
    */
   export class FS_item {
     public Modif(): string;
+
     public NameFull(): string;
+
     public NameShort(): string;
-    public ModifDigitOnly(): string;
-    public Size(): u32;
-  }
 
-  /**
-   * @source C++ class CSavedGameWrapper
-   * @customConstructor CSavedGameWrapper
-   * @group xr_fs
-   */
-  export class CSavedGameWrapper extends EngineBinding {
-    public constructor(name: string);
+    public ModifDigitOnly(): string;
 
-    public level_name(): string;
-    public level_id(): u8;
-    public game_time(): CTime;
-    public actor_health(): f32;
+    public Size(): u32;
   }
 
   /**
@@ -79,34 +73,58 @@ declare module "xray16" {
     public static FS_sort_by_size_up: 2;
 
     public append_path(a: string, b: string, c: string, d: number): unknown /* FS_Path */;
+
     public dir_delete(fs: FS, a: string, b: string, c: number): void;
+
     public dir_delete(fs: FS, a: string, c: number): void;
+
     public exist(folderAlias: string, filename: string, fs_type: TXR_fs_type): i32 | null;
+
     public exist(folderAlias: string, filename: string): i32 | null;
+
     public exist(path: string): i32 | null;
+
     public file_copy(a: string, b: string): void;
+
     public file_length(a: string): i32;
+
     public file_list_open(a: string, b: string, c: u32): FS_file_list;
+
     public file_list_open(a: string, b: u32): FS_file_list;
+
     public file_list_open_ex(a: string, b: u32, c: string): FS_file_list_ex;
+
     public file_rename(a: string, b: string, c: boolean): void;
+
     public get_file_age(a: string): u32;
+
     public get_file_age_str(fs: FS, a: string): u32;
+
     public path_exist(a: string): boolean;
+
     public r_close(reader: reader): void;
+
     public r_open(a: string): reader;
+
     public r_open(a: string, b: string): reader;
+
     public update_path(alias: string, addition: string): string;
+
     public w_close(writer: unknown /* IWriter */): void;
+
     public rescan_path(path: string): void;
 
     /**
      * Not registered in LUA, will throw.
      */
     public get_path(alias: string): unknown;
+
     public file_delete(a: string, b: string): void;
+
     public file_delete(fs: string): void;
+
     public w_open(a: string, b: string): unknown /* IWriter */;
+
     public w_open(a: string): unknown /* IWriter */;
   }
 
@@ -116,225 +134,15 @@ declare module "xray16" {
   export type TXR_fs_type = EnumeratedStaticsValues<typeof FS>;
 
   /**
-   * @source C++ class ini_file
-   * @customConstructor ini_file
-   * @group xr_fs
-   */
-  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;
-
-    /**
-     * @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 of 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;
-  }
-
-  /**
-   * @source C++ class net_packet
-   * @customConstructor net_packet
    * @group xr_fs
    */
-  export class net_packet {
-    public r_advance(value: u32): void;
-    public r_angle16(value: f32): void;
-    public r_angle8(value: f32): void;
-    public r_begin(value: u16): u32;
-    public r_bool(): boolean;
-    public r_clientID(): ClientID;
-    public r_dir(vector: vector): void;
-    public r_elapsed(): u32;
-    public r_eof(): boolean;
-    public r_float(): f32;
-    public r_float(value: f32): f32;
-    public r_float_q16(value1: f32, value2: f32, value3: f32): f32;
-    public r_float_q8(value1: f32, value2: f32, value3: f32): f32;
-    public r_matrix(matrix: matrix): matrix;
-    public r_s16(): i16;
-    public r_s16(value: u16): u16;
-    public r_s32(): i32;
-    public r_s32(value: i32): i32;
-    public r_s64(): i64;
-    public r_s64(value: i64): i64;
-    public r_s8(): i8;
-    public r_s8(value: i8): i8;
-    public r_sdir(vector: vector): void;
-    public r_seek(value: u32): void;
-    public r_stringZ<T extends string>(): T;
-    public r_tell(): u32;
-    public r_u16(): u16;
-    public r_u16(value: u16): u16;
-    public r_u32(): u32;
-    public r_u32(value: u32): u32;
-    public r_u64(): u64;
-    public r_u64(value: u64): u64;
-    public r_u8(): u8;
-    public r_u8(value: u8): u8;
-    public r_vec3(vector: vector): void;
-    public w_angle16(value: f32): void;
-    public w_angle8(value: f32): void;
-    public w_begin(value: u16): void;
-    public w_bool(value: boolean): void;
-    public w_chunk_close16(value: u32): void;
-    public w_chunk_close8(value: u32): void;
-    public w_chunk_open16(value: u32): void;
-    public w_chunk_open8(value: u32): void;
-    public w_clientID(ClientID: ClientID): void;
-    public w_dir(vector: vector): void;
-    public w_float(value: f32): void;
-    public w_float_q16(value1: f32, value2: f32, value3: f32): void;
-    public w_float_q8(value1: f32, value2: f32, value3: f32): void;
-    public w_matrix(matrix: matrix): void;
-    public w_s16(value: i16): void;
-    public w_s32(value: i32): void;
-    public w_s64(value: i64): void;
-    public w_sdir(vector: vector): void;
-    public w_stringZ(value: string | null): void;
-    public w_tell(): u32;
-    public w_u16(value: u16): void;
-    public w_u32(value: u32): void;
-    public w_u64(value: u64): void;
-    public w_u8(value: u8): void;
-    public w_vec3(vector: vector): void;
-  }
-
-  /**
-   * @source C++ class reader
-   * @customConstructor reader
-   * @group xr_fs
-   */
-  export class reader {
-    public r_advance(value: u64): void;
-    public r_elapsed(): i64;
-    public r_eof(): boolean;
-    public r_sdir(vector: vector): void;
-    public r_seek(value: u64): void;
-    public r_tell(): u64;
-
-    public r_dir(vector: vector): void;
-    public r_vec3(vector: vector): void;
-    public r_angle16(): f32;
-    public r_angle8(): f32;
-
-    public r_bool(): boolean;
-    public r_stringZ<T extends string>(): T;
-
-    public r_float<T extends f32>(value?: T): T;
-    public r_float_q16<T extends f32>(value1: T, value2: T): T;
-    public r_float_q8<T extends f32>(value1: T, value2: T): T;
-
-    public r_s16<T extends i16 = i16>(value?: T): T;
-    public r_s32<T extends i32 = i32>(value?: T): T;
-    public r_s64<T extends i64 = i64>(value?: T): T;
-    public r_s8<T extends i8 = i8>(value?: T): T;
-
-    public r_u16<T extends u16 = u16>(value?: T): T;
-    public r_u32<T extends u32 = u32>(value?: T): T;
-    public r_u64<T extends u64 = u64>(value?: T): T;
-    public r_u8<T extends u8 = u8>(value?: T): T;
-  }
+  export function getFS(this: void): FS;
 
   /**
+   * Get operating system active username.
+   *
    * @group xr_fs
+   * @returns username string
    */
-  export type TXR_net_processor = reader | net_packet;
+  export function user_name(this: void): string;
 }

package/types/xr_lib/xr_game.d.ts

@@ -0,0 +1,159 @@
+declare module "xray16" {
+
+  /**
+   * Enumeration with possible game types:
+   * - eGameIDNoGame = u32(0),
+   * - eGameIDSingle = u32(1) << 0,
+   * - eGameIDDeathmatch = u32(1) << 1,
+   * - eGameIDTeamDeathmatch = u32(1) << 2,
+   * - eGameIDArtefactHunt = u32(1) << 3,
+   * - eGameIDCaptureTheArtefact = u32(1) << 4,
+   * - eGameIDDominationZone = u32(1) << 5,
+   * - eGameIDTeamDominationZone = u32(1) << 6,
+   *
+   * @source C++ enum EGameIDs
+   * @group xr_game
+   */
+  export type TXR_EGameID = 0 | 1 | 2 | 8 | 16 | 32 | 64;
+
+  /**
+   * @source C++ class GAME_TYPE
+   * @customConstructor GAME_TYPE
+   * @group xr_game
+   */
+  export class GAME_TYPE {
+    public static readonly eGameIDArtefactHunt: 8;
+    public static readonly eGameIDCaptureTheArtefact: 16;
+    public static readonly eGameIDDeathmatch: 2;
+    public static readonly eGameIDTeamDeathmatch: 4;
+
+    public static readonly GAME_UNKNOWN: -1;
+    public static readonly GAME_ANY: 0;
+    public static readonly GAME_SINGLE: 1;
+    public static readonly GAME_DEATHMATCH: 2;
+    //	GAME_CTF							= 3,
+    //	GAME_ASSAULT						= 4,	// Team1 - assaulting, Team0 - Defending
+    public static readonly GAME_CS: 5;
+    public static readonly GAME_TEAMDEATHMATCH: 6;
+    public static readonly GAME_ARTEFACTHUNT: 7;
+    public static readonly GAME_CAPTURETHEARTEFACT: 8;
+    // identifiers in range [100...254] are registered for script game type
+    public static readonly GAME_DUMMY: 255; // temporary g
+  }
+
+  /**
+   * @group xr_game
+   */
+  type TXR_GAME_TYPE = EnumeratedStaticsValues<typeof GAME_TYPE>;
+
+  /**
+   * @source C++ class game_difficulty
+   * @customConstructor game_difficulty
+   * @group xr_game
+   */
+  export class game_difficulty {
+    public static readonly novice: 0;
+    public static readonly stalker: 1;
+    public static readonly veteran: 2;
+    public static readonly master: 3;
+  }
+
+  /**
+   * @group xr_game
+   */
+  export type TXR_game_difficulty_name = EnumeratedStaticsKeys<typeof game_difficulty>;
+
+  /**
+   * @group xr_game
+   */
+  export type TXR_game_difficulty = EnumeratedStaticsValues<typeof game_difficulty>;
+
+  /**
+   * @source namespace game
+   * @group xr_game
+   */
+  export interface IXR_game {
+    CTime: (this: void) => CTime;
+
+    translate_string(this: void, translation_key: string): string;
+
+    time(this: void): u32;
+
+    reload_language(this: void): void;
+
+    get_game_time(this: void): CTime;
+
+    log_stack_trace(this: void): void;
+
+    jump_to_level(this: void, level_name: string): void;
+
+    jump_to_level(this: void, position: vector, lvi: u32, gvi: u16): void;
+
+    jump_to_level(this: void, position: vector, lvi: u32, gvi: u16, direction: vector): void;
+
+    start_tutorial(this: void, tutorial_id: string): void;
+
+    has_active_tutorial(this: void): boolean;
+
+    active_tutorial_name(this: void): string;
+
+    stop_tutorial(this: void): void;
+  }
+
+  /**
+   * @group xr_game
+   */
+  export const game: IXR_game;
+
+  /**
+   * Check whether dynamic music setting is enabled.
+   * Dynamic music starts playing different kind of ambient sounds in actor combat.
+   *
+   * @group xr_game
+   * @returns is dynamic music allowed in game settings.
+   */
+  export function IsDynamicMusic(this: void): boolean;
+
+  /**
+   * Whether auto-save on important checkpoints option is turned on.
+   *
+   * @group xr_game
+   */
+  export function IsImportantSave(this: void): boolean;
+
+  /**
+   * @group xr_game
+   */
+  export function IsGameTypeSingle(this: void): boolean;
+
+  /**
+   * @group xr_game
+   * @returns is dev editor tool enabled currently used.
+   */
+  export function editor(this: void): boolean;
+
+  /**
+   * @group xr_game
+   */
+  export function set_start_position(position: vector): void;
+
+  /**
+   * @group xr_game
+   */
+  export function set_start_game_vertex_id(gvid: i32): void;
+
+  /**
+   * @group xr_game
+   */
+  export function is_enough_address_space_available(this: void): boolean;
+
+  /**
+   * @group xr_game
+   */
+  export function verify_if_thread_is_running(this: void): void;
+
+  /**
+   * @group xr_game
+   */
+  export function script_server_object_version(this: void): u16;
+}

package/types/xr_lib/xr_hit.d.ts

@@ -0,0 +1,41 @@
+declare module "xray16" {
+  /**
+   * @source C++ class hit
+   * @customConstructor hit
+   * @group xr_hit
+   */
+  export class hit {
+    public static readonly burn = 0;
+    public static readonly chemical_burn = 2;
+    public static readonly dummy = 12;
+    public static readonly explosion = 7;
+    public static readonly fire_wound = 8;
+    public static readonly light_burn = 11;
+    public static readonly radiation = 3;
+    public static readonly shock = 1;
+    public static readonly strike = 5;
+    public static readonly telepatic = 4;
+    public static readonly wound = 6;
+
+    public direction: vector;
+    public draftsman: game_object | null;
+    public impulse: f32;
+    public power: f32;
+    public type: TXR_hit_type;
+
+    public constructor();
+    public constructor(hit: hit);
+
+    public bone(bone: string): void;
+  }
+
+  /**
+   * @group xr_hit
+   */
+  export type TXR_hit_types = typeof hit;
+
+  /**
+   * @group xr_hit
+   */
+  export type TXR_hit_type = EnumeratedStaticsValues<TXR_hit_types>;
+}

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