@newkrok/nape-js 3.21.5 → 3.21.6

package/dist/index.d.cts

@@ -1561,6 +1561,100 @@ declare class CharacterController {
     private _getCharacterRadius;
 }
 
+/** Handler called when an interactor enters, stays in, or exits the zone. */
+type TriggerHandler = (interactor: Interactor) => void;
+/** Configuration options for {@link TriggerZone}. */
+interface TriggerZoneOptions {
+    /**
+     * Filter for which interactors trigger the zone.
+     * When `null`, any interactor triggers the zone.
+     * @default null
+     */
+    filter?: CbType | OptionType | null;
+    /**
+     * The interaction type to listen for.
+     * @default InteractionType.SENSOR
+     */
+    interactionType?: InteractionType;
+    /** Called once when an interactor enters the zone. */
+    onEnter?: TriggerHandler | null;
+    /** Called every simulation step while an interactor remains in the zone. */
+    onStay?: TriggerHandler | null;
+    /** Called once when an interactor exits the zone. */
+    onExit?: TriggerHandler | null;
+}
+/**
+ * High-level trigger zone — Unity-style `onEnter`/`onStay`/`onExit` wrapper
+ * over the nape callback system.
+ *
+ * Automatically creates sensor-based {@link InteractionListener}s and manages
+ * their lifecycle. Assign handlers directly or via the constructor options.
+ *
+ * @example
+ * ```ts
+ * const zone = new TriggerZone(space, sensorBody, {
+ *   onEnter: (other) => console.log("entered!", other),
+ *   onStay:  (other) => console.log("inside",  other),
+ *   onExit:  (other) => console.log("left!",   other),
+ * });
+ *
+ * // Later: clean up all listeners
+ * zone.dispose();
+ * ```
+ */
+declare class TriggerZone {
+    /** The CbType automatically created for this zone. */
+    readonly cbType: CbType;
+    private _space;
+    private _body;
+    private _enabled;
+    private _onEnter;
+    private _onStay;
+    private _onExit;
+    private _enterListener;
+    private _stayListener;
+    private _exitListener;
+    private _filter;
+    private _interactionType;
+    /**
+     * @param space - The physics space to register listeners on.
+     * @param body  - The body acting as the trigger zone. Its shapes should have
+     *                `sensorEnabled = true` (the constructor enables it automatically
+     *                for all shapes that don't already have it set).
+     * @param options - Optional configuration and initial handlers.
+     */
+    constructor(space: Space, body: Body, options?: TriggerZoneOptions);
+    /** Called once when an interactor enters the zone. */
+    get onEnter(): TriggerHandler | null;
+    set onEnter(handler: TriggerHandler | null);
+    /** Called every simulation step while an interactor remains in the zone. */
+    get onStay(): TriggerHandler | null;
+    set onStay(handler: TriggerHandler | null);
+    /** Called once when an interactor exits the zone. */
+    get onExit(): TriggerHandler | null;
+    set onExit(handler: TriggerHandler | null);
+    /** Whether the zone is active. When disabled, no callbacks fire. */
+    get enabled(): boolean;
+    set enabled(value: boolean);
+    /** The body acting as the trigger zone. */
+    get body(): Body;
+    /** The space the zone is registered on. */
+    get space(): Space;
+    /**
+     * Remove all listeners from the space and untag the body.
+     * After disposal, the TriggerZone should not be reused.
+     */
+    dispose(): void;
+    /**
+     * Resolve which interactor is "the other" (not the zone body) from
+     * the callback's int1/int2 pair.
+     */
+    private _resolveOther;
+    private _syncListeners;
+    private _createListener;
+    private _removeListener;
+}
+
 declare const VERSION: string;
 
-export { AABB, AngleJoint, Arbiter, Body, BodyCallback, BodyListener, BodyType, Callback, Capsule, CbEvent, CbType, CharacterController, type CharacterControllerOptions, Circle, CollisionArbiter, type ConcaveBodyOptions, Constraint, ConstraintCallback, ConstraintListener, Contact, DebugDrawFlags, DistanceJoint, Geom, GeomPoly, InteractionCallback, InteractionFilter, InteractionListener, InteractionType, Interactor, LineJoint, Listener, MarchingSquares, MatMN, Material, MotorJoint, type MoveResult, OptionType, PivotJoint, PreCallback, PreFlag, PreListener, PulleyJoint, Shape, ShapeType, Space, UserConstraint, VERSION, ValidationResult, Vec2, Vec3, WeldJoint, Winding, createConcaveBody };
+export { AABB, AngleJoint, Arbiter, Body, BodyCallback, BodyListener, BodyType, Callback, Capsule, CbEvent, CbType, CharacterController, type CharacterControllerOptions, Circle, CollisionArbiter, type ConcaveBodyOptions, Constraint, ConstraintCallback, ConstraintListener, Contact, DebugDrawFlags, DistanceJoint, Geom, GeomPoly, InteractionCallback, InteractionFilter, InteractionListener, InteractionType, Interactor, LineJoint, Listener, MarchingSquares, MatMN, Material, MotorJoint, type MoveResult, OptionType, PivotJoint, PreCallback, PreFlag, PreListener, PulleyJoint, Shape, ShapeType, Space, type TriggerHandler, TriggerZone, type TriggerZoneOptions, UserConstraint, VERSION, ValidationResult, Vec2, Vec3, WeldJoint, Winding, createConcaveBody };

package/dist/index.d.ts

@@ -1561,6 +1561,100 @@ declare class CharacterController {
     private _getCharacterRadius;
 }
 
+/** Handler called when an interactor enters, stays in, or exits the zone. */
+type TriggerHandler = (interactor: Interactor) => void;
+/** Configuration options for {@link TriggerZone}. */
+interface TriggerZoneOptions {
+    /**
+     * Filter for which interactors trigger the zone.
+     * When `null`, any interactor triggers the zone.
+     * @default null
+     */
+    filter?: CbType | OptionType | null;
+    /**
+     * The interaction type to listen for.
+     * @default InteractionType.SENSOR
+     */
+    interactionType?: InteractionType;
+    /** Called once when an interactor enters the zone. */
+    onEnter?: TriggerHandler | null;
+    /** Called every simulation step while an interactor remains in the zone. */
+    onStay?: TriggerHandler | null;
+    /** Called once when an interactor exits the zone. */
+    onExit?: TriggerHandler | null;
+}
+/**
+ * High-level trigger zone — Unity-style `onEnter`/`onStay`/`onExit` wrapper
+ * over the nape callback system.
+ *
+ * Automatically creates sensor-based {@link InteractionListener}s and manages
+ * their lifecycle. Assign handlers directly or via the constructor options.
+ *
+ * @example
+ * ```ts
+ * const zone = new TriggerZone(space, sensorBody, {
+ *   onEnter: (other) => console.log("entered!", other),
+ *   onStay:  (other) => console.log("inside",  other),
+ *   onExit:  (other) => console.log("left!",   other),
+ * });
+ *
+ * // Later: clean up all listeners
+ * zone.dispose();
+ * ```
+ */
+declare class TriggerZone {
+    /** The CbType automatically created for this zone. */
+    readonly cbType: CbType;
+    private _space;
+    private _body;
+    private _enabled;
+    private _onEnter;
+    private _onStay;
+    private _onExit;
+    private _enterListener;
+    private _stayListener;
+    private _exitListener;
+    private _filter;
+    private _interactionType;
+    /**
+     * @param space - The physics space to register listeners on.
+     * @param body  - The body acting as the trigger zone. Its shapes should have
+     *                `sensorEnabled = true` (the constructor enables it automatically
+     *                for all shapes that don't already have it set).
+     * @param options - Optional configuration and initial handlers.
+     */
+    constructor(space: Space, body: Body, options?: TriggerZoneOptions);
+    /** Called once when an interactor enters the zone. */
+    get onEnter(): TriggerHandler | null;
+    set onEnter(handler: TriggerHandler | null);
+    /** Called every simulation step while an interactor remains in the zone. */
+    get onStay(): TriggerHandler | null;
+    set onStay(handler: TriggerHandler | null);
+    /** Called once when an interactor exits the zone. */
+    get onExit(): TriggerHandler | null;
+    set onExit(handler: TriggerHandler | null);
+    /** Whether the zone is active. When disabled, no callbacks fire. */
+    get enabled(): boolean;
+    set enabled(value: boolean);
+    /** The body acting as the trigger zone. */
+    get body(): Body;
+    /** The space the zone is registered on. */
+    get space(): Space;
+    /**
+     * Remove all listeners from the space and untag the body.
+     * After disposal, the TriggerZone should not be reused.
+     */
+    dispose(): void;
+    /**
+     * Resolve which interactor is "the other" (not the zone body) from
+     * the callback's int1/int2 pair.
+     */
+    private _resolveOther;
+    private _syncListeners;
+    private _createListener;
+    private _removeListener;
+}
+
 declare const VERSION: string;
 
-export { AABB, AngleJoint, Arbiter, Body, BodyCallback, BodyListener, BodyType, Callback, Capsule, CbEvent, CbType, CharacterController, type CharacterControllerOptions, Circle, CollisionArbiter, type ConcaveBodyOptions, Constraint, ConstraintCallback, ConstraintListener, Contact, DebugDrawFlags, DistanceJoint, Geom, GeomPoly, InteractionCallback, InteractionFilter, InteractionListener, InteractionType, Interactor, LineJoint, Listener, MarchingSquares, MatMN, Material, MotorJoint, type MoveResult, OptionType, PivotJoint, PreCallback, PreFlag, PreListener, PulleyJoint, Shape, ShapeType, Space, UserConstraint, VERSION, ValidationResult, Vec2, Vec3, WeldJoint, Winding, createConcaveBody };
+export { AABB, AngleJoint, Arbiter, Body, BodyCallback, BodyListener, BodyType, Callback, Capsule, CbEvent, CbType, CharacterController, type CharacterControllerOptions, Circle, CollisionArbiter, type ConcaveBodyOptions, Constraint, ConstraintCallback, ConstraintListener, Contact, DebugDrawFlags, DistanceJoint, Geom, GeomPoly, InteractionCallback, InteractionFilter, InteractionListener, InteractionType, Interactor, LineJoint, Listener, MarchingSquares, MatMN, Material, MotorJoint, type MoveResult, OptionType, PivotJoint, PreCallback, PreFlag, PreListener, PulleyJoint, Shape, ShapeType, Space, type TriggerHandler, TriggerZone, type TriggerZoneOptions, UserConstraint, VERSION, ValidationResult, Vec2, Vec3, WeldJoint, Winding, createConcaveBody };