Class BlockSignComponentBeta

Static Readonly componentId

getRawText

• getRawText(): undefined | RawText

• Returns undefined | RawText

  Remarks

  Returns the RawText of the sign if setText was called with a RawMessage or a RawText object

  Throws

  This function can throw errors.

getText

• getText(): undefined | string

• Returns undefined | string

  Remarks

  Returns the text of the sign if setText was called with a string

  Throws

  This function can throw errors.

getTextDyeColor

• getTextDyeColor(): undefined | DyeColor

• Returns undefined | DyeColor

  Remarks

  Gets the dye that is on the text or undefined if the sign has not been dyed

  Throws

  This function can throw errors.

setText

• setText(message): void

• Parameters

  • message: string | RawText | RawMessage

    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.

  Returns void

  Remarks

  Sets the text of the sign component

  Throws

  This function can throw errors.

  Example

  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' }] };
  Copy

  Example

  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' }] };
  Copy

  Example

  SetString.ts

         // Set sign to say 'Hello'
         sign.setText('Hello');
         sign.getText(); // 'Hello'
  Copy

setTextDyeColor

• setTextDyeColor(color?): void

• Parameters

  • Optional color: DyeColor

    The dye color you want or undefined if you want to clear the dye on the sign

  Returns void

  Remarks

  Sets the dye color of the text

  Throws

  This function can throw errors.