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

    Class ArticleCenter

    集中显示文章的类

    核心功能包括：

    • 显示文章列表给玩家
    • 处理文章的解锁和显示

    注意：

    • 如果articles参数为布尔值，如果为true，则会从该脚本环境注册的所有文章中显示已经解锁的文章，反之则显示无文章提示
    • 如果articles参数为文章列表，则只从提供的文章中显示已解锁的文章
    const articleCenter = new ArticleCenter("article:id", title, body, true);
    articleCenter.display(player); // 显示文章中心给玩家
    articleCenter.subscribeEvent("itemId"); // 注册文章事件
    articleCenter.registryComponent("componentName"); // 注册自定义组件

    1.0.0

    Hierarchy

    • FormLike
      • ArticleCenter
    Index

    Constructors

    constructor

    Properties

    articleSource bindTo? body iconPath? id title

    Methods

    display jumpTo quit

    Constructors

    • Parameters

      • id: string

        文章中心ID

      • title: TextProvider

        文章中心标题

      • body: TextProvider

        文章中心内容

      • articleSource: "auto" | ReadableArticle[] | "registry"

        文章来源，如果为true，则会从该脚本环境注册的所有文章中显示已经解锁的文章，反之则显示无文章提示，如果为文章列表，则只从提供的文章中显示已解锁的文章

      • OptionalbindTo: ArticleRegistries
      • OptionaliconPath: string

      Returns ArticleCenter

    Properties

    articleSource: "auto" | ReadableArticle[] | "registry"

    文章来源，如果为true，则会从该脚本环境注册的所有文章中显示已经解锁的文章，反之则显示无文章提示，如果为文章列表，则只从提供的文章中显示已解锁的文章

    bindTo?: ArticleRegistries

    body

    body: TextProvider

    文章中心内容

    iconPath?: string
    id: string

    文章中心ID

    title: TextProvider

    文章中心标题

    Methods

    • 向玩家展示文章中心

      Parameters

      • player: Player

        要展示文章中心的玩家

      • backTo: FormLike[]

      Returns void

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

      Parameters

      • player: Player

        要跳转表单的玩家

      • form: FormLike

        要跳转到的目标表单实例

      • backTo: readonly FormLike[]

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

      Returns void

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

      Parameters

      • player: Player

        要处理返回逻辑的玩家

      • backTo: readonly FormLike[]

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

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods