Beta Private constructorReadonly blockBlock instance that this component pertains to.
Readonly isWhether or not players can edit the sign. This happens if a
sign has had a honeycomb used on it or setWaxed was called
on the sign.
This property can throw when used.
Readonly typeIdentifier of the component.
Static Readonly componentIdentifier of this component. Should always be minecraft:sign.
Optional side: SignSideThe side of the sign to read the message from. If not provided, this will return the message from the front side of the sign.
Returns the RawText of the sign if setText was called with
a RawMessage or a RawText object, otherwise returns
undefined.
This function can throw errors.
Optional side: SignSideThe side of the sign to read the message from. If not provided, this will return the message from the front side of the sign.
Returns the text of the sign if setText was called with a
string, otherwise returns undefined.
This function can throw errors.
Optional side: SignSideThe side of the sign to read the dye from. If not provided, this will return the dye on the front side of the sign.
Gets the dye that is on the text or undefined if the sign has not been dyed.
This function can throw errors.
The message to set on the sign. If set to a string, then
call getText to read that string. If set to a RawMessage,
then calling getRawText will return a RawText. If set to a
RawText, then calling getRawText will return the same
object that was passed in.
Optional side: SignSideThe side of the sign the message will be set on. If not provided, the message will be set on the front side of the sign.
Sets the text of the sign component.
This function can't be called in read-only mode.
This function can throw errors.
SetRawMessage.ts
const helloWorldMessage: RawMessage = { text: 'Hello World' };
sign.setText(helloWorldMessage);
// Sign text will be saved as a RawText
const result: RawText = sign.getRawText();
JSON.stringify(result); // { rawtext: [{ text: 'Hello World' }] };
SetRawText.ts
const helloWorldText: RawText = { rawtext: [{ text: 'Hello World' }] };
sign.setText(helloWorldText);
// There will be no data transformation unlike calling setText with a RawMessage
const result: RawText = sign.getRawText();
JSON.stringify(result); // { rawtext: [{ text: 'Hello World' }] };
SetString.ts
// Set sign to say 'Hello'
sign.setText('Hello');
sign.getText(); // 'Hello'
Represents a block that can display text on it.