Class Article

Create an article.

Hierarchy (view full)

Article
- ChapterArticle

Index

Constructors

Properties

body iconPath? id needUnlock title

Methods

checkUnlock display register unlock

Constructors

constructor

new Article(id, title, body, iconPath?, needUnlock?): Article
Parameters
- id: string
  Id of the article.
- title: string | RawMessage
  Title of the article.
- body: string | RawMessage
  Body of the article, support RawMessage.
- OptionaliconPath: string
  Icon path of the article.
- needUnlock: boolean = true
  If true, articles will be unlocked in the ArticleCollection after reading it.
Returns Article
- Defined in node_modules/lazuli-api/src/lazuli-api/article.ts:10

Properties

body

body: string | RawMessage

Body of the article, support RawMessage.

`Optional`iconPath

iconPath?: string

Icon path of the article.

`Readonly`id

id: string

Id of the article.

needUnlock

needUnlock: boolean = true

If true, articles will be unlocked in the ArticleCollection after reading it.

title

title: string | RawMessage

Title of the article.

Methods

checkUnlock

checkUnlock(player): boolean
Check the article whether it is unlocked or not to article collection.
Parameters
- player: Player
Returns boolean
- Defined in node_modules/lazuli-api/src/lazuli-api/article.ts:61

display

display(player): void
Display the reading to a player.
Parameters
- player: Player
Returns void
- Defined in node_modules/lazuli-api/src/lazuli-api/article.ts:35

`Protected`register

register(): void
Registry the prop.

Returns void
Deprecated
Use Register.articleRegistry() to registry the prop
- Defined in node_modules/lazuli-api/src/lazuli-api/article.ts:47

unlock

unlock(player): void
Unlock the article to article collection.
Parameters
- player: Player
Returns void
- Defined in node_modules/lazuli-api/src/lazuli-api/article.ts:54