The player API is accessed through the player global. Like so: player:isGliding()

Player information that isn't synced between clients is kept in the host API. Examples of unsynced data are: Creative flying, status effects, and remaining air amount.

Note: There are times during a script's functioning where the script will run, but the player global will be empty. This will cause the "Tried to access the EntityAPI before its initialization" error. To solve this, move the player API call into a protected event. If you wish to initialize a check during the initialization phase of a script (outside of any other event) you can use the entity_init event.

For most other circumstances you will want the tick event, as checks like player:isGliding() will be updated once a game tick inside that event. (There are 20 ticks in a second, and this is how often Minecraft updates information- some player functions work better in a tick event for this reason).

All provided examples assume you're using a tick event.

To reiterate:

player:isGliding() -- will error

function events.entity_init()
    player:isGliding() -- will not error, but will only play once
end

player:isGliding() -- will error

function events.tick()
    player:isGliding() -- won't error, and will update once a tick
end

player:isGliding() -- will error

Player Transformations

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

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

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

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

getVelocity

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

Player Actions

getPose

Returns the current pose of the player

For players this can be one of: "STANDING", "FALL_FLYING", "SLEEPING", "SWIMMING", "SPIN_ATTACK", or "CROUCHING"

isCrouching

Returns true if this entity is visually sneaking

isGliding

Returns if this entity is gliding with an elytra

isFishing

Returns if the player is currently fishing

isBlocking

Return if this entity is blocking with a shield

isVisuallySwimming

Returns if this entity have the swimming pose

isClimbing

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

isSneaking

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

isSprinting

Returns true if this entity is currently sprinting

riptideSpinning

Returns if this entity is riptide spinning

Player Data

isLoaded

Checks if this entity object is still being updated and loaded

A non loaded entity would be someone who is in another dimension or out of the render distance for example

getNbt

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 server side

getChargedAttackDelay

Returns the delay (in ticks) of charged attacks

getExperienceProgress

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

getExperienceLevel

Gets the player's current level

getShoulderEntity

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

getTeamInfo

Returns a table with information about the team of this player

Returns nil if the player doesnt have a team

getFood

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

getGamemode

Returns "SURVIVAL", "CREATIVE", "ADVENTURE", or "SPECTATOR" depending on the player's gamemode

If the gamemode is unknown, returns nil

getSaturation

Gets the current saturation level of the player

getExhaustion

Gets the current exhaustion level of the player

getAbsorptionAmount

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

getArmor

Returns the amount of armor points this entity has

getMaxHealth

Returns the maximum amount of health this entity can have

getHealth

Returns the amount of health this entity has remaining

getDeathTime

Returns the number of ticks this entity has been dead for

getStingerCount

Returns the number of bee stingers sticking out of this entity

getArrowCount

Returns the number of arrows sticking out of this entity

getEntityCategory

Returns the category of this entity

The categories are: "ARTHROPOD", "UNDEAD", "WATER", "ILLAGER" and by default, "UNDEFINED"

isSensitiveToWater

Returns if this entity takes damage to water

getName

Gets the name of this entity, if it has a custom name

If it doesn't, returns a translated form of getType()

isAlive

Returns whether this entity is alive or not

getType

Gets the Minecraft identifier of this entity

For instance, "minecraft:pig"

getControlledVehicle

Return the vehicle that this entity is controlling

getControllingPassenger

Returns the entity that is controlling this entity

getPassengers

Returns a List of entities of all passengers this entity have

getFrozenTicks

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

getMaxAir

Gets the maximum amount of air this entity can have

getDimensionName

Gets the Minecraft identifier of the dimension this entity is in

isUnderwater

Returns true if this entity's eyes are touching water

isInWater

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

isInRain

Returns true if this entity is currently standing in rain

isWet

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

isInLava

Returns true if this entity is currently in lava

isOnFire

Returns true if this entity is currently on fire

isInvisible

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

getVehicle

Returns a proxy for the entity that this player is currently riding

If the player isn't riding anything, returns nil

Example combined with getType and with a nil check, the first player:getVehicle() is preventing a nil value from being check by getType() after the and:

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

isSilent

Returns true if this entity is silent

isGlowing

Returns true if this entity is currently glowing

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

isOnGround

Returns whether or not this entity is currently on the ground

Note: Due to a glitch in Minecraft's code this function is unreliable, and will misfire in multiple situations such as being underwater, standing on a boat, or standing on a slime block. One workaround is to check the blockstate of the block directly underneath the player like so: world.getBlockState(player:getPos():add(0,-0.1,0)):isSolidBlock()

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

getEyeHeight

Returns the current eye height of this entity

getTargetedEntity(number)

Returns a proxy for your currently targeted Entity

This Entity appears on the F3 screen

The number is for distance in blocks to check

Maximum and Default distance is 20, Minimum is 0

Example with a nil check:

if player:getTargetedEntity(4.5) and player:getTargetedEntity(4.5):getType() == "minecraft:creeper" then
    log("You're looking at a creeper")
end

getTargetedBlock(bool, number)

Returns a proxy for your currently targeted BlockState

This BlockState appears on the F3 screen

The bool is for ignoring liquids and the number is the distance in blocks to check

Maximum and Default distance is 20, Minimum is -20

Returns a vararg of the block, the hit position and the block face the hit collided

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

hasInventory

Checks if the entity has an inventory (Horses, Camels, Llamas, ...)

hasContainer

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

isLiving

Gets if this entity is a Living Entity

isPlayer

Gets if this entity is a Player Entity

getPermissionLevel

Returns the permission level number of this entity

Server Operators, by default, have the permission level of 4

Vanilla Settings

getModelType

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

hasCape

Returns whether the player has a cape loaded

hasSkin

Returns whether the player has a custom skin loaded

isSkinLayerVisible

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

Item Functions

getItem(integer)

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

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

getHeldItem(bool)

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

if player:getHeldItem(false).id ~= "minecraft:air" then
    log("Item in mainhand")
end
if player:getHeldItem(true).id ~= "minecraft:air" then
    log("Item in offhand")
end

isUsingItem

Returns true if the entity is currently using an item

getActiveItem

Returns an ItemStack representing the item the entity is currently using

If they're not using any item, returns air

getActiveItemTime

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

Hand Functions

isLeftHanded

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

isSwingingArm

Returns true if the entity is currently swinging its arm

getSwingDuration

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

getSwingTime

Returns the number of ticks this entity has the arm swinging

getActiveHand

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

getSwingArm

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

Miscellaneous

getIPAddress

Returns this player's IP address

getUUID

Gets the UUID of the proxied entity

hasAvatar

Returns true if Figura has an avatar loaded for this entity

getVariable

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