RU/GetBanNick: Difference between revisions
Jump to navigation
Jump to search
Enterprise (talk | contribs) (New page: {{Translate}} __NOTOC__ {{Server function}} This function will return the nickname (nickname that the player had when he was banned) of the specified ban element. ==Syntax== <syntaxhighlight lang="lua">[...) |
No edit summary |
||
Line 15: | Line 15: | ||
Returns a ''string'' of the nickname if everything was successfull, ''false'' if invalid arguments are specified if there was no nickname specified for the [[ban]] element. | Returns a ''string'' of the nickname if everything was successfull, ''false'' if invalid arguments are specified if there was no nickname specified for the [[ban]] element. | ||
== | ==Пример== | ||
'''Example 1:''' This example outputs the name of the player, the admin who banned the player and the reason. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | function outputBan(ban) | ||
local plr = getBanNick(ban) -- the player who got banned | |||
local admin = getBanAdmin(ban) -- admin who banned the player | |||
local reason = getBanReason(ban) -- reason for banning | |||
if (plr and admin and reason) then | |||
outputChatBox(plr.." has been banned by "..admin.." for "..reason, getRootElement(), 255, 0, 0) -- Outputs name of the player, admin and the reason for banning | |||
end | |||
end | |||
addEventHandler("onBan", getRootElement(), outputBan) -- When a player is banned trigger the outputBan function | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Admin functions}} | {{Admin functions}} | ||
[[en:getBanNick]] | [[en:getBanNick]] |
Revision as of 18:30, 18 January 2014
This function will return the nickname (nickname that the player had when he was banned) of the specified ban element.
Syntax
string getBanNick ( ban theBan )
Required Arguments
- theBan: The ban element which nickname you want to return.
Returns
Returns a string of the nickname if everything was successfull, false if invalid arguments are specified if there was no nickname specified for the ban element.
Пример
Example 1: This example outputs the name of the player, the admin who banned the player and the reason.
function outputBan(ban) local plr = getBanNick(ban) -- the player who got banned local admin = getBanAdmin(ban) -- admin who banned the player local reason = getBanReason(ban) -- reason for banning if (plr and admin and reason) then outputChatBox(plr.." has been banned by "..admin.." for "..reason, getRootElement(), 255, 0, 0) -- Outputs name of the player, admin and the reason for banning end end addEventHandler("onBan", getRootElement(), outputBan) -- When a player is banned trigger the outputBan function