welcomePlayer()

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

Welcomes the player on join.

Signature:

declare function welcomePlayer(message?: string): (player: Player) => void;

#Parameters

Parameter

Type

Description

message

string

(Optional) Optional custom message to send to player.

Returns:

(player: Player) => void

Callback function to pass into client event.

#Example

client.on(ERLCEvents.playerJoin, welcomePlayer())