• Parameters

    • message: string
    • displayName: {
          hidden: boolean;
          sourceType: "nameTag" | "name" | "hidden" | "sudo";
          value?: string;
      }
    • Optionaloptions: {
          allowEval?: boolean;
          dimension?:
              | "overworld"
              | "nether"
              | "the_end"
              | "minecraft:overworld"
              | "minecraft:nether"
              | "minecraft:the_end";
          isPlaceholderPlayer?: boolean;
          isPlaceholderTargetPlayer?: boolean;
          messageFormatting?: string;
          messageGradientMode?: | "rainbow"
          | "randomrainbow"
          | "shuffledrainbow"
          | "bluegradient"
          | "randombluegradient"
          | "shuffledbluegradient"
          | "yellowgradient"
          | "randomyellowgradient"
          | "shuffledyellowgradient"
          | "blackgradient"
          | "randomblackgradient"
          | "shuffledblackgradient"
          | "graygradient"
          | "randomgraygradient"
          | "shuffledgraygradient"
          | "purplegradient"
          | "randompurplegradient"
          | "shuffledpurplegradient";
          messageTimeStampEnabled?: boolean;
          nameFormatting?: string;
          nameGradientMode?: | "rainbow"
          | "randomrainbow"
          | "shuffledrainbow"
          | "bluegradient"
          | "randombluegradient"
          | "shuffledbluegradient"
          | "yellowgradient"
          | "randomyellowgradient"
          | "shuffledyellowgradient"
          | "blackgradient"
          | "randomblackgradient"
          | "shuffledblackgradient"
          | "graygradient"
          | "randomgraygradient"
          | "shuffledgraygradient"
          | "purplegradient"
          | "randompurplegradient"
          | "shuffledpurplegradient";
          player?: Player;
          playerPersonalSettings?: {
              chatNameAndMessageSeparator?: string;
              chatRankPrefix?: string;
              defaultMessageFormatting?: string;
              defaultNameFormatting?: string;
              defaultSeparatorFormatting?: string;
              hideChatDisplayTimeStamp?: boolean;
              nameDisplayPrefix?: string;
              nameDisplaySuffix?: string;
              rankDisplayPrefix?: string;
              rankDisplaySeparator?: string;
              rankDisplaySuffix?: string;
          };
          ranks?: string[];
          separatorFormatting?: string;
          separatorGradientMode?: | "rainbow"
          | "randomrainbow"
          | "shuffledrainbow"
          | "bluegradient"
          | "randombluegradient"
          | "shuffledbluegradient"
          | "yellowgradient"
          | "randomyellowgradient"
          | "shuffledyellowgradient"
          | "blackgradient"
          | "randomblackgradient"
          | "shuffledblackgradient"
          | "graygradient"
          | "randomgraygradient"
          | "shuffledgraygradient"
          | "purplegradient"
          | "randompurplegradient"
          | "shuffledpurplegradient";
          showDimension?: boolean;
          tags?: string[];
          targetPlayer?: Player;
          targetPlayerSettings?: {
              hideChatDisplayTimeStamps?: boolean;
              messageTimeStampEnabled?: boolean;
              timeZone?: number;
          };
          time?: number;
      }
      • OptionalallowEval?: boolean
      • Optionaldimension?:
            | "overworld"
            | "nether"
            | "the_end"
            | "minecraft:overworld"
            | "minecraft:nether"
            | "minecraft:the_end"
      • OptionalisPlaceholderPlayer?: boolean
      • OptionalisPlaceholderTargetPlayer?: boolean
      • OptionalmessageFormatting?: string
      • OptionalmessageGradientMode?:
            | "rainbow"
            | "randomrainbow"
            | "shuffledrainbow"
            | "bluegradient"
            | "randombluegradient"
            | "shuffledbluegradient"
            | "yellowgradient"
            | "randomyellowgradient"
            | "shuffledyellowgradient"
            | "blackgradient"
            | "randomblackgradient"
            | "shuffledblackgradient"
            | "graygradient"
            | "randomgraygradient"
            | "shuffledgraygradient"
            | "purplegradient"
            | "randompurplegradient"
            | "shuffledpurplegradient"
      • OptionalmessageTimeStampEnabled?: boolean

        Should be true if the player has the chatDisplayTimeStamp tag.

        If true, the time stamp will be displayed for messages sent by this player.

        This option will soon be removed.

      • OptionalnameFormatting?: string
      • OptionalnameGradientMode?:
            | "rainbow"
            | "randomrainbow"
            | "shuffledrainbow"
            | "bluegradient"
            | "randombluegradient"
            | "shuffledbluegradient"
            | "yellowgradient"
            | "randomyellowgradient"
            | "shuffledyellowgradient"
            | "blackgradient"
            | "randomblackgradient"
            | "shuffledblackgradient"
            | "graygradient"
            | "randomgraygradient"
            | "shuffledgraygradient"
            | "purplegradient"
            | "randompurplegradient"
            | "shuffledpurplegradient"
      • Optionalplayer?: Player
      • OptionalplayerPersonalSettings?: {
            chatNameAndMessageSeparator?: string;
            chatRankPrefix?: string;
            defaultMessageFormatting?: string;
            defaultNameFormatting?: string;
            defaultSeparatorFormatting?: string;
            hideChatDisplayTimeStamp?: boolean;
            nameDisplayPrefix?: string;
            nameDisplaySuffix?: string;
            rankDisplayPrefix?: string;
            rankDisplaySeparator?: string;
            rankDisplaySuffix?: string;
        }
        • OptionalchatNameAndMessageSeparator?: string
        • OptionalchatRankPrefix?: string
        • OptionaldefaultMessageFormatting?: string
        • OptionaldefaultNameFormatting?: string
        • OptionaldefaultSeparatorFormatting?: string
        • OptionalhideChatDisplayTimeStamp?: boolean

          Should be true if the player has the hideChatDisplayTimeStamp tag.

          If true, the time stamp will not be displayed for messages sent by this player.

          This option will soon be removed.

        • OptionalnameDisplayPrefix?: string
        • OptionalnameDisplaySuffix?: string
        • OptionalrankDisplayPrefix?: string
        • OptionalrankDisplaySeparator?: string
        • OptionalrankDisplaySuffix?: string
      • Optionalranks?: string[]
      • OptionalseparatorFormatting?: string
      • OptionalseparatorGradientMode?:
            | "rainbow"
            | "randomrainbow"
            | "shuffledrainbow"
            | "bluegradient"
            | "randombluegradient"
            | "shuffledbluegradient"
            | "yellowgradient"
            | "randomyellowgradient"
            | "shuffledyellowgradient"
            | "blackgradient"
            | "randomblackgradient"
            | "shuffledblackgradient"
            | "graygradient"
            | "randomgraygradient"
            | "shuffledgraygradient"
            | "purplegradient"
            | "randompurplegradient"
            | "shuffledpurplegradient"
      • OptionalshowDimension?: boolean
      • Optionaltags?: string[]
      • OptionaltargetPlayer?: Player
      • OptionaltargetPlayerSettings?: {
            hideChatDisplayTimeStamps?: boolean;
            messageTimeStampEnabled?: boolean;
            timeZone?: number;
        }
        • OptionalhideChatDisplayTimeStamps?: boolean

          Should be true if the player has the hideChatDisplayTimeStamps tag.

          If true, the time stamp will not be displayed for messages sent to this player.

        • OptionalmessageTimeStampEnabled?: boolean

          Should be true if the player has the chatDisplayTimeStamps tag.

          If true, the time stamp will be displayed for ALL messages sent to this player.

        • OptionaltimeZone?: number
      • Optionaltime?: number

    Returns string