xray16 1.0.5 → 1.0.8

package/types/xr_lib/xr_relation.d.ts

@@ -0,0 +1,84 @@
+declare module "xray16" {
+  /**
+   * @source C++ class FactionState
+   * @customConstructor FactionState
+   * @group xr_relation
+   */
+  export class FactionState {
+    public actor_goodwill: i32;
+    public bonus: i32;
+    public faction_id: string;
+    public icon: string;
+    public icon_big: string;
+    public location: string;
+    public member_count: i32;
+    public name: string;
+    public power: f32;
+    public resource: f32;
+    public target: string;
+    public target_desc: string;
+    public war_state1: string;
+    public war_state2: string;
+    public war_state3: string;
+    public war_state4: string;
+    public war_state5: string;
+    public war_state_hint1: string;
+    public war_state_hint2: string;
+    public war_state_hint3: string;
+    public war_state_hint4: string;
+    public war_state_hint5: string;
+
+    protected constructor();
+  }
+
+  /**
+   * @source namespace relation_registry
+   * @group xr_relation
+   */
+  export interface IXR_relation_registry {
+    /**
+     * Change relation from community to object by `delta_goodwill`.
+     */
+    change_community_goodwill(this: void, from_community: string, to_object_id: i32, delta_goodwill: i32): void;
+
+    community_goodwill(this: void, from_community: string, to_object_id: i32): i32;
+
+    /**
+     * @returns relation points between communities, usually between `-5000` and `5000`
+     */
+    community_relation(this: void, from_community: string, to_community: string): i32;
+
+    /**
+     * Get relation from object to actor.
+     * Return formula looks like `personal_goodwill + community_to_obj_goodwill + community_to_community_goodwill`.
+     *
+     * @param from_object_id - object from
+     * @param to_object_id - object to
+     * @returns general goodwill from object to another object based on personal and community goodwill
+     */
+    get_general_goodwill_between(this: void, from_object_id: u16, to_object_id: u16): i32;
+
+    set_community_goodwill(this: void, from_community: string, to_object_id: i32, goodwill: i32): void;
+
+    set_community_relation(this: void, from_community: string, to_community: string, goodwill: i32): void;
+  }
+
+  /**
+   * @group xr_relation
+   */
+  export const relation_registry: IXR_relation_registry;
+
+  /**
+   * Enumeration of relations.
+   *
+   * eRelationTypeFriend - 0
+   * eRelationTypeNeutral - 1
+   * eRelationTypeEnemy - 2
+   * eRelationTypeWorstEnemy - 3
+   * eRelationTypeLast - 4
+   * eRelationTypeDummy - -1
+   *
+   * @group xr_relation
+   */
+  export type TXR_relation = 0 | 1 | 2 | 3;
+}

package/types/xr_lib/xr_render.d.ts

@@ -0,0 +1,70 @@
+declare module "xray16" {
+  /**
+   * @source C++ class render_device
+   * @customConstructor render_device
+   * @group xr_render
+   */
+  export class render_device {
+    private constructor();
+
+    public readonly cam_dir: vector;
+    public readonly cam_pos: vector;
+    public readonly cam_right: vector;
+    public readonly cam_top: vector;
+    public readonly aspect_ratio: f32;
+    public readonly fov: f32;
+    public readonly precache_frame: u32;
+    public readonly frame: u32;
+    public readonly height: u32;
+    public readonly time_delta: u32;
+    public readonly f_time_delta: f32;
+    public readonly width: u32;
+
+    /**
+     * Get current game timestamp.
+     *
+     * @example `29319`,`46297`
+     * @returns milliseconds from game start
+     */
+    public time_global(): u32;
+
+    /**
+     * @returns whether game is paused
+     */
+    public is_paused(): boolean;
+
+    /**
+     * Change game pause state.
+     *
+     * @param paused - whether game should be paused
+     */
+    public pause(paused: boolean): void;
+  }
+
+  /**
+   * @group xr_render
+   */
+  export function device(this: void): render_device;
+
+  /**
+   * @group xr_render
+   */
+  export function app_ready(this: void): boolean;
+
+  /**
+   * @group xr_render
+   */
+  export function xrRender_test_r2_hw(this: void): boolean;
+
+  /**
+   * @group xr_render
+   */
+  export function render_get_dx_level(this: void): number;
+
+  /**
+   * @group xr_global_declaration
+   * @returns whether renderer setting can be changed
+   */
+  export function renderer_allow_override(this: void): boolean;
+
+}

package/types/xr_lib/xr_save.d.ts

@@ -0,0 +1,223 @@
+declare module "xray16" {
+  /**
+   * @source C++ class ClientID
+   * @customConstructor ClientID
+   * @group xr_save
+   */
+  export class ClientID extends EngineBinding {
+    protected constructor();
+
+    public value(): u32;
+    public set(value: u32): void;
+  }
+
+  /**
+   * @source C++ class net_packet
+   * @customConstructor net_packet
+   * @group xr_save
+   */
+  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_save
+   */
+  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;
+  }
+
+  /**
+   * @group xr_save
+   */
+  export type TXR_net_processor = reader | net_packet;
+
+  /**
+   * @source C++ class CSavedGameWrapper
+   * @customConstructor CSavedGameWrapper
+   * @group xr_save
+   */
+  export class CSavedGameWrapper extends EngineBinding {
+    public constructor(name: string);
+
+    /**
+     * @returns active level name from current save file
+     */
+    public level_name(): string;
+
+    public level_id(): u8;
+
+    public game_time(): CTime;
+
+    public actor_health(): f32;
+  }
+
+  /**
+   * @group xr_save
+   */
+  export function valid_saved_game(this: void, filename: string): boolean;
+}

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

@@ -40,21 +40,31 @@ declare module "xray16" {
     public constructor(sound_path: string, type: TXR_snd_type);
 
     public length(): u32;
+
     public playing(): boolean;
+
     public get_position(): vector;
 
     public set_position(vector: vector): void;
+
     public attach_tail(sound_path: string): void;
 
     public play(object: game_object | null): void;
+
     public play(object: game_object | null, delay: f32): void;
+
     public play(object: game_object | null, delay: f32, type: i32): void;
+
     public play_at_pos(object: game_object, position: vector): void;
+
     public play_at_pos(object: game_object, position: vector, delay: f32): void;
+
     public play_at_pos(object: game_object, position: vector, delay: f32, type: i32): void;
+
     public play_no_feedback(object: game_object, type: i32, value1: f32, position: vector, value2: f32): void;
 
     public stop(): void;
+
     public stop_deffered(): void;
   }
 
@@ -138,16 +148,4 @@ declare module "xray16" {
 
     private constructor();
   }
-
-  /**
-   * @source C++ class sound_memory_object : game_memory_object
-   * @customConstructor sound_memory_object
-   * @group xr_sound
-   */
-  export class sound_memory_object extends game_memory_object {
-    public readonly power: f32;
-    public type(): i32;
-
-    protected constructor();
-  }
 }

package/types/xr_lib/xr_stats.ts

@@ -0,0 +1,20 @@
+declare module "xray16" {
+  /**
+   * @source namespace actor_stats
+   * @group xr_stats
+   */
+  export interface IXR_actor_stats {
+    add_points_str(this: void, value1: string, value2: string, value3: string): void;
+
+    get_points(this: void, value: string): i32;
+
+    add_points(this: void, value1: string, value2: string, value3: i32, value4: i32): void;
+
+    remove_from_ranking(this: void, object_id: number): void | null;
+  }
+
+  /**
+   * @group xr_stats
+   */
+  export const actor_stats: IXR_actor_stats;
+}

package/types/{xr_object/xr_quest.d.ts → xr_lib/xr_task.d.ts}

@@ -1,47 +1,99 @@
 declare module "xray16" {
+  /**
+   * @source C++ class task
+   * @customConstructor task
+   * @group xr_task
+   */
+  export class task {
+    public static readonly additional: 1;
+    public static readonly completed: 2;
+    public static readonly fail: 0;
+    public static readonly in_progress: 1;
+    public static readonly storyline: 0;
+    public static readonly task_dummy: 65535;
+
+    private constructor();
+  }
+
+  /**
+   * @group xr_task
+   */
+  export type TXR_TaskStateName = EnumeratedStaticsKeys<typeof task>;
+
+  /**
+   * ETaskState
+   *
+   * @group xr_task
+   */
+  export type TXR_TaskState = EnumeratedStaticsValues<typeof task>;
+
   /**
    * @source C++ class SGameTaskObjective
    * @customConstructor SGameTaskObjective
-   * @group xr_quest
+   * @group xr_task
    */
   export class SGameTaskObjective {
     public constructor(task: CGameTask, id: i32);
 
     public remove_map_locations(flag: boolean): void;
+
     public set_icon_name(icon_name: string): void;
+
     public get_icon_name<T extends string>(): T | null;
+
     public set_description(description: string): void;
+
     public get_description(): string;
+
     public set_title(title: string): void;
+
     public get_title(): string;
+
     public set_map_location(location: string): void;
+
     public add_on_complete_func(function_name: string): void;
+
     public add_complete_info(value: string): void;
+
     public add_on_fail_info(value: string): void;
+
     public add_on_fail_func(function_name: string): void;
+
     public add_on_complete_info(value: string): void;
+
     public add_complete_func(function_name: string): void;
+
     public add_fail_func(function_name: string): void;
+
     public add_fail_info(value: string): void;
+
     public get_state(): TXR_TaskState;
+
     public get_type(): number; /* ETaskType */
+
     public set_type(type: i32 /* ETaskType */): void;
+
     public set_map_hint(hint: string): void;
+
     public change_map_location(value: string, value2: u16): void;
+
     public set_map_object_id(id: i32): void;
   }
 
   /**
    * @source C++ class CGameTask : SGameTaskObjective
    * @customConstructor CGameTask
-   * @group xr_quest
+   * @group xr_task
    */
   export class CGameTask extends SGameTaskObjective {
     public constructor();
 
     public get_id(): string;
+
     public set_priority(priority: i32): void;
+
     public set_id(id: string): void;
+
     public get_priority(): u32;
   }
 }

package/types/xr_lib/xr_time.d.ts

@@ -0,0 +1,61 @@
+declare module "xray16" {
+  /**
+   * @source C++ class CTime
+   * @customConstructor CTime
+   * @group xr_time
+   */
+  export class CTime extends EngineBinding {
+    public static DateToDay: 0;
+    public static DateToMonth: 1;
+    public static DateToYear: 2;
+    public static TimeToHours: 0;
+    public static TimeToMilisecs: 3;
+    public static TimeToMinutes: 1;
+    public static TimeToSeconds: 2;
+
+    public constructor();
+
+    public constructor(time: CTime);
+
+    public add(time: CTime): void;
+
+    public dateToString(time: i32): string;
+
+    public diffSec(time: CTime): f32;
+
+    public get(
+      y: u32,
+      m: u32,
+      d: u32,
+      h: u32,
+      min: u32,
+      sec: u32,
+      ms: u32
+    ): LuaMultiReturn<[u32, u32, u32, u32, u32, u32, u32]>;
+
+    public set(y: i32, m: i32, d: i32, h: i32, min: i32, sec: i32, ms: i32): void;
+
+    public setHMS(a: i32, b: i32, c: i32): void;
+
+    public setHMSms(a: i32, b: i32, c: i32, d: i32): void;
+
+    public sub(time: CTime): void;
+
+    public timeToString(time: i32): string;
+  }
+
+  /**
+   * Get absolute time in millis from executable start.
+   * Returns time in milliseconds.
+   *
+   * @group xr_time
+   * @returns 'ms' from game executable start.
+   * @example 0, 1000, 60000
+   */
+  export function time_global(this: void): u32;
+
+  /**
+   * @group xr_time
+   */
+  export function time_global_async(this: void): u32;
+}

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

@@ -4,67 +4,67 @@
  */
 declare module "xray16" {
   /**
-   * @group xr_types
+   * @group xr_type
    */
   type i8 = number;
 
   /**
-   * @group xr_types
+   * @group xr_type
    */
   type u8 = number;
 
   /**
-   * @group xr_types
+   * @group xr_type
    */
   type i16 = number;
 
   /**
-   * @group xr_types
+   * @group xr_type
    */
   type u16 = number;
 
   /**
-   * @group xr_types
+   * @group xr_type
    */
   type f32 = number;
 
   /**
-   * @group xr_types
+   * @group xr_type
    */
   type i32 = number;
 
   /**
-   * @group xr_types
+   * @group xr_type
    */
   type u32 = number;
 
   /**
-   * @group xr_types
+   * @group xr_type
    */
   type f64 = number;
 
   /**
-   * @group xr_types
+   * @group xr_type
    */
   type i64 = number;
 
   /**
-   * @group xr_types
+   * @group xr_type
    */
   type u64 = number;
 
   /**
-   * @group xr_types
+   * @group xr_type
    */
   type Maybe<T> = T | null | undefined;
 
   /**
-   * @group xr_types
+   * @group xr_type
    */
   type EnumeratedStaticsKeys<T> = Exclude<keyof T, "constructor" | TEngineBindingStaticMethods>;
 
   /**
-   * @group xr_types
+   * @group xr_type
    */
   type EnumeratedStaticsValues<T> = T[Exclude<keyof T, "constructor" | TEngineBindingStaticMethods>];
 }