UNPKG

hytopia

Version:

The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.

62 lines (30 loc) 960 B
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md) &gt; [detach](./server.baseentitycontroller.detach.md) ## BaseEntityController.detach() method Override this method to handle the detachment of an entity from your entity controller. **Signature:** ```typescript detach(entity: Entity): void; ``` ## Parameters <table><thead><tr><th> Parameter </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> entity </td><td> [Entity](./server.entity.md) </td><td> The entity being detached. \*\*Category:\*\* Controllers </td></tr> </tbody></table> **Returns:** void ## Remarks \*\*Called by:\*\* `Entity.despawn()` before `despawn()` is called. \*\*Super call:\*\* Call `super.detach(entity)` to emit the `DETACH` event.