Skip to main content

Class: EntityOnFireComponent

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

Example​

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

}

Extends​

Constructors​

new EntityOnFireComponent()​

private new EntityOnFireComponent(): EntityOnFireComponent

Returns​

EntityOnFireComponent

Overrides​

EntityComponent . constructor

Properties​

entity​

Beta

readonly entity: Entity

Remarks​

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

Inherited from​

EntityComponent . entity

onFireTicksRemaining​

readonly onFireTicksRemaining: number

Remarks​

The number of ticks remaining before the fire goes out.

typeId​

readonly typeId: string

Remarks​

Identifier of the component.

Inherited from​

EntityComponent . typeId

componentId​

static readonly componentId: "minecraft:onfire" = 'minecraft:onfire'

Methods​

isValid()​

isValid(): boolean

Returns​

boolean

Whether the component is valid.

Inherited from​

EntityComponent . isValid

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.