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

层级 (查看层级一览)

属性

currentValue defaultValue effectiveMax effectiveMin entity isValid typeId

方法

resetToDefaultValue resetToMaxValue resetToMinValue setCurrentValue

属性

只读currentValue

currentValue: number

备注

Current value of this attribute for this instance.

抛出

This property can throw when used.

只读defaultValue

defaultValue: number

备注

Returns the default defined value for this attribute.

抛出

This property can throw when used.

只读effectiveMax

effectiveMax: number

备注

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

抛出

This property can throw when used.

只读effectiveMin

effectiveMin: number

备注

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

抛出

This property can throw when used.

只读entity

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

只读 betaisValid

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

typeId: string

备注

Identifier of the component.

方法

resetToDefaultValue

  • resetToDefaultValue(): void
    世界修改

    返回 void

    备注

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

    抛出

    This function can throw errors.

resetToMaxValue

  • resetToMaxValue(): void
    世界修改

    返回 void

    备注

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

    抛出

    This function can throw errors.

resetToMinValue

  • resetToMinValue(): void
    世界修改

    返回 void

    备注

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

    抛出

    This function can throw errors.

setCurrentValue

  • setCurrentValue(value: number): boolean
    世界修改

    参数

    • value: number

    返回 boolean

    备注

    Sets the current value of this attribute. The provided value will be clamped to the range of this attribute.

    抛出

    This function can throw errors.

显示设置

成员可见性

目录

属性
方法