bf6-portal-mod-types
    Preparing search index...

    Function Message

    • Returns a constructed message object which can be used with event game mode message, notification message, highlighted game mode message, and custom notification message. The message object is created by providing a number, player, or format string (which can take up to 3 format items). All strings passed as arguments must be found in the strings.json which is injected as mod.stringkeys.

      Parameters

      • msg: string | number | Player

        The message string, number, or player object.

      • msgArg0: string | number | Player

        In the case where msg is a message string with {} placeholders, this is the first argument to replace the first placeholder.

      • msgArg1: string | number | Player

        In the case where msg is a message string with {} placeholders, this is the second argument to replace the second placeholder.

      • msgArg2: string | number | Player

        In the case where msg is a message string with {} placeholders, this is the third argument to replace the third placeholder.

      Returns mod.Message

      Message The constructed opaque message object.

      // strings.json has a key "Hello" with the value "Hello {}! I am {}, player number {}." and a key "World" with the value "World".
      const message = mod.Message(mod.stringkeys.Hello, mod.stringkeys.World, player, mod.GetObjId(player));

    • Returns a constructed message object which can be used with event game mode message, notification message, highlighted game mode message, and custom notification message. The message object is created by providing a number, player, or format string (which can take up to 2 format items). All strings passed as arguments must be found in the strings.json which is injected as mod.stringkeys.

      Parameters

      • msg: string | number | Player

        The message string, number, or player object.

      • msgArg0: string | number | Player

        In the case where msg is a message string with {} placeholders, this is the first argument to replace the first placeholder.

      • msgArg1: string | number | Player

        In the case where msg is a message string with {} placeholders, this is the second argument to replace the second placeholder.

      Returns mod.Message

      Message The constructed opaque message object.

      // strings.json has a key "Hello" with the value "Hello {}! I am {}." and a key "World" with the value "World".
      const message = mod.Message(mod.stringkeys.Hello, mod.stringkeys.World, player);

    • Returns a constructed message object which can be used with event game mode message, notification message, highlighted game mode message, and custom notification message. The message object is created by providing a number, player, or format string (which can take up to 1 format items). All strings passed as arguments must be found in the strings.json which is injected as mod.stringkeys.

      Parameters

      • msg: string | number | Player

        The message string, number, or player object.

      • msgArg0: string | number | Player

        In the case where msg is a message string with {} placeholders, this is the first argument to replace the first placeholder.

      Returns mod.Message

      Message The constructed opaque message object.

      // strings.json has a key "Hello" with the value "Hello {}!" and a key "World" with the value "World".
      const message = mod.Message(mod.stringkeys.Hello, mod.stringkeys.World);

    • Returns a constructed message object which can be used with event game mode message, notification message, highlighted game mode message, and custom notification message. The message object is created by providing a number, player. All strings passed as arguments must be found in the strings.json which is injected as mod.stringkeys.

      Parameters

      • msg: string | number | Player

        The message string, number, or player object.

      Returns mod.Message

      Message The constructed opaque message object.

      // strings.json has a key "Hello" with the value "Hello!".
      const message = mod.Message(mod.stringkeys.Hello);

    • Returns a constructed message object which can be used with event game mode message, notification message, highlighted game mode message, and custom notification message. The message object is created by providing a number, player, or format string (which can take up to 3 format items).

      Parameters

      • msg: string | number | Player
      • msgArg0: string | number | Player
      • msgArg1: string | number | Player
      • msgArg2: string | number | Player

      Returns mod.Message

    • Returns a constructed message object which can be used with event game mode message, notification message, highlighted game mode message, and custom notification message. The message object is created by providing a number, player, or format string (which can take up to 3 format items).

      Parameters

      • msg: string | number | Player
      • msgArg0: string | number | Player
      • msgArg1: string | number | Player

      Returns mod.Message

    • Returns a constructed message object which can be used with event game mode message, notification message, highlighted game mode message, and custom notification message. The message object is created by providing a number, player, or format string (which can take up to 3 format items).

      Parameters

      • msg: string | number | Player
      • msgArg0: string | number | Player

      Returns mod.Message

    • Returns a constructed message object which can be used with event game mode message, notification message, highlighted game mode message, and custom notification message. The message object is created by providing a number, player, or format string (which can take up to 3 format items).

      Parameters

      Returns mod.Message

    Settings

    Member Visibility