sendChat
Sends a chat message. If the server is participating in group chat delivery, the message will be delivered to other servers in the group, including a Discord channel if connected.
Signatures
beacon.sendChat(chatMessage);
beacon.sendChat(chatMessage, senderName);
beacon.sendChat(chatMessage, chatInfo);
Parameters
chatMessage
The message to be sent to chat. Avoid special characters like emoji and accented characters, as Ark’s font cannot handle all characters in every language.
senderName
The name to use as the sender. Defaults to Sentinel.
chatInfo
An object with additional details about the sender and recipient. It supports the following properties:
| Property | Type | Notes |
|---|---|---|
| senderName | String | Works exactly the same as the senderName positional parameter. |
| specimenId | Number | The specimen / implant number of the survivor to privately deliver the chat message to. |
| characterId | String | The Sentinel UUID of the survivor to privately deliver the chat message to. |
| tribeId | String | The Sentinel UUID of the tribe to deliver the chat message to. |
Examples
Send a global chat message
beacon.sendChat('Server shutdown in 5 minutes!');
Send a private message
beacon.sendChat('Warning, please no swearing on this server', {
characterId: '305b1849-c7ac-5a4b-afe9-86628d91bf23',
});