SetServerPassword: Difference between revisions
Jump to navigation
Jump to search
(New page: Category:Private __NOTOC__ {{Server client function}}<!-- Change this to "Client function" or "Server function" appropriately--> <!-- Describe in plain english what this function does...) |
No edit summary |
||
| Line 1: | Line 1: | ||
[[Category:Private]] | [[Category:Private]] | ||
__NOTOC__ | __NOTOC__ | ||
{{Server | {{Server function}}<!-- Change this to "Client function" or "Server function" appropriately--> | ||
<!-- Describe in plain english what this function does. Don't go into details, just give an overview --> | <!-- Describe in plain english what this function does. Don't go into details, just give an overview --> | ||
This | This function changes the password required to join the server to the given string. | ||
==Syntax== | ==Syntax== | ||
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd --> | <!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd --> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool setServerPassword ( string thePassword ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type --> | <!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type --> | ||
*''' | *'''thePassword:''' The new server password you want. Pass nil or an empty string to remove the password. | ||
===Returns=== | ===Returns=== | ||
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | <!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | ||
Returns ''true'' if | Returns ''true'' if the password was successfully changed or removed, ''false'' or ''nil'' otherwize. | ||
==Example== | ==Example== | ||
| Line 30: | Line 24: | ||
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized --> | <!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized --> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | --TODO | ||
mooo | mooo | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 40: | Line 32: | ||
{{FunctionArea_functions}} | {{FunctionArea_functions}} | ||
[[Category:Needs_Example]] <!-- leave this until the example is completed. --> | [[Category:Needs_Example]] <!-- leave this until the example is completed. --> | ||
Revision as of 16:56, 14 December 2007
This function changes the password required to join the server to the given string.
Syntax
bool setServerPassword ( string thePassword )
Required Arguments
- thePassword: The new server password you want. Pass nil or an empty string to remove the password.
Returns
Returns true if the password was successfully changed or removed, false or nil otherwize.
Example
This example does...
--TODO mooo