xray16 1.6.0 → 1.6.2

package/types/xr_lib/xr_dialog.d.ts

@@ -1,132 +0,0 @@
-declare module "xray16" {
-  /**
-   * Script rules attached to a dialog phrase.
-   *
-   * @source C++ class CPhraseScript
-   * @customConstructor CPhraseScript
-   * @group xr_dialog
-   *
-   * @remarks
-   * Phrase scripts are evaluated by the dialog engine against the current actor/NPC speakers. Info portion checks use
-   * the actor info registry.
-   */
-  export class CPhraseScript {
-    /**
-     * Run a script action after the phrase is spoken.
-     *
-     * @remarks
-     * In active two-speaker dialogs the function receives `(speaker, listener, dialog_id, phrase_id)`. In simpler
-     * dialog checks it receives `(speaker, dialog_id)`.
-     *
-     * @throws If the function name cannot be resolved.
-     *
-     * @param function_name - Script function name.
-     */
-    public AddAction(function_name: string): void;
-
-    /**
-     * Disable an info portion when phrase actions run.
-     *
-     * @remarks
-     * Applied after the phrase is accepted and its actions run.
-     *
-     * @param info_portion - Info portion id.
-     */
-    public AddDisableInfo(info_portion: string): void;
-
-    /**
-     * Require an info portion to be absent before the phrase is available.
-     *
-     * @param info_portion - Info portion id.
-     */
-    public AddDontHasInfo(info_portion: string): void;
-
-    /**
-     * Give an info portion when phrase actions run.
-     *
-     * @remarks
-     * Applied after the phrase is accepted and its actions run.
-     *
-     * @param info_portion - Info portion id.
-     */
-    public AddGiveInfo(info_portion: string): void;
-
-    /**
-     * Require an info portion before the phrase is available.
-     *
-     * @param info_portion - Info portion id.
-     */
-    public AddHasInfo(info_portion: string): void;
-
-    /**
-     * Add a script predicate checked before the phrase is available.
-     *
-     * @remarks
-     * In active two-speaker dialogs the function receives `(speaker, listener, dialog_id, phrase_id, next_phrase_id)`.
-     * It should return `true` when the phrase may be shown.
-     *
-     * @throws If the function name cannot be resolved.
-     *
-     * @param function_name - Script function name.
-     */
-    public AddPrecondition(function_name: string): void;
-
-    /**
-     * Use a script function to provide phrase text.
-     *
-     * @remarks
-     * The function is called when the dialog asks for phrase text. Use it for text that depends on the current speaker
-     * or dialog state.
-     *
-     * @throws If the function name cannot be resolved.
-     *
-     * @param function_name - Script function name.
-     */
-    public SetScriptText(function_name: string): void;
-  }
-
-  /**
-   * Runtime phrase in a phrase dialog.
-   *
-   * @source C++ class CPhrase
-   * @customConstructor CPhrase
-   * @group xr_dialog
-   *
-   * @remarks
-   * Phrase instances are owned by the dialog graph. Script code usually configures them immediately after
-   * `CPhraseDialog.AddPhrase`.
-   */
-  export class CPhrase {
-    /**
-     * @returns Script helper used to configure phrase conditions and actions.
-     */
-    public GetPhraseScript(): CPhraseScript;
-  }
-
-  /**
-   * Phrase dialog built or extended from scripts.
-   *
-   * @source C++ class CPhraseDialog
-   * @customConstructor CPhraseDialog
-   * @group xr_dialog
-   *
-   * @remarks
-   * A phrase dialog is a directed phrase graph. Phrase id `"0"` is the start phrase used by loaded XML dialogs.
-   */
-  export class CPhraseDialog {
-    /**
-     * Add a phrase to the dialog tree.
-     *
-     * @remarks
-     * `prev_phrase_id` creates the edge from the previous phrase to the new one. Pass an empty string for a root phrase.
-     * Reusing an existing `phrase_id` returns the existing phrase and still links it from `prev_phrase_id`.
-     *
-     * @param text - Text or string table id.
-     * @param phrase_id - New phrase id.
-     * @param prev_phrase_id - Parent phrase id, or an empty string.
-     * @param goodwill_level - Goodwill value used when the engine orders available replies.
-     * @returns Created phrase.
-     */
-    public AddPhrase(text: string, phrase_id: string, prev_phrase_id: string, goodwill_level: i32): CPhrase;
-  }
-}

package/types/xr_lib/xr_flags.d.ts

@@ -1,592 +0,0 @@
-declare module "xray16" {
-  /**
-   * Mutable 8-bit flag mask.
-   *
-   * @source C++ class flags8
-   * @customConstructor flags8
-   * @group xr_flags
-   *
-   * @remarks
-   * Use `zero()`, `one()`, or `assign()` when you need an explicit initial state.
-   */
-  export class flags8 {
-    /**
-     * Create a flag mask.
-     */
-    public constructor();
-
-    /**
-     * Replace this mask with `source & mask`.
-     *
-     * @param source - Source mask.
-     * @param mask - Bits to keep.
-     * @returns This mask.
-     */
-    public and(source: flags8, mask: u8): flags8;
-
-    /**
-     * Apply bitwise AND to this mask.
-     *
-     * @param mask - Bits to keep.
-     * @returns This mask.
-     */
-    public and(mask: u8): flags8;
-
-    /**
-     * Copy another flag mask.
-     *
-     * @param value - Source mask.
-     * @returns This mask.
-     */
-    public assign(value: flags8): flags8;
-
-    /**
-     * Replace this mask with a raw value.
-     *
-     * @param value - Raw mask value.
-     * @returns This mask.
-     */
-    public assign(value: u8): flags8;
-
-    /**
-     * Compare this mask with another mask.
-     *
-     * @param value - Mask to compare.
-     * @returns Whether masks are equal.
-     */
-    public equal(value: Readonly<flags8>): boolean;
-
-    /**
-     * Compare selected bits with another mask.
-     *
-     * @param value - Mask to compare.
-     * @param mask - Bits to compare.
-     * @returns Whether selected bits are equal.
-     */
-    public equal(value: Readonly<flags8>, mask: u8): boolean;
-
-    /**
-     * Get raw mask value.
-     *
-     * @returns Raw mask value.
-     */
-    public get(): u8;
-
-    /**
-     * Invert all bits in this mask.
-     *
-     * @returns This mask.
-     */
-    public invert(): flags8;
-
-    /**
-     * Replace this mask with inverted source mask.
-     *
-     * @param value - Source mask.
-     * @returns This mask.
-     */
-    public invert(value: flags8): flags8;
-
-    /**
-     * Toggle selected bits in this mask.
-     *
-     * @param value - Bits to toggle.
-     * @returns This mask.
-     */
-    public invert(value: u8): flags8;
-
-    /**
-     * Check whether all selected bits are set in a source mask.
-     *
-     * @remarks
-     * This is stricter than `is_any()` and `test()`: every bit from `mask` must be present.
-     *
-     * @param value - Source mask.
-     * @param mask - Bits to test.
-     * @returns Whether all bits are set.
-     */
-    public is(value: flags8, mask: u8): boolean;
-
-    /**
-     * Check whether all selected bits are set in this mask.
-     *
-     * @remarks
-     * This is stricter than `is_any()` and `test()`: every bit from `mask` must be present.
-     *
-     * @param mask - Bits to test.
-     * @returns Whether all bits are set.
-     */
-    public is(mask: u8): boolean;
-
-    /**
-     * Check whether any selected bit is set in a source mask.
-     *
-     * @remarks
-     * Use this for overlap checks. For an all-bits check, use `is()`.
-     *
-     * @param value - Source mask.
-     * @param mask - Bits to test.
-     * @returns Whether any bit is set.
-     */
-    public is_any(value: flags8, mask: u8): boolean;
-
-    /**
-     * Check whether any selected bit is set in this mask.
-     *
-     * @remarks
-     * Use this for overlap checks. For an all-bits check, use `is()`.
-     *
-     * @param mask - Bits to test.
-     * @returns Whether any bit is set.
-     */
-    public is_any(mask: u8): boolean;
-
-    /**
-     * Set all bits.
-     *
-     * @remarks
-     * Sets all 8 bits to `1`.
-     *
-     * @returns This mask.
-     */
-    public one(): flags8;
-
-    /**
-     * Replace this mask with `source | mask`.
-     *
-     * @param source - Source mask.
-     * @param mask - Bits to set.
-     * @returns This mask.
-     */
-    public or(source: flags8, mask: u8): flags8;
-
-    /**
-     * Apply bitwise OR to this mask.
-     *
-     * @param mask - Bits to set.
-     * @returns This mask.
-     */
-    public or(mask: u8): flags8;
-
-    /**
-     * Set or clear selected bits.
-     *
-     * @param mask - Bits to update.
-     * @param enabled - Whether bits should be set.
-     * @returns This mask.
-     */
-    public set(mask: u8, enabled: boolean): flags8;
-
-    /**
-     * Test whether any selected bit is set.
-     *
-     * @remarks
-     * Equivalent to `is_any(mask)`.
-     *
-     * @param mask - Bits to test.
-     * @returns Whether any selected bit is set.
-     */
-    public test(mask: u8): boolean;
-
-    /**
-     * Clear all bits.
-     *
-     * @returns This mask.
-     */
-    public zero(): flags8;
-  }
-
-  /**
-   * Mutable 16-bit flag mask.
-   *
-   * @source C++ class flags16
-   * @customConstructor flags16
-   * @group xr_flags
-   *
-   * @remarks
-   * Use `zero()`, `one()`, or `assign()` when you need an explicit initial state.
-   */
-  export class flags16 {
-    /**
-     * Create a flag mask.
-     */
-    public constructor();
-
-    /**
-     * Replace this mask with `source & mask`.
-     *
-     * @param source - Source mask.
-     * @param mask - Bits to keep.
-     * @returns This mask.
-     */
-    public and(source: flags16, mask: u16): flags16;
-
-    /**
-     * Apply bitwise AND to this mask.
-     *
-     * @param mask - Bits to keep.
-     * @returns This mask.
-     */
-    public and(mask: u16): flags16;
-
-    /**
-     * Copy another flag mask.
-     *
-     * @param value - Source mask.
-     * @returns This mask.
-     */
-    public assign(value: flags16): flags16;
-
-    /**
-     * Replace this mask with a raw value.
-     *
-     * @param value - Raw mask value.
-     * @returns This mask.
-     */
-    public assign(value: u16): flags16;
-
-    /**
-     * Compare this mask with another mask.
-     *
-     * @param value - Mask to compare.
-     * @returns Whether masks are equal.
-     */
-    public equal(value: Readonly<flags16>): boolean;
-
-    /**
-     * Compare selected bits with another mask.
-     *
-     * @param value - Mask to compare.
-     * @param mask - Bits to compare.
-     * @returns Whether selected bits are equal.
-     */
-    public equal(value: Readonly<flags16>, mask: u16): boolean;
-
-    /**
-     * Get raw mask value.
-     *
-     * @returns Raw mask value.
-     */
-    public get(): u16;
-
-    /**
-     * Invert all bits in this mask.
-     *
-     * @returns This mask.
-     */
-    public invert(): flags16;
-
-    /**
-     * Replace this mask with inverted source mask.
-     *
-     * @param value - Source mask.
-     * @returns This mask.
-     */
-    public invert(value: flags16): flags16;
-
-    /**
-     * Toggle selected bits in this mask.
-     *
-     * @param value - Bits to toggle.
-     * @returns This mask.
-     */
-    public invert(value: u16): flags16;
-
-    /**
-     * Check whether all selected bits are set in a source mask.
-     *
-     * @remarks
-     * This is stricter than `is_any()` and `test()`: every bit from `mask` must be present.
-     *
-     * @param value - Source mask.
-     * @param mask - Bits to test.
-     * @returns Whether all bits are set.
-     */
-    public is(value: flags16, mask: u16): boolean;
-
-    /**
-     * Check whether all selected bits are set in this mask.
-     *
-     * @remarks
-     * This is stricter than `is_any()` and `test()`: every bit from `mask` must be present.
-     *
-     * @param mask - Bits to test.
-     * @returns Whether all bits are set.
-     */
-    public is(mask: u16): boolean;
-
-    /**
-     * Check whether any selected bit is set in a source mask.
-     *
-     * @remarks
-     * Use this for overlap checks. For an all-bits check, use `is()`.
-     *
-     * @param value - Source mask.
-     * @param mask - Bits to test.
-     * @returns Whether any bit is set.
-     */
-    public is_any(value: flags16, mask: u16): boolean;
-
-    /**
-     * Check whether any selected bit is set in this mask.
-     *
-     * @remarks
-     * Use this for overlap checks. For an all-bits check, use `is()`.
-     *
-     * @param mask - Bits to test.
-     * @returns Whether any bit is set.
-     */
-    public is_any(mask: u16): boolean;
-
-    /**
-     * Set all bits.
-     *
-     * @remarks
-     * Sets all 16 bits to `1`.
-     *
-     * @returns This mask.
-     */
-    public one(): flags16;
-
-    /**
-     * Replace this mask with `source | mask`.
-     *
-     * @param source - Source mask.
-     * @param mask - Bits to set.
-     * @returns This mask.
-     */
-    public or(source: flags16, mask: u16): flags16;
-
-    /**
-     * Apply bitwise OR to this mask.
-     *
-     * @param mask - Bits to set.
-     * @returns This mask.
-     */
-    public or(mask: u16): flags16;
-
-    /**
-     * Set or clear selected bits.
-     *
-     * @param mask - Bits to update.
-     * @param enabled - Whether bits should be set.
-     * @returns This mask.
-     */
-    public set(mask: u16, enabled: boolean): flags16;
-
-    /**
-     * Test whether any selected bit is set.
-     *
-     * @remarks
-     * Equivalent to `is_any(mask)`.
-     *
-     * @param mask - Bits to test.
-     * @returns Whether any selected bit is set.
-     */
-    public test(mask: u16): boolean;
-
-    /**
-     * Clear all bits.
-     *
-     * @returns This mask.
-     */
-    public zero(): flags16;
-  }
-
-  /**
-   * Mutable 32-bit flag mask.
-   *
-   * @source C++ class flags32
-   * @customConstructor flags32
-   * @group xr_flags
-   *
-   * @remarks
-   * Use `zero()`, `one()`, or `assign()` when you need an explicit initial state.
-   */
-  export class flags32 {
-    /**
-     * Create a flag mask.
-     */
-    public constructor();
-
-    /**
-     * Replace this mask with `source & mask`.
-     *
-     * @param source - Source mask.
-     * @param mask - Bits to keep.
-     * @returns This mask.
-     */
-    public and(source: flags32, mask: u32): flags32;
-
-    /**
-     * Apply bitwise AND to this mask.
-     *
-     * @param mask - Bits to keep.
-     * @returns This mask.
-     */
-    public and(mask: u32): flags32;
-
-    /**
-     * Copy another flag mask.
-     *
-     * @param value - Source mask.
-     * @returns This mask.
-     */
-    public assign(value: flags32): flags32;
-
-    /**
-     * Replace this mask with a raw value.
-     *
-     * @param value - Raw mask value.
-     * @returns This mask.
-     */
-    public assign(value: u32): flags32;
-
-    /**
-     * Compare this mask with another mask.
-     *
-     * @param value - Mask to compare.
-     * @returns Whether masks are equal.
-     */
-    public equal(value: Readonly<flags32>): boolean;
-
-    /**
-     * Compare selected bits with another mask.
-     *
-     * @param value - Mask to compare.
-     * @param mask - Bits to compare.
-     * @returns Whether selected bits are equal.
-     */
-    public equal(value: Readonly<flags32>, mask: u32): boolean;
-
-    /**
-     * Get raw mask value.
-     *
-     * @returns Raw mask value.
-     */
-    public get(): u32;
-
-    /**
-     * Invert all bits in this mask.
-     *
-     * @returns This mask.
-     */
-    public invert(): flags32;
-
-    /**
-     * Replace this mask with inverted source mask.
-     *
-     * @param value - Source mask.
-     * @returns This mask.
-     */
-    public invert(value: flags32): flags32;
-
-    /**
-     * Toggle selected bits in this mask.
-     *
-     * @param value - Bits to toggle.
-     * @returns This mask.
-     */
-    public invert(value: u32): flags32;
-
-    /**
-     * Check whether all selected bits are set in a source mask.
-     *
-     * @remarks
-     * This is stricter than `is_any()` and `test()`: every bit from `mask` must be present.
-     *
-     * @param value - Source mask.
-     * @param mask - Bits to test.
-     * @returns Whether all bits are set.
-     */
-    public is(value: flags32, mask: u32): boolean;
-
-    /**
-     * Check whether all selected bits are set in this mask.
-     *
-     * @remarks
-     * This is stricter than `is_any()` and `test()`: every bit from `mask` must be present.
-     *
-     * @param mask - Bits to test.
-     * @returns Whether all bits are set.
-     */
-    public is(mask: u32): boolean;
-
-    /**
-     * Check whether any selected bit is set in a source mask.
-     *
-     * @remarks
-     * Use this for overlap checks. For an all-bits check, use `is()`.
-     *
-     * @param value - Source mask.
-     * @param mask - Bits to test.
-     * @returns Whether any bit is set.
-     */
-    public is_any(value: flags32, mask: u32): boolean;
-
-    /**
-     * Check whether any selected bit is set in this mask.
-     *
-     * @remarks
-     * Use this for overlap checks. For an all-bits check, use `is()`.
-     *
-     * @param mask - Bits to test.
-     * @returns Whether any bit is set.
-     */
-    public is_any(mask: u32): boolean;
-
-    /**
-     * Set all bits.
-     *
-     * @remarks
-     * Sets all 32 bits to `1`.
-     *
-     * @returns This mask.
-     */
-    public one(): flags32;
-
-    /**
-     * Replace this mask with `source | mask`.
-     *
-     * @param source - Source mask.
-     * @param mask - Bits to set.
-     * @returns This mask.
-     */
-    public or(source: flags32, mask: u32): flags32;
-
-    /**
-     * Apply bitwise OR to this mask.
-     *
-     * @param mask - Bits to set.
-     * @returns This mask.
-     */
-    public or(mask: u32): flags32;
-
-    /**
-     * Set or clear selected bits.
-     *
-     * @param mask - Bits to update.
-     * @param enabled - Whether bits should be set.
-     * @returns This mask.
-     */
-    public set(mask: u32, enabled: boolean): flags32;
-
-    /**
-     * Test whether any selected bit is set.
-     *
-     * @remarks
-     * Equivalent to `is_any(mask)`.
-     *
-     * @param mask - Bits to test.
-     * @returns Whether any selected bit is set.
-     */
-    public test(mask: u32): boolean;
-
-    /**
-     * Clear all bits.
-     *
-     * @returns This mask.
-     */
-    public zero(): flags32;
-  }
-}