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

## EntityModelAnimationOptions interface

The options for creating an EntityModelAnimation instance.

\*\*Category:\*\* Entities

**Signature:**

```typescript
export interface EntityModelAnimationOptions 
```

## Properties

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

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


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

[blendMode?](./server.entitymodelanimationoptions.blendmode.md)


</td><td>


</td><td>

[EntityModelAnimationBlendMode](./server.entitymodelanimationblendmode.md)


</td><td>

_(Optional)_ The initial blend mode of the entity model animation.


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

[clampWhenFinished?](./server.entitymodelanimationoptions.clampwhenfinished.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Whether the animation should clamp when finished, holding the last frame.


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

[entity](./server.entitymodelanimationoptions.entity.md)


</td><td>


</td><td>

[Entity](./server.entity.md)


</td><td>

The entity that the entity model animation belongs to.


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

[fadesIn?](./server.entitymodelanimationoptions.fadesin.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Whether the animation fades in when played or restarted.


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

[fadesOut?](./server.entitymodelanimationoptions.fadesout.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Whether the animation fades out when paused or stopped.


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

[loopMode?](./server.entitymodelanimationoptions.loopmode.md)


</td><td>


</td><td>

[EntityModelAnimationLoopMode](./server.entitymodelanimationloopmode.md)


</td><td>

_(Optional)_ The initial loop mode of the entity model animation.


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

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


</td><td>


</td><td>

string


</td><td>

The name of the entity model animation.


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

[play?](./server.entitymodelanimationoptions.play.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Whether the animation should start playing on construction.


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

[playbackRate?](./server.entitymodelanimationoptions.playbackrate.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The initial playback rate of the entity model animation.


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

[weight?](./server.entitymodelanimationoptions.weight.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The initial blend weight of the entity model animation.


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