autoAnnouncement()

API reference for autoAnnouncement() in @erlcjs/presets.

Sends an announcement in-game every interval,

Signature:

declare function autoAnnouncement(server: Server, message: string, interval?: number): NodeJS.Timeout;

#Parameters

Parameter

Type

Description

server

Server

The server to send to.

message

string

The message to send every interval.

interval

number

(Optional) The interval to send the message at. Default is every 2 minutes.

Returns:

NodeJS.Timeout

The setInterval used to it can be stopped with clearInterval.