KickPlayer: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 6: | Line 6: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool kickPlayer ( player kickedPlayer , player responsiblePlayer , string reason ) | bool kickPlayer ( player kickedPlayer , [ player responsiblePlayer , string reason ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''kickPlayer:''' The player that will be kicked from the server | ||
===Optional Arguments=== | ===Optional Arguments=== | ||
{{OptionalArg}} | {{OptionalArg}} | ||
*''' | *'''responsiblePlayer:''' The player that is responsible the event | ||
*''' | *'''reason:''' The reason the player will be kicked from the server | ||
===Returns=== | ===Returns=== | ||
Returns ''true'' if | Returns ''true'' if the player was kicked succesfully, ''false'' if invalid arguments are specified. | ||
==Example== | ==Example== | ||
Revision as of 17:43, 19 November 2006
This fake function is for use with blah & blah and does blahblahblabhalbhl
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