Class ArticleCollection

Create an article collection. It likes ChapterArticle, but support article unlock.

Index

Constructors

Properties

articles body displayCondition id title

Methods

display register

Constructors

constructor

new ArticleCollection(id, title, body, displayCondition, articles): ArticleCollection
Parameters
- id: string
  Id of the collection.
- title: string | RawMessage
  Title of the collection.
- body: string | RawMessage
  Body of the collection.
- displayCondition: DisplayCondition
  Control when collection is displayed.
- articles: (Article | ChapterArticle)[]
  Articles in the collection.
Returns ArticleCollection
- Defined in lazuli-api/article.ts:131

Properties

articles

articles: (Article | ChapterArticle)[]

Articles in the collection.

body

body: string | RawMessage

Body of the collection.

displayCondition

displayCondition: DisplayCondition

Control when collection is displayed.

`Readonly`id

id: string

Id of the collection.

title

title: string | RawMessage

Title of the collection.

Methods

display

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

`Protected`register

register(): void
Registry the prop.

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