xray16 1.3.4 → 1.4.0

package/types/xr_lib/xr_game.d.ts

@@ -1,158 +1,261 @@
-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(this: void, position: vector): void;
-
-  /**
-   * @group xr_game
-   */
-  export function set_start_game_vertex_id(this: void, 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;
-}
+declare module "xray16" {
+  /**
+   * Bitmask values returned by `level.game_id()`.
+   *
+   * 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;
+
+  /**
+   * Game type constants used by menu and multiplayer scripts.
+   *
+   * @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>;
+
+  /**
+   * Single-player difficulty constants.
+   *
+   * @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>;
+
+  /**
+   * Global helpers exposed by the engine `game` namespace.
+   *
+   * @source namespace game
+   * @group xr_game
+   */
+  export interface IXR_game {
+    /**
+     * Create a new game time value.
+     *
+     * @returns Empty `CTime` instance.
+     */
+    CTime: (this: void) => CTime;
+
+    /**
+     * Resolve a string table key for the current language.
+     *
+     * @param translation_key - String table key to translate.
+     * @returns Localized text or the fallback string from the string table.
+     */
+    translate_string(this: void, translation_key: string): string;
+
+    /**
+     * Get current in-game time as seconds.
+     *
+     * @returns Game time counter.
+     */
+    time(this: void): u32;
+
+    /**
+     * Reload string table data for the active language.
+     */
+    reload_language(this: void): void;
+
+    /**
+     * Get current in-game calendar time.
+     *
+     * @returns Current game time value.
+     */
+    get_game_time(this: void): CTime;
+
+    /**
+     * Write the current native stack trace to the engine log.
+     */
+    log_stack_trace(this: void): void;
+
+    /**
+     * Move the actor to another level by level name.
+     *
+     * @param level_name - Target level name from the game graph.
+     */
+    jump_to_level(this: void, level_name: string): void;
+
+    /**
+     * Move the actor to another level graph point.
+     *
+     * @param position - Target position.
+     * @param level_vertex_id - Target level vertex.
+     * @param game_vertex_id - Target game graph vertex.
+     */
+    jump_to_level(this: void, position: vector, level_vertex_id: u32, game_vertex_id: u16): void;
+
+    /**
+     * Move the actor to another level graph point and face a direction.
+     *
+     * @param position - Target position.
+     * @param level_vertex_id - Target level vertex.
+     * @param game_vertex_id - Target game graph vertex.
+     * @param direction - Actor direction after the jump.
+     */
+    jump_to_level(this: void, position: vector, level_vertex_id: u32, game_vertex_id: u16, direction: vector): void;
+
+    /**
+     * Start an in-game tutorial sequence.
+     *
+     * @param tutorial_id - Tutorial identifier.
+     */
+    start_tutorial(this: void, tutorial_id: string): void;
+
+    /**
+     * Check whether a tutorial is currently active.
+     *
+     * @returns Whether any tutorial is active.
+     */
+    has_active_tutorial(this: void): boolean;
+
+    /**
+     * Get the active tutorial identifier.
+     *
+     * @returns Active tutorial name.
+     */
+    active_tutorial_name(this: void): string;
+
+    /**
+     * Stop the active tutorial sequence.
+     */
+    stop_tutorial(this: void): void;
+  }
+
+  /**
+   * Global engine `game` namespace.
+   *
+   * @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
+   *
+   * @returns Whether important saves are enabled.
+   */
+  export function IsImportantSave(this: void): boolean;
+
+  /**
+   * Check whether the active game mode is single-player.
+   *
+   * @group xr_game
+   *
+   * @returns Whether the current game type is single-player.
+   */
+  export function IsGameTypeSingle(this: void): boolean;
+
+  /**
+   * Check whether the in-game editor is active.
+   *
+   * @group xr_game
+   *
+   * @returns Whether the editor is currently enabled.
+   */
+  export function editor(this: void): boolean;
+
+  /**
+   * Set the actor start position used by level transition logic.
+   *
+   * @group xr_game
+   *
+   * @param position - Target start position.
+   */
+  export function set_start_position(this: void, position: vector): void;
+
+  /**
+   * Set the actor start game graph vertex.
+   *
+   * @group xr_game
+   *
+   * @param game_vertex_id - Target game graph vertex.
+   */
+  export function set_start_game_vertex_id(this: void, game_vertex_id: i32): void;
+
+  /**
+   * Check whether the process has enough address space for the current game.
+   *
+   * @group xr_game
+   *
+   * @returns Whether available address space is sufficient.
+   */
+  export function is_enough_address_space_available(this: void): boolean;
+
+  /**
+   * Ask the engine to verify that its watched thread is still running.
+   *
+   * @group xr_game
+   */
+  export function verify_if_thread_is_running(this: void): void;
+
+  /**
+   * Get server object serialization version used by scripts.
+   *
+   * @group xr_game
+   *
+   * @returns Script server object version.
+   */
+  export function script_server_object_version(this: void): u16;
+}

package/types/xr_lib/xr_hit.d.ts

@@ -1,41 +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>;
-}
+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>;
+}