When present on an entity, this entity is on fire.

Example

setEntityOnFire.ts

import { world, Entity, EntityComponentTypes, system } from "@minecraft/server";

function setAblaze(entity: Entity) {
entity.setOnFire(20, true);

system.runTimeout(() => {
const onfire = entity.getComponent(EntityComponentTypes.OnFire);
if (onfire) {
world.sendMessage(`${onfire.onFireTicksRemaining} fire ticks remaining, extinguishing the entity.`);
}
// This will extinguish the entity
entity.extinguishFire(true);
}, 30); // Run in 30 ticks or ~1.5 seconds

}

Hierarchy

Constructors

Properties

entity: Entity

Remarks

The entity that owns this component. The entity will be undefined if it has been removed.

onFireTicksRemaining: number

Remarks

The number of ticks remaining before the fire goes out.

typeId: string

Remarks

Identifier of the component.

componentId: "minecraft:onfire" = 'minecraft:onfire'

Methods

  • Returns boolean

    Whether the component is valid.

    Remarks

    Returns whether the component is valid. A component is considered valid if its owner is valid, in addition to any addition to any additional validation required by the component.