@rpgjs/server 5.0.0-beta.6 → 5.0.0-beta.7

package/dist/Player/Player.d.ts

@@ -639,8 +639,41 @@ export declare class RpgEvent extends RpgPlayer {
      *
      * Stops all movements before removing to prevent "unable to resolve entity" errors
      * from the MovementManager when the entity is destroyed while moving.
+     *
+     * Pass options to keep the sprite visible briefly on clients while
+     * `sprite.onBeforeRemove` runs a visual transition. Gameplay collision is
+     * removed immediately; the event is deleted from the map after `timeoutMs`.
+     *
+     * The server only sends the removal context. The client decides how to render
+     * `transition` in `sprite.onBeforeRemove`, so the payload can describe an
+     * animation, sound, particle effect, GUI transition, or project-specific data.
+     *
+     * @example
+     * ```ts
+     * event.remove({
+     *   reason: 'defeated',
+     *   transition: {
+     *     type: 'enemy-death',
+     *     animation: 'die',
+     *     graphic: 'slime_die',
+     *     sound: 'slime-death',
+     *     duration: 700
+     *   },
+     *   timeoutMs: 700
+     * })
+     * ```
      */
-    remove(): void;
+    remove(options?: {
+        reason?: string;
+        data?: any;
+        transition?: {
+            animation?: string;
+            graphic?: string | string[];
+            duration?: number;
+            effect?: string;
+        };
+        timeoutMs?: number;
+    }): void;
     isEvent(): boolean;
 }
 /**