hytopia
Version:
The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.
110 lines (51 loc) • 1.7 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [server](./server.md) > [BaseEntityController](./server.baseentitycontroller.md) > [tickWithPlayerInput](./server.baseentitycontroller.tickwithplayerinput.md)
## BaseEntityController.tickWithPlayerInput() method
Override this method to handle entity movements based on player input for your entity controller.
**Signature:**
```typescript
tickWithPlayerInput(entity: PlayerEntity, input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number): void;
```
## Parameters
<table><thead><tr><th>
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
entity
</td><td>
[PlayerEntity](./server.playerentity.md)
</td><td>
The player entity being ticked.
</td></tr>
<tr><td>
input
</td><td>
[PlayerInput](./server.playerinput.md)
</td><td>
The current input state of the player.
</td></tr>
<tr><td>
cameraOrientation
</td><td>
[PlayerCameraOrientation](./server.playercameraorientation.md)
</td><td>
The current camera orientation state of the player.
</td></tr>
<tr><td>
deltaTimeMs
</td><td>
number
</td><td>
The delta time in milliseconds since the last tick.
\*\*Category:\*\* Controllers
</td></tr>
</tbody></table>
**Returns:**
void
## Remarks
\*\*Called by:\*\* `PlayerEntity.tick()` every tick when `isTickWithPlayerInputEnabled` is true. Called before `tick()`<!-- -->.
\*\*Super call:\*\* Call `super.tickWithPlayerInput(...)` to emit the `TICK_WITH_PLAYER_INPUT` event.