UNPKG

hytopia

Version:

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

64 lines (31 loc) 1.17 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [server](./server.md) &gt; [AudioManager](./server.audiomanager.md) &gt; [unregisterEntityAttachedAudios](./server.audiomanager.unregisterentityattachedaudios.md) ## AudioManager.unregisterEntityAttachedAudios() method Unregisters and stops all audio instances attached to a specific entity. Use for: entity despawn or cleanup scenarios. **Signature:** ```typescript unregisterEntityAttachedAudios(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 to pause and unregister audio instances for. \*\*Requires:\*\* Entity should belong to this world for meaningful results. \*\*Side effects:\*\* Pauses and unregisters any attached audio instances. </td></tr> </tbody></table> **Returns:** void ## Remarks \*\*Pauses all:\*\* Calls `AudioManager.unregisterAudio` for each attached audio, which pauses them.