Returns the sum of direct child entities taking item stack counts into account.

Provides access to the entity definition metadata (ID, display name, index).

Returns true if the entity child collection is non-empty.

Entities in unloaded chunks or purely stored in inventories may not have an active visual scene node.

Returns true if the entity is stored inside an inventory, container, or attached to another entity.

Every spawned entity has a unique positive integer ID throughout the session.

Returns the node wrapper for the root scene node of this entity if instantiated.

Returns true if the underlying C# entity is active and has not been destroyed.

Gets or sets the entity 3D world coordinates.

Gets or sets rotation as Euler angles in degrees. Applying rotation updates the underlying Godot scene node.

Gets or sets the local 3D scale.

Applies a status effect (e.g. poison, burning, wet) to the entity.

entity.addState(playerEntity, "poison", 10, 30)

Counts entities within an axis-aligned bounding box.

Counts entities within distance radius of position.

Applies direct damage to the target entity, invoking damage hooks and triggering destruction if health reaches 0.

Returns true if the specified entity ID or object exists and is active.

Searches the entity scene tree for a child node with the specified name.

Retrieves a live entity by its integer ID.

local e = entity.get(42)
if e and e.isValid then
    print("Found entity with definition: " .. e.def.id)
end

Computes the Axis-Aligned Bounding Box enclosing all visible meshes on the entity.

Calculates the bounding box restricted only to surfaces that render with material.

Calculates the bounding box restricted only to surfaces that use textureName.

Returns all animation players on the entity.

Reads the float attribute value stored on the entity.

Reads the integer attribute value stored on the entity.

Reads the string attribute value stored on the entity.

Returns all 3D audio players attached to the entity.

Returns the child entity at the specified index.

Returns the number of child entities attached to val.

Searches children of parent for an entity with definition def.

Returns a table containing all child entities stored in or attached to this entity.

Returns collision nodes associated with the entity.

Calculates the effective attribute value factoring in base definitions, instance overrides, and active status buffs/debuffs.

Returns a table of all entities inside the specified axis-aligned bounding box.

Returns a table of all entities within radius of position.

local items = entity.getInRadius(player.position, 5.0)

Returns the node wrapper for the visual 3D scene instance of the entity.

Returns all light sources attached to the entity.

Shortcut for entity:getAabb(false).

Returns the names of all materials attached to mesh surfaces.

Inspects all mesh surfaces and returns the unique material definitions.

Returns all 3D mesh instances that compose this entity.

Searches the entity visual hierarchy for nodes matching the specified class type.

Returns the parent entity containing or holding this entity.

Returns GPUParticles3D and CPUParticles3D nodes attached to the entity.

Returns mesh nodes that render with material.

Returns mesh nodes that render with textureName.

Returns the raw attribute value stored on the entity instance.

Returns the raw integer attribute value.

Returns the raw string attribute value.

Looks up the active status effect instance matching stateDef on the entity.

Returns a table containing all currently applied status effects.

Calculates the terrain surface coordinate at the entity X and Z coordinates.

Returns texture file names referenced by mesh materials.

Shortcut for entity:getAabb(true).

Tests whether any mesh surface on the entity uses the specified material.

Returns true if the state is currently applied.

Tests whether any surface uses textureName.

Returns true if the named child node is active in the scene hierarchy.

Deletes the entity from the world and cleans up all scene nodes.

Clears all active status effects on the target entity.

Removes the instance attribute override, resetting behavior to default definitions.

Removes the status effect from the target entity.

Assigns a float attribute value (e.g. custom durability, health).

Assigns an integer attribute value.

Assigns a string attribute value.

Toggles active processing and visibility for the named child node.

Finds a child node by name and sets its active/visible state.

Dynamically changes the definition of an entity instance (e.g. growing a plant from stage 1 to stage 2).

e:setDefinition("apple_tree_grown")

Reparents the entity to parent.

Spawns a new entity of definition def at the given 3D coordinates.

local stone = entity.spawn("stone", vector3.new(0, 10, 0))

Calculates the ground height and slope at position and spawns the entity aligned to the terrain.

Moves item into the inventory of parent.

Unparents the entity, placing it directly into the world root.

Called whenever the child collection or stack sizes of this entity change.

Called when an entity is picked up into an inventory, transferred between containers, or dropped.

Called when the state list of the entity is modified.

Called when picked up by a player or unit.

Called when an entity collides with another entity or surface.

Called when consuming food, medicine, or potions.

Called when damage is about to be inflicted on the entity.

Called when the entity is broken, depleted, or killed.

Called when the HUD reticle points at this entity. Can return custom interaction prompt text.

Called when the entity is hidden or its chunk is unloaded.

Called when the entity is hit. Common hook for harvesting plants, mining rocks, or custom hit reactions.

def.object.banana_plant.onHit = function(sourceId, targetId, weaponId, projectileIndex)
    grow(targetId, 2)
end

Called on in-game hourly changes for plants, spoiled food, or time-dependent objects.

Called when a unit or object hits the ground after falling (e.g. for fall damage or landing sounds).

Called when entering a body of water or other terrain liquid.

Called when stepping or emerging out of liquid.

Declared on projectile entity definitions (e.g. arrows, thrown stones).

Called when the entity is generated during procedural world generation or cluster spawning.

Called when the chunk containing the entity is loaded and the entity is shown.

Invoked immediately after the entity is spawned in the game world.

def.item.flare.onSpawn = function(self)
    print("Flare spawned: " .. self.id)
end

Called immediately after a state is attached to the entity.

Called before removing a state from the entity.

Called every state tick interval (e.g. applying poison damage every second).

Allows an entity to be immune or resist specific status effects.

Invoked every frame for entities that declare onUpdate.

Called when the player presses the interaction key on this entity.

Called when secondary interaction occurs (e.g. right click or alternate use binding).

Called when looting a defeated animal or enemy.