hytopia/docs/server.worldoptions.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; [WorldOptions](./server.worldoptions.md)

## WorldOptions interface

Options for creating a World instance.

**Signature:**

```typescript
export interface WorldOptions 
```

## Properties

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

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


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

[ambientLightColor?](./server.worldoptions.ambientlightcolor.md)


</td><td>


</td><td>

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


</td><td>

_(Optional)_ The color of the ambient light for the world.


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

[ambientLightIntensity?](./server.worldoptions.ambientlightintensity.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The intensity of the ambient light for the world. 0 to 1+


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

[directionalLightColor?](./server.worldoptions.directionallightcolor.md)


</td><td>


</td><td>

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


</td><td>

_(Optional)_ The color of the directional light for the world.


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

[directionalLightIntensity?](./server.worldoptions.directionallightintensity.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The intensity of the directional light for the world. 0 to 1+


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

[directionalLightPosition?](./server.worldoptions.directionallightposition.md)


</td><td>


</td><td>

[Vector3Like](./server.vector3like.md)


</td><td>

_(Optional)_ The position the directional light originates from for the world.


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

[gravity?](./server.worldoptions.gravity.md)


</td><td>


</td><td>

[Vector3Like](./server.vector3like.md)


</td><td>

_(Optional)_ The gravity vector for the world.


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

[id](./server.worldoptions.id.md)


</td><td>


</td><td>

number


</td><td>

The unique ID of the world.


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

[map?](./server.worldoptions.map.md)


</td><td>


</td><td>

[WorldMap](./server.worldmap.md)


</td><td>

_(Optional)_ The map of the world.


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

[name](./server.worldoptions.name.md)


</td><td>


</td><td>

string


</td><td>

The name of the world.


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

[skyboxIntensity?](./server.worldoptions.skyboxintensity.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The intensity of the skybox brightness for the world. 0 is black, 1 is full brightness, 1+ is brighter.


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

[skyboxUri](./server.worldoptions.skyboxuri.md)


</td><td>


</td><td>

string


</td><td>

The URI of the skybox cubemap for the world.


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

[tag?](./server.worldoptions.tag.md)


</td><td>


</td><td>

string


</td><td>

_(Optional)_ An arbitrary identifier tag of the world. Useful for your own logic


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

[tickRate?](./server.worldoptions.tickrate.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The tick rate for the world.


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