Class BlockSignComponent

Hierarchy (View Summary)

BlockComponent
- BlockSignComponent

Index

Constructors

Properties

block isValid isWaxed typeId

Methods

getRawText getText getTextDyeColor setText setTextDyeColor setWaxed

Constructors

`Private`constructor

new BlockSignComponent(): BlockSignComponent
Returns BlockSignComponent
Overrides BlockComponent.constructor

Properties

`Readonly`block

block: Block

`Readonly`isValid

isValid: boolean

`Readonly`isWaxed

isWaxed: boolean

Throws

This property can throw errors.

World Ready

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

`Readonly`typeId

typeId: string

Methods

getRawText

getRawText(side?: SignSide): RawText
Parameters
- Optionalside: SignSide
Returns RawText
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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

getText

getText(side?: SignSide): string
Parameters
- Optionalside: SignSide
Returns string
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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

getTextDyeColor

getTextDyeColor(side?: SignSide): DyeColor
Parameters
- Optionalside: SignSide
Returns DyeColor
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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

setText

setText(message: string | RawMessage, side?: SignSide): void
Parameters
- message: string | RawMessage
- Optionalside: SignSide
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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

setTextDyeColor

setTextDyeColor(color?: DyeColor, side?: SignSide): void
Parameters
- Optionalcolor: DyeColor
- Optionalside: SignSide
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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

setWaxed

setWaxed(waxed: boolean): void
Parameters
- waxed: boolean
Returns void
Remarks
Write Privilege
This function can't be called in read-only mode.

Throws
This function can throw errors.

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