xray16 1.0.0

package/src/xr_online/xr_multiplayer.d.ts

@@ -0,0 +1,299 @@
+declare module "xray16" {
+  /**
+   * @source C++ class demo_info
+   * @customConstructor demo_info
+   * @group xr_multiplayer
+   */
+  export class demo_info {
+    protected constructor();
+
+    public get_author_name(): string;
+    public get_game_score(): string;
+    public get_game_type(): string;
+    public get_map_name(): string;
+    public get_map_version(): string;
+    public get_player(value: u32): demo_player_info;
+    public get_players_count(): u32;
+  }
+
+  /**
+   * @source C++ class demo_player_info
+   * @customConstructor demo_player_info
+   * @group xr_multiplayer
+   */
+  export class demo_player_info {
+    public get_artefacts(): u16;
+    public get_deaths(): i16;
+    public get_frags(): i16;
+    public get_name(): string;
+    public get_rank(): u8;
+    public get_spots(): i16;
+    public get_team(): u8;
+  }
+
+  /**
+   * @source C++ class SServerFilters
+   * @customConstructor SServerFilters
+   * @group xr_multiplayer
+   */
+  export class SServerFilters {
+    public empty: boolean;
+    public full: boolean;
+    public listen_servers: boolean;
+    public with_pass: boolean;
+    public without_ff: boolean;
+    public without_pass: boolean;
+
+    public constructor();
+  }
+
+  /**
+   * @source C++ class profile
+   * @customConstructor XR_profile
+   * @group xr_multiplayer
+   */
+  export class profile {
+    public unique_nick(): string;
+    public online(): boolean;
+  }
+
+  /**
+   * @source C++ class account_manager
+   * @customConstructor account_manager
+   * @group xr_multiplayer
+   */
+  export class account_manager {
+    private constructor();
+
+    public create_profile(acc: string, nick: string, mail: string, password: string, cb: account_profiles_cb): void;
+    public delete_profile(operation: account_operation_cb): void;
+    public get_account_profiles(email: string, password: string, cb: account_profiles_cb): unknown;
+    public get_found_profiles(): LuaIterable<string>;
+    public get_suggested_unicks(): LuaIterable<string>;
+    public get_verify_error_descr(): string;
+    public search_for_email(email: string, cb: found_email_cb): void;
+    public stop_fetching_account_profiles(): void;
+    public stop_searching_email(): void;
+    public stop_suggest_unique_nicks(): void;
+    public suggest_unique_nicks(nick: string, b: suggest_nicks_cb): void;
+    public verify_email(email: string): boolean;
+    public verify_password(password: string): boolean;
+    public verify_unique_nick(nick: string): boolean;
+    public is_get_account_profiles_active(): boolean;
+    public is_email_searching_active(): boolean;
+  }
+
+  /**
+   * @source C++ class login_manager
+   * @customConstructor login_manager
+   * @group xr_multiplayer
+   */
+  export class login_manager {
+    private constructor();
+
+    public forgot_password(url: string): void;
+    public get_current_profile(): profile | null;
+    public get_email_from_registry(): string;
+    public get_nick_from_registry(): string;
+    public get_password_from_registry(): string;
+    public get_remember_me_from_registry(): boolean;
+    public login(mail: string, profile: string, password: string, cb: login_operation_cb): void;
+    public login_offline(nick: string, cb: login_operation_cb): void;
+    public logout(): void;
+    public save_email_to_registry(email: string): void;
+    public save_nick_to_registry(nick: string): void;
+    public save_password_to_registry(password: string): void;
+    public save_remember_me_to_registry(remember_me: boolean): void;
+    public set_unique_nick(nick: string, cb: login_operation_cb): void;
+    public stop_login(): void;
+    public stop_setting_unique_nick(): void;
+  }
+
+  /**
+   * @source C++ class award_pair_t
+   * @customConstructor award_pair_t
+   * @group xr_multiplayer
+   */
+  export class award_pair_t {
+    public readonly first: award_data;
+    public readonly second: award_data;
+  }
+
+  /**
+   * @source C++ class best_scores_pair_t
+   * @customConstructor best_scores_pair_t
+   * @group xr_multiplayer
+   */
+  export class best_scores_pair_t {
+    public first: award_data;
+    public second: award_data;
+  }
+
+  /**
+   * @source C++ class account_profiles_cb
+   * @customConstructor account_profiles_cb
+   * @group xr_multiplayer
+   */
+  export class account_profiles_cb {
+    public constructor(object: object, cb: (this: object, code: number, description: string) => void);
+
+    public bind(object: object, cb: (this: object, code: number, description: string) => void): void;
+    public clear(): void;
+  }
+
+  /**
+   * @source C++ class login_operation_cb
+   * @customConstructor login_operation_cb
+   * @group xr_multiplayer
+   */
+  export class login_operation_cb {
+    public constructor(object: object, cb: (this: object, profile: profile | null, description: string) => void);
+
+    public bind(object: object, cb: (this: object, profile: profile | null, description: string) => void): void;
+    public clear(): void;
+  }
+
+  /**
+   * @source C++ class connect_error_cb
+   * @customConstructor connect_error_cb
+   * @group xr_multiplayer
+   */
+  export class connect_error_cb {
+    public constructor(object: object, cb: (this: object, code: number, description: string) => void);
+
+    public bind(object: object, cb: (this: object, code: number, description: string) => void): void;
+    public clear(): void;
+  }
+
+  /**
+   * @source C++ class account_operation_cb
+   * @customConstructor account_operation_cb
+   * @group xr_multiplayer
+   */
+  export class account_operation_cb {
+    public constructor(object: object, cb: (this: object, code: number, description: string) => void);
+
+    public bind(object: object, cb: (this: object, code: number, description: string) => void): void;
+    public clear(): void;
+  }
+
+  /**
+   * @source C++ class found_email_cb
+   * @customConstructor found_email_cb
+   * @group xr_multiplayer
+   */
+  export class found_email_cb {
+    public constructor(object: object, cb: (this: object, found: boolean, description: string) => void);
+
+    public bind(object: object, cb: (this: object, found: boolean, description: string) => void): void;
+    public clear(): void;
+  }
+
+  /**
+   * @source C++ class store_operation_cb
+   * @customConstructor store_operation_cb
+   * @group xr_multiplayer
+   */
+  export class store_operation_cb {
+    public constructor(object: object, cb: (this: object, code: number | boolean, description: string) => void);
+
+    public bind(object: object, cb: (this: object, code: number, description: string) => void): void;
+    public clear(): void;
+  }
+
+  /**
+   * @source C++ class suggest_nicks_cb
+   * @customConstructor suggest_nicks_cb
+   * @group xr_multiplayer
+   */
+  export class suggest_nicks_cb {
+    public constructor(object: object, cb: (this: object, result: number, description: string) => void);
+
+    public bind(object: object, cb: (this: object, result: number, description: string) => void): void;
+    public clear(): void;
+  }
+
+  /**
+   * @source C++ class Patch_Dawnload_Progress
+   * @customConstructor Patch_Dawnload_Progress
+   * @group xr_multiplayer
+   */
+  export class Patch_Dawnload_Progress {
+    public GetProgress(): f32;
+    public GetInProgress(): boolean;
+    public GetStatus(): string;
+    public GetFlieName(): string;
+  }
+
+  /**
+   * @source C++ class profile_store
+   * @customConstructor profile_store
+   * @group xr_multiplayer
+   */
+  export class profile_store {
+    public static readonly at_award_massacre: 0;
+    public static readonly at_awards_count: 30;
+    public static readonly bst_backstabs_in_row: 2;
+    public static readonly bst_bleed_kills_in_row: 2;
+    public static readonly bst_explosive_kills_in_row: 3;
+    public static readonly bst_eye_kills_in_row: 4;
+    public static readonly bst_head_shots_in_row: 3;
+    public static readonly bst_kills_in_row: 0;
+    public static readonly bst_kinife_kills_in_row: 1;
+    public static readonly bst_score_types_count: 7;
+
+    protected constructor();
+
+    public get_awards(): LuaIterable<award_pair_t>;
+    public get_best_scores(): LuaIterable<best_scores_pair_t>;
+    public load_current_profile(onProgress: store_operation_cb, onComlete: store_operation_cb): void;
+    public stop_loading(): void;
+  }
+
+  /**
+   * @source C++ class award_data
+   * @customConstructor award_data
+   * @group xr_multiplayer
+   */
+  export class award_data {
+    public m_count: u16;
+    public m_last_reward_date: u32;
+  }
+
+  /**
+   * @source C++ class game_messages
+   * @customConstructor game_messages
+   * @group xr_multiplayer
+   */
+  export class game_messages {
+    public static GAME_EVENT_ARTEFACT_DESTROYED: 17;
+    public static GAME_EVENT_ARTEFACT_DROPPED: 19;
+    public static GAME_EVENT_ARTEFACT_ONBASE: 20;
+    public static GAME_EVENT_ARTEFACT_SPAWNED: 16;
+    public static GAME_EVENT_ARTEFACT_TAKEN: 18;
+    public static GAME_EVENT_BUY_MENU_CLOSED: 23;
+    public static GAME_EVENT_PLAYER_BUY_FINISHED: 2;
+    public static GAME_EVENT_PLAYER_CHANGE_SKIN: 6;
+    public static GAME_EVENT_PLAYER_CHANGE_TEAM: 6;
+    public static GAME_EVENT_PLAYER_CONNECTED: 8;
+    public static GAME_EVENT_PLAYER_DISCONNECTED: 9;
+    public static GAME_EVENT_PLAYER_ENTER_TEAM_BASE: 21;
+    public static GAME_EVENT_PLAYER_JOIN_TEAM: 13;
+    public static GAME_EVENT_PLAYER_KILL: 1;
+    public static GAME_EVENT_PLAYER_KILLED: 11;
+    public static GAME_EVENT_PLAYER_LEAVE_TEAM_BASE: 22;
+    public static GAME_EVENT_PLAYER_READY: 0;
+    public static GAME_EVENT_ROUND_END: 15;
+    public static GAME_EVENT_ROUND_STARTED: 14;
+    public static GAME_EVENT_SCRIPT_BEGINS_FROM: 46;
+    public static GAME_EVENT_SKIN_MENU_CLOSED: 25;
+    public static GAME_EVENT_TEAM_MENU_CLOSED: 24;
+
+    protected constructor();
+  }
+
+  /**
+   * @group xr_multiplayer
+   */
+  export type TXR_game_message = EnumeratedStaticsValues<game_messages>;
+}

package/src/xr_sound/xr_sound.d.ts

@@ -0,0 +1,153 @@
+declare module "xray16" {
+  /**
+   * @source C++ class sound_params
+   * @customConstructor sound_params
+   * @group xr_sound
+   */
+  export class sound_params {
+    public frequency: f32;
+    public max_distance: f32;
+    public min_distance: f32;
+    public position: vector;
+    public volume: f32;
+
+    private constructor();
+  }
+
+  /**
+   * @source C++ class sound_object
+   * @customConstructor sound_object
+   * @group xr_sound
+   */
+  export class sound_object {
+    public static s3d: 0;
+    public static looped: 1;
+    public static s2d: 2;
+
+    public frequency: f32;
+    public max_distance: f32;
+    public min_distance: f32;
+    public volume: f32;
+
+    /**
+     * @param sound_path - file path
+     */
+    public constructor(sound_path: string);
+    /**
+     * @param sound_path - file path
+     * @param type - default 'no_sound' (0)
+     */
+    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;
+  }
+
+  /**
+   * @group xr_sound
+   */
+  export type TXR_sound_object_type = EnumeratedStaticsValues<typeof sound_object>;
+
+  /**
+   * @source C++ class snd_type
+   * @customConstructor snd_type
+   * @group xr_sound
+   */
+  export class snd_type {
+    public static ambient: 128;
+    public static anomaly: 268435456;
+    public static anomaly_idle: 268437504;
+    public static attack: 8192;
+    public static bullet_hit: 524288;
+    public static die: 131072;
+    public static drop: 33554432;
+    public static eat: 4096;
+    public static empty: 1048576;
+    public static hide: 16777216;
+    public static idle: 2048;
+    public static injure: 65536;
+    public static item: 1073741824;
+    public static item_drop: 1107296256;
+    public static item_hide: 1090519040;
+    public static item_pick_up: 1140850688;
+    public static item_take: 1082130432;
+    public static item_use: 1077936128;
+    public static monster: 536870912;
+    public static monster_attack: 536879104;
+    public static monster_die: 537001984;
+    public static monster_eat: 536875008;
+    public static monster_injure: 536936448;
+    public static monster_step: 536903680;
+    public static monster_talk: 536887296;
+    public static no_sound: 0;
+    public static object_break: 1024;
+    public static object_collide: 512;
+    public static object_explode: 256;
+    public static pick_up: 67108864;
+    public static reload: 262144;
+    public static shoot: 2097152;
+    public static step: 32768;
+    public static take: 8388608;
+    public static talk: 16384;
+    public static use: 4194304;
+    public static weapon: -2147483648;
+    public static weapon_bullet_hit: -2146959360;
+    public static weapon_empty: -2146435072;
+    public static weapon_reload: -2147221504;
+    public static weapon_shoot: -2145386496;
+    public static world: 134217728;
+    public static world_ambient: 134217856;
+    public static world_object_break: 134218752;
+    public static world_object_collide: 134218240;
+    public static world_object_explode: 134217984;
+
+    private constructor();
+  }
+
+  /**
+   * @group xr_sound
+   */
+  export type TXR_snd_type = EnumeratedStaticsValues<typeof snd_type>;
+
+  /**
+   * @source C++ class SoundInfo
+   * @customConstructor SoundInfo
+   * @group xr_sound
+   */
+  export class SoundInfo {
+    public danger: i32;
+    public position: vector;
+    public power: f32;
+    public time: i32;
+    public who: game_object;
+
+    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/src/xr_type/xr_enums.d.ts

@@ -0,0 +1,17 @@
+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_types
+   */
+  export type TXR_EGameID = 0 | 1 | 2 | 8 | 16 | 32 | 64;
+}

package/src/xr_type/xr_type.d.ts

@@ -0,0 +1,70 @@
+/**
+ * List of types that are all cast to similar number type in lua / ts.
+ * Main purpose is to indicate what is used with C++ side for better documentation.
+ */
+declare module "xray16" {
+  /**
+   * @group xr_types
+   */
+  type i8 = number;
+
+  /**
+   * @group xr_types
+   */
+  type u8 = number;
+
+  /**
+   * @group xr_types
+   */
+  type i16 = number;
+
+  /**
+   * @group xr_types
+   */
+  type u16 = number;
+
+  /**
+   * @group xr_types
+   */
+  type f32 = number;
+
+  /**
+   * @group xr_types
+   */
+  type i32 = number;
+
+  /**
+   * @group xr_types
+   */
+  type u32 = number;
+
+  /**
+   * @group xr_types
+   */
+  type f64 = number;
+
+  /**
+   * @group xr_types
+   */
+  type i64 = number;
+
+  /**
+   * @group xr_types
+   */
+  type u64 = number;
+
+  /**
+   * @group xr_types
+   */
+  type Maybe<T> = T | null | undefined;
+
+  /**
+   * @group xr_types
+   */
+  type EnumeratedStaticsKeys<T> = Exclude<keyof T, "constructor" | TEngineBindingStaticMethods>;
+
+  /**
+   * @group xr_types
+   */
+  type EnumeratedStaticsValues<T> = T[Exclude<keyof T, "constructor" | TEngineBindingStaticMethods>];
+}