xray16 1.3.4 → 1.5.0

package/types/xr_lib/xr_relation.d.ts

@@ -1,84 +1,231 @@
-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;
-}
+declare module "xray16" {
+  /**
+   * Faction state shown by faction-war UI scripts.
+   *
+   * @source C++ class FactionState
+   * @customConstructor FactionState
+   * @group xr_relation
+   *
+   * @remarks
+   * This is a mutable data object filled by faction-war UI scripts. War state slots are fixed to five entries.
+   */
+  export class FactionState {
+    /**
+     * Current goodwill from this faction to the actor.
+     */
+    public actor_goodwill: i32;
+
+    /**
+     * Faction bonus level or id.
+     */
+    public bonus: i32;
+
+    /**
+     * Faction community id.
+     */
+    public faction_id: string;
+
+    /**
+     * Small faction icon texture.
+     */
+    public icon: string;
+
+    /**
+     * Large faction icon texture.
+     */
+    public icon_big: string;
+
+    /**
+     * Current faction map location.
+     */
+    public location: string;
+
+    /**
+     * Number of faction members.
+     */
+    public member_count: i32;
+
+    /**
+     * Localized faction name or string table id.
+     */
+    public name: string;
+
+    /**
+     * Faction combat power.
+     */
+    public power: f32;
+
+    /**
+     * Faction resource amount.
+     */
+    public resource: f32;
+
+    /**
+     * Current faction target.
+     */
+    public target: string;
+
+    /**
+     * Description of the current faction target.
+     */
+    public target_desc: string;
+
+    /**
+     * First faction war state line.
+     */
+    public war_state1: string;
+
+    /**
+     * Second faction war state line.
+     */
+    public war_state2: string;
+
+    /**
+     * Third faction war state line.
+     */
+    public war_state3: string;
+
+    /**
+     * Fourth faction war state line.
+     */
+    public war_state4: string;
+
+    /**
+     * Fifth faction war state line.
+     */
+    public war_state5: string;
+
+    /**
+     * Hint for the first faction war state line.
+     */
+    public war_state_hint1: string;
+
+    /**
+     * Hint for the second faction war state line.
+     */
+    public war_state_hint2: string;
+
+    /**
+     * Hint for the third faction war state line.
+     */
+    public war_state_hint3: string;
+
+    /**
+     * Hint for the fourth faction war state line.
+     */
+    public war_state_hint4: string;
+
+    /**
+     * Hint for the fifth faction war state line.
+     */
+    public war_state_hint5: string;
+
+    /**
+     * Engine-created faction state.
+     */
+    protected constructor();
+  }
+
+  /**
+   * @source namespace relation_registry
+   * @group xr_relation
+   *
+   * @remarks
+   * Community ids are resolved through the engine community registry. Invalid names follow the native registry rules.
+   */
+  export interface IXR_relation_registry {
+    /**
+     * Change relation from community to object by `delta_goodwill`.
+     *
+     * @remarks
+     * Applies the delta to the current goodwill, then clamps the result to `community_goodwill_limits`.
+     *
+     * @param from_community - Source community id.
+     * @param to_object_id - Target object id.
+     * @param delta_goodwill - Goodwill delta to apply.
+     */
+    change_community_goodwill(this: void, from_community: string, to_object_id: i32, delta_goodwill: i32): void;
+
+    /**
+     * Get goodwill from a community to an object.
+     *
+     * @remarks
+     * Returns neutral goodwill when no explicit community-to-object value is stored.
+     *
+     * @param from_community - Source community id.
+     * @param to_object_id - Target object id.
+     * @returns Stored community goodwill.
+     */
+    community_goodwill(this: void, from_community: string, to_object_id: i32): i32;
+
+    /**
+     * Get relation between two communities.
+     *
+     * @remarks
+     * Reads the global community relation matrix, not per-object goodwill.
+     *
+     * @param from_community - Source community id.
+     * @param to_community - Target community id.
+     * @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`.
+     *
+     * @remarks
+     * Both object ids must resolve to ALife trader objects. Non-trader objects log a script error and return `0`.
+     *
+     * @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 goodwill from a community to an object.
+     *
+     * @remarks
+     * The engine clamps the stored value to `community_goodwill_limits`.
+     *
+     * @param from_community - Source community id.
+     * @param to_object_id - Target object id.
+     * @param goodwill - New goodwill value.
+     */
+    set_community_goodwill(this: void, from_community: string, to_object_id: i32, goodwill: i32): void;
+
+    /**
+     * Set relation between two communities.
+     *
+     * @remarks
+     * Updates the global community relation matrix.
+     *
+     * @param from_community - Source community id.
+     * @param to_community - Target community id.
+     * @param goodwill - New community relation value.
+     */
+    set_community_relation(this: void, from_community: string, to_community: string, goodwill: i32): void;
+  }
+
+  /**
+   * Global relation registry helpers.
+   *
+   * @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

@@ -1,69 +1,167 @@
-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;
-}
+declare module "xray16" {
+  /**
+   * Current render device state.
+   *
+   * @source C++ class render_device
+   * @customConstructor render_device
+   * @group xr_render
+   *
+   * @remarks
+   * Values are snapshots of the global engine `Device` for the current frame.
+   */
+  export class render_device {
+    /**
+     * Engine-owned render device state.
+     */
+    private constructor();
+
+    /**
+     * Camera forward direction.
+     */
+    public readonly cam_dir: vector;
+
+    /**
+     * Camera world position.
+     */
+    public readonly cam_pos: vector;
+
+    /**
+     * Camera right direction.
+     */
+    public readonly cam_right: vector;
+
+    /**
+     * Camera up direction.
+     */
+    public readonly cam_top: vector;
+
+    /**
+     * Current viewport aspect ratio.
+     */
+    public readonly aspect_ratio: f32;
+
+    /**
+     * Current field of view.
+     */
+    public readonly fov: f32;
+
+    /**
+     * Remaining precache frame count.
+     */
+    public readonly precache_frame: u32;
+
+    /**
+     * Current render frame number.
+     */
+    public readonly frame: u32;
+
+    /**
+     * Backbuffer height in pixels.
+     */
+    public readonly height: u32;
+
+    /**
+     * Last frame time delta in milliseconds.
+     *
+     * @remarks
+     * This value is `0` while the game timer is paused.
+     */
+    public readonly time_delta: u32;
+
+    /**
+     * Last frame time delta in seconds.
+     *
+     * @remarks
+     * This value is `0` while the game timer is paused.
+     */
+    public readonly f_time_delta: f32;
+
+    /**
+     * Backbuffer width in pixels.
+     */
+    public readonly width: u32;
+
+    /**
+     * Get current game timestamp.
+     *
+     * @remarks
+     * Reads the frame-updated `Device.dwTimeGlobal` value.
+     *
+     * @example `29319`, `46297`
+     *
+     * @returns Milliseconds from game start.
+     */
+    public time_global(): u32;
+
+    /**
+     * Check whether the render device is paused.
+     *
+     * @returns Whether game rendering is paused.
+     */
+    public is_paused(): boolean;
+
+    /**
+     * Change game pause state.
+     *
+     * @remarks
+     * Pauses the game timer but not sound emitters. Dedicated servers and benchmark mode ignore pause requests.
+     *
+     * @param paused - Whether the game should be paused.
+     */
+    public pause(paused: boolean): void;
+  }
+
+  /**
+   * Get the global render device.
+   *
+   * @group xr_render
+   *
+   * @remarks
+   * Returns the engine-owned `Device` singleton.
+   *
+   * @returns Render device.
+   */
+  export function device(this: void): render_device;
+
+  /**
+   * Check whether the game persistent state finished loading.
+   *
+   * @group xr_render
+   *
+   * @returns Whether the app is ready for gameplay/render logic.
+   */
+  export function app_ready(this: void): boolean;
+
+  /**
+   * Check whether R2 renderer hardware support is available.
+   *
+   * @group xr_render
+   *
+   * @remarks
+   * In this binding the hardware test always returns `true`.
+   *
+   * @returns Whether R2 hardware test passes.
+   */
+  export function xrRender_test_r2_hw(this: void): boolean;
+
+  /**
+   * Get active renderer feature level.
+   *
+   * @group xr_render
+   *
+   * @returns Renderer DX level.
+   */
+  export function render_get_dx_level(this: void): number;
+
+  /**
+   * Check whether renderer setting can be changed at runtime.
+   *
+   * @group xr_global_declaration
+   *
+   * @remarks
+   * Returns `false` after the renderer command is locked by command-line or config processing.
+   *
+   * @returns Whether renderer setting can be changed.
+   */
+  export function renderer_allow_override(this: void): boolean;
+}