RU/getBanReason: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: {{Translate}} {{Server function}} This function will return the ban reason of the specified ban pointer. ==Syntax== <syntaxhighlight lang="lua"> string getBanReason ( ban theBan ) </syntaxhighlight> ===Requi...)
 
mNo edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Translate}}
__NOTOC__
{{Server function}}
{{RU/Server function}}
This function will return the ban reason of the specified [[ban]] pointer.
Эта функция возвращает причину, по которой был забанен игрок.


==Syntax==  
==Синтаксис==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getBanReason ( ban theBan )
string getBanReason ( ban theBan )
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===  
===Обязательные аргументы===  
*'''theBan:''' The [[ban]] in which you want to return the reason of.
*'''theBan:''' [[Бан]], у которого вы хотите узнать причину.


===Returns===
===Возвращает===
Returns a ''string'' of the reason if everything was successful, ''false'' if invalid arguments are specified if there was no reason specified for the [[ban]].
Возвращает строку с причиной если всё успешно, ''false'', если даны неверные аргументы или при бане не была указана причина.


==Example==
==Пример==
<syntaxhighlight lang="lua">
'''Пример 1:'''{{RU/Example/viewBanParameters}}
--TODO
</syntaxhighlight>


==See Also==
==Смотрите также==
{{RU/Admin functions}}
{{RU/Admin functions}}
[[Category:Needs Example]]
[[en:getBanReason]]
[[en:getBanReason]]

Latest revision as of 22:08, 10 September 2014

Эта функция возвращает причину, по которой был забанен игрок.

Синтаксис

string getBanReason ( ban theBan )

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

  • theBan: Бан, у которого вы хотите узнать причину.

Возвращает

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

Пример

Пример 1:Этот пример выводит в чат ник забаненного игрока, админа, который дал бан, и причину.

function outputBan(ban)
    local plr = getBanNick(ban) -- игрок, который был забанен
    local admin = getBanAdmin(ban) -- админ, который забанил игрока
    local reason = getBanReason(ban) -- причина бана
    if (plr and admin and reason) then
        outputChatBox(plr.." был забанен админом "..admin.." за "..reason, getRootElement(), 255, 0, 0) -- Выводит имя игрока, админа и причину бана
    end
end
addEventHandler("onBan", getRootElement(), outputBan) -- Вызывает функцию outputBan при бане любого игрока

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

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

  • 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