xray16 1.4.0 → 1.5.1

package/types/xr_object/server/xr_server_object.d.ts

@@ -72,13 +72,32 @@ declare module "xray16" {
   export interface IXR_cpure_server_object extends IXR_ipure_server_object {}
 
   /**
+   * Server-side inventory item mixin.
+   *
    * @source C++ class cse_alife_inventory_item
    * @group xr_object_server
+   *
+   * @remarks
+   * Upgrade ids are stored on the server object and serialized with it.
    */
   export interface IXR_cse_alife_inventory_item {
+    /**
+     * Check whether the item already has an upgrade section.
+     *
+     * @param section - Upgrade section id.
+     * @returns Whether the upgrade is installed.
+     */
     has_upgrade(section: string): boolean;
 
-    add_upgrade(section: string): boolean;
+    /**
+     * Add an upgrade section to the item.
+     *
+     * @remarks
+     * Adding the same upgrade twice is a fatal engine error.
+     *
+     * @param section - Upgrade section id.
+     */
+    add_upgrade(section: string): void;
   }
 
   /**
@@ -88,29 +107,87 @@ declare module "xray16" {
   export interface IXR_cse_alife_object_breakable extends cse_alife_dynamic_object_visual {}
 
   /**
+   * Server object binding for `CSE_AbstractVisual`.
+   *
    * @source C++ class CSE_AbstractVisual : cse_visual, cse_abstract
    * @customConstructor CSE_AbstractVisual
    * @group xr_object_server
    */
   export class CSE_AbstractVisual extends cse_abstract implements IXR_cse_visual {
+    /**
+     * Get the startup animation configured for the visual object.
+     *
+     * @returns Startup animation name.
+     */
     public getStartupAnimation(): string;
+
+    /**
+     * Initialize the server object and return its base abstract entity.
+     *
+     * @returns Initialized abstract entity.
+     */
     public init(): cse_abstract;
   }
 
   /**
+   * Server object binding for `cse_alife_trader_abstract`.
+   *
    * @source C++ class cse_alife_trader_abstract
    * @customConstructor cse_alife_trader_abstract
    * @group xr_object_server
    */
   export class cse_alife_trader_abstract extends cse_alife_dynamic_object_visual {
+    /**
+     * @returns Trader reputation value.
+     */
     public reputation(): i32;
+
+    /**
+     * @returns Trader rank.
+     */
     public rank(): i32;
+
+    /**
+     * Set trader rank.
+     *
+     * @param rank - New rank value.
+     */
     public set_rank(rank: i32): void;
+
+    /**
+     * @returns Trader community name.
+     */
     public community(): string;
+
+    /**
+     * @returns Character profile section name.
+     */
     public profile_name(): string;
+
+    /**
+     * @returns Localized character name.
+     */
     public character_name(): string;
+
+    /**
+     * Resolve and return the character icon name.
+     *
+     * @returns Icon name.
+     */
     public character_icon(): string;
+
+    /**
+     * Set character profile section name.
+     *
+     * @param name - Profile section name.
+     */
     public set_profile_name(name: string): void;
+
+    /**
+     * Set localized character name.
+     *
+     * @param name - Character name.
+     */
     public set_character_name(name: string): void;
   }
 
@@ -120,33 +197,104 @@ declare module "xray16" {
    * @source C++ class cse_abstract : cpure_server_object
    * @customConstructor cse_abstract
    * @group xr_object_server
+   *
+   * @remarks
+   * Server objects are ALife/network objects, not live client `game_object` wrappers.
    */
   export class cse_abstract extends EngineBinding implements IXR_cpure_server_object {
+    /**
+     * Server object id.
+     */
     public readonly id: u16;
+
+    /**
+     * Parent server object id, or `65535` when there is no parent.
+     */
     public readonly parent_id: u16;
+
+    /**
+     * Script data version stored with this object.
+     */
     public readonly script_version: u16;
 
+    /**
+     * Server-side world position.
+     */
     public position: vector;
+
+    /**
+     * Server-side orientation angles.
+     */
     public angle: vector;
 
+    /**
+     * Create a server object for an object section.
+     *
+     * @param section - Spawn section name.
+     */
     public constructor(section: string);
 
+    /**
+     * @returns Runtime object name.
+     */
     public name<T extends string = string>(): T;
 
+    /**
+     * @returns Engine class id.
+     */
     public clsid(): TXR_class_id;
 
+    /**
+     * @returns Spawn ini attached to this object, if any.
+     */
     public spawn_ini(): ini_file | null;
 
+    /**
+     * @returns Spawn section name.
+     */
     public section_name<T extends string = string>(): T;
 
+    /**
+     * Read an update packet into this object.
+     *
+     * @remarks
+     * Use only with packets written for the same server object class and update format.
+     *
+     * @param packet - Source network packet.
+     */
     public UPDATE_Read(packet: net_packet): void;
 
+    /**
+     * Read a state packet into this object.
+     *
+     * @remarks
+     * Use only with packets written for the same server object class and state format.
+     *
+     * @param packet - Source network packet.
+     * @param size - Serialized state size.
+     */
     public STATE_Read(packet: net_packet, size: number): void;
 
+    /**
+     * Write an update packet from this object.
+     *
+     * @param packet - Target network packet.
+     */
     public UPDATE_Write(packet: net_packet): void;
 
+    /**
+     * Write a state packet from this object.
+     *
+     * @param packet - Target network packet.
+     */
     public STATE_Write(packet: net_packet): void;
 
+    /**
+     * Fill editor property rows for this object.
+     *
+     * @param pref - Property prefix.
+     * @param items - Property collection to populate.
+     */
     public FillProps(pref: string, items: LuaTable<number, unknown>): void;
   }
 
@@ -156,9 +304,20 @@ declare module "xray16" {
    * @source C++ class cse_alife_object : cse_abstract
    * @customConstructor cse_alife_object
    * @group xr_object_server
+   *
+   * @remarks
+   * Base ALife object registered in the simulator graph. Switching flags describe whether the simulator may move it
+   * between offline and online state.
    */
   export class cse_alife_object extends cse_abstract {
+    /**
+     * Game graph vertex used by ALife simulation.
+     */
     public readonly m_game_vertex_id: u16;
+
+    /**
+     * Level graph vertex used by ALife simulation.
+     */
     public readonly m_level_vertex_id: u32;
     /**
      * Always numeric value.
@@ -170,59 +329,158 @@ declare module "xray16" {
      */
     public readonly online: boolean;
 
+    /**
+     * Create an ALife object for a spawn section.
+     *
+     * @param section - Spawn section name.
+     */
     public constructor(section: string);
 
+    /**
+     * @returns Whether the object uses AI location graph data.
+     */
     public used_ai_locations(): boolean;
 
+    /**
+     * Enable or disable AI location graph use.
+     *
+     * @param value - Whether AI locations should be used.
+     */
     public use_ai_locations(value: boolean): void;
 
+    /**
+     * @returns Whether this object should be saved.
+     */
     public can_save(): boolean;
 
+    /**
+     * @returns Whether this object may switch online.
+     */
     public can_switch_online(): boolean;
 
+    /**
+     * Allow or block switching online.
+     *
+     * @remarks
+     * Sets the object's switch-online flag; it does not switch the object immediately.
+     *
+     * @param value - Whether online switching is allowed.
+     */
     public can_switch_online(value: boolean): void;
 
+    /**
+     * Initialize the ALife object and return its abstract base.
+     *
+     * @returns Initialized abstract entity.
+     */
     public init(): cse_abstract;
 
+    /**
+     * @returns Whether the object is interactive.
+     */
     public interactive(): boolean;
 
-    public visible_for_map(): void;
+    /**
+     * @returns Whether the object is visible on the map.
+     */
+    public visible_for_map(): boolean;
 
+    /**
+     * Set whether the object is visible on the map.
+     *
+     * @param value - Whether the object should be shown on the map.
+     */
     public visible_for_map(value: boolean): void;
 
+    /**
+     * @returns Whether this object may switch offline.
+     */
     public can_switch_offline(): boolean;
 
+    /**
+     * Allow or block switching offline.
+     *
+     * @remarks
+     * Sets the object's switch-offline flag; it does not switch the object immediately.
+     *
+     * @param value - Whether offline switching is allowed.
+     */
     public can_switch_offline(value: boolean): void;
 
+    /**
+     * @returns Whether the object should move while offline.
+     */
     public move_offline(): boolean;
 
+    /**
+     * Set whether the object should move while offline.
+     *
+     * @param value - Whether offline movement is enabled.
+     */
     public move_offline(value?: boolean): void;
 
+    /**
+     * Run the server-side ALife update for this object.
+     */
     public update(): void;
   }
 
   /**
+   * Server object binding for `cse_alife_dynamic_object`.
+   *
    * @source C++ class cse_alife_dynamic_object : cse_alife_object
    * @customConstructor cse_alife_dynamic_object
    * @group xr_object_server
+   *
+   * @remarks
+   * Dynamic ALife object that can have a client representation while online.
    */
   export class cse_alife_dynamic_object extends cse_alife_object {
+    /**
+     * Move the object to offline ALife simulation.
+     *
+     * @remarks
+     * Call only when the object is currently online and the object type supports switching offline.
+     */
     public switch_offline(): void;
 
+    /**
+     * Bring the object online and create its client-side representation.
+     *
+     * @remarks
+     * Call only when the object is currently offline and the object type supports switching online.
+     */
     public switch_online(): void;
 
+    /**
+     * @returns Whether saved data should be kept even when regular cleanup would remove it.
+     */
     public keep_saved_data_anyway(): boolean;
 
+    /**
+     * Called after the object is registered in the ALife registry.
+     */
     public on_register(): void;
 
+    /**
+     * Called before the object is registered in the ALife registry.
+     */
     public on_before_register(): void;
 
+    /**
+     * Called when the object has been spawned.
+     */
     public on_spawn(): void;
 
+    /**
+     * Called when the object is removed from the ALife registry.
+     */
     public on_unregister(): void;
   }
 
   /**
+   * Server object binding for `cse_alife_space_restrictor`.
+   *
    * @source C++ class cse_alife_space_restrictor : cse_alife_dynamic_object,cse_shape
    * @customConstructor cse_alife_space_restrictor
    * @group xr_object_server
@@ -230,15 +488,24 @@ declare module "xray16" {
   export class cse_alife_space_restrictor extends cse_alife_dynamic_object implements IXR_cse_shape {}
 
   /**
+   * Server object binding for `cse_alife_dynamic_object_visual`.
+   *
    * @source C++ class cse_alife_dynamic_object_visual : cse_alife_dynamic_object,cse_visual
    * @customConstructor cse_alife_dynamic_object_visual
    * @group xr_object_server
    */
   export class cse_alife_dynamic_object_visual extends cse_alife_dynamic_object implements IXR_cse_visual {
+    /**
+     * Set object yaw.
+     *
+     * @param yaw - Yaw angle.
+     */
     public set_yaw(yaw: number): void;
   }
 
   /**
+   * Server object binding for `cse_custom_zone`.
+   *
    * @source C++ class cse_custom_zone : cse_alife_dynamic_object,cse_shape
    * @customConstructor cse_custom_zone
    * @group xr_object_server
@@ -251,6 +518,10 @@ declare module "xray16" {
    * @source C++ class cse_alife_creature_abstract : cse_alife_dynamic_object_visual
    * @customConstructor cse_alife_creature_abstract
    * @group xr_object_server
+   *
+   * @remarks
+   * Base server object for actor, stalker, and monster creatures. Creature-specific helpers require a creature ALife
+   * object, not an arbitrary server object.
    */
   export class cse_alife_creature_abstract extends cse_alife_dynamic_object_visual {
     /**
@@ -266,55 +537,142 @@ declare module "xray16" {
      */
     public team: u8;
 
+    /**
+     * Game group id.
+     */
     public group: u8;
 
     /**
      * Object squad id, maximal u16 (65535) if no squad assigned.
      */
     public group_id: u16;
+
+    /**
+     * Assigned smart terrain id, or `65535` when none is assigned.
+     */
     public m_smart_terrain_id: u16;
 
+    /**
+     * @returns Current creature health.
+     */
     public health(): f32;
 
+    /**
+     * @returns Whether the creature is alive.
+     */
     public alive(): boolean;
 
+    /**
+     * @returns Game team id.
+     */
     public g_team(): u8;
 
+    /**
+     * @returns Game group id.
+     */
     public g_group(): u8;
 
+    /**
+     * @returns Game squad id.
+     */
     public g_squad(): u8;
 
+    /**
+     * @returns Torso rotation state.
+     */
     public o_torso(): rotation;
 
+    /**
+     * Notify the server object that this creature died.
+     *
+     * @remarks
+     * Marks server-side health as dead and records death time. It is not a general damage method.
+     *
+     * @param killer - Server object that killed this creature.
+     */
     public on_death(killer: cse_alife_object): void;
 
+    /**
+     * @returns Assigned smart terrain id, or `65535` when none is assigned.
+     */
     public smart_terrain_id(): u16;
 
+    /**
+     * Kill the server-side creature.
+     *
+     * @remarks
+     * Intended for creature server objects managed by ALife.
+     */
     public kill(): void;
 
+    /**
+     * Set goodwill from this creature toward another object.
+     *
+     * @remarks
+     * `npc_id` must resolve to an ALife object that can store personal goodwill.
+     *
+     * @param goodwill - New goodwill value.
+     * @param npc_id - Target object id.
+     */
     public force_set_goodwill(goodwill: number, npc_id: number): void;
 
+    /**
+     * Clear the assigned smart terrain.
+     */
     public clear_smart_terrain(): void;
 
-    public travel_speed(): unknown;
+    /**
+     * @returns Travel speed used for graph movement.
+     */
+    public travel_speed(): f32;
 
+    /**
+     * Set travel speed used for graph movement.
+     *
+     * @param value - New travel speed.
+     */
     public travel_speed(value: number): void;
 
-    public smart_terrain_task_deactivate(): unknown;
+    /**
+     * Mark the current smart terrain task as not reached.
+     */
+    public smart_terrain_task_deactivate(): void;
 
     /**
      * Works for `CSE_ALifeMonsterAbstract`, marks smart terrain as reached and switches logic to terrain task.
+     *
+     * @remarks
+     * Only meaningful for monsters assigned to a smart terrain task.
      */
     public smart_terrain_task_activate(): void;
 
-    public current_level_travel_speed(): unknown;
+    /**
+     * @returns Travel speed used inside the current level.
+     */
+    public current_level_travel_speed(): f32;
 
-    public current_level_travel_speed(value: number): unknown;
+    /**
+     * Set travel speed used inside the current level.
+     *
+     * @param value - New travel speed.
+     */
+    public current_level_travel_speed(value: number): void;
 
+    /**
+     * @throws If this creature type has no ALife monster brain.
+     *
+     * @returns ALife brain that drives offline monster behavior.
+     */
     public brain(): CAILifeMonsterBrain;
 
+    /**
+     * @returns Whether the creature has a detector.
+     */
     public has_detector(): boolean;
 
+    /**
+     * @returns Creature rank.
+     */
     public rank(): i32;
 
     /**
@@ -331,10 +689,21 @@ declare module "xray16" {
    * @group xr_object_server
    */
   export class cse_alife_human_abstract extends cse_alife_monster_abstract {
+    /**
+     * @returns Character profile section name.
+     */
     public profile_name(): string;
 
+    /**
+     * Set human rank.
+     *
+     * @param rank - New rank value.
+     */
     public set_rank(rank: i32): void;
 
+    /**
+     * @returns Human reputation value.
+     */
     public reputation(): i32;
   }
 
@@ -346,11 +715,28 @@ declare module "xray16" {
    * @group xr_object_server
    */
   export class cse_alife_item extends cse_alife_dynamic_object_visual implements IXR_cse_alife_inventory_item {
+    /**
+     * @returns Whether the ALife item is useful to AI.
+     */
     public bfUseful(): boolean;
 
+    /**
+     * Check whether the item already has an upgrade section.
+     *
+     * @param section - Upgrade section id.
+     * @returns Whether the upgrade is installed.
+     */
     public has_upgrade(section: string): boolean;
 
-    public add_upgrade(section: string): boolean;
+    /**
+     * Add an upgrade section to the item.
+     *
+     * @remarks
+     * Adding the same upgrade twice is a fatal engine error.
+     *
+     * @param section - Upgrade section id.
+     */
+    public add_upgrade(section: string): void;
   }
 
   /**
@@ -361,16 +747,37 @@ declare module "xray16" {
    * @group xr_object_server
    */
   export class cse_alife_item_weapon extends cse_alife_item {
-    public clone_addons(cse_alife_item_weapon: cse_alife_item_weapon): void;
+    /**
+     * Copy addon flags from another weapon server object.
+     *
+     * @remarks
+     * Copies addon state only. Ammo, condition, and installed upgrades are handled by other fields or helpers.
+     *
+     * @param weapon - Weapon to copy addon state from.
+     */
+    public clone_addons(weapon: cse_alife_item_weapon): void;
 
+    /**
+     * Set ammo currently loaded in the weapon.
+     *
+     * @param count - Loaded ammo count.
+     */
     public set_ammo_elapsed(count: u16): void;
 
+    /**
+     * @returns Ammo currently loaded in the weapon.
+     */
     public get_ammo_elapsed(): u16;
 
+    /**
+     * @returns Weapon magazine size from the weapon section.
+     */
     public get_ammo_magsize(): u16;
   }
 
   /**
+   * Server object binding for `cse_zone_visual`.
+   *
    * @source C++ class cse_zone_visual : cse_anomalous_zone,cse_visual
    * @customConstructor cse_zone_visual
    * @group xr_object_server
@@ -378,24 +785,36 @@ declare module "xray16" {
   export class cse_zone_visual extends cse_anomalous_zone implements IXR_cse_visual {}
 
   /**
+   * Server object binding for `cse_spectator`.
+   *
    * @source C++ class cse_spectator : cse_abstract
    * @customConstructor cse_spectator
    * @group xr_object_server
    */
   export class cse_spectator extends cse_abstract {
+    /**
+     * Initialize spectator server state.
+     */
     public init(): void;
   }
 
   /**
+   * Server object binding for `cse_temporary`.
+   *
    * @source C++ class cse_temporary : cse_abstract
    * @customConstructor cse_temporary
    * @group xr_object_server
    */
   export class cse_temporary extends cse_abstract {
+    /**
+     * Initialize temporary projectile server state.
+     */
     public init(): void;
   }
 
   /**
+   * Server object binding for `cse_alife_item_weapon_magazined`.
+   *
    * @source C++ class cse_alife_item_weapon_magazined : cse_alife_item_weapon
    * @customConstructor cse_alife_item_weapon_magazined
    * @group xr_object_server
@@ -412,6 +831,8 @@ declare module "xray16" {
   export class cse_alife_item_weapon_magazined_w_gl extends cse_alife_item_weapon {}
 
   /**
+   * Server object binding for `cse_alife_item_weapon_shotgun`.
+   *
    * @source C++ class cse_alife_item_weapon_shotgun : cse_alife_item_weapon
    * @customConstructor cse_alife_item_weapon_shotgun
    * @group xr_object_server
@@ -419,15 +840,22 @@ declare module "xray16" {
   export class cse_alife_item_weapon_shotgun extends cse_alife_item_weapon {}
 
   /**
+   * Server object binding for `cse_alife_level_changer`.
+   *
    * @source C++ class cse_alife_level_changer : cse_alife_space_restrictor
    * @customConstructor cse_alife_level_changer
    * @group xr_object_server
    */
   export class cse_alife_level_changer extends cse_alife_space_restrictor {
+    /**
+     * @returns Destination level name configured for the level changer.
+     */
     public get_dest_level_name(): string;
   }
 
   /**
+   * Server object binding for `cse_alife_monster_abstract`.
+   *
    * @source C++ class cse_alife_monster_abstract : cse_alife_creature_abstract,cse_alife_schedulable
    * @customConstructor cse_alife_monster_abstract
    * @group xr_object_server
@@ -435,6 +863,8 @@ declare module "xray16" {
   export class cse_alife_monster_abstract extends cse_alife_creature_abstract implements IXR_cse_alife_schedulable {}
 
   /**
+   * Server object binding for `cse_alife_monster_base`.
+   *
    * @source C++ class cse_alife_monster_base : cse_alife_monster_abstract,cse_ph_skeleton
    * @customConstructor cse_alife_monster_base
    * @group xr_object_server
@@ -442,6 +872,8 @@ declare module "xray16" {
   export class cse_alife_monster_base extends cse_alife_monster_abstract implements IXR_cse_ph_skeleton {}
 
   /**
+   * Server object binding for `cse_alife_monster_rat`.
+   *
    * @source C++ class cse_alife_monster_rat : cse_alife_monster_abstract,cse_alife_inventory_item
    * @customConstructor cse_alife_monster_rat
    * @group xr_object_server
@@ -449,6 +881,8 @@ declare module "xray16" {
   export class cse_alife_monster_rat extends cse_alife_monster_abstract {}
 
   /**
+   * Server object binding for `cse_alife_monster_zombie`.
+   *
    * @source C++ class cse_alife_monster_zombie : cse_alife_monster_abstract
    * @customConstructor cse_alife_monster_zombie
    * @group xr_object_server
@@ -456,6 +890,8 @@ declare module "xray16" {
   export class cse_alife_monster_zombie extends cse_alife_monster_abstract {}
 
   /**
+   * Server object binding for `cse_alife_mounted_weapon`.
+   *
    * @source C++ class cse_alife_mounted_weapon : cse_alife_dynamic_object_visual
    * @customConstructor cse_alife_mounted_weapon
    * @group xr_object_server
@@ -463,6 +899,8 @@ declare module "xray16" {
   export class cse_alife_mounted_weapon extends cse_alife_dynamic_object_visual {}
 
   /**
+   * Server object binding for `cse_alife_inventory_box`.
+   *
    * @source C++ class cse_alife_inventory_box : cse_alife_dynamic_object_visual
    * @customConstructor cse_alife_inventory_box
    * @group xr_object_server
@@ -470,6 +908,8 @@ declare module "xray16" {
   export class cse_alife_inventory_box extends cse_alife_dynamic_object_visual {}
 
   /**
+   * Server object binding for `cse_alife_item_ammo`.
+   *
    * @source C++ class cse_alife_item_ammo : cse_alife_item
    * @customConstructor cse_alife_item_ammo
    * @group xr_object_server
@@ -477,6 +917,8 @@ declare module "xray16" {
   export class cse_alife_item_ammo extends cse_alife_item {}
 
   /**
+   * Server object binding for `cse_alife_item_artefact`.
+   *
    * @source C++ class cse_alife_item_artefact : cse_alife_item
    * @customConstructor cse_alife_item_artefact
    * @group xr_object_server
@@ -484,6 +926,8 @@ declare module "xray16" {
   export class cse_alife_item_artefact extends cse_alife_item {}
 
   /**
+   * Server object binding for `cse_alife_item_bolt`.
+   *
    * @source C++ class cse_alife_item_bolt : cse_alife_item
    * @customConstructor cse_alife_item_bolt
    * @group xr_object_server
@@ -491,6 +935,8 @@ declare module "xray16" {
   export class cse_alife_item_bolt extends cse_alife_item {}
 
   /**
+   * Server object binding for `cse_alife_item_custom_outfit`.
+   *
    * @source C++ class cse_alife_item_custom_outfit : cse_alife_item
    * @customConstructor cse_alife_item_custom_outfit
    * @group xr_object_server
@@ -498,6 +944,8 @@ declare module "xray16" {
   export class cse_alife_item_custom_outfit extends cse_alife_item {}
 
   /**
+   * Server object binding for `cse_alife_item_helmet`.
+   *
    * @source C++ class cse_alife_item_helmet : cse_alife_item
    * @customConstructor cse_alife_item_helmet
    * @group xr_object_server
@@ -505,6 +953,8 @@ declare module "xray16" {
   export class cse_alife_item_helmet extends cse_alife_item {}
 
   /**
+   * Server object binding for `cse_alife_item_document`.
+   *
    * @source C++ class cse_alife_item_document : cse_alife_item
    * @customConstructor cse_alife_item_document
    * @group xr_object_server
@@ -512,6 +962,8 @@ declare module "xray16" {
   export class cse_alife_item_document extends cse_alife_item {}
 
   /**
+   * Server object binding for `cse_alife_item_explosive`.
+   *
    * @source C++ class cse_alife_item_explosive : cse_alife_item
    * @customConstructor cse_alife_item_explosive
    * @group xr_object_server
@@ -519,6 +971,8 @@ declare module "xray16" {
   export class cse_alife_item_explosive extends cse_alife_item {}
 
   /**
+   * Server object binding for `cse_alife_item_grenade`.
+   *
    * @source C++ class cse_alife_item_grenade : cse_alife_item
    * @customConstructor cse_alife_item_grenade
    * @group xr_object_server
@@ -526,6 +980,8 @@ declare module "xray16" {
   export class cse_alife_item_grenade extends cse_alife_item {}
 
   /**
+   * Server object binding for `cse_alife_item_pda`.
+   *
    * @source C++ class cse_alife_item_pda : cse_alife_item
    * @customConstructor cse_alife_item_pda
    * @group xr_object_server
@@ -533,6 +989,8 @@ declare module "xray16" {
   export class cse_alife_item_pda extends cse_alife_item {}
 
   /**
+   * Server object binding for `cse_alife_item_detector`.
+   *
    * @source C++ class cse_alife_item_detector : cse_alife_item
    * @customConstructor cse_alife_item_detector
    * @group xr_object_server
@@ -540,6 +998,8 @@ declare module "xray16" {
   export class cse_alife_item_detector extends cse_alife_item {}
 
   /**
+   * Server object binding for `cse_alife_item_torch`.
+   *
    * @source C++ class cse_alife_item_torch : cse_alife_item
    * @customConstructor cse_alife_item_torch
    * @group xr_object_server
@@ -547,6 +1007,8 @@ declare module "xray16" {
   export class cse_alife_item_torch extends cse_alife_item {}
 
   /**
+   * Server object binding for `cse_alife_item_weapon_auto_shotgun`.
+   *
    * @source C++ class cse_alife_item_weapon_auto_shotgun : cse_alife_item_weapon
    * @customConstructor cse_alife_item_weapon_auto_shotgun
    * @group xr_object_server
@@ -554,6 +1016,8 @@ declare module "xray16" {
   export class cse_alife_item_weapon_auto_shotgun extends cse_alife_item_weapon {}
 
   /**
+   * Server object binding for `cse_anomalous_zone`.
+   *
    * @source C++ class cse_anomalous_zone : cse_custom_zone
    * @customConstructor cse_anomalous_zone
    * @group xr_object_server
@@ -561,15 +1025,22 @@ declare module "xray16" {
   export class cse_anomalous_zone extends cse_custom_zone {}
 
   /**
+   * Server object binding for `cse_alife_object_climable`.
+   *
    * @source C++ class cse_alife_object_climable : cse_shape,cse_abstract
    * @customConstructor cse_alife_object_climable
    * @group xr_object_server
    */
   export class cse_alife_object_climable extends cse_abstract implements IXR_cse_shape {
+    /**
+     * Initialize climable object server state.
+     */
     public init(): void;
   }
 
   /**
+   * Server object binding for `cse_alife_object_hanging_lamp`.
+   *
    * @source C++ class cse_alife_object_hanging_lamp : cse_alife_dynamic_object_visual,cse_ph_skeleton
    * @customConstructor cse_alife_object_hanging_lamp
    * @group xr_object_server
@@ -577,6 +1048,8 @@ declare module "xray16" {
   export class cse_alife_object_hanging_lamp extends cse_alife_dynamic_object_visual implements IXR_cse_ph_skeleton {}
 
   /**
+   * Server object binding for `cse_alife_object_physic`.
+   *
    * @source C++ class cse_alife_object_physic : cse_alife_dynamic_object_visual,cse_ph_skeleton
    * @customConstructor cse_alife_object_physic
    * @group xr_object_server
@@ -584,6 +1057,8 @@ declare module "xray16" {
   export class cse_alife_object_physic extends cse_alife_dynamic_object_visual implements IXR_cse_ph_skeleton {}
 
   /**
+   * Server object binding for `cse_alife_object_projector`.
+   *
    * @source C++ class cse_alife_object_projector : cse_alife_dynamic_object_visual
    * @customConstructor cse_alife_object_projector
    * @group xr_object_server
@@ -601,39 +1076,104 @@ declare module "xray16" {
   }
 
   /**
+   * Server object binding for `cse_alife_online_offline_group`.
+   *
    * @source C++ class cse_alife_online_offline_group : cse_alife_dynamic_object,cse_alife_schedulable
    * @customConstructor cse_alife_online_offline_group
    * @group xr_object_server
+   *
+   * @remarks
+   * Squad-like ALife group that owns live monster members. Registering or unregistering members also updates ALife
+   * graph and scheduling state.
    */
   export class cse_alife_online_offline_group<T extends cse_alife_creature_abstract = cse_alife_creature_abstract>
     extends cse_alife_dynamic_object
     implements IXR_cse_alife_schedulable
   {
+    /**
+     * Current member object exposed during squad member iteration.
+     */
     public readonly object: T;
 
+    /**
+     * Add an object to this online/offline group.
+     *
+     * @remarks
+     * The id must resolve to a live monster server object that is not already in this group.
+     *
+     * @throws If the member is already registered, is not a monster, or is not alive.
+     *
+     * @param id - Server object id.
+     */
     public register_member(id: u16): void;
 
+    /**
+     * Remove all location type filters from the group.
+     *
+     * @remarks
+     * Clears the terrain masks on the group and on every current member.
+     */
     public clear_location_types(): void;
 
+    /**
+     * @throws The base online/offline group implementation does not provide a task.
+     *
+     * @returns Current smart terrain task, when one is assigned.
+     */
     public get_current_task(): CALifeSmartTerrainTask;
 
     /**
      * Get current squad command ID.
+     *
+     * @returns First member id, or `65535` when the group is empty.
      */
     public commander_id(): u16;
 
+    /**
+     * Remove an object from this online/offline group.
+     *
+     * @throws If the id is not a member of this group.
+     *
+     * @param id - Server object id.
+     */
     public unregister_member(id: u16): void;
 
+    /**
+     * Iterate over group members.
+     *
+     * @returns Lua iterator of squad member records.
+     */
     public squad_members(): LuaIterable<IXR_squad_member<T>>; // Struct std::less<unsigned short> 3rd param
 
+    /**
+     * Force the group's graph position from a world position.
+     *
+     * @remarks
+     * Recomputes level and game graph vertices from `vector`.
+     *
+     * @param vector - Target world position.
+     */
     public force_change_position(vector: vector): void;
 
+    /**
+     * Add a location type accepted by the group.
+     *
+     * @remarks
+     * Adds the terrain mask to the group and to every current member.
+     *
+     * @param location - Location type name.
+     */
     public add_location_type(location: string): void;
 
+    /**
+     * @returns Number of NPCs in the group.
+     */
     public npc_count(): i32;
   }
 
   /**
+   * Server object binding for `cse_alife_ph_skeleton_object`.
+   *
    * @source C++ class cse_alife_ph_skeleton_object : cse_alife_dynamic_object_visual,cse_ph_skeleton
    * @customConstructor cse_alife_ph_skeleton_object
    * @group xr_object_server
@@ -641,6 +1181,8 @@ declare module "xray16" {
   export class cse_alife_ph_skeleton_object extends cse_alife_dynamic_object_visual implements IXR_cse_ph_skeleton {}
 
   /**
+   * Server object binding for `cse_alife_psydog_phantom`.
+   *
    * @source C++ class cse_alife_psydog_phantom : cse_alife_monster_base
    * @customConstructor cse_alife_psydog_phantom
    * @group xr_object_server
@@ -648,27 +1190,74 @@ declare module "xray16" {
   export class cse_alife_psydog_phantom extends cse_alife_monster_abstract {}
 
   /**
+   * Server object binding for `cse_alife_smart_zone`.
+   *
    * @source C++ class cse_alife_smart_zone : cse_alife_space_restrictor,cse_alife_schedulable
    * @customConstructor cse_alife_smart_zone
    * @group xr_object_server
+   *
+   * @remarks
+   * Server-side smart terrain/zone hook. Base implementations may be placeholders; gameplay scripts usually work with
+   * concrete smart-terrain logic.
    */
   export class cse_alife_smart_zone extends cse_alife_space_restrictor implements IXR_cse_alife_schedulable {
-    public detect_probability(): void;
+    /**
+     * @returns Probability used by the zone for detecting objects.
+     */
+    public detect_probability(): f32;
 
-    public smart_touch(cse_alife_monster_abstract: cse_alife_creature_abstract): void;
+    /**
+     * Notify the smart zone that a monster touched it.
+     *
+     * @remarks
+     * The base implementation is empty; concrete smart zones can override behavior.
+     *
+     * @param monster - Monster server object.
+     */
+    public smart_touch(monster: cse_alife_monster_abstract): void;
 
-    public unregister_npc(cse_alife_monster_abstract: cse_alife_creature_abstract): void;
+    /**
+     * Remove a monster from the smart zone.
+     *
+     * @param monster - Monster server object.
+     */
+    public unregister_npc(monster: cse_alife_monster_abstract): void;
 
-    public register_npc(cse_alife_monster_abstract: cse_alife_creature_abstract): void;
+    /**
+     * Register a monster in the smart zone.
+     *
+     * @param monster - Monster server object.
+     */
+    public register_npc(monster: cse_alife_monster_abstract): void;
 
-    public suitable(cse_alife_monster_abstract: cse_alife_creature_abstract): void;
+    /**
+     * Rate how suitable this smart zone is for a monster.
+     *
+     * @param monster - Monster server object.
+     * @returns Suitability score.
+     */
+    public suitable(monster: cse_alife_monster_abstract): f32;
 
-    public task(cse_alife_monster_abstract: cse_alife_creature_abstract): CALifeSmartTerrainTask | null;
+    /**
+     * Get the smart terrain task assigned to a monster.
+     *
+     * @param monster - Monster server object.
+     * @returns Smart terrain task, or `null` when none is assigned.
+     */
+    public task(monster: cse_alife_monster_abstract): CALifeSmartTerrainTask | null;
 
-    public enabled(cse_alife_monster_abstract: cse_alife_creature_abstract): void;
+    /**
+     * Check whether this smart zone is enabled for a monster.
+     *
+     * @param monster - Monster server object.
+     * @returns Whether the zone can be used.
+     */
+    public enabled(monster: cse_alife_monster_abstract): boolean;
   }
 
   /**
+   * Server object binding for `cse_alife_team_base_zone`.
+   *
    * @source C++ class cse_alife_team_base_zone : cse_alife_space_restrictor
    * @customConstructor cse_alife_team_base_zone
    * @group xr_object_server
@@ -676,6 +1265,8 @@ declare module "xray16" {
   export class cse_alife_team_base_zone extends cse_alife_space_restrictor {}
 
   /**
+   * Server object binding for `cse_torrid_zone`.
+   *
    * @source C++ class cse_torrid_zone : cse_custom_zone,cse_motion
    * @customConstructor cse_torrid_zone
    * @group xr_object_server
@@ -683,44 +1274,98 @@ declare module "xray16" {
   export class cse_torrid_zone extends cse_custom_zone implements cse_abstract {}
 
   /**
+   * Server object binding for `cse_alife_trader`.
+   *
    * @source C++ class cse_alife_trader : cse_alife_dynamic_object_visual,cse_alife_trader_abstract
    * @customConstructor cse_alife_trader
    * @group xr_object_server
    */
   export class cse_alife_trader extends cse_alife_dynamic_object_visual implements cse_alife_trader_abstract {
+    /**
+     * @returns Trader reputation value.
+     */
     public reputation(): i32;
 
+    /**
+     * @returns Trader rank.
+     */
     public rank(): i32;
 
+    /**
+     * Set trader rank.
+     *
+     * @param rank - New rank value.
+     */
     public set_rank(rank: i32): void;
 
+    /**
+     * @returns Trader community name.
+     */
     public community(): string;
 
+    /**
+     * @returns Character profile section name.
+     */
     public profile_name(): string;
 
+    /**
+     * @returns Localized character name.
+     */
     public character_name(): string;
 
+    /**
+     * Resolve and return the character icon name.
+     *
+     * @returns Icon name.
+     */
     public character_icon(): string;
 
+    /**
+     * Set character profile section name.
+     *
+     * @param name - Profile section name.
+     */
     public set_profile_name(name: string): void;
 
+    /**
+     * Set localized character name.
+     *
+     * @param name - Character name.
+     */
     public set_character_name(name: string): void;
   }
 
   /**
+   * Server object binding for `cse_smart_cover`.
+   *
    * @source C++ class cse_smart_cover : cse_alife_dynamic_object
    * @customConstructor cse_smart_cover
    * @group xr_object_server
    */
   export class cse_smart_cover extends cse_alife_dynamic_object {
+    /**
+     * @returns Smart-cover description table id.
+     */
     public description<T extends string = string>(): T | null;
 
+    /**
+     * Replace the table of available loopholes.
+     *
+     * @param object - Lua table with loophole ids.
+     */
     public set_available_loopholes(object: unknown): void;
 
+    /**
+     * Enable or disable editor validation for the loopholes table.
+     *
+     * @param value - Whether loopholes should be checked.
+     */
     public set_loopholes_table_checker(value: boolean): void;
   }
 
   /**
+   * Server object binding for `cse_alife_car`.
+   *
    * @source C++ class cse_alife_car : cse_alife_dynamic_object_visual,cse_ph_skeleton
    * @customConstructor cse_alife_car
    * @group xr_object_server
@@ -728,6 +1373,8 @@ declare module "xray16" {
   export class cse_alife_car extends cse_alife_dynamic_object_visual implements IXR_cse_ph_skeleton {}
 
   /**
+   * Server object binding for `cse_alife_creature_actor`.
+   *
    * @source C++ class cse_alife_creature_actor : cse_alife_creature_abstract,cse_alife_trader_abstract,cse_ph_skeleton
    * @customConstructor cse_alife_creature_actor
    * @group xr_object_server
@@ -736,24 +1383,58 @@ declare module "xray16" {
     extends cse_alife_creature_abstract
     implements IXR_cse_ph_skeleton, cse_alife_trader_abstract
   {
+    /**
+     * @returns Actor reputation value.
+     */
     public reputation(): i32;
 
+    /**
+     * @returns Actor rank.
+     */
     public rank(): i32;
 
+    /**
+     * Set actor rank.
+     *
+     * @param rank - New rank value.
+     */
     public set_rank(rank: i32): void;
 
+    /**
+     * @returns Actor character profile section name.
+     */
     public profile_name(): string;
 
+    /**
+     * @returns Localized actor character name.
+     */
     public character_name(): string;
 
+    /**
+     * Resolve and return the actor character icon name.
+     *
+     * @returns Icon name.
+     */
     public character_icon(): string;
 
+    /**
+     * Set actor character profile section name.
+     *
+     * @param name - Profile section name.
+     */
     public set_profile_name(name: string): void;
 
+    /**
+     * Set localized actor character name.
+     *
+     * @param name - Character name.
+     */
     public set_character_name(name: string): void;
   }
 
   /**
+   * Server object binding for `cse_alife_creature_crow`.
+   *
    * @source C++ class cse_alife_creature_crow : cse_alife_creature_abstract
    * @customConstructor cse_alife_creature_crow
    * @group xr_object_server
@@ -761,6 +1442,8 @@ declare module "xray16" {
   export class cse_alife_creature_crow extends cse_alife_creature_abstract {}
 
   /**
+   * Server object binding for `cse_alife_creature_phantom`.
+   *
    * @source C++ class cse_alife_creature_phantom : cse_alife_creature_abstract
    * @customConstructor cse_alife_creature_phantom
    * @group xr_object_server
@@ -768,15 +1451,22 @@ declare module "xray16" {
   export class cse_alife_creature_phantom extends cse_alife_creature_abstract {}
 
   /**
+   * Server object binding for `cse_alife_graph_point`.
+   *
    * @source C++ class cse_alife_graph_point : cse_abstract
    * @customConstructor cse_alife_graph_point
    * @group xr_object_server
    */
   export class cse_alife_graph_point extends cse_abstract {
+    /**
+     * Initialize graph point server state.
+     */
     public init(): void;
   }
 
   /**
+   * Server object binding for `cse_alife_helicopter`.
+   *
    * @source C++ class cse_alife_helicopter : cse_alife_dynamic_object_visual,cse_motion,cse_ph_skeleton
    * @customConstructor cse_alife_helicopter
    * @group xr_object_server
@@ -786,6 +1476,8 @@ declare module "xray16" {
     implements IXR_cse_motion, IXR_cse_ph_skeleton {}
 
   /**
+   * Server object binding for `cse_alife_human_stalker`.
+   *
    * @source C++ class cse_alife_human_stalker : cse_alife_human_abstract,cse_ph_skeleton
    * @customConstructor cse_alife_human_stalker
    * @group xr_object_server