Class ItemBookComponent

Hierarchy (View Summary)

ItemComponent
- ItemBookComponent

Index

Constructors

Properties

author? contents isSigned isValid pageCount rawContents title? typeId

Methods

getPageContent getRawPageContent insertPage removePage setContents setPageContent signBook

Constructors

`Private`constructor

new ItemBookComponent(): ItemBookComponent
Returns ItemBookComponent
Overrides ItemComponent.constructor

Properties

`Optional` `Readonly`author

author?: string

Throws

This property can throw errors.

InvalidItemStackError

World Ready

This property can't be read in early-execution mode.

`Readonly`contents

contents: string[]

Throws

This property can throw errors.

InvalidItemStackError

World Ready

This property can't be read in early-execution mode.

`Readonly`isSigned

isSigned: boolean

Throws

This property can throw errors.

InvalidItemStackError

World Ready

This property can't be read in early-execution mode.

`Readonly`isValid

isValid: boolean

`Readonly`pageCount

pageCount: number

Throws

This property can throw errors.

InvalidItemStackError

World Ready

This property can't be read in early-execution mode.

`Readonly`rawContents

rawContents: RawMessage[]

Throws

This property can throw errors.

InvalidItemStackError

World Ready

This property can't be read in early-execution mode.

`Optional` `Readonly`title

title?: string

Throws

This property can throw errors.

InvalidItemStackError

World Ready

This property can't be read in early-execution mode.

`Readonly`typeId

typeId: string

Methods

getPageContent

getPageContent(pageIndex: number): string
Parameters
- pageIndex: number
Returns string
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

InvalidItemStackError

World Ready
This function can't be called in early-execution mode.

getRawPageContent

getRawPageContent(pageIndex: number): RawMessage
Parameters
- pageIndex: number
Returns RawMessage
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

InvalidItemStackError

World Ready
This function can't be called in early-execution mode.

insertPage

insertPage(
pageIndex: number,
content: string | RawMessage | (string | RawMessage)[],
): void
Parameters
- pageIndex: number
- content: string | RawMessage | (string | RawMessage)[]
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

BookError

BookPageContentError

InvalidItemStackError

World Ready
This function can't be called in early-execution mode.

removePage

removePage(pageIndex: number): void
Parameters
- pageIndex: number
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

InvalidItemStackError

World Ready
This function can't be called in early-execution mode.

setContents

setContents(contents: (string | RawMessage | (string | RawMessage)[])[]): void
Parameters
- contents: (string | RawMessage | (string | RawMessage)[])[]
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

BookError

BookPageContentError

InvalidItemStackError

World Ready
This function can't be called in early-execution mode.

setPageContent

setPageContent(
pageIndex: number,
content: string | RawMessage | (string | RawMessage)[],
): void
Parameters
- pageIndex: number
- content: string | RawMessage | (string | RawMessage)[]
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

BookError

BookPageContentError

InvalidItemStackError

World Ready
This function can't be called in early-execution mode.

signBook

signBook(title: string, author: string): void
Parameters
- title: string
- author: string
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

BookError

InvalidEntityError

InvalidItemStackError

World Ready
This function can't be called in early-execution mode.