Skip to content
On this page

kick()

Kick a player with a reason.

Function Definition

ts
public kick(reason?: string): void;

Arguments

  • reason?: string

Returns

  • void

Documentation

Examples

ts
const ping = player.ping;
if (player.ping >= 200) {
    player.kick('Ping too high');
    return;
}

Documentation Created with ❤️ by Stuyk