RemoveAccount: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Добавление языков)
 
(17 intermediate revisions by 13 users not shown)
Line 1: Line 1:
__NOTOC__  
{{Server function}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
__NOTOC__
This fake function is for use with blah & blah and does blahblahblabhalbhl
This function is used to delete existing player [[account]]s.


==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 -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool removeAccount ( account theAccount )
bool removeAccount ( account theAccount )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[account]]:remove||}}


===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 -->
*'''theAccount:''' The account you wish to remove
*'''argumentName:''' description
 
<!-- 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 -->
Returns ''true'' if account was successfully removed, ''false'' if the account does not exist.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example does...
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...
function onCmdDeregister ( playerSource, commandName )
blabhalbalhb --abababa
-- grab the account
--This line does this...
local sourceAccount = getPlayerAccount ( playerSource )
mooo
if sourceAccount then
removeAccount ( sourceAccount )
outputChatBox ( "Account deregistered for " .. getPlayerName ( playerSource ) )
else
outputChatBox ( "Unable to get your account, make sure you are logged in", playerSource )
end
end
addCommandHandler("deregister",onCmdDeregister)
</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}}
{{Account_functions}}
[[Category:Incomplete]]
 
[[en:removeAccount]]
[[ru:removeAccount]]
[[ar:removeAccount]]

Latest revision as of 15:20, 12 April 2021

This function is used to delete existing player accounts.

Syntax

bool removeAccount ( account theAccount )

OOP Syntax Help! I don't understand this!

Method: account:remove(...)


Required Arguments

  • theAccount: The account you wish to remove

Returns

Returns true if account was successfully removed, false if the account does not exist.

Example

This example does... 

function onCmdDeregister ( playerSource, commandName )
	-- grab the account
	local sourceAccount = getPlayerAccount ( playerSource )
	if sourceAccount then
		removeAccount ( sourceAccount )
		outputChatBox ( "Account deregistered for " .. getPlayerName ( playerSource ) )
	else 
		outputChatBox ( "Unable to get your account, make sure you are logged in", playerSource )
	end
end
 
addCommandHandler("deregister",onCmdDeregister)

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/RemoveAccount?oldid=70112"