Script API - v1.20.30
    Preparing search index...

    Class EntityHealthComponent

    Defines the health properties of an entity.

    const getEntityHealthComponent = entity.getComponent("health");
    getEntityHealthComponent.currentValue;
    getEntityHealthComponent.defaultValue;
    getEntityHealthComponent.effectiveMax;
    getEntityHealthComponent.effectiveMin;
    getEntityHealthComponent.resetToDefaultValue();
    getEntityHealthComponent.resetToMaxValue();
    getEntityHealthComponent.resetToMinValue();
    getEntityHealthComponent.setCurrentValue(100); // Assuming 100 as an example value

    // Custom function to check if the health attribute is within a valid range
    function isValidHealthValue(value) {
        return (
            value >= getEntityHealthComponent.effectiveMin &&
            value <= getEntityHealthComponent.effectiveMax
        );
    }

    // Example usage of the custom isValidHealthValue function
    const newHealthValue = 80;
    if (isValidHealthValue(newHealthValue)) {
        getEntityHealthComponent.setCurrentValue(newHealthValue);
    }

    Hierarchy (View Summary)

    Index

    Properties

    currentValue defaultValue effectiveMax effectiveMin typeId componentId

    Methods

    isValid resetToDefaultValue resetToMaxValue resetToMinValue setCurrentValue

    Properties

    currentValue: number

    Current value of this attribute for this instance.

    This property can throw when used.

    defaultValue: number

    Returns the default defined value for this attribute.

    This property can throw when used.

    effectiveMax: number

    Returns the effective max of this attribute given any other ambient components or factors.

    This property can throw when used.

    effectiveMin: number

    Returns the effective min of this attribute given any other ambient components or factors.

    This property can throw when used.

    typeId: string

    Identifier of the component.

    componentId: "minecraft:health" = 'minecraft:health'

    Methods

    • Returns boolean

      Whether the component is valid.

      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.

    • Returns void

      Resets the current value of this attribute to the defined default value.

      This function can't be called in read-only mode.

      This function can throw errors.

    • Returns void

      Resets the current value of this attribute to the maximum defined value.

      This function can't be called in read-only mode.

      This function can throw errors.

    • Returns void

      Resets the current value of this attribute to the minimum defined value.

      This function can't be called in read-only mode.

      This function can throw errors.

    • Parameters

      • value: number

      Returns boolean

      Sets the current value of this attribute.

      This function can't be called in read-only mode.

      This function can throw errors.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods