RU/kickPlayer: Difference between revisions

Latest revision as of 12:30, 9 September 2014

Эта функция кикает (выбрасывает) указанного игрока с сервера.

Синтаксис

bool kickPlayer ( player kickedPlayer, [ player responsiblePlayer, string reason = "" ] )

или

bool kickPlayer ( player kickedPlayer, [ string reason = "" ] )

Синтаксис ООП Помогите! Я не понимаю, что это!

Метод: player:kick(...)

Обязательные аргументы

kickedPlayer: Игрок, который будет выброшен с сервера

Необязательные аргументы

responsiblePlayer: Игрок, ответственный за событие. Примечание: Если оставить пустым, ответственным за кик игроком будет "Console" (Максимально 30 символов).
reason: Причина кика. (Максимально 64 символа)

Возвращает

Возвращает true, если игрок был успешно выброшен, false, если указаны неверные аргументы.

Пример

Данный пример позволяет кикнуть любого игрока с более низким уровнем.

function kickPlayerHandler ( sourcePlayer, commandname, kickedname, reason )
	-- Получаем элемент игрока по имени
	local kicked = getPlayerFromName ( kickedname )
	-- Если клиент, который отправил команду, имеет высокий уровень
	if ( hasObjectPermissionTo ( sourcePlayer, "function.kickPlayer" ) ) then
		-- Кикаем игрока
		kickPlayer ( kicked, sourcePlayer, reason )
	end
end
-- Добавляем обработчик команды "kick"
addCommandHandler ( "kick", kickPlayerHandler )

Смотрите также

Серверные функции

addBan — блокирует доступ по серийному номеру, IP адресу и / или нику
banPlayer — блокирует указанного игрока по серийному номеру, IP адресу и / или нику
getBanAdmin — возвращает ник администратора, ответственного за указанную блокировку
getBanIP — возвращает заблокированный IP адрес для указанной блокировки
getBanNick — возвращает ник заблокированного игрока для указанной блокировки
getBanReason — возвращает причину выдачи для указанной блокировки
getBans — возвращает таблицу выданных блокировок
getBanSerial — возвращает заблокированный серийный номер для указанной блокировки
getBanTime — возвращает время в секундах, прошедшее от 1.01.1970 до момента выдачи указанной блокировки
getBanUsername — возвращает ник заблокированного игрока для указанной блокировки (устарела)
getUnbanTime — возвращает время в секундах, прошедшее от 1.01.1970 до момента снятия указанной блокировки
isBan — проверка значение на соответствие типу ban
kickPlayer — исключает указанного игрока из игры
setBanAdmin — изменяет никнейм ответственного за блокировку администратора
setBanNick — изменяет никнейм игрока для указанной блокировки
setBanReason — изменяет причину указанной блокировки
setUnbanTime — изменяет время разблокировки для указанного игрока
removeBan — удаляет указанную блокировку
reloadBans — обновление данных о выданных блокировках из файла banlist.xml

@@ Line 1: / Line 1: @@
+{{RU/Server function}}
 __NOTOC__
-Эта функция кикает (т.е. выбрасывает игрока из сервера)
+Эта функция кикает (выбрасывает) указанного игрока с сервера.
 ==Синтаксис==
 <syntaxhighlight lang="lua">
-bool kickPlayer ( игрок kickedPlayer , [ игрок responsiblePlayer , строка reason ] )
+bool kickPlayer ( player kickedPlayer, [ player responsiblePlayer, string reason = "" ] )
 </syntaxhighlight>
+''или''
+<syntaxhighlight lang="lua">
+bool kickPlayer ( player kickedPlayer, [ string reason = "" ] )
+</syntaxhighlight>
+{{RU/OOP||[[player]]:kick||}}
 ===Обязательные аргументы===
-*'''kickedPlayer:''' Игрок, которого нужно кикнуть.
+*'''kickedPlayer:''' Игрок, который будет выброшен с сервера
 ===Необязательные аргументы===
-{{RU/OptionalArg}}
+*'''responsiblePlayer:''' Игрок, ответственный за событие. '''Примечание''': Если оставить пустым, ответственным за кик игроком будет "Console" (Максимально 30 символов).
-*'''responsiblePlayer:''' Игрок, вызвавший кик другого игрока.
+*'''reason:''' Причина кика. (Максимально 64 символа)
-*'''reason:''' Причина кика.
-===Возврашения===
+===Возвращает===
-Возвращает правду, если игрок был успешно кинут, и ложь если были ошибки.
+Возвращает ''true'', если игрок был успешно выброшен, ''false'', если указаны неверные аргументы.
 ==Пример==
-Данный код позволяет кикнуть выбранного игрока, если вызывающий игрок имеет доступ к кику (админы, модераторы)
+Данный пример позволяет кикнуть любого игрока с более низким уровнем.
 <syntaxhighlight lang="lua">
 function kickPlayerHandler ( sourcePlayer, commandname, kickedname, reason )
-	-- Получить игрока из kickedname (чтобы кикнуть игрока)
+	-- Получаем элемент игрока по имени
-	local kicked = getPlayerFromNick ( kickedname )
+	local kicked = getPlayerFromName ( kickedname )
-	-- Если вызвавший функцию имеет доступ к кику
+	-- Если клиент, который отправил команду, имеет высокий уровень
 	if ( hasObjectPermissionTo ( sourcePlayer, "function.kickPlayer" ) ) then
-		-- кикнуть игрока
+		-- Кикаем игрока
 		kickPlayer ( kicked, sourcePlayer, reason )
 	end
 end
--- Добавляем комманду для кика (функция kickPlayerHandler)
+-- Добавляем обработчик команды "kick"
 addCommandHandler ( "kick", kickPlayerHandler )
 </syntaxhighlight>
@@ Line 38: / Line 41: @@
 {{RU/Admin_functions}}
 [[en:kickPlayer]]
+[[es:kickPlayer]]