player

The global instance of the EntityAPI and its subtypes

field signature:

player

Method Property	Fluent Description	Representation
Field Type	a PlayerAPI	`PlayerAPI`

PlayerAPI.getGamemode

Example by JimmyHelp:
if player:getGamemode() and player:getGamemode() == "SURVIVAL" then
  log("You're in survival mode")
end 

Returns "SURVIVAL", "CREATIVE", "ADVENTURE", or "SPECTATOR" depending on the player's gamemode
If the gamemode is unknown, returns nil

overload 1:
                        
player:getGamemode()  
 Method Property Fluent Description Representation
Return Value either a String or nil String | nil

Method Property	Fluent Description	Representation
Return Value	either a String or nil	`String \| nil`

PlayerAPI.getTeamInfo

Returns a table with information about the team of this player
Returns nil if the player doesn't have a team

overload 1:
                        
player:getTeamInfo()  
 Method Property Fluent Description Representation
Return Value a table Table

Method Property	Fluent Description	Representation
Return Value	a table	`Table`

PlayerAPI.getShoulderEntity

Returns a table of the nbt of this entity left or right shoulder entity

overload 1:
                        
player:getShoulderEntity()  
 Method Property Fluent Description Representation
Return Value a table Table 
   
overload 2:
                        
player:getShoulderEntity(right)  
 Method Property Fluent Description Representation
right accepts a Boolean Boolean 
   
Return Value a table Table

Method Property	Fluent Description	Representation
Return Value	a table	`Table`

Method Property	Fluent Description	Representation
right accepts	a Boolean	`Boolean`
Return Value	a table	`Table`

PlayerAPI.hasSkin

Returns whether the player has a custom skin loaded

overload 1:
                        
player:hasSkin()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

PlayerAPI.getModelType

Example by JimmyHelp:
if player:getModelType() == "DEFAULT" then
  log("You're Steve")
end 

Returns "SLIM" or "DEFAULT", depending on the player's model type

overload 1:
                        
player:getModelType()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

PlayerAPI.isFishing

Returns if the player is currently fishing

overload 1:
                        
player:isFishing()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

PlayerAPI.isSkinLayerVisible

Example by JimmyHelp:
if player:isSkinLayerVisible("HAT") then
  log("Your hat's on")
end 

Returns whether the specified skin layer, from the Skin Customizations settings, is currently visible

overload 1:
                        
player:isSkinLayerVisible(part)  
 Method Property Fluent Description Representation
part accepts a String String 
   
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
part accepts	a String	`String`
Return Value	a Boolean	`Boolean`

PlayerAPI.hasCape

Returns whether the player has a cape loaded

overload 1:
                        
player:hasCape()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

PlayerAPI.getCooldownPercent

Returns the whether a given ItemStack has an active cool down as a percent from 0.0 to 1.0
If it has none, it returns 0.0
Takes two parameters stack, and delta, delta offsets the cooldown's tick count by it, used for smoother animation.

overload 1:
                        
player:getCooldownPercent(stack, delta)  
 Method Property Fluent Description Representation
stack accepts an ItemStack ItemStack 
   
delta accepts a Number Number 
   
Return Value a Number Number

Method Property	Fluent Description	Representation
stack accepts	an ItemStack	`ItemStack`
delta accepts	a Number	`Number`
Return Value	a Number	`Number`

PlayerAPI.getExperienceLevel

Example by JimmyHelp:
if player:getExperienceLevel() == 30 then
  log("You have 30 levels")
end 

Gets the player's current level

overload 1:
                        
player:getExperienceLevel()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

PlayerAPI.getChargedAttackDelay

Returns the delay (in ticks) of charged attacks

overload 1:
                        
player:getChargedAttackDelay()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

PlayerAPI.getExperienceProgress

Example by JimmyHelp:
if player:getExperienceProgress() > .5 then
   log("You're over halfway to the next level")
 end 

Gets the progress of the way towards the player's next level, as a value from 0 to 1

overload 1:
                        
player:getExperienceProgress()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

PlayerAPI.getFood

Example by JimmyHelp:
if player:getFood() == 0 then
  log("You're starving")
end 

Gets the current food level of the player, from 0 to 20

overload 1:
                        
player:getFood()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

PlayerAPI.getExhaustion

Gets the current exhaustion level of the player

overload 1:
                        
player:getExhaustion()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

PlayerAPI.getSaturation

Example by JimmyHelp:
if player:getSaturation() == 20 then
  log("Your saturation is 20")
end 

Gets the current saturation level of the player

overload 1:
                        
player:getSaturation()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

PlayerAPI.isBlocking

Inherited from LivingEntityAPI

Return if this entity is blocking with a shield

overload 1:
                        
player:isBlocking()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

PlayerAPI.getSwingDuration

Inherited from LivingEntityAPI

Returns the number of ticks this entity will have while swinging its arms

overload 1:
                        
player:getSwingDuration()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

PlayerAPI.getAbsorptionAmount

Inherited from LivingEntityAPI

Returns the amount of this entity's absorption (yellow hearts)

overload 1:
                        
player:getAbsorptionAmount()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

PlayerAPI.isVisuallySwimming

Inherited from LivingEntityAPI

Returns if this entity has the swimming pose

overload 1:
                        
player:isVisuallySwimming()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

PlayerAPI.isSensitiveToWater

Inherited from LivingEntityAPI

Returns if this entity takes damage to water

overload 1:
                        
player:isSensitiveToWater()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

PlayerAPI.riptideSpinning

Inherited from LivingEntityAPI

Returns if this entity is riptide spinning

overload 1:
                        
player:riptideSpinning()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

PlayerAPI.getSwingArm

Inherited from LivingEntityAPI

Returns "OFF_HAND" or "MAIN_HAND", based on the arm this entity is currently swinging

overload 1:
                        
player:getSwingArm()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

PlayerAPI.isGliding

Inherited from LivingEntityAPI

Returns if this entity is gliding with an elytra

overload 1:
                        
player:isGliding()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

PlayerAPI.getEntityCategory

Inherited from LivingEntityAPI

Returns the category of this entity
The categories are: "ARTHROPOD", "UNDEAD", "WATER", "ILLAGER" and by default, "UNDEFINED"

overload 1:
                        
player:getEntityCategory()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

PlayerAPI.getSwingTime

Inherited from LivingEntityAPI

Returns the number of ticks this entity has the arm swinging

overload 1:
                        
player:getSwingTime()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

PlayerAPI.isSwingingArm

Inherited from LivingEntityAPI

Returns true if the entity is currently swinging its arm

overload 1:
                        
player:isSwingingArm()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

PlayerAPI.getArmor

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getArmor() == 20 then
  log("You have max armor points")
end 

Returns the amount of armor points this entity has

overload 1:
                        
player:getArmor()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

PlayerAPI.getActiveHand

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getActiveHand() == "MAIN_HAND" then
  log("You're using your main hand")
end 

Returns "OFF_HAND" or "MAIN_HAND", depending on which hand this entity uses an item with

overload 1:
                        
player:getActiveHand()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

PlayerAPI.isClimbing

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isClimbing() then
  log("You're climbing")
end 

Returns true if the entity is currently using a climbable block, like a ladder or vine

overload 1:
                        
player:isClimbing()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

PlayerAPI.isUsingItem

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isUsingItem() then
  log("You're using an item")
end 

Returns true if the entity is currently using an item

overload 1:
                        
player:isUsingItem()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

PlayerAPI.isLeftHanded

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isLeftHanded() then
  log("You're left handed")
end 

Returns true if the entity's main hand is its left

overload 1:
                        
player:isLeftHanded()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

PlayerAPI.getBodyYaw

Inherited from LivingEntityAPI

Example by JimmyHelp:
models:setRot(0,player:getBodyYaw()) 

Gets the yaw of this entity's body in degrees
If delta is passed in, then it will be used to linearly interpolate the rotation of the body between the previous tick and the current tick
The default value of delta is 1

overload 1:
                        
player:getBodyYaw()  
 Method Property Fluent Description Representation
Return Value a Number Number 
   
overload 2:
                        
player:getBodyYaw(delta)  
 Method Property Fluent Description Representation
delta accepts a Number Number 
   
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

Method Property	Fluent Description	Representation
delta accepts	a Number	`Number`
Return Value	a Number	`Number`

PlayerAPI.getHeldItem

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getHeldItem(false).id == "minecraft:diamond_sword" then
  log("You're holding a diamond sword")
end 

Returns an ItemStack representing the item in this entity's main hand
If true is passed in for "offhand", then it will instead look at the item in the entity's offhand
If the entity isn't holding an item in that hand, returns air

overload 1:
                        
player:getHeldItem()  
 Method Property Fluent Description Representation
Return Value an ItemStack ItemStack 
   
overload 2:
                        
player:getHeldItem(offhand)  
 Method Property Fluent Description Representation
offhand accepts a Boolean Boolean 
   
Return Value an ItemStack ItemStack

Method Property	Fluent Description	Representation
Return Value	an ItemStack	`ItemStack`

Method Property	Fluent Description	Representation
offhand accepts	a Boolean	`Boolean`
Return Value	an ItemStack	`ItemStack`

PlayerAPI.getDeathTime

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getDeathTime() > 0 then
  log("You're dead")
end 

Returns the number of ticks this entity has been dead for

overload 1:
                        
player:getDeathTime()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

PlayerAPI.getHealth

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getHealth() == 20 then
  log("You're at full health")
end 

Returns the amount of health this entity has remaining

overload 1:
                        
player:getHealth()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

PlayerAPI.getMaxHealth

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getMaxHealth() == 20 then
  log("You're healthy")
end 

Returns the maximum amount of health this entity can have

overload 1:
                        
player:getMaxHealth()  
 Method Property Fluent Description Representation
Return Value a Number Number

Method Property	Fluent Description	Representation
Return Value	a Number	`Number`

PlayerAPI.getActiveItem

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getActiveItem().id == "minecraft:bow" then
  log("You're drawing back a bow")
end 

Returns an ItemStack representing the item the entity is currently using
If they're not using any item, returns air

overload 1:
                        
player:getActiveItem()  
 Method Property Fluent Description Representation
Return Value an ItemStack ItemStack

Method Property	Fluent Description	Representation
Return Value	an ItemStack	`ItemStack`

PlayerAPI.getArrowCount

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getArrowCount() > 0 then
  log("You've been shot")
end 

Returns the number of arrows sticking out of this entity

overload 1:
                        
player:getArrowCount()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

PlayerAPI.getActiveItemTime

Inherited from LivingEntityAPI

Returns the ticks this entity's active item has been used for

overload 1:
                        
player:getActiveItemTime()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

PlayerAPI.getStingerCount

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getStingerCount() > 0 then
  log("You've been stung")
end 

Returns the number of bee stingers sticking out of this entity

overload 1:
                        
player:getStingerCount()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

Method Property	Fluent Description	Representation
Return Value	an Integer	`Integer`

PlayerAPI.getName

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getName() == "JimmyHelp" then
  log("You're... me?")
end 

Gets the name of this entity, if it has a custom name
If it doesn't, returns a translated form of getType()

overload 1:
                        
player:getName()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

PlayerAPI.isAlive

Inherited from LivingEntityAPI

Returns whether this entity is alive or not

overload 1:
                        
player:isAlive()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

PlayerAPI.getType

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getType() == "minecraft:player" then
  log("You're a player")
end 

Gets the Minecraft identifier of this entity
For instance, "minecraft:pig"

overload 1:
                        
player:getType()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

PlayerAPI.isLoaded

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isLoaded() then
  log("You're being loaded")
end 

Checks if this entity object is still being updated and loaded
A non-loaded entity would be someone or something which is in another dimension or out of the render distance for example

overload 1:
                        
player:isLoaded()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

PlayerAPI.getItem

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getItem(5).id == "minecraft:elytra" then
  log("You're wearing an elytra")
end 

Gets an ItemStack for the item in the given slot
For the player, slots are indexed with 1 as the main hand, 2 as the off hand, and 3,4,5,6 as the 4 armor slots from the boots to the helmet
If an invalid slot number is given, this will return nil

overload 1:
                        
player:getItem(index)  
 Method Property Fluent Description Representation
index accepts an Integer Integer 
   
Return Value an ItemStack ItemStack

Method Property	Fluent Description	Representation
index accepts	an Integer	`Integer`
Return Value	an ItemStack	`ItemStack`

PlayerAPI.getControlledVehicle

Inherited from LivingEntityAPI

Return the vehicle that this entity is controlling

overload 1:
                        
player:getControlledVehicle()  
 Method Property Fluent Description Representation
Return Value an EntityAPI EntityAPI

Method Property	Fluent Description	Representation
Return Value	an EntityAPI	`EntityAPI`

PlayerAPI.getControllingPassenger

Inherited from LivingEntityAPI

Returns the entity that is controlling this entity

overload 1:
                        
player:getControllingPassenger()  
 Method Property Fluent Description Representation
Return Value an EntityAPI EntityAPI

PlayerAPI.getPos

Inherited from LivingEntityAPI

Example by JimmyHelp:
models:setPos(player:getPos()) 

Gets the position of the entity in the world
If delta is passed in, then it will be used to linearly interpolate the position of the entity between the previous tick and the current tick
The default value of delta is 1

overload 1:
                        
player:getPos()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3 
   
overload 2:
                        
player:getPos(delta)  
 Method Property Fluent Description Representation
delta accepts a Number Number 
   
Return Value a Vector3 Vector3

PlayerAPI.getRot

Inherited from LivingEntityAPI

Example by JimmyHelp:
models:setRot(player:getRot()) 

Gets the rotation of the entity in degrees
If delta is passed in, then it will be used to linearly interpolate the rotation of the entity between the previous tick and the current tick
The default value of delta is 1

overload 1:
                        
player:getRot()  
 Method Property Fluent Description Representation
Return Value a Vector2 Vector2 
   
overload 2:
                        
player:getRot(delta)  
 Method Property Fluent Description Representation
delta accepts a Number Number 
   
Return Value a Vector2 Vector2

PlayerAPI.getVehicle

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getVehicle() and player:getVehicle():getType() == "minecraft:pig" then
  log("You're riding a pig")
end 

Returns a proxy for the entity that this player is currently riding
If the player isn't riding anything, returns nil

overload 1:
                        
player:getVehicle()  
 Method Property Fluent Description Representation
Return Value an EntityAPI EntityAPI

PlayerAPI.isWet

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isWet() then
  log("You're touching water")
end 

Returns true in any of three conditions: if the entity is in water, if the entity is in rain, or if the entity is in a bubble column
Otherwise, returns false

overload 1:
                        
player:isWet()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.getFrozenTicks

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getFrozenTicks() == 140 then
  log("You're being frozen solid")
end 

Gets the number of ticks this entity has been freezing in powder snow for

overload 1:
                        
player:getFrozenTicks()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

PlayerAPI.getLookDir

Inherited from LivingEntityAPI

Example by JimmyHelp:
models:setRot(player:getLookDir()) 

Returns a unit vector pointing in the direction that this entity is looking
See the blue line in the F3+B screen for an example

overload 1:
                        
player:getLookDir()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

PlayerAPI.getPose

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getPose() == "CROUCHING" then
  log("You're crouching")
end 

Returns the current pose of the player
This can be one of: "STANDING", "FALL_FLYING", "SLEEPING", "SWIMMING", "SPIN_ATTACK", "CROUCHING", "LONG_JUMPING", or "DYING"

overload 1:
                        
player:getPose()  
 Method Property Fluent Description Representation
Return Value a String String

PlayerAPI.getEyeHeight

Inherited from LivingEntityAPI

Example by JimmyHelp:
models:setPos(0,player:getEyeHeight()) 

Returns the current eye height of this entity

overload 1:
                        
player:getEyeHeight()  
 Method Property Fluent Description Representation
Return Value a Number Number

PlayerAPI.isInRain

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isInRain() then
  log("You're in rain")
end 

Returns true if this entity is currently standing in rain

overload 1:
                        
player:isInRain()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.getMaxAir

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getMaxAir() == 300 then
  log("You've got healthy lungs")
end 

Gets the maximum amount of air this entity can have

overload 1:
                        
player:getMaxAir()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

PlayerAPI.getUUID

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getUUID() == "5003b2ce-7a8d-4c56-8b91-ec705985fe08" then
  log("You're... me?")
end 

Gets the UUID of the proxied entity

overload 1:
                        
player:getUUID()  
 Method Property Fluent Description Representation
Return Value a String String

PlayerAPI.hasAvatar

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:hasAvatar() then
  log("You have an avatar")
end 

Returns true if Figura has an avatar loaded for this entity

overload 1:
                        
player:hasAvatar()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.isInLava

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isInLava() then
  log("You're in lava")
end 

Returns true if this entity is currently in lava

overload 1:
                        
player:isInLava()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.isInWater

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isInWater() then
  log("You're in water")
end 

Returns true if this entity is currently in a water block, including waterlogging

overload 1:
                        
player:isInWater()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.isOnGround

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isOnGround() then
  log("You're on the ground")
end 

Returns whether or not this entity is currently on the ground

overload 1:
                        
player:isOnGround()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.getVelocity

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getVelocity():length() > 0 then
  log("You're moving in any direction")
end 

Gets the current velocity of this entity in world coordinates, calculated as its position this tick minus its position last tick

overload 1:
                        
player:getVelocity()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

PlayerAPI.getDimensionName

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getDimensionName() == "minecraft:overworld" then
  log("You're in the Overworld")
end 

Gets the Minecraft identifier of the dimension this entity is in

overload 1:
                        
player:getDimensionName()  
 Method Property Fluent Description Representation
Return Value a String String

PlayerAPI.getBoundingBox

Inherited from LivingEntityAPI

Example by JimmyHelp:
log(player:getBoundingBox()) 

Returns the size of this entity's bounding box as a Vector3
{x, y, z} are the width, height, and width
Minecraft entity hitboxes always have square bases

overload 1:
                        
player:getBoundingBox()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

PlayerAPI.isUnderwater

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isUnderwater() then
  log("You're underwater")
end 

Returns true if this entity's eyes are touching water

overload 1:
                        
player:isUnderwater()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.isSprinting

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isSprinting() then
  log("You're sprinting")
end 

Returns true if this entity is currently sprinting

overload 1:
                        
player:isSprinting()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.hasInventory

Inherited from LivingEntityAPI

Checks if the entity has an inventory (Horses, Camels, LLamas, …)

overload 1:
                        
player:hasInventory()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.isInvisible

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isInvisible() then
  log("You're invisible")
end 

Returns true if this entity is invisible, for one reason or another

overload 1:
                        
player:isInvisible()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.getEyeY

Inherited from LivingEntityAPI

Example by JimmyHelp:
models:setPos(0,player:getEyeY()) 

Returns the Y level of this entity's eyes
Not to be confused with getEyeHeight, this function also takes the entity itself's Y position into account

overload 1:
                        
player:getEyeY()  
 Method Property Fluent Description Representation
Return Value a Number Number

PlayerAPI.isMoving

Inherited from LivingEntityAPI

Returns true if this entity has some velocity
Takes a boolean parameter, where if true, the y velocity is ignored

overload 1:
                        
player:isMoving()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean 
   
overload 2:
                        
player:isMoving(ignoreY)  
 Method Property Fluent Description Representation
ignoreY accepts a Boolean Boolean 
   
Return Value a Boolean Boolean

PlayerAPI.isCrouching

Inherited from LivingEntityAPI

Returns true if this entity is visually sneaking

overload 1:
                        
player:isCrouching()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.isSilent

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isSilent() then
  log("You're silent")
end 

Returns true if this entity is silent

overload 1:
                        
player:isSilent()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.isSneaking

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isSneaking() then
  log("You're sneaking")
end 

Returns true if this entity is logically sneaking (can't fall from blocks edges, can't see nameplate behind walls, etc)

overload 1:
                        
player:isSneaking()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.isOnFire

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isOnFire() then
  log("You're on fire")
end 

Returns true if this entity is currently on fire

overload 1:
                        
player:isOnFire()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.hasContainer

Inherited from LivingEntityAPI

Checks if the entity has a container (Chest Boats, Minecarts with Chests, …)

overload 1:
                        
player:hasContainer()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.isGlowing

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:isGlowing() then
  log("You're glowing")
end 

Returns true if this entity is currently glowing

overload 1:
                        
player:isGlowing()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.isFalling

Inherited from LivingEntityAPI

Returns true if this entity has negative Y-velocity and is not on the ground

overload 1:
                        
player:isFalling()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.getPassengers

Inherited from LivingEntityAPI

Returns a List of entities of all passengers this entity has

overload 1:
                        
player:getPassengers()  
 Method Property Fluent Description Representation
Return Value a table Table

PlayerAPI.getNearestEntity

Inherited from LivingEntityAPI

Returns the closest entity to this entity
If `type` is an entity id, (e.g. `minecraft:bee`), only entities of that type will be considered
Radius defaults to 20, and controls the size of the area for checking entities as a box expanding in every direction from the player

overload 1:
                        
player:getNearestEntity(type, radius)  
 Method Property Fluent Description Representation
type accepts a String String 
   
radius accepts a Number Number 
   
Return Value an EntityAPI EntityAPI 
   
overload 2:
                        
player:getNearestEntity(type)  
 Method Property Fluent Description Representation
type accepts a String String 
   
Return Value an EntityAPI EntityAPI 
   
overload 3:
                        
player:getNearestEntity()  
 Method Property Fluent Description Representation
Return Value an EntityAPI EntityAPI

PlayerAPI.isLiving

Inherited from LivingEntityAPI

Gets if this entity is a Living Entity

overload 1:
                        
player:isLiving()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.getVariable

Inherited from LivingEntityAPI

Gets the value of a variable this entity stored in themselves using the Avatar API's store() function

overload 1:
                        
player:getVariable()  
 Method Property Fluent Description Representation
Return Value anything AnyType 
   
overload 2:
                        
player:getVariable(key)  
 Method Property Fluent Description Representation
key accepts a String String 
   
Return Value anything AnyType

PlayerAPI.getTargetedEntity

Inherited from LivingEntityAPI

Returns a proxy for your currently targeted Entity
This Entity appears on the F3 screen
Maximum and Default distance is 20, Minimum is 0

overload 1:
                        
player:getTargetedEntity()  
 Method Property Fluent Description Representation
Return Value a Varargs Varargs 
   
overload 2:
                        
player:getTargetedEntity(distance)  
 Method Property Fluent Description Representation
distance accepts a Number Number 
   
Return Value a Varargs Varargs

PlayerAPI.isPlayer

Inherited from LivingEntityAPI

Gets if this entity is a Player Entity

overload 1:
                        
player:isPlayer()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

PlayerAPI.getTargetedBlock

Inherited from LivingEntityAPI

Example by JimmyHelp:
if player:getTargetedBlock(true,4.5).id == "minecraft:grass_block" then
  log("You're looking at grass")
end 

Returns a proxy for your currently targeted BlockState
This BlockState appears on the F3 screen
The maximum (and default) distance is 20, minimum is -20
Returns the block, the hit position, and the targeted block face as three separate values

overload 1:
                        
player:getTargetedBlock()  
 Method Property Fluent Description Representation
Return Value a Varargs Varargs 
   
overload 2:
                        
player:getTargetedBlock(ignoreLiquids)  
 Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean Boolean 
   
Return Value a Varargs Varargs 
   
overload 3:
                        
player:getTargetedBlock(ignoreLiquids, distance)  
 Method Property Fluent Description Representation
ignoreLiquids accepts a Boolean Boolean 
   
distance accepts a Number Number 
   
Return Value a Varargs Varargs

PlayerAPI.getPermissionLevel

Inherited from LivingEntityAPI

Returns the permission level number of this entity
Server Operators, by default, have the permission level of 4

overload 1:
                        
player:getPermissionLevel()  
 Method Property Fluent Description Representation
Return Value an Integer Integer

PlayerAPI.getNbt

Inherited from LivingEntityAPI

Gets a table containing the NBT of this entity
Please note that not all values in the entity's NBT may be synced, as some are handled only on the server side

overload 1:
                        
player:getNbt()  
 Method Property Fluent Description Representation
Return Value a table Table

Method Property	Fluent Description	Representation
ignoreY accepts	a Boolean	`Boolean`
Return Value	a Boolean	`Boolean`

Method Property	Fluent Description	Representation
type accepts	a String	`String`
radius accepts	a Number	`Number`
Return Value	an EntityAPI	`EntityAPI`

Method Property	Fluent Description	Representation
distance accepts	a Number	`Number`
Return Value	a Varargs	`Varargs`

Method Property	Fluent Description	Representation
ignoreLiquids accepts	a Boolean	`Boolean`
Return Value	a Varargs	`Varargs`

Global Objects

Miscellaneous Types

Miscelanous

action_wheel

animations

nameplate

world

vanilla_model

models

player

events

keybinds

vectors

matrices

particles

sounds

pings

textures

data

json

net

Miscellaneous Enums

player

PlayerAPI.getGamemode

PlayerAPI.getTeamInfo

PlayerAPI.getShoulderEntity

PlayerAPI.hasSkin

PlayerAPI.getModelType

PlayerAPI.isFishing

PlayerAPI.isSkinLayerVisible

PlayerAPI.hasCape

PlayerAPI.getCooldownPercent

PlayerAPI.getExperienceLevel

PlayerAPI.getChargedAttackDelay

PlayerAPI.getExperienceProgress

PlayerAPI.getFood

PlayerAPI.getExhaustion

PlayerAPI.getSaturation

PlayerAPI.isBlocking

PlayerAPI.getSwingDuration

PlayerAPI.getAbsorptionAmount

PlayerAPI.isVisuallySwimming

PlayerAPI.isSensitiveToWater

PlayerAPI.riptideSpinning

PlayerAPI.getSwingArm

PlayerAPI.isGliding

PlayerAPI.getEntityCategory

PlayerAPI.getSwingTime

PlayerAPI.isSwingingArm

PlayerAPI.getArmor

PlayerAPI.getActiveHand

PlayerAPI.isClimbing

PlayerAPI.isUsingItem

PlayerAPI.isLeftHanded

PlayerAPI.getBodyYaw

PlayerAPI.getHeldItem

PlayerAPI.getDeathTime

PlayerAPI.getHealth

PlayerAPI.getMaxHealth

PlayerAPI.getActiveItem

PlayerAPI.getArrowCount

PlayerAPI.getActiveItemTime

PlayerAPI.getStingerCount

PlayerAPI.getName

PlayerAPI.isAlive

PlayerAPI.getType

PlayerAPI.isLoaded

PlayerAPI.getItem

PlayerAPI.getControlledVehicle

PlayerAPI.getControllingPassenger

PlayerAPI.getPos

PlayerAPI.getRot

PlayerAPI.getVehicle

PlayerAPI.isWet

PlayerAPI.getFrozenTicks

PlayerAPI.getLookDir

PlayerAPI.getPose

PlayerAPI.getEyeHeight

PlayerAPI.isInRain

PlayerAPI.getMaxAir