[Home](./index.md) > [server](./server.md) > [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) ## DefaultPlayerEntityController class The default player entity controller implementation. When to use: player-controlled avatars using `DefaultPlayerEntity`. Do NOT use for: NPCs or non-player entities; use `SimpleEntityController` or `PathfindingEntityController` instead. **Signature:** ```typescript export default class DefaultPlayerEntityController extends BaseEntityController ``` **Extends:** [BaseEntityController](./server.baseentitycontroller.md) ## Remarks Extends `BaseEntityController` and implements default movement, platforming, jumping, and swimming. You can extend this class to add custom logic.

Coordinate System & Model Orientation

HYTOPIA uses \*\*-Z as forward\*\*. Models must be authored with their front facing -Z. A yaw of 0 means facing -Z. The controller rotates the entity based on camera yaw and movement direction, always orienting the entity's -Z axis in the intended facing direction. ## Example ```typescript // Create a custom entity controller for myEntity, prior to spawning it. myEntity.setController(new DefaultPlayerEntityController({ jumpVelocity: 10, runVelocity: 8, walkVelocity: 4, })); // Spawn the entity in the world. myEntity.spawn(world, { x: 53, y: 10, z: 23 }); ``` \*\*Category:\*\* Controllers ## Constructors
Constructor Modifiers Description
[(constructor)(options)](./server.defaultplayerentitycontroller._constructor_.md) Constructs a new instance of the `DefaultPlayerEntityController` class
## Properties
Property Modifiers Type Description
[applyDirectionalMovementRotations](./server.defaultplayerentitycontroller.applydirectionalmovementrotations.md) boolean Whether to apply directional rotations to the entity while moving, defaults to true.
[autoCancelMouseLeftClick](./server.defaultplayerentitycontroller.autocancelmouseleftclick.md) boolean Whether to automatically cancel left click input after first processed tick, defaults to true.
[canJump](./server.defaultplayerentitycontroller.canjump.md) (controller: [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md)) => boolean A function allowing custom logic to determine if the entity can jump.
[canRun](./server.defaultplayerentitycontroller.canrun.md) (controller: [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md)) => boolean A function allowing custom logic to determine if the entity can run.
[canSwim](./server.defaultplayerentitycontroller.canswim.md) (controller: [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md)) => boolean A function allowing custom logic to determine if the entity can swim.
[canWalk](./server.defaultplayerentitycontroller.canwalk.md) (controller: [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md)) => boolean A function allowing custom logic to determine if the entity can walk.
[facesCameraWhenIdle](./server.defaultplayerentitycontroller.facescamerawhenidle.md) boolean Whether the entity rotates to face the camera direction when idle. When `true`, the entity always faces the camera direction. When `false`, the entity only rotates while actively moving.
[idleLoopedAnimations](./server.defaultplayerentitycontroller.idleloopedanimations.md) string\[\] The looped animation(s) that will play when the entity is idle.
[interactOneshotAnimations](./server.defaultplayerentitycontroller.interactoneshotanimations.md) string\[\] The oneshot animation(s) that will play when the entity interacts (left click)
[isActivelyMoving](./server.defaultplayerentitycontroller.isactivelymoving.md) `readonly` boolean Whether the entity is moving from player inputs. \*\*Category:\*\* Controllers
[isGrounded](./server.defaultplayerentitycontroller.isgrounded.md) `readonly` boolean Whether the entity is grounded. \*\*Category:\*\* Controllers
[isOnPlatform](./server.defaultplayerentitycontroller.isonplatform.md) `readonly` boolean Whether the entity is on a platform.
[isSwimming](./server.defaultplayerentitycontroller.isswimming.md) `readonly` boolean Whether the entity is swimming.
[jumpLandHeavyOneshotAnimations](./server.defaultplayerentitycontroller.jumplandheavyoneshotanimations.md) string\[\] The oneshot animation(s) that will play when the entity lands with a high velocity.
[jumpLandLightOneshotAnimations](./server.defaultplayerentitycontroller.jumplandlightoneshotanimations.md) string\[\] The oneshot animation(s) that will play when the entity lands after jumping or being airborne.
[jumpOneshotAnimations](./server.defaultplayerentitycontroller.jumponeshotanimations.md) string\[\] The oneshot animation(s) that will play when the entity is jumping.
[jumpVelocity](./server.defaultplayerentitycontroller.jumpvelocity.md) number The upward velocity applied to the entity when it jumps.
[platform](./server.defaultplayerentitycontroller.platform.md) `readonly` [Entity](./server.entity.md) \| undefined The platform the entity is on, if any. \*\*Category:\*\* Controllers
[runLoopedAnimations](./server.defaultplayerentitycontroller.runloopedanimations.md) string\[\] The looped animation(s) that will play when the entity is running.
[runVelocity](./server.defaultplayerentitycontroller.runvelocity.md) number The normalized horizontal velocity applied to the entity when it runs.
[sticksToPlatforms](./server.defaultplayerentitycontroller.stickstoplatforms.md) boolean Whether the entity sticks to platforms.
[swimFastVelocity](./server.defaultplayerentitycontroller.swimfastvelocity.md) number The normalized horizontal velocity applied to the entity when it swims fast (equivalent to running).
[swimGravity](./server.defaultplayerentitycontroller.swimgravity.md) number The gravity modifier applied to the entity when swimming.
[swimIdleLoopedAnimations](./server.defaultplayerentitycontroller.swimidleloopedanimations.md) string\[\] The looped animation(s) that will play when the entity is not moving while swimming.
[swimLoopedAnimations](./server.defaultplayerentitycontroller.swimloopedanimations.md) string\[\] The looped animation(s) that will play when the entity is swimming in any direction.
[swimMaxGravityVelocity](./server.defaultplayerentitycontroller.swimmaxgravityvelocity.md) number The maximum downward velocity that the entity can reach when affected by gravity while swimming.
[swimSlowVelocity](./server.defaultplayerentitycontroller.swimslowvelocity.md) number The normalized horizontal velocity applied to the entity when it swims slowly (equivalent to walking).
[swimUpwardVelocity](./server.defaultplayerentitycontroller.swimupwardvelocity.md) number The upward velocity applied to the entity when swimming.
[walkLoopedAnimations](./server.defaultplayerentitycontroller.walkloopedanimations.md) string\[\] The looped animation(s) that will play when the entity is walking.
[walkVelocity](./server.defaultplayerentitycontroller.walkvelocity.md) number The normalized horizontal velocity applied to the entity when it walks.
## Methods
Method Modifiers Description
[attach(entity)](./server.defaultplayerentitycontroller.attach.md) Called when the controller is attached to an entity.
[spawn(entity)](./server.defaultplayerentitycontroller.spawn.md) Called when the controlled entity is spawned. In DefaultPlayerEntityController, this function is used to create the colliders for the entity for wall and ground detection.
[tickWithPlayerInput(entity, input, cameraOrientation, deltaTimeMs)](./server.defaultplayerentitycontroller.tickwithplayerinput.md) Ticks the player movement for the entity controller, overriding the default implementation. If the entity to tick is a child entity, only the event will be emitted but the default movement logic will not be applied.