xray16 1.4.0 → 1.5.0

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

@@ -1,47 +1,85 @@
 declare module "xray16" {
   /**
+   * Client object binding for `CSpaceRestrictor` zones.
+   *
    * @source C++ class CSpaceRestrictor : CGameObject
    * @customConstructor CSpaceRestrictor
    * @group xr_zone
+   *
+   * @remarks
+   * Restrictor wrappers represent level volumes used by AI and script logic. They are not inventory items or alive
+   * entities.
    */
   export class CSpaceRestrictor extends CGameObject {}
 
   /**
+   * Client object binding for `CCustomZone` zones.
+   *
    * @source C++ class CCustomZone : public CSpaceRestrictor, public Feel::Touch
    * @customConstructor CCustomZone
    * @group xr_zone
+   *
+   * @remarks
+   * Anomaly power and activation helpers on `game_object` require this family.
    */
   export class CCustomZone extends CSpaceRestrictor {}
 
   /**
+   * Client object binding for `CLevelChanger` zones.
+   *
    * @source C++ class CLevelChanger : CGameObject
    * @customConstructor CLevelChanger
    * @group xr_zone
+   *
+   * @remarks
+   * Level-changer enable and invitation helpers require this runtime class.
    */
   export class CLevelChanger extends CGameObject {}
 
   /**
+   * Client object binding for `smart_cover_object` zones.
+   *
    * @source C++ class smart_cover_object : CGameObject
    * @customConstructor smart_cover_object
    * @group xr_zone
+   *
+   * @remarks
+   * Smart-cover suitability and loophole checks require this kind of object as the cover target.
    */
   export class smart_cover_object extends CGameObject {}
 
   /**
+   * Client object binding for `ce_script_zone` zones.
+   *
    * @source C++ class ce_script_zone : DLL_Pure
    * @customConstructor ce_script_zone
    * @group xr_zone
+   *
+   * @remarks
+   * Server-side zone entity wrapper used by engine internals and spawn data. Gameplay scripts usually interact with
+   * the client `CSpaceRestrictor` or `CCustomZone` wrapper instead.
    */
   export class ce_script_zone extends DLL_Pure {
+    /**
+     * Engine-created script zone server entity.
+     */
     protected constructor();
   }
 
   /**
+   * Client object binding for `ce_smart_zone` zones.
+   *
    * @source C++ class ce_smart_zone : DLL_Pure
    * @customConstructor ce_smart_zone
    * @group xr_zone
+   *
+   * @remarks
+   * Server-side smart-zone entity wrapper. Use client smart-cover objects for runtime cover checks.
    */
   export class ce_smart_zone extends DLL_Pure {
+    /**
+     * Engine-created smart zone server entity.
+     */
     protected constructor();
   }
 }

package/types/xr_object/script/xr_script_interface.d.ts

@@ -1,31 +1,65 @@
 declare module "xray16" {
   /**
+   * Cover point returned by cover search helpers.
+   *
    * @source C++ class cover_point
    * @customConstructor cover_point
    * @group xr_script_interface
    */
   export class cover_point {
+    /**
+     * Engine-created cover point descriptor.
+     */
     private constructor();
 
+    /**
+     * Get the level vertex occupied by this cover.
+     *
+     * @returns Level vertex id.
+     */
     public level_vertex_id(): u32;
 
+    /**
+     * Check whether this cover point comes from a smart cover.
+     *
+     * @returns Whether it is a smart cover.
+     */
     public is_smart_cover(): boolean;
 
+    /**
+     * Get cover position.
+     *
+     * @returns Cover position.
+     */
     public position(): vector;
   }
 
   /**
+   * Hit context passed to monster combat callbacks.
+   *
    * @source C++ class MonsterHitInfo
    * @customConstructor MonsterHitInfo
    * @group xr_script_interface
    */
   export class MonsterHitInfo extends EngineBinding {
+    /**
+     * Engine-created monster hit descriptor.
+     */
     private constructor();
 
+    /**
+     * Hit direction.
+     */
     public direction: vector;
 
+    /**
+     * Hit time.
+     */
     public time: i32;
 
+    /**
+     * Object that caused the hit.
+     */
     public who: game_object;
   }
 
@@ -49,6 +83,8 @@ declare module "xray16" {
   export type TXR_game_object_path = 0 | 1 | 2 | 3 | number;
 
   /**
+   * Engine callback id registry.
+   *
    * @source C++ class callback
    * @customConstructor callback
    * @group xr_script_interface
@@ -58,65 +94,230 @@ declare module "xray16" {
      * Default x-ray 16 callbacks.
      */
     public static readonly trade_start: 0;
+    /**
+     * Engine enum value for `callback.trade_stop`.
+     */
     public static readonly trade_stop: 1;
+    /**
+     * Engine enum value for `callback.trade_sell_buy_item`.
+     */
     public static readonly trade_sell_buy_item: 2;
+    /**
+     * Engine enum value for `callback.trade_perform_operation`.
+     */
     public static readonly trade_perform_operation: 3;
+    /**
+     * Engine enum value for `callback.zone_enter`.
+     */
     public static readonly zone_enter: 4;
+    /**
+     * Engine enum value for `callback.zone_exit`.
+     */
     public static readonly zone_exit: 5;
+    /**
+     * Engine enum value for `callback.level_border_exit`.
+     */
     public static readonly level_border_exit: 6;
+    /**
+     * Engine enum value for `callback.level_border_enter`.
+     */
     public static readonly level_border_enter: 7;
+    /**
+     * Engine enum value for `callback.death`.
+     */
     public static readonly death: 8;
+    /**
+     * Engine enum value for `callback.patrol_path_in_point`.
+     */
     public static readonly patrol_path_in_point: 9;
+    /**
+     * Engine enum value for `callback.inventory_pda`.
+     */
     public static readonly inventory_pda: 10;
+    /**
+     * Engine enum value for `callback.inventory_info`.
+     */
     public static readonly inventory_info: 11;
+    /**
+     * Engine enum value for `callback.article_info`.
+     */
     public static readonly article_info: 12;
+    /**
+     * Engine enum value for `callback.task_state`.
+     */
     public static readonly task_state: 13;
+    /**
+     * Engine enum value for `callback.map_location_added`.
+     */
     public static readonly map_location_added: 14;
+    /**
+     * Engine enum value for `callback.use_object`.
+     */
     public static readonly use_object: 15;
+    /**
+     * Engine enum value for `callback.hit`.
+     */
     public static readonly hit: 16;
+    /**
+     * Engine enum value for `callback.sound`.
+     */
     public static readonly sound: 17;
+    /**
+     * Engine enum value for `callback.action_movement`.
+     */
     public static readonly action_movement: 18;
+    /**
+     * Engine enum value for `callback.action_watch`.
+     */
     public static readonly action_watch: 19;
+    /**
+     * Engine enum value for `callback.action_removed`.
+     */
     public static readonly action_removed: 20;
+    /**
+     * Engine enum value for `callback.action_animation`.
+     */
     public static readonly action_animation: 21;
+    /**
+     * Engine enum value for `callback.action_sound`.
+     */
     public static readonly action_sound: 22;
+    /**
+     * Engine enum value for `callback.action_particle`.
+     */
     public static readonly action_particle: 23;
+    /**
+     * Engine enum value for `callback.action_object`.
+     */
     public static readonly action_object: 24;
+    /**
+     * Engine enum value for `callback.actor_sleep`.
+     */
     public static readonly actor_sleep: 25;
+    /**
+     * Engine enum value for `callback.helicopter_on_point`.
+     */
     public static readonly helicopter_on_point: 26;
+    /**
+     * Engine enum value for `callback.helicopter_on_hit`.
+     */
     public static readonly helicopter_on_hit: 27;
+    /**
+     * Engine enum value for `callback.on_item_take`.
+     */
     public static readonly on_item_take: 28;
+    /**
+     * Engine enum value for `callback.on_item_drop`.
+     */
     public static readonly on_item_drop: 29;
+    /**
+     * Engine enum value for `callback.script_animation`.
+     */
     public static readonly script_animation: 30;
+    /**
+     * Engine enum value for `callback.trader_global_anim_request`.
+     */
     public static readonly trader_global_anim_request: 31;
+    /**
+     * Engine enum value for `callback.trader_head_anim_request`.
+     */
     public static readonly trader_head_anim_request: 32;
+    /**
+     * Engine enum value for `callback.trader_sound_end`.
+     */
     public static readonly trader_sound_end: 33;
+    /**
+     * Engine enum value for `callback.take_item_from_box`.
+     */
     public static readonly take_item_from_box: 34;
+    /**
+     * Engine enum value for `callback.weapon_no_ammo`.
+     */
     public static readonly weapon_no_ammo: 35;
+    /**
+     * Engine enum value for `callback.hud_animation_end`.
+     */
     public static readonly hud_animation_end: 36;
 
+    /**
+     * Engine enum value for `callback.key_press`.
+     */
     public static readonly key_press: 37;
+    /**
+     * Engine enum value for `callback.key_release`.
+     */
     public static readonly key_release: 38;
+    /**
+     * Engine enum value for `callback.key_hold`.
+     */
     public static readonly key_hold: 39;
+    /**
+     * Engine enum value for `callback.mouse_move`.
+     */
     public static readonly mouse_move: 40;
+    /**
+     * Engine enum value for `callback.mouse_wheel`.
+     */
     public static readonly mouse_wheel: 41;
+    /**
+     * Engine enum value for `callback.controller_press`.
+     */
     public static readonly controller_press: 42;
+    /**
+     * Engine enum value for `callback.controller_release`.
+     */
     public static readonly controller_release: 43;
+    /**
+     * Engine enum value for `callback.controller_hold`.
+     */
     public static readonly controller_hold: 44;
     // Public static readonly controller_attitude_change: 45;
 
+    /**
+     * Engine enum value for `callback.item_to_belt`.
+     */
     public static readonly item_to_belt: 46;
+    /**
+     * Engine enum value for `callback.item_to_slot`.
+     */
     public static readonly item_to_slot: 47;
+    /**
+     * Engine enum value for `callback.item_to_ruck`.
+     */
     public static readonly item_to_ruck: 48;
 
+    /**
+     * Engine enum value for `callback.weapon_zoom_in`.
+     */
     public static readonly weapon_zoom_in: 49;
+    /**
+     * Engine enum value for `callback.weapon_zoom_out`.
+     */
     public static readonly weapon_zoom_out: 50;
+    /**
+     * Engine enum value for `callback.weapon_jammed`.
+     */
     public static readonly weapon_jammed: 51;
+    /**
+     * Engine enum value for `callback.weapon_magazine_empty`.
+     */
     public static readonly weapon_magazine_empty: 52;
 
+    /**
+     * Engine enum value for `callback.actor_before_death`.
+     */
     public static readonly actor_before_death: 53;
+    /**
+     * Engine enum value for `callback.on_attach_vehicle`.
+     */
     public static readonly on_attach_vehicle: 54;
+    /**
+     * Engine enum value for `callback.on_detach_vehicle`.
+     */
     public static readonly on_detach_vehicle: 55;
+    /**
+     * Engine enum value for `callback.on_use_vehicle`.
+     */
     public static readonly on_use_vehicle: 56;
   }
 
@@ -242,7 +443,7 @@ declare module "xray16" {
     // 10 todo: inventory_pda -> implement in game engine
 
     /**
-     * 11 todo:
+     * Callback executed when an NPC receives an info portion.
      */
     public set_callback<T extends AnyObject>(
       type: TXR_callbacks["inventory_info"],
@@ -278,6 +479,10 @@ declare module "xray16" {
       cb?: ((this: void, object: game_object) => void) | null,
       object?: Maybe<T>
     ): void;
+
+    /**
+     * 15 Use some object with explicit user object.
+     */
     public set_callback<T extends AnyObject>(
       type: TXR_callbacks["use_object"],
       cb?: ((this: void, object: game_object, who: game_object) => void) | null,
@@ -569,16 +774,46 @@ declare module "xray16" {
 
     // 56 todo: on_use_vehicle
 
+    /**
+     * Clear all callbacks registered on this object.
+     */
     public clear_callbacks(): void;
 
+    /**
+     * Clear the custom enemy selector callback.
+     */
     public set_enemy_callback(cb: null): void;
 
+    /**
+     * Set a custom enemy selector callback.
+     *
+     * @param cb - Callback that receives this object and a candidate enemy.
+     * @param object - Lua context used as callback `this`.
+     */
     public set_enemy_callback<T>(cb: (this: T, object: game_object, enemy: game_object) => boolean, object: T): void;
 
+    /**
+     * Set a fast update callback for this object.
+     *
+     * @param cb - Callback called from the object's fast update path.
+     * @param context - Lua context used as callback `this`.
+     */
     public set_fastcall<T>(cb: (this: T) => boolean, context: T): void;
 
+    /**
+     * Set or clear the patrol extrapolation callback.
+     *
+     * @param cb - Callback called with current patrol point index.
+     * @param object - Optional Lua context.
+     */
     public set_patrol_extrapolate_callback(cb?: ((cur_pt: number) => boolean) | null, object?: object): void;
 
+    /**
+     * Set or clear smart-cover target selection callback.
+     *
+     * @param cb - Callback that receives this object when a smart-cover target is selected.
+     * @param object - Optional Lua context.
+     */
     public set_smart_cover_target_selector(cb?: ((object: game_object) => void) | null, object?: object | null): void;
   }
 }