Other great resources: Official JS API docs, Scripting Forum

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Current »

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:
    • ALLIESSend a chat message to your allies.
    • ALL_PLAYERSSend a chat message to all players.
    • ENEMIESFilter 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

 

  • No labels