BanPlayer: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
__NOTOC__ | __NOTOC__ | ||
This | This function will ban the specified player from the server. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool banPlayer ( player bannedPlayer , [ player responsiblePlayer , string reason ] ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''banPlayer:''' The player that will be banned from the server | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*''' | *'''responsiblePlayer:''' The player that is responsible the event | ||
*''' | *'''reason:''' The reason the player will be banned from the server | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if | Returns ''true'' if the player was banned succesfully, ''false'' if invalid arguments are specified. | ||
==Example== | ==Example== | ||
Revision as of 17:46, 19 November 2006
This function will ban the specified player from the server.
Syntax
bool banPlayer ( player bannedPlayer , [ player responsiblePlayer , string reason ] )
Required Arguments
- banPlayer: 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