> For the complete documentation index, see [llms.txt](https://scripting.breeze.rip/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://scripting.breeze.rip/newgen/api/net/minecraft/client/player/localplayer.md).

# LocalPlayer

The player you control.

### Extends

* [`Player`](/newgen/api/net/minecraft/world/entity/player/player.md)

### Properties

#### absorptionAmount

> `readonly` **absorptionAmount**: `number`

Extra hearts from absorption.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`absorptionAmount`](/newgen/api/net/minecraft/world/entity/player/player.md#absorptionamount)

***

#### activeEffects

> `readonly` **activeEffects**: [`MobEffectInstance`](/newgen/api/net/minecraft/world/effect/mobeffectinstance.md)\[]

The status effects on the entity.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`activeEffects`](/newgen/api/net/minecraft/world/entity/player/player.md#activeeffects)

***

#### airSupply

> `readonly` **airSupply**: `number`

The remaining air in ticks.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`airSupply`](/newgen/api/net/minecraft/world/entity/player/player.md#airsupply)

***

#### armorValue

> `readonly` **armorValue**: `number`

The armor points.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`armorValue`](/newgen/api/net/minecraft/world/entity/player/player.md#armorvalue)

***

#### arrowCount

> `readonly` **arrowCount**: `number`

Arrows stuck in the entity.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`arrowCount`](/newgen/api/net/minecraft/world/entity/player/player.md#arrowcount)

***

#### bbHeight

> `readonly` **bbHeight**: `number`

The height of the collision box in blocks.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`bbHeight`](/newgen/api/net/minecraft/world/entity/player/player.md#bbheight)

***

#### bbWidth

> `readonly` **bbWidth**: `number`

The width of the collision box in blocks.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`bbWidth`](/newgen/api/net/minecraft/world/entity/player/player.md#bbwidth)

***

#### blockInteractionRange

> `readonly` **blockInteractionRange**: `number`

How far the player can reach to break or place blocks, in blocks.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`blockInteractionRange`](/newgen/api/net/minecraft/world/entity/player/player.md#blockinteractionrange)

***

#### blockPosBelow

> `readonly` **blockPosBelow**: [`BlockPos`](/newgen/api/net/minecraft/core/blockpos.md)

The block whose properties affect this entity's movement, just below its feet.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`blockPosBelow`](/newgen/api/net/minecraft/world/entity/player/player.md#blockposbelow)

***

#### blockPosition

> `readonly` **blockPosition**: [`BlockPos`](/newgen/api/net/minecraft/core/blockpos.md)

The block the entity is in.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`blockPosition`](/newgen/api/net/minecraft/world/entity/player/player.md#blockposition)

***

#### boundingBox

> `readonly` **boundingBox**: [`AABB`](/newgen/api/net/minecraft/world/phys/aabb.md)

The collision box.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`boundingBox`](/newgen/api/net/minecraft/world/entity/player/player.md#boundingbox)

***

#### controllingPassenger

> `readonly` **controllingPassenger**: [`Entity`](/newgen/api/net/minecraft/world/entity/entity.md)

The living entity steering this one, or null.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`controllingPassenger`](/newgen/api/net/minecraft/world/entity/player/player.md#controllingpassenger)

***

#### currentItemAttackStrengthDelay

> `readonly` **currentItemAttackStrengthDelay**: `number`

Ticks a full attack charge takes with the held item.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`currentItemAttackStrengthDelay`](/newgen/api/net/minecraft/world/entity/player/player.md#currentitemattackstrengthdelay)

***

#### customName

> `readonly` **customName**: `string`

The custom name, or null when the entity has none.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`customName`](/newgen/api/net/minecraft/world/entity/player/player.md#customname)

***

#### deathTime

> `readonly` **deathTime**: `number`

Counts up from 0 to 20 while the death animation plays.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`deathTime`](/newgen/api/net/minecraft/world/entity/player/player.md#deathtime)

***

#### deltaMovement

> `readonly` **deltaMovement**: [`Vec3`](/newgen/api/net/minecraft/world/phys/vec3.md)

The velocity in blocks per tick.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`deltaMovement`](/newgen/api/net/minecraft/world/entity/player/player.md#deltamovement)

***

#### entityInteractionRange

> `readonly` **entityInteractionRange**: `number`

How far the player can reach to attack entities, in blocks.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`entityInteractionRange`](/newgen/api/net/minecraft/world/entity/player/player.md#entityinteractionrange)

***

#### experienceLevel

> `readonly` **experienceLevel**: `number`

The experience level.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`experienceLevel`](/newgen/api/net/minecraft/world/entity/player/player.md#experiencelevel)

***

#### experienceProgress

> `readonly` **experienceProgress**: `number`

Progress to the next experience level, 0 to 1.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`experienceProgress`](/newgen/api/net/minecraft/world/entity/player/player.md#experienceprogress)

***

#### eyeHeight

> `readonly` **eyeHeight**: `number`

The height of the eyes above the feet in blocks, for the current pose.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`eyeHeight`](/newgen/api/net/minecraft/world/entity/player/player.md#eyeheight)

***

#### eyePosition

> `readonly` **eyePosition**: [`Vec3`](/newgen/api/net/minecraft/world/phys/vec3.md)

The eye position this tick.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`eyePosition`](/newgen/api/net/minecraft/world/entity/player/player.md#eyeposition)

***

#### eyeY

> `readonly` **eyeY**: `number`

The Y position of the eyes.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`eyeY`](/newgen/api/net/minecraft/world/entity/player/player.md#eyey)

***

#### fallDistance

> `readonly` **fallDistance**: `number`

How far the entity has fallen since last on the ground.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`fallDistance`](/newgen/api/net/minecraft/world/entity/player/player.md#falldistance)

***

#### fallFlyingTicks

> `readonly` **fallFlyingTicks**: `number`

Ticks spent gliding.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`fallFlyingTicks`](/newgen/api/net/minecraft/world/entity/player/player.md#fallflyingticks)

***

#### flying

> `readonly` **flying**: `boolean`

Whether the player is flying with creative or spectator flight.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`flying`](/newgen/api/net/minecraft/world/entity/player/player.md#flying)

***

#### flyingSpeed

> `readonly` **flyingSpeed**: `number`

The flying speed from the abilities.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`flyingSpeed`](/newgen/api/net/minecraft/world/entity/player/player.md#flyingspeed)

***

#### foodLevel

> `readonly` **foodLevel**: `number`

The hunger level, 0 to 20.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`foodLevel`](/newgen/api/net/minecraft/world/entity/player/player.md#foodlevel)

***

#### forwardImpulse

> `readonly` **forwardImpulse**: `number`

The forward input this tick, -1 to 1.

***

#### hasContainerOpen

> `readonly` **hasContainerOpen**: `boolean`

Whether a container screen is open.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`hasContainerOpen`](/newgen/api/net/minecraft/world/entity/player/player.md#hascontaineropen)

***

#### health

> `readonly` **health**: `number`

The current health.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`health`](/newgen/api/net/minecraft/world/entity/player/player.md#health)

***

#### horizontalCollision

> `readonly` **horizontalCollision**: `boolean`

Whether the entity walked into a wall last tick.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`horizontalCollision`](/newgen/api/net/minecraft/world/entity/player/player.md#horizontalcollision)

***

#### hurtDuration

> `readonly` **hurtDuration**: `number`

The value hurtTime starts counting down from after a hit, in ticks.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`hurtDuration`](/newgen/api/net/minecraft/world/entity/player/player.md#hurtduration)

***

#### hurtTime

> `readonly` **hurtTime**: `number`

Counts down from 10 after being hurt.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`hurtTime`](/newgen/api/net/minecraft/world/entity/player/player.md#hurttime)

***

#### id

> `readonly` **id**: `number`

The network id of this entity.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`id`](/newgen/api/net/minecraft/world/entity/player/player.md#id)

***

#### inputBackward

> `readonly` **inputBackward**: `boolean`

Whether the backward key is held this tick.

***

#### inputForward

> `readonly` **inputForward**: `boolean`

Whether the forward key is held this tick.

***

#### inputJump

> `readonly` **inputJump**: `boolean`

Whether the jump key is held this tick.

***

#### inputLeft

> `readonly` **inputLeft**: `boolean`

Whether the left key is held this tick.

***

#### inputRight

> `readonly` **inputRight**: `boolean`

Whether the right key is held this tick.

***

#### inputShift

> `readonly` **inputShift**: `boolean`

Whether the sneak key is held this tick.

***

#### inputSprint

> `readonly` **inputSprint**: `boolean`

Whether the sprint key is held this tick.

***

#### instabuild

> `readonly` **instabuild**: `boolean`

Whether blocks break instantly, as in creative mode.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`instabuild`](/newgen/api/net/minecraft/world/entity/player/player.md#instabuild)

***

#### inventory

> `readonly` **inventory**: [`Inventory`](/newgen/api/net/minecraft/world/entity/player/inventory.md)

The inventory.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`inventory`](/newgen/api/net/minecraft/world/entity/player/player.md#inventory)

***

#### invulnerableAbility

> `readonly` **invulnerableAbility**: `boolean`

Whether the player's abilities make it immune to damage.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`invulnerableAbility`](/newgen/api/net/minecraft/world/entity/player/player.md#invulnerableability)

***

#### invulnerableTime

> `readonly` **invulnerableTime**: `number`

Ticks of damage immunity left after being hurt.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`invulnerableTime`](/newgen/api/net/minecraft/world/entity/player/player.md#invulnerabletime)

***

#### jumpBoostPower

> `readonly` **jumpBoostPower**: `number`

The extra jump power from the jump boost effect.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`jumpBoostPower`](/newgen/api/net/minecraft/world/entity/player/player.md#jumpboostpower)

***

#### jumping

> `readonly` **jumping**: `boolean`

Whether the entity is trying to jump.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`jumping`](/newgen/api/net/minecraft/world/entity/player/player.md#jumping)

***

#### lastHurtByMob

> `readonly` **lastHurtByMob**: [`Entity`](/newgen/api/net/minecraft/world/entity/entity.md)

The entity that last hurt this one, or null.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`lastHurtByMob`](/newgen/api/net/minecraft/world/entity/player/player.md#lasthurtbymob)

***

#### lastHurtMob

> `readonly` **lastHurtMob**: [`Entity`](/newgen/api/net/minecraft/world/entity/entity.md)

The entity this one last hurt, or null.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`lastHurtMob`](/newgen/api/net/minecraft/world/entity/player/player.md#lasthurtmob)

***

#### leftImpulse

> `readonly` **leftImpulse**: `number`

The sideways input this tick, -1 (right) to 1 (left).

***

#### lookAngle

> `readonly` **lookAngle**: [`Vec3`](/newgen/api/net/minecraft/world/phys/vec3.md)

The unit vector the entity looks along.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`lookAngle`](/newgen/api/net/minecraft/world/entity/player/player.md#lookangle)

***

#### mainHandItem

> `readonly` **mainHandItem**: [`ItemStack`](/newgen/api/net/minecraft/world/item/itemstack.md)

The item in the main hand.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`mainHandItem`](/newgen/api/net/minecraft/world/entity/player/player.md#mainhanditem)

***

#### maxAbsorption

> `readonly` **maxAbsorption**: `number`

The most absorption the entity can have.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`maxAbsorption`](/newgen/api/net/minecraft/world/entity/player/player.md#maxabsorption)

***

#### maxHealth

> `readonly` **maxHealth**: `number`

The maximum health.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`maxHealth`](/newgen/api/net/minecraft/world/entity/player/player.md#maxhealth)

***

#### mayBuild

> `readonly` **mayBuild**: `boolean`

Whether the player's abilities allow placing and breaking blocks.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`mayBuild`](/newgen/api/net/minecraft/world/entity/player/player.md#maybuild)

***

#### mayfly

> `readonly` **mayfly**: `boolean`

Whether the player is allowed to fly.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`mayfly`](/newgen/api/net/minecraft/world/entity/player/player.md#mayfly)

***

#### moveDist

> `readonly` **moveDist**: `number`

How far the entity has moved on the ground in total, used for step sounds and bobbing.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`moveDist`](/newgen/api/net/minecraft/world/entity/player/player.md#movedist)

***

#### name

> `readonly` **name**: `string`

The display name, without formatting.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`name`](/newgen/api/net/minecraft/world/entity/player/player.md#name)

***

#### noPhysics

> `readonly` **noPhysics**: `boolean`

Whether the entity ignores collisions with blocks.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`noPhysics`](/newgen/api/net/minecraft/world/entity/player/player.md#nophysics)

***

#### offhandItem

> `readonly` **offhandItem**: [`ItemStack`](/newgen/api/net/minecraft/world/item/itemstack.md)

The item in the off hand.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`offhandItem`](/newgen/api/net/minecraft/world/entity/player/player.md#offhanditem)

***

#### onGround

> `readonly` **onGround**: `boolean`

Whether the entity stands on a block.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`onGround`](/newgen/api/net/minecraft/world/entity/player/player.md#onground)

***

#### passengers

> `readonly` **passengers**: [`Entity`](/newgen/api/net/minecraft/world/entity/entity.md)\[]

The entities riding this one.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`passengers`](/newgen/api/net/minecraft/world/entity/player/player.md#passengers)

***

#### portalEffectIntensity

> `readonly` **portalEffectIntensity**: `number`

How strong the nether portal screen effect is, 0 to 1.

***

#### pose

> `readonly` **pose**: [`Pose`](/newgen/api/enum_types/pose.md)

The current pose.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`pose`](/newgen/api/net/minecraft/world/entity/player/player.md#pose)

***

#### profileName

> `readonly` **profileName**: `string`

The account name from the game profile.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`profileName`](/newgen/api/net/minecraft/world/entity/player/player.md#profilename)

***

#### remainingFireTicks

> `readonly` **remainingFireTicks**: `number`

Ticks the entity keeps burning for, 0 when not on fire.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`remainingFireTicks`](/newgen/api/net/minecraft/world/entity/player/player.md#remainingfireticks)

***

#### rootVehicle

> `readonly` **rootVehicle**: [`Entity`](/newgen/api/net/minecraft/world/entity/entity.md)

The bottom entity of the vehicle stack this one rides, or itself.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`rootVehicle`](/newgen/api/net/minecraft/world/entity/player/player.md#rootvehicle)

***

#### saturation

> `readonly` **saturation**: `number`

The food saturation, which is spent before the hunger bar drops.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`saturation`](/newgen/api/net/minecraft/world/entity/player/player.md#saturation)

***

#### scale

> `readonly` **scale**: `number`

The size multiplier of the entity.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`scale`](/newgen/api/net/minecraft/world/entity/player/player.md#scale)

***

#### score

> `readonly` **score**: `number`

The score shown on the death screen.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`score`](/newgen/api/net/minecraft/world/entity/player/player.md#score)

***

#### scoreboardName

> `readonly` **scoreboardName**: `string`

The name the scoreboard knows this entity by: the player name, or the UUID.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`scoreboardName`](/newgen/api/net/minecraft/world/entity/player/player.md#scoreboardname)

***

#### serverSprintState

> `readonly` **serverSprintState**: `boolean`

Whether the server was last told the player is sprinting.

***

#### shiftKeyDown

> `readonly` **shiftKeyDown**: `boolean`

Whether the entity is sneaking.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`shiftKeyDown`](/newgen/api/net/minecraft/world/entity/player/player.md#shiftkeydown)

***

#### speed

> `readonly` **speed**: `number`

The movement speed attribute scaled for the tick, in blocks per tick.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`speed`](/newgen/api/net/minecraft/world/entity/player/player.md#speed)

***

#### sprinting

> `readonly` **sprinting**: `boolean`

Whether the entity is sprinting.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`sprinting`](/newgen/api/net/minecraft/world/entity/player/player.md#sprinting)

***

#### swinging

> `readonly` **swinging**: `boolean`

Whether the swing animation is playing.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`swinging`](/newgen/api/net/minecraft/world/entity/player/player.md#swinging)

***

#### swingTime

> `readonly` **swingTime**: `number`

Ticks into the current swing animation.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`swingTime`](/newgen/api/net/minecraft/world/entity/player/player.md#swingtime)

***

#### teamColor

> `readonly` **teamColor**: `number`

The team's color as 0xRRGGBB, or 0xFFFFFF when there is none.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`teamColor`](/newgen/api/net/minecraft/world/entity/player/player.md#teamcolor)

***

#### teamName

> `readonly` **teamName**: `string`

The scoreboard team this entity is on, or null.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`teamName`](/newgen/api/net/minecraft/world/entity/player/player.md#teamname)

***

#### tickCount

> `readonly` **tickCount**: `number`

Ticks this entity has existed for on the client.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`tickCount`](/newgen/api/net/minecraft/world/entity/player/player.md#tickcount)

***

#### ticksFrozen

> `readonly` **ticksFrozen**: `number`

Ticks spent in powder snow.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`ticksFrozen`](/newgen/api/net/minecraft/world/entity/player/player.md#ticksfrozen)

***

#### ticksUsingItem

> `readonly` **ticksUsingItem**: `number`

How many ticks the current item has been in use.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`ticksUsingItem`](/newgen/api/net/minecraft/world/entity/player/player.md#ticksusingitem)

***

#### totalExperience

> `readonly` **totalExperience**: `number`

The total experience points collected.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`totalExperience`](/newgen/api/net/minecraft/world/entity/player/player.md#totalexperience)

***

#### type

> `readonly` **type**: `string`

The entity type id, e.g. "minecraft:zombie".

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`type`](/newgen/api/net/minecraft/world/entity/player/player.md#type)

***

#### usedItemHand

> `readonly` **usedItemHand**: [`InteractionHand`](/newgen/api/enum_types/interactionhand.md)

The hand the item in use is held in. Only meaningful while isUsingItem is true.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`usedItemHand`](/newgen/api/net/minecraft/world/entity/player/player.md#useditemhand)

***

#### useItem

> `readonly` **useItem**: [`ItemStack`](/newgen/api/net/minecraft/world/item/itemstack.md)

The item being used, or an empty stack when none is.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`useItem`](/newgen/api/net/minecraft/world/entity/player/player.md#useitem)

***

#### useItemRemainingTicks

> `readonly` **useItemRemainingTicks**: `number`

Ticks left until the used item finishes.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`useItemRemainingTicks`](/newgen/api/net/minecraft/world/entity/player/player.md#useitemremainingticks)

***

#### uuid

> `readonly` **uuid**: `string`

The UUID of this entity, as a string.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`uuid`](/newgen/api/net/minecraft/world/entity/player/player.md#uuid)

***

#### vehicle

> `readonly` **vehicle**: [`Entity`](/newgen/api/net/minecraft/world/entity/entity.md)

The entity this one rides, or null.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`vehicle`](/newgen/api/net/minecraft/world/entity/player/player.md#vehicle)

***

#### verticalCollision

> `readonly` **verticalCollision**: `boolean`

Whether the entity hit a ceiling or floor last move.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`verticalCollision`](/newgen/api/net/minecraft/world/entity/player/player.md#verticalcollision)

***

#### walkingSpeed

> `readonly` **walkingSpeed**: `number`

The walking speed from the abilities.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`walkingSpeed`](/newgen/api/net/minecraft/world/entity/player/player.md#walkingspeed)

***

#### x

> `readonly` **x**: `number`

The X position.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`x`](/newgen/api/net/minecraft/world/entity/player/player.md#x)

***

#### xo

> `readonly` **xo**: `number`

The X position last tick.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`xo`](/newgen/api/net/minecraft/world/entity/player/player.md#xo)

***

#### xRot

> **xRot**: `number`

The vertical rotation (pitch) in degrees, positive is down.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`xRot`](/newgen/api/net/minecraft/world/entity/player/player.md#xrot)

***

#### xRotO

> `readonly` **xRotO**: `number`

The vertical rotation (pitch) last tick in degrees.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`xRotO`](/newgen/api/net/minecraft/world/entity/player/player.md#xroto)

***

#### xxa

> `readonly` **xxa**: `number`

The sideways movement input, positive to the left.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`xxa`](/newgen/api/net/minecraft/world/entity/player/player.md#xxa)

***

#### y

> `readonly` **y**: `number`

The Y position, at the entity's feet.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`y`](/newgen/api/net/minecraft/world/entity/player/player.md#y)

***

#### yBodyRot

> `readonly` **yBodyRot**: `number`

The horizontal rotation of the body in degrees.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`yBodyRot`](/newgen/api/net/minecraft/world/entity/player/player.md#ybodyrot)

***

#### yHeadRot

> `readonly` **yHeadRot**: `number`

The horizontal rotation of the head in degrees.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`yHeadRot`](/newgen/api/net/minecraft/world/entity/player/player.md#yheadrot)

***

#### yo

> `readonly` **yo**: `number`

The Y position last tick.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`yo`](/newgen/api/net/minecraft/world/entity/player/player.md#yo)

***

#### yRot

> **yRot**: `number`

The horizontal rotation (yaw) in degrees.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`yRot`](/newgen/api/net/minecraft/world/entity/player/player.md#yrot)

***

#### yRotO

> `readonly` **yRotO**: `number`

The horizontal rotation (yaw) last tick in degrees.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`yRotO`](/newgen/api/net/minecraft/world/entity/player/player.md#yroto)

***

#### z

> `readonly` **z**: `number`

The Z position.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`z`](/newgen/api/net/minecraft/world/entity/player/player.md#z)

***

#### zo

> `readonly` **zo**: `number`

The Z position last tick.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`zo`](/newgen/api/net/minecraft/world/entity/player/player.md#zo)

***

#### zza

> `readonly` **zza**: `number`

The forward movement input, negative when moving backward.

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`zza`](/newgen/api/net/minecraft/world/entity/player/player.md#zza)

### Methods

#### canUseGameMasterBlocks()

> **canUseGameMasterBlocks**(): `boolean`

Whether the player has operator permissions for command blocks.

**Returns**

`boolean`

***

#### closeContainer()

> **closeContainer**(): `void`

Closes the open container screen and tells the server.

**Returns**

`void`

**Remarks**

Sends a container close packet.

***

#### distanceTo()

> **distanceTo**(`other`): `number`

The distance between the feet of two entities.

**Parameters**

**other**

[`Entity`](/newgen/api/net/minecraft/world/entity/entity.md)

The other entity.

**Returns**

`number`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`distanceTo`](/newgen/api/net/minecraft/world/entity/player/player.md#distanceto)

***

#### distanceToPos()

> **distanceToPos**(`point`): `number`

The distance from the feet to a point.

**Parameters**

**point**

[`Vec3`](/newgen/api/net/minecraft/world/phys/vec3.md)

The point.

**Returns**

`number`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`distanceToPos`](/newgen/api/net/minecraft/world/entity/player/player.md#distancetopos)

***

#### distanceToSqr()

> **distanceToSqr**(`other`): `number`

The squared distance between the feet of two entities.

**Parameters**

**other**

[`Entity`](/newgen/api/net/minecraft/world/entity/entity.md)

The other entity.

**Returns**

`number`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`distanceToSqr`](/newgen/api/net/minecraft/world/entity/player/player.md#distancetosqr)

***

#### distanceToSqrPos()

> **distanceToSqrPos**(`x`, `y`, `z`): `number`

The squared distance from the feet to a point.

**Parameters**

**x**

`number`

X.

**y**

`number`

Y.

**z**

`number`

Z.

**Returns**

`number`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`distanceToSqrPos`](/newgen/api/net/minecraft/world/entity/player/player.md#distancetosqrpos)

***

#### getArmorCoverPercentage()

> **getArmorCoverPercentage**(): `number`

The share of armor slots filled, 0 to 1.

**Returns**

`number`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`getArmorCoverPercentage`](/newgen/api/net/minecraft/world/entity/player/player.md#getarmorcoverpercentage)

***

#### getAttackAnim()

> **getAttackAnim**(`partialTicks`): `number`

How far the swing animation has progressed, 0 to 1.

**Parameters**

**partialTicks**

`number`

The partial tick, from a render event.

**Returns**

`number`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`getAttackAnim`](/newgen/api/net/minecraft/world/entity/player/player.md#getattackanim)

***

#### getAttackStrengthScale()

> **getAttackStrengthScale**(`partialTicks`): `number`

How charged an attack is, 0 to 1.

**Parameters**

**partialTicks**

`number`

The partial tick, 0 for this tick.

**Returns**

`number`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`getAttackStrengthScale`](/newgen/api/net/minecraft/world/entity/player/player.md#getattackstrengthscale)

***

#### getAttributeBaseValue()

> **getAttributeBaseValue**(`id`): `number`

The attribute's value before modifiers, or 0 when the entity lacks it.

**Parameters**

**id**

`string`

The attribute id, e.g. "minecraft:movement\_speed".

**Returns**

`number`

**See**

[Attribute ids](https://minecraft.wiki/w/Attribute#List_of_attributes)

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`getAttributeBaseValue`](/newgen/api/net/minecraft/world/entity/player/player.md#getattributebasevalue)

***

#### getAttributeValue()

> **getAttributeValue**(`id`): `number`

The attribute's value with all modifiers applied, or 0 when the entity lacks it.

**Parameters**

**id**

`string`

The attribute id, e.g. "minecraft:movement\_speed".

**Returns**

`number`

**See**

[Attribute ids](https://minecraft.wiki/w/Attribute#List_of_attributes)

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`getAttributeValue`](/newgen/api/net/minecraft/world/entity/player/player.md#getattributevalue)

***

#### getEffect()

> **getEffect**(`id`): [`MobEffectInstance`](/newgen/api/net/minecraft/world/effect/mobeffectinstance.md)

The status effect of a kind on the entity, or null.

**Parameters**

**id**

`string`

The effect id, e.g. "minecraft:speed".

**Returns**

[`MobEffectInstance`](/newgen/api/net/minecraft/world/effect/mobeffectinstance.md)

**See**

[Effect ids](https://minecraft.wiki/w/Java_Edition_data_values/Effects)

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`getEffect`](/newgen/api/net/minecraft/world/entity/player/player.md#geteffect)

***

#### getEyePosition()

> **getEyePosition**(`partialTicks`): [`Vec3`](/newgen/api/net/minecraft/world/phys/vec3.md)

The eye position, interpolated for rendering.

**Parameters**

**partialTicks**

`number`

The partial tick, from a render event.

**Returns**

[`Vec3`](/newgen/api/net/minecraft/world/phys/vec3.md)

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`getEyePosition`](/newgen/api/net/minecraft/world/entity/player/player.md#geteyeposition)

***

#### getItemBySlot()

> **getItemBySlot**(`slot`): [`ItemStack`](/newgen/api/net/minecraft/world/item/itemstack.md)

The item in an equipment slot, such as armor.

**Parameters**

**slot**

[`EquipmentSlot`](/newgen/api/enum_types/equipmentslot.md)

The slot.

**Returns**

[`ItemStack`](/newgen/api/net/minecraft/world/item/itemstack.md)

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`getItemBySlot`](/newgen/api/net/minecraft/world/entity/player/player.md#getitembyslot)

***

#### getItemCooldownPercent()

> **getItemCooldownPercent**(`stack`, `partialTicks`): `number`

How much of the item's cooldown is left, 0 to 1.

**Parameters**

**stack**

[`ItemStack`](/newgen/api/net/minecraft/world/item/itemstack.md)

A stack of the item.

**partialTicks**

`number`

The partial tick, 0 for this tick.

**Returns**

`number`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`getItemCooldownPercent`](/newgen/api/net/minecraft/world/entity/player/player.md#getitemcooldownpercent)

***

#### getItemInHand()

> **getItemInHand**(`hand`): [`ItemStack`](/newgen/api/net/minecraft/world/item/itemstack.md)

The item held in a hand.

**Parameters**

**hand**

[`InteractionHand`](/newgen/api/enum_types/interactionhand.md)

The hand.

**Returns**

[`ItemStack`](/newgen/api/net/minecraft/world/item/itemstack.md)

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`getItemInHand`](/newgen/api/net/minecraft/world/entity/player/player.md#getiteminhand)

***

#### getPosition()

> **getPosition**(`partialTicks`): [`Vec3`](/newgen/api/net/minecraft/world/phys/vec3.md)

The position, interpolated for rendering.

**Parameters**

**partialTicks**

`number`

The partial tick, from a render event.

**Returns**

[`Vec3`](/newgen/api/net/minecraft/world/phys/vec3.md)

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`getPosition`](/newgen/api/net/minecraft/world/entity/player/player.md#getposition)

***

#### getViewVector()

> **getViewVector**(`partialTicks`): [`Vec3`](/newgen/api/net/minecraft/world/phys/vec3.md)

The unit vector the entity looks along, interpolated for rendering.

**Parameters**

**partialTicks**

`number`

The partial tick, from a render event.

**Returns**

[`Vec3`](/newgen/api/net/minecraft/world/phys/vec3.md)

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`getViewVector`](/newgen/api/net/minecraft/world/entity/player/player.md#getviewvector)

***

#### getXRotInterpolated()

> **getXRotInterpolated**(`partialTicks`): `number`

The vertical rotation in degrees, interpolated for rendering.

**Parameters**

**partialTicks**

`number`

The partial tick, from a render event.

**Returns**

`number`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`getXRotInterpolated`](/newgen/api/net/minecraft/world/entity/player/player.md#getxrotinterpolated)

***

#### getYRotInterpolated()

> **getYRotInterpolated**(`partialTicks`): `number`

The horizontal rotation in degrees, interpolated for rendering.

**Parameters**

**partialTicks**

`number`

The partial tick, from a render event.

**Returns**

`number`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`getYRotInterpolated`](/newgen/api/net/minecraft/world/entity/player/player.md#getyrotinterpolated)

***

#### hasAttribute()

> **hasAttribute**(`id`): `boolean`

Whether the entity has an attribute.

**Parameters**

**id**

`string`

The attribute id, e.g. "minecraft:movement\_speed".

**Returns**

`boolean`

**See**

[Attribute ids](https://minecraft.wiki/w/Attribute#List_of_attributes)

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`hasAttribute`](/newgen/api/net/minecraft/world/entity/player/player.md#hasattribute)

***

#### hasEffect()

> **hasEffect**(`id`): `boolean`

Whether the entity has a status effect.

**Parameters**

**id**

`string`

The effect id, e.g. "minecraft:speed".

**Returns**

`boolean`

**See**

[Effect ids](https://minecraft.wiki/w/Java_Edition_data_values/Effects)

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`hasEffect`](/newgen/api/net/minecraft/world/entity/player/player.md#haseffect)

***

#### hasLineOfSight()

> **hasLineOfSight**(`other`): `boolean`

Whether a ray from this entity's eyes to the other entity's eyes hits no block.

**Parameters**

**other**

[`Entity`](/newgen/api/net/minecraft/world/entity/entity.md)

The other entity.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`hasLineOfSight`](/newgen/api/net/minecraft/world/entity/player/player.md#haslineofsight)

***

#### hasPassenger()

> **hasPassenger**(`other`): `boolean`

Whether the given entity rides this one.

**Parameters**

**other**

[`Entity`](/newgen/api/net/minecraft/world/entity/entity.md)

The entity.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`hasPassenger`](/newgen/api/net/minecraft/world/entity/player/player.md#haspassenger)

***

#### isAlive()

> **isAlive**(): `boolean`

Whether the entity is alive and not removed.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isAlive`](/newgen/api/net/minecraft/world/entity/player/player.md#isalive)

***

#### isAlliedTo()

> **isAlliedTo**(`other`): `boolean`

Whether the other entity is on the same scoreboard team.

**Parameters**

**other**

[`Entity`](/newgen/api/net/minecraft/world/entity/entity.md)

The other entity.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isAlliedTo`](/newgen/api/net/minecraft/world/entity/player/player.md#isalliedto)

***

#### isAttackable()

> **isAttackable**(): `boolean`

Whether the entity can be attacked.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isAttackable`](/newgen/api/net/minecraft/world/entity/player/player.md#isattackable)

***

#### isAutoSpinAttack()

> **isAutoSpinAttack**(): `boolean`

Whether the entity is riptiding.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isAutoSpinAttack`](/newgen/api/net/minecraft/world/entity/player/player.md#isautospinattack)

***

#### isBaby()

> **isBaby**(): `boolean`

Whether the entity is a baby.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isBaby`](/newgen/api/net/minecraft/world/entity/player/player.md#isbaby)

***

#### isBlocking()

> **isBlocking**(): `boolean`

Whether a shield is raised.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isBlocking`](/newgen/api/net/minecraft/world/entity/player/player.md#isblocking)

***

#### isCloseEnough()

> **isCloseEnough**(`other`, `distance`): `boolean`

Whether the other entity is within a distance of this one's feet.

**Parameters**

**other**

[`Entity`](/newgen/api/net/minecraft/world/entity/entity.md)

The other entity.

**distance**

`number`

The distance in blocks.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isCloseEnough`](/newgen/api/net/minecraft/world/entity/player/player.md#iscloseenough)

***

#### isCreative()

> **isCreative**(): `boolean`

Whether the player is in creative mode.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isCreative`](/newgen/api/net/minecraft/world/entity/player/player.md#iscreative)

***

#### isCrouching()

> **isCrouching**(): `boolean`

Whether the entity is in the crouching pose.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isCrouching`](/newgen/api/net/minecraft/world/entity/player/player.md#iscrouching)

***

#### isCurrentlyGlowing()

> **isCurrentlyGlowing**(): `boolean`

Whether the entity has the glowing outline, from the effect or spectral arrows.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isCurrentlyGlowing`](/newgen/api/net/minecraft/world/entity/player/player.md#iscurrentlyglowing)

***

#### isCustomNameVisible()

> **isCustomNameVisible**(): `boolean`

Whether the custom name shows above the entity.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isCustomNameVisible`](/newgen/api/net/minecraft/world/entity/player/player.md#iscustomnamevisible)

***

#### isDeadOrDying()

> **isDeadOrDying**(): `boolean`

Whether the entity has no health left.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isDeadOrDying`](/newgen/api/net/minecraft/world/entity/player/player.md#isdeadordying)

***

#### isFallFlying()

> **isFallFlying**(): `boolean`

Whether the entity glides with an elytra.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isFallFlying`](/newgen/api/net/minecraft/world/entity/player/player.md#isfallflying)

***

#### isFree()

> **isFree**(`x`, `y`, `z`): `boolean`

Whether the collision box moved by an offset would be free of blocks.

**Parameters**

**x**

`number`

X offset.

**y**

`number`

Y offset.

**z**

`number`

Z offset.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isFree`](/newgen/api/net/minecraft/world/entity/player/player.md#isfree)

***

#### isHandsBusy()

> **isHandsBusy**(): `boolean`

Whether the player is busy with both hands, such as when riding a boat.

**Returns**

`boolean`

***

#### isInLava()

> **isInLava**(): `boolean`

Whether the entity is in lava.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isInLava`](/newgen/api/net/minecraft/world/entity/player/player.md#isinlava)

***

#### isInLiquid()

> **isInLiquid**(): `boolean`

Whether the entity is in water or lava.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isInLiquid`](/newgen/api/net/minecraft/world/entity/player/player.md#isinliquid)

***

#### isInPowderSnow()

> **isInPowderSnow**(): `boolean`

Whether the entity is in powder snow.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isInPowderSnow`](/newgen/api/net/minecraft/world/entity/player/player.md#isinpowdersnow)

***

#### isInvisible()

> **isInvisible**(): `boolean`

Whether the entity is invisible.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isInvisible`](/newgen/api/net/minecraft/world/entity/player/player.md#isinvisible)

***

#### isInvulnerable()

> **isInvulnerable**(): `boolean`

Whether the entity takes no damage at all.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isInvulnerable`](/newgen/api/net/minecraft/world/entity/player/player.md#isinvulnerable)

***

#### isInWall()

> **isInWall**(): `boolean`

Whether the entity's eyes are inside a solid block.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isInWall`](/newgen/api/net/minecraft/world/entity/player/player.md#isinwall)

***

#### isInWater()

> **isInWater**(): `boolean`

Whether the entity is in water.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isInWater`](/newgen/api/net/minecraft/world/entity/player/player.md#isinwater)

***

#### isInWaterOrRain()

> **isInWaterOrRain**(): `boolean`

Whether the entity is in water or being rained on.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isInWaterOrRain`](/newgen/api/net/minecraft/world/entity/player/player.md#isinwaterorrain)

***

#### isItemOnCooldown()

> **isItemOnCooldown**(`stack`): `boolean`

Whether the item is on cooldown, e.g. an ender pearl or shield.

**Parameters**

**stack**

[`ItemStack`](/newgen/api/net/minecraft/world/item/itemstack.md)

A stack of the item.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isItemOnCooldown`](/newgen/api/net/minecraft/world/entity/player/player.md#isitemoncooldown)

***

#### isLocalPlayer()

> **isLocalPlayer**(): `boolean`

Whether this is the player you control.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isLocalPlayer`](/newgen/api/net/minecraft/world/entity/player/player.md#islocalplayer)

***

#### isMovingSlowly()

> **isMovingSlowly**(): `boolean`

Whether sneaking or crawling slows the player down.

**Returns**

`boolean`

***

#### isNoGravity()

> **isNoGravity**(): `boolean`

Whether gravity does not apply to the entity.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isNoGravity`](/newgen/api/net/minecraft/world/entity/player/player.md#isnogravity)

***

#### isOnFire()

> **isOnFire**(): `boolean`

Whether the entity is burning.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isOnFire`](/newgen/api/net/minecraft/world/entity/player/player.md#isonfire)

***

#### isOnRails()

> **isOnRails**(): `boolean`

Whether the entity is on a rail block.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isOnRails`](/newgen/api/net/minecraft/world/entity/player/player.md#isonrails)

***

#### isPassenger()

> **isPassenger**(): `boolean`

Whether the entity rides another.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isPassenger`](/newgen/api/net/minecraft/world/entity/player/player.md#ispassenger)

***

#### isPushable()

> **isPushable**(): `boolean`

Whether other entities can push this one.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isPushable`](/newgen/api/net/minecraft/world/entity/player/player.md#ispushable)

***

#### isRemoved()

> **isRemoved**(): `boolean`

Whether the entity left the world.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isRemoved`](/newgen/api/net/minecraft/world/entity/player/player.md#isremoved)

***

#### isSilent()

> **isSilent**(): `boolean`

Whether the entity makes no sounds.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isSilent`](/newgen/api/net/minecraft/world/entity/player/player.md#issilent)

***

#### isSleeping()

> **isSleeping**(): `boolean`

Whether the entity is in a bed.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isSleeping`](/newgen/api/net/minecraft/world/entity/player/player.md#issleeping)

***

#### isSpectator()

> **isSpectator**(): `boolean`

Whether the entity is a player in spectator mode.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isSpectator`](/newgen/api/net/minecraft/world/entity/player/player.md#isspectator)

***

#### isSteppingCarefully()

> **isSteppingCarefully**(): `boolean`

Whether sneaking stops the entity from walking off edges.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isSteppingCarefully`](/newgen/api/net/minecraft/world/entity/player/player.md#issteppingcarefully)

***

#### isSwimming()

> **isSwimming**(): `boolean`

Whether the entity is swimming (sprint-swimming in water).

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isSwimming`](/newgen/api/net/minecraft/world/entity/player/player.md#isswimming)

***

#### isUnderWater()

> **isUnderWater**(): `boolean`

Whether the entity's eyes are under water.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isUnderWater`](/newgen/api/net/minecraft/world/entity/player/player.md#isunderwater)

***

#### isUsingItem()

> **isUsingItem**(): `boolean`

Whether an item is being used (eating, blocking, drawing a bow\...).

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isUsingItem`](/newgen/api/net/minecraft/world/entity/player/player.md#isusingitem)

***

#### isVehicle()

> **isVehicle**(): `boolean`

Whether another entity rides this one.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isVehicle`](/newgen/api/net/minecraft/world/entity/player/player.md#isvehicle)

***

#### isVisuallyCrawling()

> **isVisuallyCrawling**(): `boolean`

Whether the entity is crawling in a one block high gap.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isVisuallyCrawling`](/newgen/api/net/minecraft/world/entity/player/player.md#isvisuallycrawling)

***

#### isWithinEntityInteractionRange()

> **isWithinEntityInteractionRange**(`entity`, `buffer`): `boolean`

Whether the entity is close enough to attack with the held item.

**Parameters**

**entity**

[`Entity`](/newgen/api/net/minecraft/world/entity/entity.md)

The entity.

**buffer**

`number`

Extra reach in blocks to allow.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`isWithinEntityInteractionRange`](/newgen/api/net/minecraft/world/entity/player/player.md#iswithinentityinteractionrange)

***

#### jumpFromGround()

> **jumpFromGround**(): `void`

Applies a jump to the player's velocity, including sprint and jump boost.

**Returns**

`void`

**Remarks**

Happens on the client only; the server learns of it from the movement that follows.

***

#### onClimbable()

> **onClimbable**(): `boolean`

Whether the entity is on a ladder, vine or similar.

**Returns**

`boolean`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`onClimbable`](/newgen/api/net/minecraft/world/entity/player/player.md#onclimbable)

***

#### position()

> **position**(): [`Vec3`](/newgen/api/net/minecraft/world/phys/vec3.md)

The position as a Vec3.

**Returns**

[`Vec3`](/newgen/api/net/minecraft/world/phys/vec3.md)

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`position`](/newgen/api/net/minecraft/world/entity/player/player.md#position)

***

#### sendOpenInventory()

> **sendOpenInventory**(): `void`

Asks the server to open the player's inventory.

**Returns**

`void`

**Remarks**

Sends a command packet.

***

#### setDeltaMovement()

> **setDeltaMovement**(`x`, `y`, `z`): `void`

Sets the velocity in blocks per tick.

**Parameters**

**x**

`number`

X.

**y**

`number`

Y.

**z**

`number`

Z.

**Returns**

`void`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`setDeltaMovement`](/newgen/api/net/minecraft/world/entity/player/player.md#setdeltamovement)

***

#### swing()

> **swing**(`hand`): `void`

Plays the swing animation, and tells the server for the local player.

**Parameters**

**hand**

[`InteractionHand`](/newgen/api/enum_types/interactionhand.md)

The hand to swing.

**Returns**

`void`

**Inherited from**

[`Player`](/newgen/api/net/minecraft/world/entity/player/player.md).[`swing`](/newgen/api/net/minecraft/world/entity/player/player.md#swing)

***

#### tryToStartFallFlying()

> **tryToStartFallFlying**(): `boolean`

Starts gliding when an elytra is worn, the player is airborne and not already gliding. Returns whether it started.

**Returns**

`boolean`

**Remarks**

Tells the server with a start-fall-flying command.
