SetServerPassword: Difference between revisions

From Multi Theft Auto: Wiki
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
 
(13 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:Private]]
__NOTOC__  
__NOTOC__  
{{Server client function}}<!-- Change this to "Client function" or "Server function" appropriately-->
{{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 fake function is for use with blah & blah and does blahblahblabhalbhl
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">
returnType functionName ( arguments )
bool setServerPassword ( string thePassword )
</syntaxhighlight>  
</syntaxhighlight>  
[[File:Mta-screen 2020-04-27 16-22-06.png|thumb|Lock icon indicating a password protected server.]]


===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 -->
*'''argumentName:''' description
*'''thePassword:''' The new server password you want. Pass ''nil'' or an empty string to remove the password.
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===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 blah, ''false'' otherwise.
Returns ''true'' if the password was successfully changed or removed, ''false'' or ''nil'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example adds two commands for you to use: setpassword and removepassword.
This example does...
<!-- 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">
--This line does...
addCommandHandler( "setpassword", -- add a command handler for the command
blabhalbalhb --abababa
  function( thePlayer, command, password )
--This line does this...
      if #password < 3 then -- check if the password is shorter than 3 letters
mooo
        outputChatBox( "The password needs to be atleast 3 letters long!", thePlayer ) -- tell the player that password was too short
        return -- abort command
      end
      local success = setServerPassword( password ) -- check whether changing password worked
      if success then
        outputChatBox( "Server password change to: " .. password, thePlayer ) -- if it did, tell the player
      else
        outputChatBox( "Failed to change servers password.", thePlayer ) -- if it didn't, tell the player
      end
  end
)
 
addCommandHandler( "removepassword", -- add a command handler for the command
  function( thePlayer, command )
      local success = setServerPassword( nil ) -- check whether removing password worked
      if success then
        outputChatBox( "Server password removed successfully", thePlayer ) -- if it did, tell the player
      else
        outputChatBox( "Failed to remove servers password.", thePlayer ) -- if it didn't, tell the player
      end
  end
)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{FunctionArea_functions}}
{{Server functions}}
[[Category:Needs_Example]] <!-- leave this until the example is completed. -->
[[Category:Need_Syntax]] <!-- leave this until syntax is available. Cannot document the function or event without syntax. -->
[[Category:Incomplete]] <!-- leave this unless you complete the function -->

Latest revision as of 14:16, 27 April 2020

This function changes the password required to join the server to the given string.

Syntax

bool setServerPassword ( string thePassword )
Lock icon indicating a password protected server.

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 otherwise.

Example

This example adds two commands for you to use: setpassword and removepassword. 

addCommandHandler( "setpassword", -- add a command handler for the command
   function( thePlayer, command, password )
      if #password < 3 then -- check if the password is shorter than 3 letters
         outputChatBox( "The password needs to be atleast 3 letters long!", thePlayer ) -- tell the player that password was too short
         return -- abort command
      end
      local success = setServerPassword( password ) -- check whether changing password worked
      if success then
         outputChatBox( "Server password change to: " .. password, thePlayer ) -- if it did, tell the player
      else
         outputChatBox( "Failed to change servers password.", thePlayer ) -- if it didn't, tell the player
      end
   end
)

addCommandHandler( "removepassword", -- add a command handler for the command
   function( thePlayer, command )
      local success = setServerPassword( nil ) -- check whether removing password worked
      if success then
         outputChatBox( "Server password removed successfully", thePlayer ) -- if it did, tell the player
      else
         outputChatBox( "Failed to remove servers password.", thePlayer ) -- if it didn't, tell the player
      end
   end
)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetServerPassword?oldid=66170"