@ascentbv/ts-common - v1.0.123
    Preparing search index...

    Class EntityBreathableComponent

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Methods

    getBreatheBlocks getNonBreatheBlocks

    Properties

    isValid: boolean

    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.

    typeId: string

    Identifier of the component.

    breathesAir: boolean

    If true, this entity can breathe in air.

    This property can throw when used.

    breathesLava: boolean

    If true, this entity can breathe in lava.

    This property can throw when used.

    breathesSolids: boolean

    If true, this entity can breathe in solid blocks.

    This property can throw when used.

    breathesWater: boolean

    If true, this entity can breathe in water.

    This property can throw when used.

    generatesBubbles: boolean

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

    This property can throw when used.

    inhaleTime: number

    Time in seconds to recover breath to maximum.

    This property can throw when used.

    suffocateTime: number

    Time in seconds between suffocation damage.

    This property can throw when used.

    totalSupply: number

    Time in seconds the entity can hold its breath.

    This property can throw when used.

    componentId: "minecraft:breathable" = 'minecraft:breathable'
    entity: Entity

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

    This property can throw when used.

    InvalidEntityError

    Methods

    • Returns BlockPermutation[]

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

      This function can throw errors.

    • Returns BlockPermutation[]

      List of blocks this entity can't breathe in.

      This function can throw errors.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods