Class VirtualEffect

constructor

• new VirtualEffect(
      id: string,
      updateTick?: number,
      name: TextProvider,
      type?: VirtualEffectType,
  ): VirtualEffect

  Parameters

  • id: string

    状态效果的 ID

  • updateTick: number = 1

    设置状态效果更新的间隔，推荐设置的大一些以避免游戏卡顿

  • name: TextProvider

    状态效果的名称

  • Optionaltype: VirtualEffectType

    状态效果的类型（正面、负面、中性）

  Returns VirtualEffect

Readonlyid

Readonlyname

Optionaltype

ReadonlyupdateTick

add

• add(entity: Entity, duration: number, amplifier?: number): boolean

  向实体添加该状态效果

  Parameters

  • entity: Entity

    要添加状态效果的实体

  • duration: number

    效果持续时间，以刻为单位 （20刻=1秒）

  • amplifier: number = 0

    效果的等级（0为代表1级）

  Returns boolean

  本次添加操作是否成功

getAmplifier

• getAmplifier(entity: Entity): number | undefined

  获取该状态效果的等级

  Parameters

  • entity: Entity

  Returns number | undefined

  实体的状态效果等级

getRemainTicks

• getRemainTicks(entity: Entity): number

  Parameters

  • entity: Entity

  Returns number

onAddToEntity

• onAddToEntity(event: (entity: Entity, amplifier: number) => void): void

  当状态效果添加到实体时的事件

  Parameters

  • event: (entity: Entity, amplifier: number) => void

  Returns void

onTimeOut

• onTimeOut(event: (entity: Entity, amplifier: number) => void): void

  当模拟效果过期时触发的事件

  Parameters

  • event: (entity: Entity, amplifier: number) => void

  Returns void

onUpdate

• onUpdate(event: (entity: Entity, amplifier: number) => void): void

  当状态效果更新时，触发的事件

  Parameters

  • event: (entity: Entity, amplifier: number) => void

  Returns void

remove

• remove(entity: Entity): boolean

  向实体移除该状态效果

  Parameters

  • entity: Entity

    要移除效果的实体

  Returns boolean

  本次移除操作是否成功

  Throws

  如果 Runner ID 数据类型不是 number 或 undefined，则抛出错误