KickPlayer: Difference between revisions

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


__NOTOC__  
__NOTOC__  
This fake function is for use with blah & blah and does blahblahblabhalbhl
This function will kick the specified player from the server.


==Syntax==  
==Syntax==  

Revision as of 17:45, 19 November 2006


This function will kick the specified player from the server.

Syntax

bool kickPlayer ( player kickedPlayer , [ player responsiblePlayer , string reason ] )         

Required Arguments

  • kickPlayer: The player that will be kicked 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 kicked from the server

Returns

Returns true if the player was kicked 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