UNPKG

hytopia

Version:

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

74 lines (35 loc) 1.07 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [server](./server.md) &gt; [Entity](./server.entity.md) &gt; [setOutline](./server.entity.setoutline.md) ## Entity.setOutline() method Sets the outline rendering options for the entity. **Signature:** ```typescript setOutline(outline: Outline | undefined, forPlayer?: Player): void; ``` ## Parameters <table><thead><tr><th> Parameter </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> outline </td><td> [Outline](./server.outline.md) \| undefined </td><td> The outline options, or undefined to remove the outline. </td></tr> <tr><td> forPlayer </td><td> [Player](./server.player.md) </td><td> _(Optional)_ The player to set the outline for, if undefined the outline will be set for all players. \*\*Side effects:\*\* Emits `EntityEvent.SET_OUTLINE` when spawned. \*\*Category:\*\* Entities </td></tr> </tbody></table> **Returns:** void