AddAccount: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 4: Line 4:


==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 -->
{{New feature/item|3|1.0|848|
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
account addAccount ( string name, string pass )
account addAccount ( string name, string pass )
</syntaxhighlight>
</syntaxhighlight>
}}
{{Deprecated_feature|3|1.0|
<syntaxhighlight lang="lua">
bool addAccount ( string name, string pass )
</syntaxhighlight>
}}


===Required Arguments===  
===Required Arguments===  
Line 22: Line 14:


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
{{New feature|3|1.0 r848|
Returns an [[account]] or ''false'' if the account already exists or an error occured.
Returns an [[account]] or ''false'' if the account already exists or an error occured.
}}
 
{{Deprecated_feature|3|1.0|
===Limits===
Returns ''true'' if the account was created, ''false'' if the account already exists or an error occured.
*'''name:'''
}}
** Minimal account name length is 1 character.
** Account names are case-sensitive.
** Account name can not be equal to "*****"
*'''pass:'''
** Minimal account password length is 1 character.
** Maximum account password length is 30 characters.
** Account password can not be equal to "*****"


==Example==  
==Example==  

Revision as of 06:28, 27 June 2014

This function adds an account to the list of registered accounts of the current server.

Syntax

account addAccount ( string name, string pass )

Required Arguments

  • name: The name of the account you wish to make, this normally is the player's name.
  • pass: The password to set for this account for future logins.

Returns

Returns an account or false if the account already exists or an error occured.

Limits

  • name:
    • Minimal account name length is 1 character.
    • Account names are case-sensitive.
    • Account name can not be equal to "*****"
  • pass:
    • Minimal account password length is 1 character.
    • Maximum account password length is 30 characters.
    • Account password can not be equal to "*****"

Example

Click to collapse [-]
Server

Example 1: This enables players to register on your server by using /register <password> in the chat window. 

function registerPlayer ( source, commandName, password )
	-- Check if the password field is blank or not (only blank if they didnt enter one)
	if ( password ~= "" and password ~= nil ) then
		--Attempt to add the account, and save its value in a var
		local accountAdded = addAccount( getPlayerName(source), password )
		if ( accountAdded ) then
			--  Tell the user all is done
			outputChatBox ( "Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login", source )
		else
			-- There was an error making the account, tell the user
			outputChatBox ( "Error creating account, contact the server admin", source )
		end
	else
		-- There was an error in the syntax, tell the user the correct syntax.
		outputChatBox ( "Error creating account, correct syntax: /register <password>", source )
	end
end
addCommandHandler ( "register", registerPlayer ) -- add the command handler

This code differs by allowing the user to change their username that they wish to use.

Example 2: This enables players to register on your server by using /register <username> <password> in the chat window. 

function registerPlayer ( source, commandName, username, password )
        if(password ~= "" and password ~= nil and username ~= "" and username ~= nil) then
                local accountAdded = addAccount(username,password)
                if(accountAdded) then
                        outputChatBox("Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login",source)
                else
                        outputChatBox("Error creating account, contact the server admin.",source)
                end
        else
                outputChatBox("Error creating account, correct syntax: /register <nick> <pass>",source)
        end
end
addCommandHandler ( "register", registerPlayer ) -- add the command handler

Example 3: This code differs again so the user can only register once /register <username> <password>. 

local bRegisteredOnce = false

function registerPlayer ( source, commandName, username, password )
        if(password ~= "" and password ~= nil and username ~= "" and username ~= nil and bRegisteredOnce == false) then
                local accountAdded = addAccount(username,password)
                if(accountAdded) then
                        outputChatBox("Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login",source)
                        bRegisteredOnce = true
                else
                        outputChatBox("Error creating account, contact the server admin.",source)
                end
        else
                if bRegisteredOnce == true then
                    outputChatBox("You already registered on this server!",source)
                else
                    outputChatBox("Error creating account, correct syntax: /register <nick> <pass>",source)
                end
        end
end
addCommandHandler ( "register", registerPlayer ) -- add the command handler

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/AddAccount?oldid=40360"