kickPlayer

Desconecta um jogador do servidor.

Sintaxe

bool kickPlayer ( player oJogador [, string motivo ] )
bool kickPlayer ( player oJogador, player/string responsavel [, string motivo ] )

Parâmetros

Nome	Tipo	Padrão	Descrição
oJogador	player	—	Jogador a expulsar.
responsavel	player / string	"Console"	Quem está expulsando. Sendo um elemento, o nome dele é usado.
motivo	string	""	Motivo mostrado ao jogador e registrado no console.

O segundo argumento muda a leitura da chamada:

• apenas um texto → esse texto é o motivo, e o responsável continua sendo "Console";
• dois textos → o primeiro é o responsável, o segundo é o motivo;
• um elemento → o nome dele vira o responsável, e o terceiro argumento é o motivo.

Retorno

true se o jogador foi desconectado; false se o primeiro argumento não for um jogador ou se ele já não estiver mais conectado.

Nota

O nome do responsável é cortado em 30 caracteres e o motivo em 128. A mensagem que o jogador vê é responsável (motivo) — ou só o nome do responsável, quando nenhum motivo é informado.

Exemplo

addCommandHandler("expulsar", function(admin, _, nome)
    local alvo = getPlayerFromName(nome)
    if alvo then
        kickPlayer(alvo, admin, "flood no chat")
    end
end)

Veja também

• redirectPlayer — Manda o cliente do jogador se conectar a outro servidor.
• setPlayerName — Troca o nome de um jogador conectado.
• setPlayerMuted — Marca um jogador como silenciado, ou tira o silenciamento.
• isPlayerMuted — Verifica se um jogador está silenciado no momento.
• spawnPlayer — Coloca um jogador no mundo, numa posição definida.
• setPlayerBlurLevel — Ajusta o nível de borrão da tela do jogador.
• getPlayerBlurLevel — Devolve o nível de borrão do jogador.
• setControlState — Força um controle do jogo ligado ou desligado no cliente do jogador, como se ele estivesse apertando a tecla.