Player

Class in @minecraft/server

Extends Entity

A player in the world. Players can’t be constructed; get them from events or the world.

import { Player } from '@minecraft/server';

Example

TypeScript JavaScript

import { world, type Player } from '@minecraft/server';

function heal(player: Player): void {
    const health = player.getComponent('minecraft:health');
    health?.setCurrentValue(health.effectiveMax);
    player.sendMessage('You have been healed.');
}

// Heal players every time they spawn.
world.afterEvents.playerSpawn.subscribe((event) => heal(event.player));

import { world } from '@minecraft/server';

function heal(player) {
    const health = player.getComponent('minecraft:health');
    health?.setCurrentValue(health.effectiveMax);
    player.sendMessage('You have been healed.');
}

// Heal players every time they spawn.
world.afterEvents.playerSpawn.subscribe((event) => heal(event.player));

Properties

name

read-only

readonly name: string;

The player’s gamertag.

nameTag

nameTag: string;

The name shown above the player, their gamertag until set. Setting it changes what other players see, now and when they next come into view.

typeId

read-only

readonly typeId: string;

Always "minecraft:player".

isValid

read-only

readonly isValid: boolean;

False once the player has left. Calls on a player who left throw.

location

read-only

readonly location: Vector3;

Where their feet are.

Types

Vector3

onScreenDisplay

read-only

readonly onScreenDisplay: ScreenDisplay;

What the player sees over the world: titles, the action bar, the HUD.

Types

ScreenDisplay

isSneaking

read-only

readonly isSneaking: boolean;

Whether the player is sneaking, as their client last said.

isSprinting

read-only

readonly isSprinting: boolean;

Whether the player is sprinting, as their client last said.

isFlying

read-only

readonly isFlying: boolean;

Whether the player is flying, in creative or spectator.

isEmoting

read-only

readonly isEmoting: boolean;

Whether the player is playing an emote; it ends when they move or it finishes.

isGliding

read-only

readonly isGliding: boolean;

Whether the player is gliding with elytra.

isJumping

read-only

readonly isJumping: boolean;

Whether the player holds jump, as their latest input said.

selectedSlotIndex

selectedSlotIndex: number;

The hotbar slot held, from 0 to 8. Setting it selects another.

locale

read-only

readonly locale: string;

The client’s language, as en_US.

clientSystemInfo

read-only

readonly clientSystemInfo: ClientSystemInfo;

The device the player joined on.

Types

ClientSystemInfo

level

read-only

readonly level: number;

The experience level.

xpEarnedAtCurrentLevel

read-only

readonly xpEarnedAtCurrentLevel: number;

Experience gained since the level was reached.

totalXpNeededForNextLevel

read-only

readonly totalXpNeededForNextLevel: number;

Experience the level takes to finish.

inputInfo

read-only

readonly inputInfo: PlayerInputInfo;

How the player last steered: keyboard, touch, gamepad or motion controller.

Types

PlayerInputInfo

inputPermissions

read-only

readonly inputPermissions: PlayerInputPermissions;

Which of the player’s controls work; turn some off to hold them still.

Types

PlayerInputPermissions

commandPermissionLevel

commandPermissionLevel: CommandPermissionLevel;

The player’s permission level for slash commands.

Types

CommandPermissionLevel

playerPermissionLevel

read-only

readonly playerPermissionLevel: PlayerPermissionLevel;

The player’s operator/member permission level.

Types

PlayerPermissionLevel

camera

read-only

readonly camera: Camera;

The player’s camera.

Types

Camera

fogSettings

read-only

readonly fogSettings: FogSettings;

The player’s client fog stack.

Types

FogSettings

graphicsMode

read-only

readonly graphicsMode: GraphicsMode;

The player’s graphics mode.

Types

GraphicsMode

locatorBar

read-only

readonly locatorBar: LocatorBar;

The player’s locator bar.

Types

LocatorBar

Methods

getRotation

getRotation(): Vector2;

x is the pitch, y the yaw.

Returns

Vector2

Types

Vector2

getGameMode

getGameMode(): GameMode;

The player’s game mode.

Returns

GameMode

Types

GameMode

setGameMode

setGameMode(gameMode?: GameMode): void;

Puts the player in a game mode; undefined gives them the world’s default.

Parameters

gameModeoptional

GameMode

Types

GameMode

getSpawnPoint

getSpawnPoint(): DimensionLocation | undefined;

The bed or anchor they spawn at, if they set one.

Returns

DimensionLocation | undefined

Types

DimensionLocation

setSpawnPoint

setSpawnPoint(spawnPoint?: DimensionLocation | Vector3): void;

Sets where the player comes back after dying, or with nothing the world’s spawn again. The dimension is always the overworld in Basalt.

Parameters

spawnPointoptional

DimensionLocation | Vector3

Types

DimensionLocationVector3

getItemCooldown

getItemCooldown(cooldownCategory: string): number;

Ticks the player still waits on an item cooldown category, 0 for none.

Parameters

cooldownCategory

string

Returns

number

startItemCooldown

startItemCooldown(cooldownCategory: string, tickDuration: number): void;

Starts an item cooldown, greying the category’s items out on their screen.

Parameters

cooldownCategory

string

tickDuration

number

getTotalXp

getTotalXp(): number;

Every experience point the player has, their levels counted in.

Returns

number

addExperience

addExperience(amount: number): number;

Adds experience points, or takes them with a negative amount.

Parameters

amount

number

Returns

numberThe total after.

addLevels

addLevels(amount: number): number;

Parameters

amount

number

Returns

numberThe level after.

resetLevel

resetLevel(): void;

Takes away every level and point of experience.

clearEffects

clearEffects(): void;

Takes every effect off. (addEffect/getEffect/getEffects/removeEffect are inherited from Entity.)

isOp

isOp(): boolean;

Whether the player is an operator in permissions.json.

Returns

boolean

sendMessage

sendMessage(message: string | RawMessage | (string | RawMessage)[]): void;

Sends a chat message to this player alone.

Parameters

message

string | RawMessage | (string | RawMessage)[]

Types

RawMessage

playSound

playSound(soundId: string, soundOptions?: PlayerSoundOptions): void;

Plays a sound to this player alone.

Parameters

soundId

string

soundOptionsoptional

PlayerSoundOptions

Types

PlayerSoundOptions

stopSound

stopSound(soundId: string): void;

Stops a sound playing to this player, as /stopsound.

Parameters

soundId

string

stopAllSounds

stopAllSounds(): void;

Stops every sound playing to this player.

playMusic

playMusic(trackId: string, musicOptions?: MusicOptions): void;

Plays a music track, as music.menu or record.pigstep, in place of what’s playing.

Parameters

trackId

string

musicOptionsoptional

MusicOptions

Types

MusicOptions

queueMusic

queueMusic(trackId: string, musicOptions?: MusicOptions): void;

Plays a music track once what’s playing ends.

Parameters

trackId

string

musicOptionsoptional

MusicOptions

Types

MusicOptions

stopMusic

stopMusic(): void;

Stops the music, the queue too.

spawnParticle

spawnParticle(effectName: string, location: Vector3, molangVariables?: MolangVariableMap): void;

Shows this player alone a particle effect, built in or a pack’s, as minecraft:heart_particle.

Parameters

effectName

string

location

Vector3

molangVariablesoptional

MolangVariableMap

Types

Vector3MolangVariableMap

eatItem

eatItem(itemStack: ItemStack): void;

Gives the player what eating the food would, at once: hunger, saturation and its effects. Nothing is taken from their inventory. A potion gives its effects.

Parameters

itemStack

ItemStack

Throws

• If the item isn’t a food or potion.

Types

ItemStack

teleport

teleport(location: Vector3, teleportOptions?: TeleportOptions): void;

Moves the player, turned to rotation if given.

Parameters

location

Vector3

teleportOptionsoptional

TeleportOptions

Types

Vector3TeleportOptions

runCommand

runCommand(commandString: string): CommandResult;

Runs a command as this player, without its slash, at the player’s own permission.

Parameters

commandString

string

Returns

CommandResultA result whose count is 1 once the command is queued.

Types

CommandResult

runCommandAsync

runCommandAsync(commandString: string): Promise<CommandResult>;

Deprecated

Removed in

Runs a command as this player.

Parameters

commandString

string

Returns

Promise<CommandResult>

Types

CommandResult

setVelocity

setVelocity(velocity: Vector3): void;

Sets the player’s motion outright, sent to their client at once.

Parameters

velocity

Vector3

Types

Vector3

applyImpulse

applyImpulse(vector: Vector3): void;

Adds to the player’s motion: what their client last reported, plus the push.

Parameters

vector

Vector3

Types

Vector3

getVelocity

getVelocity(): Vector3;

How the player moves, in blocks a tick, as their client last reported it.

Returns

Vector3

Types

Vector3

setInputPermissions

setInputPermissions(categories: Partial<Record<InputPermissionCategory, boolean>>): void;

Turns input permission categories on or off at once, keyed by InputPermissionCategory; categories left out are unchanged.

Parameters

categories

Partial<Record<InputPermissionCategory, boolean>>

Example

player.setInputPermissions({ [InputPermissionCategory.Movement]: false });

Types

InputPermissionCategory

resetInputPermissions

resetInputPermissions(): void;

Turns every input permission category back on.

kick

kick(reason?: string): void;

Disconnects the player with a reason.

Parameters

reasonoptional

string

sendToast

sendToast(title: string | RawMessage, message: string | RawMessage): void;

A toast at the top of the screen.

Parameters

title

string | RawMessage

message

string | RawMessage

Types

RawMessage

addBossBar

addBossBar(title: string | RawMessage, options?: BossBarOptions): BossBar;

Shows this player a boss bar, to change or remove later.

Parameters

title

string | RawMessage

optionsoptional

BossBarOptions

Returns

BossBar

Types

RawMessageBossBarOptionsBossBar

hidePlayer

hidePlayer(player: Player): void;

This player stops seeing player, who stays in the player list.

Parameters

player

Player

showPlayer

showPlayer(player: Player): void;

Undoes Player.hidePlayer.

Parameters

player

Player

canSee

canSee(player: Player): boolean;

Whether this player sees player.

Parameters

player

Player

Returns

boolean

getAimAssist

getAimAssist(): PlayerAimAssist;

The player’s aim-assist settings.

Returns

PlayerAimAssist

Types

PlayerAimAssist

getControlScheme

getControlScheme(): ControlScheme;

How the player’s controls are laid out.

Returns

ControlScheme

Types

ControlScheme

setControlScheme

setControlScheme(controlScheme?: ControlScheme): void;

Sets the control scheme, or clears an override with nothing.

Parameters

controlSchemeoptional

ControlScheme

Types

ControlScheme

setPropertyOverrideForEntity

setPropertyOverrideForEntity(targetEntity: Entity, identifier: string, value: boolean | number | string): void;

Overrides a client entity property this player sees on an entity.

Parameters

targetEntity

Entity

identifier

string

value

boolean | number | string

Types

Entity

removePropertyOverrideForEntity

removePropertyOverrideForEntity(targetEntity: Entity, identifier: string): void;

Clears one such override.

Parameters

targetEntity

Entity

identifier

string

Types

Entity

clearPropertyOverridesForEntity

clearPropertyOverridesForEntity(targetEntity: Entity | string): void;

Clears every such override on an entity.

Parameters

targetEntity

Entity | string

Types

Entity

Used by

ItemCooldownComponent.getCooldownTicksRemaining, ItemCooldownComponent.startCooldown, ItemEntity.owner, ItemEntity.showTo, ItemEntity.hideFrom, BossBar.player, Dimension.getPlayers, ChatSendAfterEvent.sender, ChatSendBeforeEvent.sender, PlayerSpawnAfterEvent.player, PlayerLeaveBeforeEvent.player, PlayerHurtAfterEvent.hurtEntity, PlayerHurtBeforeEvent.hurtEntity, PlayerBreakBlockBeforeEvent.player, PlayerBreakBlockAfterEvent.player, PlayerPlaceBlockBeforeEvent.player, PlayerPlaceBlockAfterEvent.player, PlayerInteractWithBlockAfterEvent.player, PlayerInteractWithEntityAfterEvent.player, ItemUseAfterEvent.source, PlayerPickupItemAfterEvent.player, PlayerDropItemAfterEvent.player, PlayerGameModeChangeAfterEvent.player, PlayerTeleportAfterEvent.player and 59 more

Inherited

From Entity: id, dimension, localizationKey, isOnGround, isInWater, isFalling, fallDistance, isClimbing, isSwimming, getHeadLocation, getComponent, getComponents, hasComponent, matches, getViewDirection, clearVelocity, applyKnockback, getTags, hasTag, addTag, removeTag, getDynamicProperty, setDynamicProperty, setDynamicProperties, getDynamicPropertyIds, getDynamicPropertyTotalByteCount, clearDynamicProperties, scoreboardIdentity, kill, remove, isSleeping, addEffect, getEffect, getEffects, removeEffect, addItem, applyDamage, setOnFire, extinguishFire, lookAt, setRotation, playAnimation, triggerEvent, tryTeleport, getProperty, setProperty, resetProperty, getBlockFromViewDirection, getEntitiesFromViewDirection, getBlockStandingOn, getAllBlocksStandingOn, getAABB, nameplateDepthTested, nameplateRenderDistance