xray16 1.3.2 → 1.4.0

package/types/xr_lib/xr_time.d.ts

@@ -1,61 +1,166 @@
-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;
-}
+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
+   */
+  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.
+     *
+     * @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
+   *
+   * @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
+   *
+   * @returns Milliseconds from game executable start.
+   */
+  export function time_global_async(this: void): u32;
+}

package/types/xr_lib/xr_type.d.ts

@@ -1,75 +1,75 @@
-/**
- * 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 Maybe<T> = T | null | undefined;
-
-  /**
-   * @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>];
-}
+/**
+ * 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 Maybe<T> = T | null | undefined;
+
+  /**
+   * @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,50 +1,50 @@
-declare module "xray16" {
-  /**
-   * @source C++ class CMosquitoBald : CGameObject
-   * @customConstructor CMosquitoBald
-   * @group xr_anomaly
-   */
-  export class CMosquitoBald extends CGameObject {}
-
-  /**
-   * @source C++ class CTorch : CGameObject
-   * @customConstructor CTorch
-   * @group xr_anomaly
-   */
-  export class CTorch extends CGameObject {}
-
-  /**
-   * @source C++ class CTorridZone : CGameObject
-   * @customConstructor CTorridZone
-   * @group xr_anomaly
-   */
-  export class CTorridZone extends CGameObject {}
-
-  /**
-   * @source C++ class CRadioactiveZone : CGameObject
-   * @customConstructor CRadioactiveZone
-   * @group xr_anomaly
-   */
-  export class CRadioactiveZone extends CGameObject {}
-
-  /**
-   * @source C++ class CMincer : CGameObject
-   * @customConstructor CMincer
-   * @group xr_anomaly
-   */
-  export class CMincer extends CGameObject {}
-
-  /**
-   * @source C++ class CFracture : CGameObject
-   * @customConstructor CFracture
-   * @group xr_anomaly
-   */
-  export class CFracture extends CGameObject {}
-
-  /**
-   * @source C++ class CHairsZone : CGameObject
-   * @customConstructor CHairsZone
-   * @group xr_anomaly
-   */
-  export class CHairsZone extends CGameObject {}
-}
+declare module "xray16" {
+  /**
+   * @source C++ class CMosquitoBald : CGameObject
+   * @customConstructor CMosquitoBald
+   * @group xr_anomaly
+   */
+  export class CMosquitoBald extends CGameObject {}
+
+  /**
+   * @source C++ class CTorch : CGameObject
+   * @customConstructor CTorch
+   * @group xr_anomaly
+   */
+  export class CTorch extends CGameObject {}
+
+  /**
+   * @source C++ class CTorridZone : CGameObject
+   * @customConstructor CTorridZone
+   * @group xr_anomaly
+   */
+  export class CTorridZone extends CGameObject {}
+
+  /**
+   * @source C++ class CRadioactiveZone : CGameObject
+   * @customConstructor CRadioactiveZone
+   * @group xr_anomaly
+   */
+  export class CRadioactiveZone extends CGameObject {}
+
+  /**
+   * @source C++ class CMincer : CGameObject
+   * @customConstructor CMincer
+   * @group xr_anomaly
+   */
+  export class CMincer extends CGameObject {}
+
+  /**
+   * @source C++ class CFracture : CGameObject
+   * @customConstructor CFracture
+   * @group xr_anomaly
+   */
+  export class CFracture extends CGameObject {}
+
+  /**
+   * @source C++ class CHairsZone : CGameObject
+   * @customConstructor CHairsZone
+   * @group xr_anomaly
+   */
+  export class CHairsZone extends CGameObject {}
+}

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

@@ -1,98 +1,98 @@
-declare module "xray16" {
-  /**
-   * @source C++ class CArtefact : CGameObject
-   * @customConstructor CArtefact
-   * @group xr_artefact
-   */
-  export class CArtefact extends CGameObject {
-    public constructor();
-
-    public FollowByPath(a: string, b: i32, c: vector): void;
-    public GetAfRank(): u8;
-    public SwitchVisibility(to: boolean): void;
-  }
-
-  /**
-   * @source C++ class CZudaArtefact : CArtefact
-   * @customConstructor CZudaArtefact
-   * @group xr_artefact
-   */
-  export class CZudaArtefact extends CArtefact {}
-
-  /**
-   * @source C++ class CThornArtefact : CArtefact
-   * @customConstructor CThornArtefact
-   * @group xr_artefact
-   */
-  export class CThornArtefact extends CArtefact {}
-
-  /**
-   * @source C++ class CBastArtefact : CArtefact
-   * @customConstructor CBastArtefact
-   * @group xr_artefact
-   */
-  export class CBastArtefact extends CArtefact {}
-
-  /**
-   * @source C++ class CBlackDrops : CArtefact
-   * @customConstructor CBlackDrops
-   * @group xr_artefact
-   */
-  export class CBlackDrops extends CArtefact {}
-
-  /**
-   * @source C++ class CBlackGraviArtefact : CArtefact
-   * @customConstructor CBlackGraviArtefact
-   * @group xr_artefact
-   */
-  export class CBlackGraviArtefact extends CArtefact {}
-
-  /**
-   * @source C++ class CDummyArtefact : CArtefact
-   * @customConstructor CDummyArtefact
-   * @group xr_artefact
-   */
-  export class CDummyArtefact extends CArtefact {}
-
-  /**
-   * @source C++ class CElectricBall : CArtefact
-   * @customConstructor CElectricBall
-   * @group xr_artefact
-   */
-  export class CElectricBall extends CArtefact {}
-
-  /**
-   * @source C++ class CFadedBall : CArtefact
-   * @customConstructor CFadedBall
-   * @group xr_artefact
-   */
-  export class CFadedBall extends CArtefact {}
-
-  /**
-   * @source C++ class CGalantineArtefact : CArtefact
-   * @customConstructor CGalantineArtefact
-   * @group xr_artefact
-   */
-  export class CGalantineArtefact extends CArtefact {}
-
-  /**
-   * @source C++ class CGraviArtefact : CArtefact
-   * @customConstructor CGraviArtefact
-   * @group xr_artefact
-   */
-  export class CGraviArtefact extends CArtefact {}
-
-  /**
-   * @source C++ class CMercuryBall : CArtefact
-   * @customConstructor CMercuryBall
-   * @group xr_artefact
-   */
-  export class CMercuryBall extends CArtefact {}
-
-  /**
-   * @source C++ class CRustyHairArtefact : CArtefact
-   * @customConstructor CRustyHairArtefact
-   * @group xr_artefact
-   */
-  export class CRustyHairArtefact extends CArtefact {}
-}
+declare module "xray16" {
+  /**
+   * @source C++ class CArtefact : CGameObject
+   * @customConstructor CArtefact
+   * @group xr_artefact
+   */
+  export class CArtefact extends CGameObject {
+    public constructor();
+
+    public FollowByPath(a: string, b: i32, c: vector): void;
+    public GetAfRank(): u8;
+    public SwitchVisibility(to: boolean): void;
+  }
+
+  /**
+   * @source C++ class CZudaArtefact : CArtefact
+   * @customConstructor CZudaArtefact
+   * @group xr_artefact
+   */
+  export class CZudaArtefact extends CArtefact {}
+
+  /**
+   * @source C++ class CThornArtefact : CArtefact
+   * @customConstructor CThornArtefact
+   * @group xr_artefact
+   */
+  export class CThornArtefact extends CArtefact {}
+
+  /**
+   * @source C++ class CBastArtefact : CArtefact
+   * @customConstructor CBastArtefact
+   * @group xr_artefact
+   */
+  export class CBastArtefact extends CArtefact {}
+
+  /**
+   * @source C++ class CBlackDrops : CArtefact
+   * @customConstructor CBlackDrops
+   * @group xr_artefact
+   */
+  export class CBlackDrops extends CArtefact {}
+
+  /**
+   * @source C++ class CBlackGraviArtefact : CArtefact
+   * @customConstructor CBlackGraviArtefact
+   * @group xr_artefact
+   */
+  export class CBlackGraviArtefact extends CArtefact {}
+
+  /**
+   * @source C++ class CDummyArtefact : CArtefact
+   * @customConstructor CDummyArtefact
+   * @group xr_artefact
+   */
+  export class CDummyArtefact extends CArtefact {}
+
+  /**
+   * @source C++ class CElectricBall : CArtefact
+   * @customConstructor CElectricBall
+   * @group xr_artefact
+   */
+  export class CElectricBall extends CArtefact {}
+
+  /**
+   * @source C++ class CFadedBall : CArtefact
+   * @customConstructor CFadedBall
+   * @group xr_artefact
+   */
+  export class CFadedBall extends CArtefact {}
+
+  /**
+   * @source C++ class CGalantineArtefact : CArtefact
+   * @customConstructor CGalantineArtefact
+   * @group xr_artefact
+   */
+  export class CGalantineArtefact extends CArtefact {}
+
+  /**
+   * @source C++ class CGraviArtefact : CArtefact
+   * @customConstructor CGraviArtefact
+   * @group xr_artefact
+   */
+  export class CGraviArtefact extends CArtefact {}
+
+  /**
+   * @source C++ class CMercuryBall : CArtefact
+   * @customConstructor CMercuryBall
+   * @group xr_artefact
+   */
+  export class CMercuryBall extends CArtefact {}
+
+  /**
+   * @source C++ class CRustyHairArtefact : CArtefact
+   * @customConstructor CRustyHairArtefact
+   * @group xr_artefact
+   */
+  export class CRustyHairArtefact extends CArtefact {}
+}