GetBanAdmin: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| (7 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server function}} | {{Server function}} | ||
This function will return the admin (nickname of the admin) of the specified [[ban]] | This function will return the responsible admin (nickname of the admin) of the specified [[ban]]. | ||
==Syntax== | ==Syntax== | ||
| Line 7: | Line 7: | ||
string getBanAdmin ( ban theBan ) | string getBanAdmin ( ban theBan ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[ban]]:getAdmin|admin|setBanAdmin}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theBan:''' The [[ban]] | *'''theBan:''' The [[ban]] you want to return the admin of. | ||
===Returns=== | ===Returns=== | ||
Returns a ''string'' of the admin if everything was | Returns a ''string'' of the admin if everything was successful, ''false'' if invalid arguments are specified if there was no admin specified for the [[ban]]. | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | function outputBan(ban) | ||
local banned = getBanNick(ban) -- Get the name of the player who was banned | |||
local banner = getBanAdmin(ban) -- Get the name of the admin who banned the player | |||
local reason = getBanReason(ban) -- Get the reason the player was banned | |||
outputChatBox("-----BAN-----",root,255,0,0) | |||
if (banned) then | |||
outputChatBox("Player banned: "..banned,root,255,0,0) -- Output the player name who was banned | |||
end | |||
if (banner) then | |||
outputChatBox("Banner: "..banner,root,255,0,0) -- Output the admin name who performed the ban | |||
end | |||
if (reason) then | |||
outputChatBox("Reason: "..reason,root,255,0,0) -- outputt the reason the player was banned | |||
end | |||
end | |||
addEventHandler("onBan",root,outputBan) -- When a player is banned trigger the outputBan function | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Admin functions}} | {{Admin functions}} | ||
[[ru:getBanAdmin]] | |||
Latest revision as of 15:48, 5 July 2020
This function will return the responsible admin (nickname of the admin) of the specified ban.
Syntax
string getBanAdmin ( ban theBan )
OOP Syntax Help! I don't understand this!
- Method: ban:getAdmin(...)
- Variable: .admin
- Counterpart: setBanAdmin
Required Arguments
- theBan: The ban you want to return the admin of.
Returns
Returns a string of the admin if everything was successful, false if invalid arguments are specified if there was no admin specified for the ban.
Example
function outputBan(ban)
local banned = getBanNick(ban) -- Get the name of the player who was banned
local banner = getBanAdmin(ban) -- Get the name of the admin who banned the player
local reason = getBanReason(ban) -- Get the reason the player was banned
outputChatBox("-----BAN-----",root,255,0,0)
if (banned) then
outputChatBox("Player banned: "..banned,root,255,0,0) -- Output the player name who was banned
end
if (banner) then
outputChatBox("Banner: "..banner,root,255,0,0) -- Output the admin name who performed the ban
end
if (reason) then
outputChatBox("Reason: "..reason,root,255,0,0) -- outputt the reason the player was banned
end
end
addEventHandler("onBan",root,outputBan) -- When a player is banned trigger the outputBan function