kick
kick(
authority,player,kickOptions):void
Removes player from the game as the step ends: each plugin’s
onPlayerLeave runs with LeaveReason.Kicked, her save is stored, and
her page shows message as the room closes her connection. It takes an
authority first, the room’s step or requireAuthority(world), so a
predicted system or a view cannot call it by type. As Roblox’s
Player:Kick(message).
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
authority |
Authority |
player |
Entity |
kickOptions |
KickOptions |
Returns
Section titled “Returns”void