SetAccountPassword: Difference between revisions

Latest revision as of 15:48, 12 April 2021

This function sets the password of the specified account.

[[{{{image}}}\|link=\|]]	Note: Don't forget to give admin rights to the resource, in which you are using setAccountPassword function or it won't work.

Syntax

bool setAccountPassword ( account theAccount, string password )

OOP Syntax Help! I don't understand this!

Method: account:setPassword(...)

Variable: .password

Required Arguments

theAccount: the account whose password you want to set
password: the password

[[{{{image}}}\|link=\|]]	Note: The password will always be encrypted with sha256, other types are no longer supported. See CAccountPassword for more information.

Returns

Returns true if the password was set correctly, false otherwise.

Limits

The following limits apply:

Minimum account password length is 1 character.
Maximum account password length is 30 characters.
Account password can not be equal to "*****"

Example

This example allows a user to change their password with a command.

function ChangePlayerPassword(player, command, oldpass, newpass)
	-- get the account the player is currently logged into
	local account = getPlayerAccount(player)
	if (account) then
		-- if its only a guest account, do not allow the password to be changed
		if (isGuestAccount(account)) then
			outputChatBox("You must be logged into an account to change your password.", player) 
			-- end the function
			return
		end
		
		-- check that the old password is correct
		local password_check = getAccount(getAccountName(account), oldpass)
		if (password_check) then
			-- check the length of the new password
			if (string.len(newpass)>=5) then
				setAccountPassword(account,newpass)
			else
				outputChatBox("Your new password must be at least 5 characters long.", player)
			end
		else
			outputChatBox("Old password invalid.", player)
		end
	end
end
addCommandHandler("changepass", ChangePlayerPassword)

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Server function}}
-<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
+This function sets the password of the specified [[account]].
-This fake function is for use with blah & blah and does blahblahblabhalbhl
+{{note| Don't forget to give admin rights to the resource, in which you are using setAccountPassword function or it won't work.}}
 ==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 -->
 <syntaxhighlight lang="lua">
-returnType functionName ( arguments )
+bool setAccountPassword ( account theAccount, string password )
 </syntaxhighlight>
+{{OOP||[[account]]:setPassword|password|}}
 ===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 -->
+*'''theAccount:''' the account whose password you want to set
-*'''argumentName:''' description
+*'''password:''' the password
+{{Note|The password will always be encrypted with '''sha256''', other types are no longer supported. See [https://github.com/multitheftauto/mtasa-blue/wiki/CAccountPassword CAccountPassword] for more information.}}
-<!-- Only include this section below if there are optional arguments -->
+===Returns===
-===Optional Arguments===
+Returns ''true'' if the password was set correctly, ''false'' otherwise.
-{{OptionalArg}}
-*'''argumentName2:''' description
-*'''argumentName3:''' description
-===Returns===
+===Limits===
-<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
+The following limits apply:
-Returns ''true'' if blah, ''false'' otherwise.
+* Minimum account password length is 1 character.
+* Maximum account password length is 30 characters.
+* Account password can not be equal to "*****"
 ==Example==
 <!-- Explain what the example is in a single sentance -->
-This example does...
+This example allows a user to change their password with a command.
 <!-- 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">
---This line does...
+function ChangePlayerPassword(player, command, oldpass, newpass)
-blabhalbalhb --abababa
+	-- get the account the player is currently logged into
---This line does this...
+	local account = getPlayerAccount(player)
-mooo
+	if (account) then
+		-- if its only a guest account, do not allow the password to be changed
+		if (isGuestAccount(account)) then
+			outputChatBox("You must be logged into an account to change your password.", player)
+			-- end the function
+			return
+		end
+		-- check that the old password is correct
+		local password_check = getAccount(getAccountName(account), oldpass)
+		if (password_check) then
+			-- check the length of the new password
+			if (string.len(newpass)>=5) then
+				setAccountPassword(account,newpass)
+			else
+				outputChatBox("Your new password must be at least 5 characters long.", player)
+			end
+		else
+			outputChatBox("Old password invalid.", player)
+		end
+	end
+end
+addCommandHandler("changepass", ChangePlayerPassword)
 </syntaxhighlight>
 ==See Also==
-<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
+{{Account functions}}
-{{FunctionArea_functions}}
-[[Category:Incomplete]]
+[[en:setAccountPassword]]
+[[ru:setAccountPassword]]
+[[ar:setAccountPassword]]
+[[es:setAccountPassword]]
+[[zh-cn:setAccountPassword]]