View source for RU/banPlayer

{{Translate|ru}}
{{Server function}}
{{New feature|3|1.0|
This function will ban the specified player by either IP, [[serial]] or username
}}

{{Deprecated_feature|3|1.0|
This function will ban the specified player from the server by IP.
}}

==Syntax== 
{{New feature|3|1.0|
<syntaxhighlight lang="lua">
ban banPlayer ( player bannedPlayer, [ bool IP = true, bool Username = false, bool Serial = false, player responsiblePlayer = nil, string reason = nil, int seconds = 0 ] )
</syntaxhighlight>
}}

{{Deprecated_feature|3|1.0|
<syntaxhighlight lang="lua">
bool banPlayer ( player bannedPlayer , [ element responsibleElement, string reason ] )         
</syntaxhighlight>
}}

===Required Arguments=== 
*'''bannedPlayer:''' Игрок, который должен быть забанен сервером.

===Необязательные аргументы=== 
{{RU\OptionalArg}} 
{{New feature|3|1.0|
*'''IP:''' Забанить игрока по IP?
*'''Username:''' Забанить игрока по имени?
*'''Serial:''' Забанить игрока по serial?

:'''Note:''' Что бы забанить игрока по имени или serial, ''verifyserials'' должна быть включена в серверном файле конфигурации.

}}
*'''responsibleElement:''' Элемент, который отвечает за бан игрока. Это может быть игрок или корневой элемент ([[getRootElement]]()).
*'''reason:''' Нарушение, за которое нужно забанить игрока.
*'''seconds:''' Количество секунд для бана игрока. Можеть быть 0 для бесконечного бана.

===Возвращения===
{{Deprecated_feature|3|1.0|
Возвращает ''true'' если игрок успешно забанен, ''false''если даны неправильные аргументы.
}}

{{New feature|3|1.0|
Возращает [[ban]] метку если игрок успешно забанен, или ''false'' если не успешно.
}}

==Example==
Этот пример банит кого-нибудь, если он имеет ACL права.
<syntaxhighlight lang="lua">
--Add the "ban" command handler
-- Example with the player
function banPlayerCommand ( theClient, commandName, bannedName, reason )

	-- Give the player a nice error if he doesn't have rights
	if ( hasObjectPermissionTo ( theClient, "function.banPlayer" ) ) then
		--Get player element from the name
		local bannedPlayer = getPlayerFromNick ( bannedName )

		--Ban the player
		banPlayer ( bannedPlayer, theClient, reason )
		outputChatBox ( "ban: " .. bannedName .. " successfully banned", theClient )

	else
		outputChatBox ( "ban: You don't have enough permissions", theClient )
	end

end
addCommandHandler ( "ban", banPlayerCommand )

-- Example function with the root element. Here you would pass a player element to the function.
function banCheater(theCheater)
	banPlayer(theCheater, getRootElement(), "You are banned because of cheating.")
end
</syntaxhighlight>

==See Also==
{{RU/Admin_functions}}
[[en:banPlayer]]