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

    Class EntityHungerComponent

    Defines the interactions with this entity for hunger. Wraps the minecraft.player.hunger attribute.

    Hierarchy (View Summary)

    Index

    Properties

    isValid typeId currentValue defaultValue effectiveMax effectiveMin entity componentId

    Methods

    resetToDefaultValue resetToMaxValue resetToMinValue setCurrentValue

    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.

    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.

    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

    componentId: "minecraft:player.hunger" = 'minecraft:player.hunger'

    Methods

    • 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.

      If the value is out of bounds, an ArgumentOutOfBounds Error is thrown.

      minecraftcommon.ArgumentOutOfBoundsError

      InvalidEntityError

    Settings

    Member Visibility

    On This Page

    Properties
    Methods