BanPlayer: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 10: Line 10:


===Required Arguments===  
===Required Arguments===  
*'''banPlayer:''' The player that will be banned from the server
*'''bannedPlayer:''' The player that will be banned from the server


===Optional Arguments===  
===Optional Arguments===  

Revision as of 17:49, 19 November 2006


This function will ban the specified player from the server.

Syntax

bool banPlayer ( player bannedPlayer , [ player responsiblePlayer , string reason ] )         

Required Arguments

  • bannedPlayer: The player that will be banned from the server

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • responsiblePlayer: The player that is responsible the event
  • reason: The reason the player will be banned from the server

Returns

Returns true if the player was banned succesfully, false if invalid arguments are specified.

Example

This example does...

--This line does...
blabhalbalhb --abababa
--This line does this...
mooo

See Also

Template:FunctionArea Functions