Class EntityBreathableComponent

Defines what blocks this entity can breathe in and gives them the ability to suffocate.

Example: pigBreathable.js

import { world } from "@minecraft/server";

const pig = world
    .getDimension("overworld")
    .getEntities({ type: "minecraft:pig" })[0];
const breathable = pig.getComponent("breathable");
if (breathable) {
    breathable.breathesAir;
    breathable.breathesLava;
    breathable.breathesSolids;
    breathable.breathesWater;
    breathable.generatesBubbles;
    breathable.inhaleTime;
    breathable.suffocateTime;
    breathable.totalSupply;
    breathable.getBreatheBlocks();
    breathable.getNonBreatheBlocks();
    breathable.airSupply = 100; // Assuming 100 as an example value
}

Hierarchy (View Summary)

Constructors

constructor

Properties

airSupply breathesAir breathesLava breathesSolids breathesWater canBreathe entity generatesBubbles inhaleTime isValid suffocateTime totalSupply typeId componentId

Methods

getBreatheBlocks getNonBreatheBlocks

Constructors

Privateconstructor

Properties

BetaairSupply

airSupply: number

Remarks

The current air supply of the entity.

This property can't be edited in read-only mode.

Throws

Will throw an error if the air supply is out of bounds [suffocationTime, maxAirSupply].

ReadonlybreathesAir

breathesAir: boolean

Remarks

If true, this entity can breathe in air.

Throws

This property can throw when used.

ReadonlybreathesLava

breathesLava: boolean

Remarks

If true, this entity can breathe in lava.

Throws

This property can throw when used.

ReadonlybreathesSolids

breathesSolids: boolean

Remarks

If true, this entity can breathe in solid blocks.

Throws

This property can throw when used.

ReadonlybreathesWater

breathesWater: boolean

Remarks

If true, this entity can breathe in water.

Throws

This property can throw when used.

Readonly BetacanBreathe

canBreathe: boolean

Remarks

If true, the entity is able to breathe.

Throws

This property can throw when used.

Readonlyentity

entity: Entity

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

ReadonlygeneratesBubbles

generatesBubbles: boolean

Remarks

If true, this entity will have visible bubbles while in water.

Throws

This property can throw when used.

ReadonlyinhaleTime

inhaleTime: number

Remarks

Time in seconds to recover breath to maximum.

Throws

This property can throw when used.

Readonly BetaisValid

isValid: boolean

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.

ReadonlysuffocateTime

suffocateTime: number

Remarks

Time in seconds between suffocation damage.

Throws

This property can throw when used.

ReadonlytotalSupply

totalSupply: number

Remarks

Time in seconds the entity can hold its breath.

Throws

This property can throw when used.

ReadonlytypeId

typeId: string

Remarks

Identifier of the component.

Static ReadonlycomponentId

componentId: "minecraft:breathable" = 'minecraft:breathable'

Methods

getBreatheBlocks

  • getBreatheBlocks(): BlockPermutation[]

    Returns BlockPermutation[]

    Remarks

    List of blocks this entity can breathe in, in addition to the separate properties for classes of blocks.

    Throws

    This function can throw errors.

getNonBreatheBlocks

Settings

Member Visibility

On This Page

Constructors
Properties
Methods