SetBanNick

From Multi Theft Auto: Wiki
Revision as of 17:12, 31 March 2015 by HuX (talk | contribs) (→‎Example)
Jump to navigation Jump to search

Accessories-text-editor.png Script Example Missing Function SetBanNick needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.


This function sets a new nick for a ban.

Syntax

bool setBanNick ( ban theBan, string theNick )

Required Arguments

  • theBan: The ban you want to change the nick of.
  • theNick: A string representing the nick you want to set the ban to.

Returns

Returns true if changed, false otherwise.

Example

-- this example looks if there is a ban with nick 'Steve', and if is, it changes ban nick to 'Mike'
function changeBanNick()
   for i,ban in pairs(getBans()) do
      if getBanNick(ban) == "Steve" then
         setBanNick(ban,"Mike")
      end
   end
end
addCommandHandler("setbannick",changeBanNick)

See Also