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.

Use for: entities rendered from a glTF model. Do NOT use for: block entities; use `BlockEntityOptions`<!-- -->.

\*\*Category:\*\* Entities

**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>

[modelAnimations?](./server.modelentityoptions.modelanimations.md)


</td><td>


</td><td>

Omit&lt;[EntityModelAnimationOptions](./server.entitymodelanimationoptions.md)<!-- -->, 'entity'&gt;\[\]


</td><td>

_(Optional)_ The model animation options for animations to configure immediately.


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

[modelNodeOverrides?](./server.modelentityoptions.modelnodeoverrides.md)


</td><td>


</td><td>

Omit&lt;[EntityModelNodeOverrideOptions](./server.entitymodelnodeoverrideoptions.md)<!-- -->, 'entity'&gt;\[\]


</td><td>

_(Optional)_ The node overrides for the entity's model. `nameMatch` is exact by default, with optional edge wildcard (`head*`<!-- -->, `*head`<!-- -->, `*head*`<!-- -->).


</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>

[Vector3Like](./server.vector3like.md) \| number


</td><td>

_(Optional)_ The scale of the entity's model. Can be a vector3 for per-axis scaling, or a number for uniform scaling.


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

[modelScaleInterpolationMs?](./server.modelentityoptions.modelscaleinterpolationms.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The interpolation time in milliseconds applied to model scale changes.


</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>