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

    Class EntityAttributeComponent

    This is a base abstract class for any entity component that centers around a number and can have a minimum, maximum, and default defined value.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    currentValue defaultValue effectiveMax effectiveMin entity isValid typeId

    Methods

    resetToDefaultValue resetToMaxValue resetToMinValue setCurrentValue

    Constructors

    Properties

    currentValue: number

    Current value of this attribute for this instance.

    This property can throw when used.

    This property can't be read in early-execution mode.

    defaultValue: number

    Returns the default defined value for this attribute.

    This property can throw when used.

    This property can't be read in early-execution mode.

    effectiveMax: number

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

    This property can throw when used.

    This property can't be read in early-execution mode.

    effectiveMin: number

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

    This property can throw when used.

    This property can't be read in early-execution mode.

    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

    This property can't be read in early-execution mode.

    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.

    This property can't be read in early-execution mode.

    typeId: string

    Identifier of the component.

    This property can't be read in early-execution mode.

    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.

      This function can't be called in early-execution mode.

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

      This function can't be called in early-execution mode.

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

      This function can't be called in early-execution mode.

    • 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

      This function can't be called in early-execution mode.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods