@occultus/api-root - v0.29.3
    Preparing search index...

    表示饰品的类

    Hierarchy

    • FormLike
      • Artifact
    Index

    Constructors

    • Parameters

      • typeId: string

        饰品的 ID

      • name: TextProvider

        饰品的名称

      • description: TextProvider

        饰品的描述

      • slot: ArtifactSlot

        饰品适用的饰品槽位

      • OptionaliconPath: string

        饰品的图标路径

      • equipmentSound: string = "armor.equip_generic"

        装备饰品时发送给玩家的声音

      Returns Artifact

    Properties

    description: TextProvider

    饰品的描述

    equipEvent: (arg: ItemComponentUseEvent) => void = ...
    equipmentSound: string = "armor.equip_generic"

    装备饰品时发送给玩家的声音

    hitEntityEvent: (arg: EntityHitEntityAfterEvent) => void = ...
    hurtEvent: (arg: EntityHurtAfterEvent) => void = ...
    iconPath?: string

    饰品的图标路径

    mineBlockEvent: (arg: PlayerBreakBlockAfterEvent) => void = ...

    饰品的名称

    饰品适用的饰品槽位

    typeId: string

    饰品的 ID

    unequipEvent: (arg: Player) => void = ...

    Methods

    • 向玩家展示饰品界面

      Parameters

      • player: Player

        要被展示饰品的界面的玩家

      • backTo: FormLike[]

      Returns void

    • 统一的表单跳转方法,子类跳转新表单时请调用此方法

      Parameters

      • player: Player

        要跳转表单的玩家

      • form: FormLike

        要跳转到的目标表单实例

      • backTo: readonly FormLike[]

        当前的只读返回栈,直接透传display方法的backTo参数即可

      Returns void

    • Parameters

      • callback: (arg: ItemComponentUseEvent) => void

      Returns void

    • Parameters

      • callback: (arg: EntityHitEntityAfterEvent) => void

      Returns void

    • Parameters

      • callback: (arg: EntityHurtAfterEvent) => void

      Returns void

    • Parameters

      • callback: (arg: PlayerBreakBlockAfterEvent) => void

      Returns void

    • Parameters

      • callback: (arg: Player) => void

      Returns void

    • 处理表单关闭后的返回逻辑,跳转到上一级表单

      Parameters

      • player: Player

        要处理返回逻辑的玩家

      • backTo: readonly FormLike[]

        只读的表单返回栈,避免原数组被篡改

      Returns void