Bedrock API Reference

Appearance

@minecraft/server

@minecraft/server / EntityOnFireComponent

Class: EntityOnFireComponent ​

Defined in: @minecraft/server/index.d.ts:11824

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

Example ​

setOnFire.ts

typescript
import { system, EntityOnFireComponent, EntityComponentTypes, DimensionLocation } from '@minecraft/server';
import { MinecraftEntityTypes } from '@minecraft/vanilla-data';

function setOnFire(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
  const skelly = targetLocation.dimension.spawnEntity(MinecraftEntityTypes.Skeleton, targetLocation);

  skelly.setOnFire(20, true);

  system.runTimeout(() => {
    const onfire = skelly.getComponent(EntityComponentTypes.OnFire) as EntityOnFireComponent;
    log(onfire?.onFireTicksRemaining + ' fire ticks remaining.');

    skelly.extinguishFire(true);
    log('Never mind. Fire extinguished.');
  }, 20);
}

Extends ​

Properties ​

entity ​

readonly entity: Entity

Defined in: @minecraft/server/index.d.ts:9981

Remarks ​

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

Throws ​

This property can throw when used.

InvalidEntityError

Inherited from ​

EntityComponent.entity

isValid ​

readonly isValid: boolean

Defined in: @minecraft/server/index.d.ts:6234

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.

Inherited from ​

EntityComponent.isValid

onFireTicksRemaining ​

readonly onFireTicksRemaining: number

Defined in: @minecraft/server/index.d.ts:11831

Remarks ​

The number of ticks remaining before the fire goes out.

typeId ​

readonly typeId: string

Defined in: @minecraft/server/index.d.ts:6240

Remarks ​

Identifier of the component.

Inherited from ​

EntityComponent.typeId

componentId ​

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

Defined in: @minecraft/server/index.d.ts:11832