Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Excerpt

Send an in-game message to a specific player, your alliance or everyone.

Availability

...

 

Syntax

Code Block
theme

...

RDark
languagejavascript
linenumberstrue
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:
    Child pages (Children Display)
    alltrue
    depthall
    pageChat Scope
    excerpttrue
3.2
messageString(tick)The message to send to the recipient.3.2

Return value

(question) It's not clear from the C++ code (to me at least) what the return values might be (sad)

Example

Code Block
theme

...

RDark
languagejavascript
titleSend a message to your allies
linenumberstrue
chat(ALLIES,"Hello friends");
Code Block
theme

...

RDark
languagejavascript
titleSend a message to player 2
linenumberstrue
// remember that players are zero-referenced, so player #1 = 0, player #2 = 1, etc.
chat(1,"Hello player 2");
Div
classbox

Availability

Requires:

  • Warzone 3.2 and above.
Div
classbox

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