xray16 1.6.0 → 1.6.2

package/types/xr_lib/xr_task.d.ts

@@ -1,390 +0,0 @@
-import type { Nullable } from "../internal";
-
-declare module "xray16" {
-  /**
-   * Task state and task type constants.
-   *
-   * @source C++ class task
-   * @customConstructor task
-   * @group xr_task
-   *
-   * @remarks
-   * State and type constants share one native export. Use the matching subset for each API.
-   */
-  export class task {
-    /**
-     * Engine enum value for `task.additional`.
-     */
-    public static readonly additional: 1;
-    /**
-     * Engine enum value for `task.completed`.
-     */
-    public static readonly completed: 2;
-    /**
-     * Engine enum value for `task.fail`.
-     */
-    public static readonly fail: 0;
-    /**
-     * Engine enum value for `task.in_progress`.
-     */
-    public static readonly in_progress: 1;
-    /**
-     * Engine enum value for `task.insignificant`.
-     */
-    public static readonly insignificant: 2;
-    /**
-     * Engine enum value for `task.storyline`.
-     */
-    public static readonly storyline: 0;
-    /**
-     * Engine enum value for `task.task_dummy`.
-     */
-    public static readonly task_dummy: 65535;
-
-    /**
-     * Engine-owned task constants.
-     */
-    private constructor();
-  }
-
-  /**
-   * @group xr_task
-   */
-  export type TXR_TaskStateName = EnumeratedStaticsKeys<typeof task>;
-
-  /**
-   * ETaskState.
-   *
-   * @group xr_task
-   */
-  export type TXR_TaskState = EnumeratedStaticsValues<typeof task>;
-
-  /**
-   * One objective inside a game task.
-   *
-   * @source C++ class SGameTaskObjective
-   * @customConstructor SGameTaskObjective
-   * @group xr_task
-   *
-   * @remarks
-   * Objective `0` is the task root objective. Additional objectives start at `1`.
-   */
-  export class SGameTaskObjective {
-    /**
-     * Whether the default map location should be visible for this objective.
-     *
-     * @remarks
-     * This mirrors the native `def_ml_enabled` field used by loaded task objectives.
-     */
-    public def_ml_enabled: boolean;
-
-    /**
-     * @remarks
-     * The objective stores a pointer to `task`; keep the parent task alive while using this objective.
-     *
-     * @param task - Parent task.
-     * @param id - Objective index.
-     */
-    public constructor(task: CGameTask, id: i32);
-
-    /**
-     * Get objective index inside the parent task.
-     *
-     * @returns Objective index.
-     */
-    public get_idx(): u16;
-
-    /**
-     * Set objective icon texture.
-     *
-     * @param icon_name - Icon texture or string table id.
-     */
-    public set_icon_name(icon_name: string): void;
-
-    /**
-     * @returns Objective icon name, or null when none is set.
-     */
-    public get_icon_name<T extends string = string>(): Nullable<T>;
-
-    /**
-     * Set objective description text.
-     *
-     * @param description - Description text or string table id.
-     */
-    public set_description(description: string): void;
-
-    /**
-     * @returns Objective description text or string table id.
-     */
-    public get_description(): string;
-
-    /**
-     * Set objective title.
-     *
-     * @param title - Title text or string table id.
-     */
-    public set_title(title: string): void;
-
-    /**
-     * @returns Objective title.
-     */
-    public get_title(): string;
-
-    /**
-     * Set encyclopedia article id unlocked with this objective.
-     *
-     * @param id - Encyclopedia article id.
-     */
-    public set_article_id(id: string): void;
-
-    /**
-     * Set encyclopedia article key for this objective.
-     *
-     * @param key - Article key.
-     */
-    public set_article_key(key: string): void;
-
-    /**
-     * Set map spot type used by this objective.
-     *
-     * @param location - Map location type.
-     */
-    public set_map_location(location: string): void;
-
-    /**
-     * Add a script function called after objective completion.
-     *
-     * @remarks
-     * Function names are resolved when a script-created objective is added to a task. Missing functions are logged and
-     * then skipped by the engine.
-     *
-     * @param function_name - Script function name.
-     */
-    public add_on_complete_func(function_name: string): void;
-
-    /**
-     * Require an info portion for objective completion.
-     *
-     * @param value - Info portion id.
-     */
-    public add_complete_info(value: string): void;
-
-    /**
-     * Give an info portion when objective fails.
-     *
-     * @param value - Info portion id.
-     */
-    public add_on_fail_info(value: string): void;
-
-    /**
-     * Add a script function called after objective failure.
-     *
-     * @remarks
-     * Function names are resolved when a script-created objective is added to a task. Missing functions are logged and
-     * then skipped by the engine.
-     *
-     * @param function_name - Script function name.
-     */
-    public add_on_fail_func(function_name: string): void;
-
-    /**
-     * Give an info portion when objective completes.
-     *
-     * @param value - Info portion id.
-     */
-    public add_on_complete_info(value: string): void;
-
-    /**
-     * Add a script predicate used to decide objective completion.
-     *
-     * @remarks
-     * Function names are resolved when a script-created objective is added to a task. Missing functions are logged and
-     * then skipped by the engine.
-     *
-     * @param function_name - Script function name.
-     */
-    public add_complete_func(function_name: string): void;
-
-    /**
-     * Add a script predicate used to decide objective failure.
-     *
-     * @remarks
-     * Function names are resolved when a script-created objective is added to a task. Missing functions are logged and
-     * then skipped by the engine.
-     *
-     * @param function_name - Script function name.
-     */
-    public add_fail_func(function_name: string): void;
-
-    /**
-     * Require an info portion for objective failure.
-     *
-     * @param value - Info portion id.
-     */
-    public add_fail_info(value: string): void;
-
-    /**
-     * @returns Current objective state.
-     */
-    public get_state(): TXR_TaskState;
-
-    /**
-     * @returns Task type, such as `task.storyline` or `task.additional`.
-     */
-    public get_type(): number; /* ETaskType */
-
-    /**
-     * Set task type.
-     *
-     * @param type - Task type, such as `task.storyline` or `task.additional`.
-     */
-    public set_type(type: i32 /* ETaskType */): void;
-
-    /**
-     * Set hint text for the linked map location.
-     *
-     * @param hint - Hint text or string table id.
-     */
-    public set_map_hint(hint: string): void;
-
-    /**
-     * @returns Target map location of task object.
-     */
-    public get_map_location(): string;
-
-    /**
-     * @returns Target map object ID of task object.
-     */
-    public get_map_object_id(): u16;
-
-    /**
-     * Replace linked map location data and recreate the spot.
-     *
-     * @remarks
-     * Removes the current linked spot, sets the objective back to `task.in_progress`, then creates a new map spot.
-     *
-     * @param new_map_location - New map location type.
-     * @param new_map_object_id - New target object id.
-     */
-    public change_map_location(new_map_location: string, new_map_object_id: u16): void;
-
-    /**
-     * Remove linked map locations.
-     *
-     * @remarks
-     * When `notify` is `false`, the linked map location is removed from the level map manager. The objective then clears
-     * its stored location type and object id.
-     *
-     * @param notify - Whether to notify task manager that the location was released.
-     */
-    public remove_map_locations(notify: boolean): void;
-
-    /**
-     * Create the linked map location if the objective has a spot type and object id.
-     *
-     * @remarks
-     * During load, the objective tries to reattach to an existing serializable spot owned by the task. During normal
-     * creation, it creates a new serializable spot and disables its pointer. The objective must already have a map
-     * location type and a valid game object id.
-     *
-     * @param on_load - Whether creation happens during save loading.
-     */
-    public create_map_location(on_load: boolean): void;
-
-    /**
-     * Set object id tracked by the objective map spot.
-     *
-     * @param id - Game object id.
-     */
-    public set_map_object_id(id: i32): void;
-
-    /**
-     * Shadow of Chernobyl alias for `set_map_object_id`.
-     *
-     * @param id - Game object id.
-     */
-    public set_object_id(id: i32): void;
-  }
-
-  /**
-   * Game task with one or more objectives.
-   *
-   * @source C++ class CGameTask : SGameTaskObjective
-   * @customConstructor CGameTask
-   * @group xr_task
-   *
-   * @remarks
-   * A task is also its root objective. Methods inherited from `SGameTaskObjective` operate on that root objective.
-   */
-  export class CGameTask extends SGameTaskObjective {
-    /**
-     * Create an empty game task.
-     */
-    public constructor();
-
-    /**
-     * Load task data from configs.
-     *
-     * @remarks
-     * Reads from `gameplay/game_tasks.xml`. Task XML function names are resolved immediately.
-     *
-     * @throws If the task id is missing from `game_tasks.xml` or a referenced task function cannot be resolved.
-     *
-     * @param id - Task id.
-     */
-    public load(id: string): void;
-
-    /**
-     * @returns Task id.
-     */
-    public get_id(): string;
-
-    /**
-     * Set task priority used by task UI ordering.
-     *
-     * @param priority - New priority.
-     */
-    public set_priority(priority: i32): void;
-
-    /**
-     * Set task id.
-     *
-     * @param id - Task id.
-     */
-    public set_id(id: string): void;
-
-    /**
-     * @returns Task priority.
-     */
-    public get_priority(): u32;
-
-    /**
-     * Add an objective to this task.
-     *
-     * @remarks
-     * The native binding adopts the objective and copies its current data into the task objective list. Mutating the
-     * original objective after this call does not update the stored copy.
-     *
-     * @param objective - Objective to adopt into the task.
-     */
-    public add_objective(objective: SGameTaskObjective): void;
-
-    /**
-     * Get objective by index.
-     *
-     * @remarks
-     * Index `0` returns the root objective. Other indices access native storage without a bounds check.
-     *
-     * @param objective_id - Objective index.
-     * @returns Objective instance.
-     */
-    public get_objective(objective_id: i32): SGameTaskObjective;
-
-    /**
-     * Count task objectives including the root objective.
-     *
-     * @returns Objective count.
-     */
-    public get_objectives_cnt(): u32;
-  }
-}

package/types/xr_lib/xr_time.d.ts

@@ -1,177 +0,0 @@
-declare module "xray16" {
-  /**
-   * Mutable game calendar/time value.
-   *
-   * Use `game.get_game_time()` for the current in-game time and `time_global()` for real elapsed milliseconds.
-   *
-   * @source C++ class CTime
-   * @customConstructor CTime
-   * @group xr_time
-   * @remarks
-   * Methods such as `add`, `sub`, `set`, and `setHMS` mutate the current instance.
-   */
-  export class CTime extends EngineBinding {
-    /**
-     * Date formatting mode: day.
-     */
-    public static DateToDay: 0;
-
-    /**
-     * Date formatting mode: month.
-     */
-    public static DateToMonth: 1;
-
-    /**
-     * Date formatting mode: year.
-     */
-    public static DateToYear: 2;
-
-    /**
-     * Time formatting mode: hours.
-     */
-    public static TimeToHours: 0;
-
-    /**
-     * Time formatting mode: milliseconds.
-     */
-    public static TimeToMilisecs: 3;
-
-    /**
-     * Time formatting mode: minutes.
-     */
-    public static TimeToMinutes: 1;
-
-    /**
-     * Time formatting mode: seconds.
-     */
-    public static TimeToSeconds: 2;
-
-    /**
-     * Create an empty time value.
-     */
-    public constructor();
-
-    /**
-     * Copy another time value.
-     *
-     * @param time - Time value to copy.
-     */
-    public constructor(time: CTime);
-
-    /**
-     * Add another time value to this one.
-     *
-     * @param time - Time span to add.
-     */
-    public add(time: CTime): void;
-
-    /**
-     * Format one date component as text.
-     *
-     * @param mode - One of `CTime.DateTo*` formatting constants.
-     * @returns Requested date component.
-     */
-    public dateToString(mode: i32): string;
-
-    /**
-     * Get difference from another game time in seconds.
-     *
-     * @param time - Time to compare with.
-     * @returns Difference in seconds.
-     */
-    public diffSec(time: CTime): f32;
-
-    /**
-     * Read all date and time components.
-     *
-     * The input values are placeholders for Lua out parameters.
-     *
-     * @returns Year, month, day, hour, minute, second, and millisecond.
-     */
-    public get(
-      y: u32,
-      m: u32,
-      d: u32,
-      h: u32,
-      min: u32,
-      sec: u32,
-      ms: u32
-    ): LuaMultiReturn<[u32, u32, u32, u32, u32, u32, u32]>;
-
-    /**
-     * Replace all date and time components.
-     *
-     * @param y - Year.
-     * @param m - Month.
-     * @param d - Day.
-     * @param h - Hour.
-     * @param min - Minute.
-     * @param sec - Second.
-     * @param ms - Millisecond.
-     */
-    public set(y: i32, m: i32, d: i32, h: i32, min: i32, sec: i32, ms: i32): void;
-
-    /**
-     * Replace time of day.
-     *
-     * @param h - Hour.
-     * @param m - Minute.
-     * @param s - Second.
-     */
-    public setHMS(h: i32, m: i32, s: i32): void;
-
-    /**
-     * Replace time of day including milliseconds.
-     *
-     * @param h - Hour.
-     * @param m - Minute.
-     * @param s - Second.
-     * @param ms - Millisecond.
-     */
-    public setHMSms(h: i32, m: i32, s: i32, ms: i32): void;
-
-    /**
-     * Subtract another time value from this one.
-     *
-     * @remarks
-     * The result is clamped at zero when `time` is greater than the current value.
-     *
-     * @param time - Time span to subtract.
-     */
-    public sub(time: CTime): void;
-
-    /**
-     * Format one time component as text.
-     *
-     * @param mode - One of `CTime.TimeTo*` formatting constants.
-     * @returns Requested time component.
-     */
-    public timeToString(mode: i32): string;
-  }
-
-  /**
-   * Get main-thread engine time in milliseconds since executable start.
-   *
-   * @group xr_time
-   *
-   * @remarks
-   * Reads `Device.dwTimeGlobal`, the frame-updated engine clock.
-   *
-   * @example 0, 1000, 60000
-   *
-   * @returns Milliseconds from game executable start.
-   */
-  export function time_global(this: void): u32;
-
-  /**
-   * Get asynchronous engine time in milliseconds since executable start.
-   *
-   * @group xr_time
-   *
-   * @remarks
-   * Reads the asynchronous multimedia timer, so it can advance outside the frame-updated `time_global` value.
-   *
-   * @returns Milliseconds from game executable start.
-   */
-  export function time_global_async(this: void): u32;
-}

package/types/xr_lib/xr_type.d.ts

@@ -1,70 +0,0 @@
-/**
- * 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_type
-   */
-  type i8 = number;
-
-  /**
-   * @group xr_type
-   */
-  type u8 = number;
-
-  /**
-   * @group xr_type
-   */
-  type i16 = number;
-
-  /**
-   * @group xr_type
-   */
-  type u16 = number;
-
-  /**
-   * @group xr_type
-   */
-  type f32 = number;
-
-  /**
-   * @group xr_type
-   */
-  type i32 = number;
-
-  /**
-   * @group xr_type
-   */
-  type u32 = number;
-
-  /**
-   * @group xr_type
-   */
-  type f64 = number;
-
-  /**
-   * @group xr_type
-   */
-  type i64 = number;
-
-  /**
-   * @group xr_type
-   */
-  type u64 = number;
-
-  /**
-   * @group xr_type
-   */
-  type AnyObject = Record<string, any>;
-
-  /**
-   * @group xr_type
-   */
-  type EnumeratedStaticsKeys<T> = Exclude<keyof T, "constructor" | TEngineBindingStaticMethods>;
-
-  /**
-   * @group xr_type
-   */
-  type EnumeratedStaticsValues<T> = T[Exclude<keyof T, "constructor" | TEngineBindingStaticMethods>];
-}

package/types/xr_object/client/xr_anomaly.d.ts

@@ -1,70 +0,0 @@
-declare module "xray16" {
-  /**
-   * Client object binding for `CMosquitoBald` anomaly objects.
-   *
-   * @source C++ class CMosquitoBald : CGameObject
-   * @customConstructor CMosquitoBald
-   * @group xr_anomaly
-   *
-   * @remarks
-   * Concrete anomaly wrapper. Generic anomaly helpers are usually available through `CCustomZone`/`game_object`.
-   */
-  export class CMosquitoBald extends CGameObject {}
-
-  /**
-   * Client object binding for torch items.
-   *
-   * @source C++ class CTorch : CGameObject
-   * @customConstructor CTorch
-   * @group xr_anomaly
-   *
-   * @remarks
-   * Torch-specific night-vision helpers on `game_object` require this runtime object.
-   */
-  export class CTorch extends CGameObject {}
-
-  /**
-   * Client object binding for `CTorridZone` anomaly objects.
-   *
-   * @source C++ class CTorridZone : CGameObject
-   * @customConstructor CTorridZone
-   * @group xr_anomaly
-   */
-  export class CTorridZone extends CGameObject {}
-
-  /**
-   * Client object binding for `CRadioactiveZone` anomaly objects.
-   *
-   * @source C++ class CRadioactiveZone : CGameObject
-   * @customConstructor CRadioactiveZone
-   * @group xr_anomaly
-   */
-  export class CRadioactiveZone extends CGameObject {}
-
-  /**
-   * Client object binding for `CMincer` anomaly objects.
-   *
-   * @source C++ class CMincer : CGameObject
-   * @customConstructor CMincer
-   * @group xr_anomaly
-   */
-  export class CMincer extends CGameObject {}
-
-  /**
-   * Client object binding for `CFracture` anomaly objects.
-   *
-   * @source C++ class CFracture : CGameObject
-   * @customConstructor CFracture
-   * @group xr_anomaly
-   */
-  export class CFracture extends CGameObject {}
-
-  /**
-   * Client object binding for `CHairsZone` anomaly objects.
-   *
-   * @source C++ class CHairsZone : CGameObject
-   * @customConstructor CHairsZone
-   * @group xr_anomaly
-   */
-  export class CHairsZone extends CGameObject {}
-}