类 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

备注

拥有此组件的实体。若该实体已被移除，则为 undefined。

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

抛出

使用时可能会抛出异常。

抛出

This property can throw when used.

InvalidEntityError

只读 实验性isValid

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.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    此函数可能会抛出错误。

    抛出

    This function can throw errors.

resetToMaxValue

  • resetToMaxValue(): void
  • 实验性

    返回 void

    备注

    将该属性的当前值重置为定义的最大值。

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

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    此函数可能会抛出错误。

    抛出

    This function can throw errors.

resetToMinValue

  • resetToMinValue(): void
  • 实验性

    返回 void

    备注

    将该属性的当前值重置为定义的最小值。

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

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    此函数可能会抛出错误。

    抛出

    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.

    无法在只读模式下调用此函数，详见 WorldBeforeEvents。

    抛出

    此函数可能会抛出错误。

    抛出

    This function can throw errors.

显示设置

成员可见性

目录

属性
方法