xray16 1.3.4 → 1.5.0

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

@@ -1,47 +1,85 @@
-declare module "xray16" {
-  /**
-   * @source C++ class CSpaceRestrictor : CGameObject
-   * @customConstructor CSpaceRestrictor
-   * @group xr_zone
-   */
-  export class CSpaceRestrictor extends CGameObject {}
-
-  /**
-   * @source C++ class CCustomZone : public CSpaceRestrictor, public Feel::Touch
-   * @customConstructor CCustomZone
-   * @group xr_zone
-   */
-  export class CCustomZone extends CSpaceRestrictor {}
-
-  /**
-   * @source C++ class CLevelChanger : CGameObject
-   * @customConstructor CLevelChanger
-   * @group xr_zone
-   */
-  export class CLevelChanger extends CGameObject {}
-
-  /**
-   * @source C++ class smart_cover_object : CGameObject
-   * @customConstructor smart_cover_object
-   * @group xr_zone
-   */
-  export class smart_cover_object extends CGameObject {}
-
-  /**
-   * @source C++ class ce_script_zone : DLL_Pure
-   * @customConstructor ce_script_zone
-   * @group xr_zone
-   */
-  export class ce_script_zone extends DLL_Pure {
-    protected constructor();
-  }
-
-  /**
-   * @source C++ class ce_smart_zone : DLL_Pure
-   * @customConstructor ce_smart_zone
-   * @group xr_zone
-   */
-  export class ce_smart_zone extends DLL_Pure {
-    protected constructor();
-  }
-}
+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();
+  }
+}