Entity

Acts as a proxy for an entity in the Minecraft world

warning

This page is a WIP. It contains all the information in Figura's documentation but we're working on adding more helpful descriptions.

For this page assume:

local thisEntity = thisEntity:getTargetedEntity()

Entity 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

Overload 1
Overload 2

getPos()

Returns:

Type	Description
`Vector3`	-

getPos(delta)

Parameters:

Name	Type	Description	Default
delta	`Number`	-	-

Returns:

Type	Description
`Vector3`	-

Example:

thisEntity:getPos()

`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
Overload 2

getRot()

Returns:

Type	Description
`Vector2`	-

getRot(delta)

Parameters:

Name	Type	Description	Default
delta	`Number`	-	-

Returns:

Type	Description
`Vector2`	-

Example:

thisEntity:getRot()

`getVelocity()`

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

getVelocity()

Returns:

Type	Description
`Vector3`	-

Example:

thisEntity:getVelocity()

`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

getLookDir()

Returns:

Type	Description
`Vector3`	-

Example:

thisEntity:getLookDir()

Entity Actions

`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

getBoundingBox()

Returns:

Type	Description
`Vector3`	-

Example:

thisEntity:getBoundingBox()

`getControlledVehicle()`

Return the vehicle that this entity is controlling

getControlledVehicle()

Returns:

Type	Description
`EntityAPI`	Returns self for chaining

Example:

thisEntity:getControlledVehicle()

`getControllingPassenger()`

Returns the entity that is controlling this entity

getControllingPassenger()

Returns:

Type	Description
`EntityAPI`	Returns self for chaining

Example:

thisEntity:getControllingPassenger()

`getDimensionName()`

Gets the Minecraft identifier of the dimension this entity is in

getDimensionName()

Returns:

Type	Description
`String`	-

Example:

thisEntity:getDimensionName()

`getEyeHeight()`

Returns the current eye height of this entity

getEyeHeight()

Returns:

Type	Description
`Number`	-

Example:

thisEntity:getEyeHeight()

`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

getEyeY()

Returns:

Type	Description
`Number`	-

Example:

thisEntity:getEyeY()

`getFrozenTicks()`

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

getFrozenTicks()

Returns:

Type	Description
`Integer`	-

Example:

thisEntity:getFrozenTicks()

`getMaxAir()`

Gets the maximum amount of air this entity can have

getMaxAir()

Returns:

Type	Description
`Integer`	-

Example:

thisEntity:getMaxAir()

`getName()`

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

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

getName()

Returns:

Type	Description
`String`	-

Example:

thisEntity:getName()

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

getNbt()

Returns:

Type	Description
`Table`	-

Example:

thisEntity:getNbt()

`getPassengers()`

Returns a List of entities of all passengers this entity has

getPassengers()

Returns:

Type	Description
`Table`	-

Example:

thisEntity:getPassengers()

`getPermissionLevel()`

Returns the permission level number of this entity

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

getPermissionLevel()

Returns:

Type	Description
`Integer`	-

Example:

thisEntity:getPermissionLevel()

`getPose()`

Returns the current pose of the player

This can be one of: "STANDING", "FALL_FLYING", "SLEEPING", "SWIMMING", "SPIN_ATTACK", "CROUCHING", "LONG_JUMPING", or "DYING"

getPose()

Returns:

Type	Description
`String`	-

Example:

thisEntity:getPose() == "CROUCHING"

`getTargetedBlock()`

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
Overload 2
Overload 3

getTargetedBlock()

Returns:

Type	Description
`BlockState`	Targeted block
`Vector3`	Hit position
`String`	Targeted block face

getTargetedBlock(ignoreLiquids)

Parameters:

Name	Type	Description	Default
ignoreLiquids	`Boolean`	-	-

Returns:

Type	Description
`BlockState`	Targeted block
`Vector3`	Hit position
`String`	Targeted block face

getTargetedBlock(ignoreLiquids, distance)

Parameters:

Name	Type	Description	Default
ignoreLiquids	`Boolean`	-	-
distance	`Number`	-	-

Returns:

Type	Description
`BlockState`	Targeted block
`Vector3`	Hit position
`String`	Targeted block face

Example:

local block, hitPos, side = thisEntity:getTargetedBlock(true, 4.5)
if block.id == "minecraft:grass_block" then
    log("You're looking at grass")
end

`getTargetedEntity()`

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
Overload 2

getTargetedEntity()

Returns:

Type	Description
`Entity`	Targeted entity
`Vector3`	Hit position

getTargetedEntity(distance)

Parameters:

Name	Type	Description	Default
distance	`Number`	-	-

Returns:

Type	Description
`Entity`	Targeted entity
`Vector3`	Hit position

Example:

local entity, hitPos = thisEntity:getTargetedEntity()

`getType()`

Gets the Minecraft identifier of this entity

For instance, "minecraft:pig"

getType()

Returns:

Type	Description
`String`	-

Example:

thisEntity:getType()

`getVehicle()`

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

If the player isn't riding anything, returns nil

getVehicle()

Returns:

Type	Description
`EntityAPI`	Returns self for chaining

Example:

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

`hasContainer()`

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

hasContainer()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:hasContainer()

`hasInventory()`

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

hasInventory()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:hasInventory()

`isAlive()`

Returns whether this entity is alive or not

isAlive()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isAlive()

`isCrouching()`

Returns true if this entity is visually sneaking

isCrouching()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isCrouching()

`isGlowing()`

Returns true if this entity is currently glowing

isGlowing()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isGlowing()

`isInLava()`

Returns true if this entity is currently in lava

isInLava()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isInLava()

`isInRain()`

Returns true if this entity is currently standing in rain

isInRain()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isInRain()

`isInWater()`

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

isInWater()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isInWater()

`isInvisible()`

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

isInvisible()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isInvisible()

`isLiving()`

Gets if this entity is a Living Entity

isLiving()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isLiving()

`isLoaded()`

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

isLoaded()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isLoaded()

`isOnFire()`

Returns true if this entity is currently on fire

isOnFire()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isOnFire()

`isOnGround()`

caution

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.

Work Around:

-- check the blockstate of the block directly underneath the entity
world.getBlockState(thisEntity:getPos():add(0, -0.1, 0)):isSolidBlock()

Returns whether or not this entity is currently on the ground

isOnGround()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isOnGround()

`isPlayer()`

Gets if this entity is a Player Entity

isPlayer()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isPlayer()

`isSilent()`

Returns true if this entity is silent

isSilent()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isSilent()

`isSneaking()`

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

isSneaking()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isSneaking()

`isSprinting()`

Returns true if this entity is currently sprinting

isSprinting()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isSprinting()

`isUnderwater()`

Returns true if this entity's eyes are touching water

isUnderwater()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isUnderwater()

`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

isWet()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:isWet()

Item Functions

`getItem()`

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

getItem(index)

Parameters:

Name	Type	Description	Default
index	`Integer`	-	-

Returns:

Type	Description
`ItemStack`	-

Example:

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

Miscellaneous

`getUUID()`

Gets the UUID of the proxied entity

getUUID()

Returns:

Type	Description
`String`	-

Example:

thisEntity:getUUID()

`getVariable()`

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

Overload 1
Overload 2

getVariable()

Returns:

Type	Description
`AnyType`	-

getVariable(key)

Parameters:

Name	Type	Description	Default
key	`String`	-	-

Returns:

Type	Description
`AnyType`	-

Example:

thisEntity:getVariable()

`hasAvatar()`

Returns true if Figura has an avatar loaded for this entity

hasAvatar()

Returns:

Type	Description
`Boolean`	-

Example:

thisEntity:hasAvatar()

Entity Transformations​

getPos()​

getRot()​

getVelocity()​

getLookDir()​

Entity Actions​

getBoundingBox()​

getControlledVehicle()​

getControllingPassenger()​

getDimensionName()​

getEyeHeight()​

getEyeY()​

getFrozenTicks()​

getMaxAir()​

getName()​

getNbt()​

getPassengers()​

getPermissionLevel()​

getPose()​

getTargetedBlock()​

getTargetedEntity()​

getType()​

getVehicle()​

hasContainer()​

hasInventory()​

isAlive()​

isCrouching()​

isGlowing()​

isInLava()​

isInRain()​

isInWater()​

isInvisible()​

isLiving()​

isLoaded()​

isOnFire()​

isOnGround()​

isPlayer()​

isSilent()​

isSneaking()​

isSprinting()​

isUnderwater()​

isWet()​

Item Functions​

getItem()​

Miscellaneous​

getUUID()​

getVariable()​

hasAvatar()​

Entity Transformations

`getPos()`

`getRot()`

`getVelocity()`

`getLookDir()`

Entity Actions

`getBoundingBox()`

`getControlledVehicle()`

`getControllingPassenger()`

`getDimensionName()`

`getEyeHeight()`

`getEyeY()`

`getFrozenTicks()`

`getMaxAir()`

`getName()`

`getNbt()`

`getPassengers()`

`getPermissionLevel()`

`getPose()`

`getTargetedBlock()`

`getTargetedEntity()`

`getType()`

`getVehicle()`

`hasContainer()`

`hasInventory()`

`isAlive()`

`isCrouching()`

`isGlowing()`

`isInLava()`

`isInRain()`

`isInWater()`

`isInvisible()`

`isLiving()`

`isLoaded()`

`isOnFire()`

`isOnGround()`

`isPlayer()`

`isSilent()`

`isSneaking()`

`isSprinting()`

`isUnderwater()`

`isWet()`

Item Functions

`getItem()`

Miscellaneous

`getUUID()`

`getVariable()`

`hasAvatar()`