GetBanUsername: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Learn to indent code and create examples which actually use a function correctly, not confuse people.)
Line 17: Line 17:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function retrieveBan(theBan)
function retrieveBan(theBan)
local ban = getBanUsername(theBan)
    local ban = getBanUsername(theBan)
if ban then
    if ban then
outputChatBox("The following ban nickname is: "..ban, getRootElement(), 255,255,255, true)
        outputChatBox("The following bans username is: "..ban, getRootElement(), 255,255,255, true)
end
    end
end
end
</syntaxhighlight>
</syntaxhighlight>

Revision as of 09:03, 3 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 bans username is: "..ban, getRootElement(), 255,255,255, true)
    end
end

See Also