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

## ModelEntityOptions interface

The options for creating a model entity.

**Signature:**

```typescript
export interface ModelEntityOptions extends BaseEntityOptions 
```
**Extends:** [BaseEntityOptions](./server.baseentityoptions.md)

## Properties

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

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


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

[modelAnimationsPlaybackRate?](./server.modelentityoptions.modelanimationsplaybackrate.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The playback rate of the entity's model animations.


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

[modelHiddenNodes?](./server.modelentityoptions.modelhiddennodes.md)


</td><td>


</td><td>

string\[\]


</td><td>

_(Optional)_ The nodes to hide on the entity's model.


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

[modelLoopedAnimations?](./server.modelentityoptions.modelloopedanimations.md)


</td><td>


</td><td>

string\[\]


</td><td>

_(Optional)_ The looped animations to start when the entity is spawned.


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

[modelPreferredShape?](./server.modelentityoptions.modelpreferredshape.md)


</td><td>


</td><td>

[ColliderShape](./server.collidershape.md)


</td><td>

_(Optional)_ The preferred shape of the entity's model when automatically generating its collider when no explicit colliders are provided.


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

[modelScale?](./server.modelentityoptions.modelscale.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The scale of the entity's model.


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

[modelShownNodes?](./server.modelentityoptions.modelshownnodes.md)


</td><td>


</td><td>

string\[\]


</td><td>

_(Optional)_ The nodes to show on the entity's model, overriding hidden nodes.


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

[modelTextureUri?](./server.modelentityoptions.modeltextureuri.md)


</td><td>


</td><td>

string


</td><td>

_(Optional)_ The texture uri of the entity's model. Setting this overrides the model's default texture.


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

[modelUri?](./server.modelentityoptions.modeluri.md)


</td><td>


</td><td>

string


</td><td>

_(Optional)_ The URI or path to the .gltf model asset to be used for the entity.


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