Class Article

创建一个文章

Since

1.0.0

Hierarchy

FormLike
- Article

Index

Constructors

Properties

body chapters? iconPath? id needUnlock title DYNAMIC_DATA_ID

Methods

checkUnlock display jumpTo quit unlock

Constructors

constructor

new Article(
    id: string,
    title: TextProvider,
    body: TextProvider,
    chapters?: ChapterData[],
    iconPath?: string,
    needUnlock?: boolean,
): Article
Parameters
- id: string
  文章ID
- title: TextProvider
  文章标题
- body: TextProvider
  文章内容，支持字符串、RawMessage 和动态生成
- Optionalchapters: ChapterData[]
  文章的章节
- OptionaliconPath: string
  文章的图标路径
- needUnlock: boolean = true
  是否需要解锁
Returns Article
Overrides FormLike.constructor
- Defined in packages/article/src/api/Article.ts:22

Properties

body

body: TextProvider

文章内容，支持字符串、RawMessage 和动态生成

`Optional`chapters

chapters?: ChapterData[]

文章的章节

`Optional`iconPath

iconPath?: string

文章的图标路径

`Readonly`id

id: string

文章ID

needUnlock

needUnlock: boolean = true

是否需要解锁

title

title: TextProvider

文章标题

`Static`DYNAMIC_DATA_ID

DYNAMIC_DATA_ID: string = "starock:unlocked_articles"

Methods

checkUnlock

checkUnlock(player: Player): boolean
检查文章是否在文章中心里解锁
Parameters
- player: Player
Returns boolean
- Defined in packages/article/src/api/Article.ts:149

display

display(player: Player, backTo: FormLike[]): void
向玩家展示文章
Parameters
- player: Player
  要展示文章的玩家
- backTo: FormLike[]
  关闭文章后返回的界面
Returns void
Overrides FormLike.display
- Defined in packages/article/src/api/Article.ts:113

`Protected`jumpTo

jumpTo(player: Player, form: FormLike, backTo: readonly FormLike[]): void
统一的表单跳转方法，子类跳转新表单时请调用此方法
Parameters
- player: Player
  要跳转表单的玩家
- form: FormLike
  要跳转到的目标表单实例
- backTo: readonly FormLike[]
  当前的只读返回栈，直接透传display方法的backTo参数即可
Returns void
Inherited from FormLike.jumpTo
- Defined in node_modules/.pnpm/@occultus+core@1.1.0_@minecraft+server@2.4.0_@minecraft+common@1.2.0_@minecraft+vanilla-data@1.21.131_/node_modules/@occultus/core/src/api/base/FormLike.ts:69

quit

quit(player: Player, backTo: readonly FormLike[]): void
处理表单关闭后的返回逻辑，跳转到上一级表单
Parameters
- player: Player
  要处理返回逻辑的玩家
- backTo: readonly FormLike[]
  只读的表单返回栈，避免原数组被篡改
Returns void
Inherited from FormLike.quit
- Defined in node_modules/.pnpm/@occultus+core@1.1.0_@minecraft+server@2.4.0_@minecraft+common@1.2.0_@minecraft+vanilla-data@1.21.131_/node_modules/@occultus/core/src/api/base/FormLike.ts:55

unlock

unlock(player: Player): boolean
在文章中心里解锁文章
Parameters
- player: Player
Returns boolean
true如果文章需要解锁，并且成功解锁；否则返回false
- Defined in packages/article/src/api/Article.ts:125