Class BlockSignComponentBeta

Readonly BetaisWaxed

Static Readonly BetacomponentId

getRawText

• getRawText(side?: SignSide): RawText
  Beta

  Parameters

  • Optionalside: SignSide

    The 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 RawText

  Remarks

  Returns the RawText of the sign if setText was called with a RawMessage or a RawText object, otherwise returns undefined.

  Throws

  This function can throw errors.

getText

• getText(side?: SignSide): string
  Beta

  Parameters

  • Optionalside: SignSide

    The 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 string

  Remarks

  Returns the text of the sign if setText was called with a string, otherwise returns undefined.

  Throws

  This function can throw errors.

getTextDyeColor

• getTextDyeColor(side?: SignSide): DyeColor
  Beta

  Parameters

  • Optionalside: SignSide

    The side of the sign to read the dye from. If not provided, this will return the dye on the front side of the sign.

  Returns 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: string | RawText | RawMessage, side?: SignSide): void
  Beta

  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.
  • Optionalside: SignSide

    The 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.

  Returns void

  Remarks

  Sets the text of the sign component.

  This function can't be called in read-only mode.

  Throws

  Throws if the provided message is greater than 512 characters in length.

  Example: SetRawMessage.ts

  const signLocation: Vector3 = { x: 0, y: -60, z: 0 }; // Replace with your sign's coordinates
  const block = world.getDimension("overworld").getBlock(signLocation);
  if (!block) {
    world.sendMessage("Could not find a block at specified location.");
    return;
  }
  const sign = block.getComponent("minecraft:sign") as BlockSignComponent;
  const helloWorldMessage: RawMessage = { text: "Hello World" };
  sign.setText(helloWorldMessage);
  
  // Sign text will be saved as a RawText
  const result = sign.getRawText();
  world.sendMessage(JSON.stringify(result)); // { rawtext: [{ text: 'Hello World' }] };
  Copy

  Example: SetRawText.ts

  const signLocation: Vector3 = { x: 0, y: -60, z: 0 }; // Replace with your sign's coordinates
  const block = world.getDimension("overworld").getBlock(signLocation);
  if (!block) {
    world.sendMessage("Could not find a block at specified location.");
    return;
  }
  const sign = block.getComponent("minecraft:sign") as BlockSignComponent;
  const helloWorldText: RawText = { rawtext: [{ text: "Hello World" }] };
  sign.setText(helloWorldText);
  
  // There will be no data transformation unlike calling setText with a RawMessage
  const result = sign.getRawText();
  world.sendMessage(JSON.stringify(result)); // { rawtext: [{ text: 'Hello World' }] };
  Copy

  Example: SetString.ts

  const signLocation: Vector3 = { x: 0, y: -60, z: 0 }; // Replace with your sign's coordinates
  const block = world.getDimension("overworld").getBlock(signLocation);
  if (!block) {
    world.sendMessage("Could not find a block at specified location.");
    return;
  }
  const sign = block.getComponent("minecraft:sign") as BlockSignComponent;
  // Set sign to say 'Hello'
  sign.setText("Hello World");
  world.sendMessage(sign.getText() ?? "undefined"); // 'Hello World'
  Copy

setTextDyeColor

• setTextDyeColor(color?: DyeColor, side?: SignSide): void
  Beta

  Parameters

  • Optionalcolor: DyeColor

    The dye color to apply to the sign or undefined to clear the dye on the sign.
  • Optionalside: SignSide

    The side of the sign the color will be set on. If not provided, the color will be set on the front side of the sign.

  Returns void

  Remarks

  Sets the dye color of the text.

  This function can't be called in read-only mode.

  Throws

  This function can throw errors.

setWaxed

• setWaxed(waxed: boolean): void
  Beta

  Parameters

  • waxed: boolean

  Returns void

  Remarks

  Makes it so players cannot edit this sign.

  This function can't be called in read-only mode.

  Throws

  This function can throw errors.