Class ChapterArticle

Create an article with chapters.

Hierarchy (view full)

Constructors

constructor

Properties

body chapters iconPath? id needUnlock title

Methods

checkUnlock display register unlock

Constructors

constructor

  • new ChapterArticle(id, title, body, chapters, iconPath?, needUnlock?): ChapterArticle

  • Parameters

    • id: string

      Id of the article.

    • title: string | RawMessage

      Title of the article.

    • body: string | RawMessage

      Body of the article, support RawMessage.

    • chapters: ChapterData[]

      Chapters of the article.

    • OptionaliconPath: string

      Icon path of the article.

    • needUnlock: boolean = true

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

    Returns ChapterArticle

Properties

body

body: string | RawMessage

Body of the article, support RawMessage.

chapters

chapters: ChapterData[]

Chapters of the article.

OptionaliconPath

iconPath?: string

Icon path of the article.

Readonlyid

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

display

  • display(player): void

  • Display the reading to a player.

    Parameters

    • player: Player

    Returns void

Protectedregister

  • register(): void

  • Registry the prop.

    Returns void

    Deprecated

    Use Register.articleRegistry() to registry the prop

unlock

  • unlock(player): void

  • Unlock the article to article collection.

    Parameters

    • player: Player

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods