SetAccountName: Difference between revisions

Revision as of 05:21, 4 February 2021

This function sets the name of an account.

Syntax

bool setAccountName ( account theAccount, string name [, bool allowCaseVariations = false] )

OOP Syntax Help! I don't understand this!

Method: account:setName(...)

Variable: .name

Counterpart: getAccountName

Required Arguments

theAccount: The account you wish to change the name.
name: The new name.

Optional Arguments

allowCaseVariations: Whether the username is case sensitive (if this is set to true, usernames "Bob" and "bob" will refer to different accounts)

Returns

Returns a true if the account name was set, false if an invalid argument was specified.

Example

Change the name of an account.

addCommandHandler("changeaccountname", function(player, _, oldname, newname)
    if not oldname or not newname then
        return
    end
    local account = getAccount(oldname)
    if not account then
        return 
    end
    setAccountName(account, newname)
end)

@@ Line 37: / Line 37: @@
 ==See Also==
 {{Account_functions}}
+[[zh-cn:SetAccountName]]