GetBanUsername: Difference between revisions
Jump to navigation
Jump to search
Enterprise (talk | contribs) No edit summary |
No edit summary |
||
| Line 16: | Line 16: | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function retrieveBan(theBan) | |||
local ban = getBanUsername(theBan) | |||
if ban then | |||
outputChatBox("The following ban nickname is: "..ban, getRootElement(), 255,255,255, true) | |||
end | |||
end | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 20:14, 2 May 2011
This function will return the username of the specified ban pointer.
Syntax
string getBanUsername ( ban theBan )
Required Arguments
- theBan: The ban in which you wish to retrieve the username of.
Returns
Returns a string of the username if everything was successful, false if invalid arguments are specified if there was no username specified for the ban.
Example
function retrieveBan(theBan)
local ban = getBanUsername(theBan)
if ban then
outputChatBox("The following ban nickname is: "..ban, getRootElement(), 255,255,255, true)
end
end