(info) Other great resources: Official JS API docs, Scripting Forum

chat()

Owned by Aubergine
Last updated: Jan 10, 2013Version comment
1 min read
Send an in-game message to a specific player, your alliance or everyone.

 

Syntax

chat(to, message);

Parameters

ParameterTypeMandatoryDescriptionGame version
to

Number,

Constant

(tick)

Who should the message be sent to?

  • Specify a player id to send to that specific player
  • Or use one of the following constants:
    • ALLIES — Send a chat message to your allies.
    • ALL_PLAYERS — Send a chat message to all players.
    • ENEMIES — Filter enumeration to enemy objects.
3.2
messageString(tick)The message to send to the recipient.3.2

Return value

(question)

Notes

When you send a chat message to another player, it will echo the message to your own eventChat().

Examples

Send a message to your allies
chat(ALLIES, "Hello friends");
Send a message to player 2
// remember that players are zero-referenced, so player #1 = 0, player #2 = 1, etc.
chat(1, "Hello player 2");
Availability 3.2+

Requires:

  • Warzone 3.2 and above.
Contents

Jump to:

See also

Related API features:

  • Player Scope – constants relating to chat messages
  • eventChat() – receive chat messages
  • console() – send a message to the script's player console
  • debug() – send a message to the terminal or logs

Add-on APIs:

  • Babel API – send data objects between scripts using the chat interface.
  • Chat API – define chat commands and orchestrate chat conversations.
  • Util API – its out() function supports chat messages