hytopia/docs/server.outline.md

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

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [server](./server.md) &gt; [Outline](./server.outline.md)

## Outline interface

The options for rendering an outline.

\*\*Category:\*\* Types

**Signature:**

```typescript
interface Outline 
```

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[color?](./server.outline.color.md)


</td><td>


</td><td>

[RgbColor](./server.rgbcolor.md)


</td><td>

_(Optional)_ The color of the outline. Defaults to black.


</td></tr>
<tr><td>

[colorIntensity?](./server.outline.colorintensity.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The intensity multiplier for the outline color. Use values over 1 for brighter/glowing outlines. Defaults to 1.0.


</td></tr>
<tr><td>

[occluded?](./server.outline.occluded.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Whether the outline should be hidden when the entity is occluded by other objects. If false, the outline is always visible (shows through walls). Defaults to true.


</td></tr>
<tr><td>

[opacity?](./server.outline.opacity.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The opacity of the outline between 0 and 1. Defaults to 1.0.


</td></tr>
<tr><td>

[thickness?](./server.outline.thickness.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The thickness of the outline in world units. Defaults to 0.03.


</td></tr>
</tbody></table>