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

## PlayerEntityControllerOptions interface

Options for creating a PlayerEntityController instance.

**Signature:**

```typescript
export interface PlayerEntityControllerOptions 
```

## Properties

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

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


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

[autoCancelMouseLeftClick?](./server.playerentitycontrolleroptions.autocancelmouseleftclick.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Whether to automatically cancel left click input after first processed tick, defaults to true.


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

[canJump?](./server.playerentitycontrolleroptions.canjump.md)


</td><td>


</td><td>

() =&gt; boolean


</td><td>

_(Optional)_ A function allowing custom logic to determine if the entity can jump.


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

[canRun?](./server.playerentitycontrolleroptions.canrun.md)


</td><td>


</td><td>

() =&gt; boolean


</td><td>

_(Optional)_ A function allowing custom logic to determine if the entity can run.


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

[canWalk?](./server.playerentitycontrolleroptions.canwalk.md)


</td><td>


</td><td>

() =&gt; boolean


</td><td>

_(Optional)_ A function allowing custom logic to determine if the entity can walk.


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

[idleLoopedAnimations?](./server.playerentitycontrolleroptions.idleloopedanimations.md)


</td><td>


</td><td>

string\[\]


</td><td>

_(Optional)_ Overrides the animation(s) that will play when the entity is idle.


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

[interactOneshotAnimations?](./server.playerentitycontrolleroptions.interactoneshotanimations.md)


</td><td>


</td><td>

string\[\]


</td><td>

_(Optional)_ Overrides the animation(s) that will play when the entity interacts (left click)


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

[jumpOneshotAnimations?](./server.playerentitycontrolleroptions.jumponeshotanimations.md)


</td><td>


</td><td>

string\[\]


</td><td>

_(Optional)_ Overrides the animation(s) that will play when the entity is jumping.


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

[jumpVelocity?](./server.playerentitycontrolleroptions.jumpvelocity.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The upward velocity applied to the entity when it jumps.


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

[runLoopedAnimations?](./server.playerentitycontrolleroptions.runloopedanimations.md)


</td><td>


</td><td>

string\[\]


</td><td>

_(Optional)_ Overrides the animation(s) that will play when the entity is running.


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

[runVelocity?](./server.playerentitycontrolleroptions.runvelocity.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The normalized horizontal velocity applied to the entity when it runs.


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

[sticksToPlatforms?](./server.playerentitycontrolleroptions.stickstoplatforms.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Whether the entity sticks to platforms, defaults to true.


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

[walkLoopedAnimations?](./server.playerentitycontrolleroptions.walkloopedanimations.md)


</td><td>


</td><td>

string\[\]


</td><td>

_(Optional)_ Overrides the animation(s) that will play when the entity is walking.


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

[walkVelocity?](./server.playerentitycontrolleroptions.walkvelocity.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The normalized horizontal velocity applied to the entity when it walks.


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