Multi Theft Auto: Wiki - User contributions [en]

GetAccounts

2010-01-29T18:21:15Z

Milkshake333: /* Example */

__NOTOC__
{{Server function}}
This function returns a table over all the accounts that exist in the server accounts.xml file.
==Syntax==
<syntaxhighlight lang="lua">
table getAccounts ()
</syntaxhighlight>

===Returns===
A [[table]] over the accounts that exist in the server accounts.xml file. This table might be empty.

==Example==
<syntaxhighlight lang="lua">
function printAmountOfAccounts ( thePlayer )
local accountTable = getAccounts () -- return the table over accounts
if #accountTable == 0 then -- if the table is empty
outputChatBox( "There are no accounts. :(", thePlayer )
else -- table isn't empty
outputChatBox( "There are " .. #accountTable .. " accounts in this server!", thePlayer )
end
end
addCommandHandler( "accountcount", printAmountOfAccounts ) -- add a command handler for command 'accountcount'
</syntaxhighlight>

==See Also==
{{Account functions}}

GetAccounts

2010-01-29T18:20:59Z

Milkshake333: /* Example */

__NOTOC__
{{Server function}}
This function returns a table over all the accounts that exist in the server accounts.xml file.
==Syntax==
<syntaxhighlight lang="lua">
table getAccounts ()
</syntaxhighlight>

===Returns===
A [[table]] over the accounts that exist in the server accounts.xml file. This table might be empty.

==Example==
<syntaxhighlight lang="lua">
function printAmountOfAccounts ( thePlayer )
local accountTable = getAccounts () -- return the table over accounts
if #accountTable == 0 then -- if the table is empty
outputChatBox( "There is no accounts. :(", thePlayer )
else -- table isn't empty
outputChatBox( "There are " .. #accountTable .. " accounts in this server!", thePlayer )
end
end
addCommandHandler( "accountcount", printAmountOfAccounts ) -- add a command handler for command 'accountcount'
</syntaxhighlight>

==See Also==
{{Account functions}}

GetAccount

2010-01-02T14:42:11Z

Milkshake333: /* Example */

__NOTOC__
{{Server function}}
This function returns an account for a specific user.
==Syntax==
<syntaxhighlight lang="lua">
account getAccount ( string username, [ string password ] )
</syntaxhighlight>

===Required Arguments===
*'''username:''' The username of the account you want to retrieve

===Optional Arguments===
{{OptionalArg}}
*'''password:''' The password for the account. If this argument is not specified, you can get the account whatever password it is, otherwise the password must match the account's.

===Returns===
An ''account'' value or ''false'' if an account matching the username specified (and password, if specified) could not be found.

==Example==
<syntaxhighlight lang="lua">
function retAccount ( username, password ) --both arguements are strings
if getAccount( username, password ) then
return getAccount( username, password )
else
return false
end
end
</syntaxhighlight>

==See Also==
{{Account functions}}

[[pl:GetAccount]]

AddBan

2010-01-01T13:10:44Z

Milkshake333: /* Example */

AddBan

2010-01-01T13:03:38Z

Milkshake333: /* Example */

__NOTOC__
{{Server function}}
This function will add a ban for the specified IP/username/serial to the server.

==Syntax==
<syntaxhighlight lang="lua">
ban addBan ( [ string IP, string Username, string Serial, player responsibleElement, string reason, int seconds = 0 ] )
</syntaxhighlight>
'''Note:''' One of the three: IP, Username or Serial have to be specified.

===Required Arguments===
*'''IP:''' The IP to be banned. If you don't want to ban by IP, set this to ''nil''.
'''or'''
*'''Username:''' The username to be banned. If you don't want to ban by username, set this to ''nil''.
'''or'''
*'''Serial:''' The serial to be banned. If you don't want to ban by serial, set this to ''nil''.
''' or any combination.'''

===Optional Arguments===
{{OptionalArg}}
*'''responsibleElement:''' The element that is responsible for banning the IP/username/serial. This can be a player or the root ([[getRootElement]]()).
*'''reason:''' The reason the IP/username/serial will be banned from the server.
*'''seconds:''' The amount of seconds the player will be banned from the server for. This can be 0 for an infinite amount of time.

===Returns===
Returns ''true'' if the IP/username/serial was banned succesfully, ''false'' if invalid arguments are specified.

==Example==
<syntaxhighlight lang="lua">
function banPlayer( thePlayer, theCommand, theTarget, theReason, theSeconds )
if theTarget and theReason then
local target = getPlayerFromName(theTarget)
if target == false then --Check if there is someone online with that name
outputChatbox("There isn't someone online with that name.", thePlayer)
return
end
if hasObjectPermissionTo( thePlayer, "function.addBan", false) then
--Check if the player has the permission to ban someone
if hasObjectPermissionTo( getThisResource(), "function.addBan", true) then
--Check if this resource has the permission to ban a player
if theSeconds then
--If there is a time specified we use it
addBan(theTarget, thePlayer, theReason, tonumber(theSeconds))
--We ban the target by it's name.
else
--If there wasn't a time specified
addBan(theTarget, thePlayer, theReason)
--Ban him permanent
end
else
--If the resource doesn't have the permission to use addBan
outputChatBox("This resource has not acces to use the addBan function.", thePlayer)
end
else
--If the user doesn't have the permission to use addBan
outputChatBox("You do not have the acces to use the addBan function.", thePlayer)
end
else
--Tell the syntax to the player
outputChatBox("Syntax: /ban targetname reason (seconds)", thePlayer)
end
end
addCommandHandler("ban", banPlayer)
</syntaxhighlight>

==See Also==
{{Admin functions}}
[[Category:Needs Example]]
[[ru:addBan]]

AddBan

2010-01-01T12:47:15Z

Milkshake333: /* Example */