Multi Theft Auto: Wiki - User contributions [en]

Template:Account functions

2012-03-01T17:15:07Z

OpenIDUser34:

*[[addAccount]]
*[[copyAccountData]]
*[[getAccount]]
*[[getAccountData]]
*[[getAccountName]]
{{New items|3|1.0|
*[[getAccountPlayer]]
}}
*[[getAccounts]]
*[[isGuestAccount]]
*[[logIn]]
*[[logOut]]
*[[removeAccount]]
*[[setAccountData]]
*[[setAccountPassword]]
{{Deprecated items|3|1.0|
*[[getAccountClient]]
}}
*[[getAllAccountData]]
<noinclude>
[[Category:Functions templates]]
</noinclude>

GetAccountAllData

2012-03-01T17:11:45Z

OpenIDUser34: moved GetAccountAllData to GetAllAccountData: changed function name

#REDIRECT [[GetAllAccountData]]

GetAllAccountData

2012-03-01T17:11:45Z

OpenIDUser34: moved GetAccountAllData to GetAllAccountData: changed function name

__NOTOC__
{{Server function}}
This function returns a table containing all the user data for the account provided
==Syntax==
<syntaxhighlight lang="lua">
table getAccountAllData ( account theAccount )
</syntaxhighlight>

===Returns===
A [[table]] containing all the user data. This table might be empty.

==Example==
<syntaxhighlight lang="lua">
function printAllData ( thePlayer )
local playerAccount = getPlayerAccount( thePlayer ) -- get his account
if ( playerAccount ) then -- if we got the account then
local data = getAccountAllData( playerAccount ) -- get data
count = 0
for _ in pairs(data) do count = count + 1 end -- get the count
outputChatBox ( "table holds " .. count .. " entries" ) -- output number of rows
if ( data ) then
for k,v in pairs ( data ) do
outputChatBox(k..": "..v) -- print the key and value of each entry of data
end
end
end
end
addCommandHandler( "getall", printAllData ) -- add a command handler for command 'getall'
</syntaxhighlight>

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

SetPedAnimationProgress

2012-02-28T23:09:36Z

OpenIDUser34:

__NOTOC__
{{Server client function}}

Sets the current animation progress of a player or ped.

==Syntax==
<syntaxhighlight lang="lua">
bool setPedAnimationProgress ( ped thePed [, string anim, float progress] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the player or ped you want to change animation progress.

===Optional Arguments===
*'''anim:''' the animation name currently applied to ped, if not supplied, the animation will stop
*'''progress:''' current animation progress you want to apply, value from 0.0 to 1.0, if not supplied will default to 0.0

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==

<section name="Server" class="server" show="true">
This example creates a ped, apply animation to it, and "freeze" the animation at half of overall animation time.
<syntaxhighlight lang="lua">
function animRender( ped1 )
setPedAnimationProgress(ped1, "M_SMKSTND_LOOP", 0.5)
setTimer ( animRender, 50, 1, ped1 )
end

function makePed()
local ped1 = createPed(56, 1, 1, 4)
setPedAnimation( ped1, "SMOKING", "M_SMKSTND_LOOP")
setTimer ( animRender, 50, 1, ped1 )
end
addCommandHandler("makemyped", makePed)
</syntaxhighlight>
</section>

==See Also==
{{Ped_functions}}
[[ru:setPedAnimationProgress]]

OnClientSoundStopped

2012-02-28T13:37:38Z

OpenIDUser34:

{{Client event}}
__NOTOC__
This event is triggered when a '''sound''' is stopped.

==Parameters==
<syntaxhighlight lang="lua">
string reason
</syntaxhighlight>

*'''reason''': the reason the '''sound''' was stopped, can be "finished", "paused" or "destroyed".

==Source==
The [[event system#Event source|source]] of this event is the [[Element/Sound|sound's element]].

==Example==
This example outputs the reason the sound stopped.
<syntaxhighlight lang="lua">
function onSoundStopped ( reason )
if ( reason == "destroyed" ) then
outputChatBox ( "sound destroyed" )
elseif ( reason == "finished" ) then
outputChatBox ( "end of sound" )
elseif ( reason == "paused" ) then
outputChatBox ( "sound paused" )
end
end
addEventHandler ( "onClientSoundStopped", getRootElement(), onSoundStopped )
);
</syntaxhighlight>

==See Also==
===Client sound events===
{{Sound_events}}
===Client event functions===
{{Client_event_functions}}

OnClientSoundStarted

2012-02-28T13:35:09Z

OpenIDUser34:

{{Client event}}
__NOTOC__
This event is triggered when a '''sound''' is started.

==Parameters==
<syntaxhighlight lang="lua">
string reason
</syntaxhighlight>

*'''reason''': the reason the '''sound''' was started, can be "play" or "resumed".

==Source==
The [[event system#Event source|source]] of this event is the [[Element/Sound|sound's element]].

==Example==
This example outputs the reason the sound started .
<syntaxhighlight lang="lua">
function onSoundStarted ( reason )
if ( reason == "play" ) then
outputChatBox ( "sound started" )
elseif ( reason == "resumed" ) then
outputChatBox ( "sound resumed" )
end
end
addEventHandler ( "onClientSoundStarted", getRootElement(), onSoundStarted )
);
</syntaxhighlight>

==See Also==
===Client sound events===
{{Sound_events}}
===Client event functions===
{{Client_event_functions}}

OnClientSoundStarted

2012-02-28T13:34:29Z

OpenIDUser34:

{{Client event}}
__NOTOC__
This event is triggered when a ''sound''' is started.

==Parameters==
<syntaxhighlight lang="lua">
string reason
</syntaxhighlight>

*'''reason''': the reason the '''sound''' was started, can be "play" or "resumed".

==Source==
The [[event system#Event source|source]] of this event is the [[Element/Sound|sound's element]].

==Example==
This example outputs the reason the sound started .
<syntaxhighlight lang="lua">
function onSoundStarted ( reason )
if ( reason == "play" ) then
outputChatBox ( "sound started" )
elseif ( reason == "resumed" ) then
outputChatBox ( "sound resumed" )
end
end
addEventHandler ( "onClientSoundStarted", getRootElement(), onSoundStarted )
);
</syntaxhighlight>

==See Also==
===Client sound events===
{{Sound_events}}
===Client event functions===
{{Client_event_functions}}

OnClientFileDownloadComplete

2012-02-27T17:22:00Z

OpenIDUser34:

{{Client event}}
__NOTOC__
This event is triggered when a file has been downloaded after [[downloadFile]] has been successfully called.

==Parameters==
<syntaxhighlight lang="lua">
string fileName, bool success
</syntaxhighlight>

*'''fileName''': the file downloaded.
*'''success''': whether successful or not.

==Source==
The [[event system#Event source|source]] of this event is the [[root element]] of the resource that called [[downloadFile]].

==Example==
This example plays a sound if it was downloaded successfully
<syntaxhighlight lang="lua">
function onDownloadFinish ( file, success )
if ( source == resourceRoot ) then -- if the file relates to this resource
if ( success ) then -- if the file was downloaded successfully
if ( file == "test.mp3" ) then -- if the file name is what we were expecting
currentTrack = playSound ( "test.mp3" )
end
else -- if the file wasn't downloaded successfully
if ( file == "test.mp3" ) then
outputChatBox ( "test.mp3 failed to download" )
end
end
end
end
addEventHandler ( "onClientFileDownloadComplete", getRootElement(), onDownloadFinish )
</syntaxhighlight>

==See Also==
===Other client events===
{{Client_other_events}}
===Client event functions===
{{Client_event_functions}}

OnClientFileDownloadComplete

2012-02-27T17:16:38Z

OpenIDUser34:

{{Client event}}
__NOTOC__
This event is triggered when a file has been downloaded after [[downloadFile]] has been successfully called.

==Parameters==
<syntaxhighlight lang="lua">
string fileName, bool success
</syntaxhighlight>

*'''fileName''': the file downloaded.
*'''success''': whether successful or not.

==Source==
The [[event system#Event source|source]] of this event is the [[root element]] of the resource that called [[downloadFile]].

==Example==
This example plays a sound if it was downloaded successfully
<syntaxhighlight lang="lua">
function onDownloadFinish ( file, success )
if ( source == resourceRoot ) then
if ( success ) then
if ( file == "test.mp3" ) then
currentTrack = playSound ( "test.mp3" )
end
else
if ( file == "test.mp3" ) then
outputChatBox ( "test.mp3 failed to download" )
end
end
end
end
addEventHandler ( "onClientFileDownloadComplete", getRootElement(), onDownloadFinish )
</syntaxhighlight>

==See Also==
===Other client events===
{{Client_other_events}}
===Client event functions===
{{Client_event_functions}}

OnClientFileDownloadComplete

2012-02-22T22:13:14Z

OpenIDUser34:

__NOTOC__
{{Client event}}

my test example until I get a chance to document properly

<syntaxhighlight lang="lua">
currentTrack = nil
function onStart ( )
downloadFile ( "test.mp3" )
end
addEventHandler ( "onClientResourceStart", getRootElement(), onStart )

function onDownloadFinish ( file, success )
if ( success ) then
if ( file == "test.mp3" ) then
currentTrack = playSound ( "test.mp3" )
end
else
if ( file == "test.mp3" ) then
outputChatBox ( "test.mp3 failed to download" )
end
end
end
addEventHandler ( "onClientFileDownloadComplete", getRootElement(), onDownloadFinish )

function onSoundStopped ( reason )
if ( source == currentTrack ) then
if ( reason == "destroyed" ) then
outputChatBox ( "sound destroyed" )
elseif ( reason == "finished" ) then
outputChatBox ( "end of sound" )
elseif ( reason == "paused" ) then
outputChatBox ( "sound paused" )
end
end
end
addEventHandler ( "onClientSoundStopped", getRootElement(), onSoundStopped )

function onSoundStarted ( reason )
if ( reason == "play" ) then
outputChatBox ( "sound started" )
elseif ( reason == "resumed" ) then
outputChatBox ( "sound resumed" )
end
end
addEventHandler ( "onClientSoundStarted", getRootElement(), onSoundStarted )

function stopSoundFunction ()
stopSound ( currentTrack )
end
addCommandHandler ( "stop1", stopSoundFunction )

function songPause()
local pause = isSoundPaused ( currentTrack )
if ( pause == true ) then
setSoundPaused ( currentTrack, false )
else
setSoundPaused ( currentTrack, true )
end
end
addCommandHandler("pause", songPause)

function startSoundFunction ()
currentTrack = playSound ( "test.mp3" )
end
addCommandHandler ( "start1", startSoundFunction )
</syntaxhighlight>

==See Also==
===Other client events===
{{Client_other_events}}

OnClientFileDownloadComplete

2012-02-22T22:07:42Z

OpenIDUser34:

__NOTOC__
{{Client event}}

my test example until I get a chance to document properly

<syntaxhighlight lang="lua">
currentTrack = nil
function onStart ( )
downloadFile ( "test.mp3" )
end
addEventHandler ( "onClientResourceStart", getRootElement(), onStart )

function onDownloadFinish ( file, success )
if ( success ) then
if ( file == "test.mp3" ) then
currentTrack = playSound ( "test.mp3" )
end
else
if ( file == "test.mp3" ) then
outputChatBox ( "test.mp3 failed to download" )
end
end
end
addEventHandler ( "onClientFileDownloadComplete", getRootElement(), onDownloadFinish )

function onSoundStopped ( reason )
if ( source == currentTrack ) then
if ( reason == "destroyed" ) then
outputChatBox ( "sound destroyed" )
elseif ( reason == "finished" ) then
outputChatBox ( "end of sound" )
elseif ( reason == "paused" ) then
outputChatBox ( "sound paused" )
end
end
end
addEventHandler ( "onClientSoundStopped", getRootElement(), onSoundStopped )

function onSoundStarted ( reason )
if ( source == currentTrack ) then
if ( reason == "play" ) then
outputChatBox ( "sound started" )
elseif ( reason == "resumed" ) then
outputChatBox ( "sound resumed" )
end
end
end
addEventHandler ( "onClientSoundStarted", getRootElement(), onSoundStarted )

function stopSoundFunction ()
stopSound ( currentTrack )
end
addCommandHandler ( "stop1", stopSoundFunction )

function songPause()
local pause = isSoundPaused ( currentTrack )
if ( pause == true ) then
setSoundPaused ( currentTrack, false )
else
setSoundPaused ( currentTrack, true )
end
end
addCommandHandler("pause", songPause)

function startSoundFunction ()
currentTrack = playSound ( "test.mp3" )
end
addCommandHandler ( "start1", startSoundFunction )
</syntaxhighlight>

==See Also==
===Other client events===
{{Client_other_events}}

OnClientSoundStopped

2012-02-22T22:06:01Z

OpenIDUser34: Created page with "{{Client_Function}} test example until properly documented <syntaxhighlight lang="lua"> function onSoundStopped ( reason ) if ( source == currentTrack ) then if ( reason == "destroyed" ) t..."

{{Client_Function}}

test example until properly documented

<syntaxhighlight lang="lua">
function onSoundStopped ( reason )
if ( source == currentTrack ) then
if ( reason == "destroyed" ) then
outputChatBox ( "sound destroyed" )
elseif ( reason == "finished" ) then
outputChatBox ( "end of sound" )
elseif ( reason == "paused" ) then
outputChatBox ( "sound paused" )
end
end
end
addEventHandler ( "onClientSoundStopped", getRootElement(), onSoundStopped )
</syntaxhighlight>

==See Also==
===Client sound events===
{{Sound_events}}
===Client event functions===
{{Client_event_functions}}

OnClientSoundStarted

2012-02-22T22:05:53Z

OpenIDUser34: Created page with "{{Client_Function}} test example until properly documented <syntaxhighlight lang="lua"> function onSoundStarted ( reason ) if ( source == currentTrack ) then if ( reason == "play" ) then ..."

{{Client_Function}}

test example until properly documented

<syntaxhighlight lang="lua">
function onSoundStarted ( reason )
if ( source == currentTrack ) then
if ( reason == "play" ) then
outputChatBox ( "sound started" )
elseif ( reason == "resumed" ) then
outputChatBox ( "sound resumed" )
end
end
end
addEventHandler ( "onClientSoundStarted", getRootElement(), onSoundStarted )
</syntaxhighlight>

==See Also==
===Client sound events===
{{Sound_events}}
===Client event functions===
{{Client_event_functions}}

OnClientSoundChangedMeta

2012-02-22T22:05:47Z

OpenIDUser34:

__NOTOC__
{{Client event}}
This event is triggered when a sound's meta tags have been modified.

==Parameters==
<syntaxhighlight lang="lua">
string streamTitle
</syntaxhighlight>

*'''streamTitle''': The title of a specific stream

==Source==
The [[event system#Event source|source]] of this event is the [[sound]] of which the meta tags have just been modified.

==Example==

<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

==See Also==
===Client sound events===
{{Sound_events}}
===Client event functions===
{{Client_event_functions}}

[[Category:Needs_Example]]

Template:Sound events

2012-02-22T22:03:50Z

OpenIDUser34:

{{New items|3.0110|1.1|
* [[onClientSoundChangedMeta]]
* [[onClientSoundFinishedDownload]]
* [[onClientSoundStream]]
}}
{{New items|3.0152|1.3.1|
* [[onClientSoundStarted]]
* [[onClientSoundStopped]]
}}
<noinclude>[[Category:Events templates]]</noinclude>

DownloadFile

2012-02-22T19:26:19Z

OpenIDUser34:

{{Client function}}
__NOTOC__
This function downloads a file from the HTTP server. This can only be used on files on the HTTP server associated with the MTA server and will only download files from within the folder of the resource that is calling it. The '''file''' should also be included in meta.xml with the '''download''' attribute set to "false", see [[meta.xml]] for more details. If the file has been previously downloaded and the CRC matches, the file will not be downloaded again but [[onClientFileDownloadComplete]] will still run.

==Syntax==
<syntaxhighlight lang="lua">
bool downloadFile ( string fileName )
</syntaxhighlight>

===Required Arguments===
* '''fileName''': A string referencing the name of the file to download

===Returns===
Returns ''true'' if file download has been queued, ''false'' otherwise.

==Example==
'''Example 1:''' This client side event downloads a file when the resource has started.
<syntaxhighlight lang="lua">
-- the function is called, since the local player never changes)
function onStart ( )
downloadFile ( "test.txt" )
end
addEventHandler ( "onClientResourceStart", getRootElement(), onStart )
</syntaxhighlight>

==See Also==
{{Client_utility_functions}}

OnClientFileDownloadComplete

2012-02-22T11:29:51Z

OpenIDUser34:

__NOTOC__
{{Client event}}

my test example until I get a chance to document properly

<syntaxhighlight lang="lua">
function onStart ( )
outputChatBox ( "downloading test.mp3" )
downloadFile ( "test.mp3" )
end
addEventHandler ( "onClientResourceStart", getRootElement(), onStart )

function onDownloadFinish ( file, success )
if ( success ) then
if ( file == "test.mp3" ) then
outputChatBox ( "test.mp3 downloaded successfully" )
playSound ( "test.mp3" )
outputChatBox ( "playing test.mp3" )
end
else
if ( file == "test.mp3" ) then
outputChatBox ( "test.mp3 failed to download" )
end
end
end
addEventHandler ( "onClientFileDownloadComplete", getRootElement(), onDownloadFinish )
</syntaxhighlight>

==See Also==
===Other client events===
{{Client_other_events}}

OnFileDownloadComplete

2012-02-22T11:24:20Z

OpenIDUser34: Blanked the page

OnFileDownloadComplete

2012-02-22T11:23:51Z

OpenIDUser34: moved OnFileDownloadComplete to OnClientFileDownloadComplete

#REDIRECT [[OnClientFileDownloadComplete]]

OnClientFileDownloadComplete

2012-02-22T11:23:51Z

OpenIDUser34: moved OnFileDownloadComplete to OnClientFileDownloadComplete

__NOTOC__
{{Client event}}

my test example until I get a chance to document properly

<syntaxhighlight lang="lua">
function onStart ( )
outputChatBox ( "downloading test.mp3" )
downloadFile ( "test.mp3" )
end
addEventHandler ( "onClientResourceStart", getRootElement(), onStart )

function onDownloadFinish ( file, success )
if ( success ) then
if ( file == "test.mp3" ) then
outputChatBox ( "test.mp3 downloaded successfully" )
playSound ( "test.mp3" )
outputChatBox ( "playing test.mp3" )
end
else
if ( file == "test.mp3" ) then
outputChatBox ( "test.mp3 failed to download" )
end
end
end
addEventHandler ( "onFileDownloadComplete", getRootElement(), onDownloadFinish )
</syntaxhighlight>

==See Also==
===Other client events===
{{Client_other_events}}

Template:Client other events

2012-02-22T11:23:32Z

OpenIDUser34:

*[[onClientConsole]]
{{New items|3.0110|1.1|
*[[onClientDebugMessage]]
*[[onClientHUDRender]]
*[[onClientMinimize]]
*[[onClientRestore]]
}}
*[[onClientRender]]
*[[onClientExplosion]]
*[[onClientChatMessage]]
*[[onClientPreRender]]
{{New items|3.0151|1.3.1|
*[[onClientFileDownloadComplete]]
}}
<noinclude>[[Category:Events templates]]</noinclude>

Template:Client utility functions

2012-02-22T11:21:20Z

OpenIDUser34:

* [[getDistanceBetweenPoints2D]]
* [[getDistanceBetweenPoints3D]]
* [[getEasingValue]]
* [[interpolateBetween]]
* [[getRealTime]]
* [[getTickCount]]
* [[getTimerDetails]]
* [[getNetworkStats]]
* [[setClipboard]]
* [[getTimers]]
* [[gettok]]
* [[killTimer]]
* [[resetTimer]]
* [[setTimer]]
* [[split]]
* [[getVersion]]
* [[isTimer]]
* [[md5]]
* [[tocolor]]

* [[utfChar]]
* [[utfCode]]
* [[utfLen]]
* [[utfSeek]]
* [[utfSub]]
{{New items|3.0120|1.2|
* [[toJSON]]
* [[fromJSON]]
* [[setDevelopmentMode]]
* [[getDevelopmentMode]]
}}
{{New items|3.0151|1.3.1|
* [[downloadFile]]
}}
<noinclude>[[Category:Functions templates]]</noinclude>

OnClientFileDownloadComplete

2012-02-22T11:20:37Z

OpenIDUser34:

__NOTOC__
{{Client event}}

my test example until I get a chance to document properly

<syntaxhighlight lang="lua">
function onStart ( )
outputChatBox ( "downloading test.mp3" )
downloadFile ( "test.mp3" )
end
addEventHandler ( "onClientResourceStart", getRootElement(), onStart )

function onDownloadFinish ( file, success )
if ( success ) then
if ( file == "test.mp3" ) then
outputChatBox ( "test.mp3 downloaded successfully" )
playSound ( "test.mp3" )
outputChatBox ( "playing test.mp3" )
end
else
if ( file == "test.mp3" ) then
outputChatBox ( "test.mp3 failed to download" )
end
end
end
addEventHandler ( "onFileDownloadComplete", getRootElement(), onDownloadFinish )
</syntaxhighlight>

==See Also==
===Other client events===
{{Client_other_events}}

Template:Client other events

2012-02-22T11:20:23Z

OpenIDUser34:

*[[onClientConsole]]
{{New items|3.0110|1.1|
*[[onClientDebugMessage]]
*[[onClientHUDRender]]
*[[onClientMinimize]]
*[[onClientRestore]]
}}
*[[onClientRender]]
*[[onClientExplosion]]
*[[onClientChatMessage]]
*[[onClientPreRender]]
{{New items|3.0151|1.3.1|
*[[onFileDownloadComplete]]
}}
<noinclude>[[Category:Events templates]]</noinclude>

Template:Client other events

2012-02-22T11:17:03Z

OpenIDUser34:

*[[onClientConsole]]
{{New items|3.0110|1.1|
*[[onClientDebugMessage]]
*[[onClientHUDRender]]
*[[onClientMinimize]]
*[[onClientRestore]]
}}
*[[onClientRender]]
*[[onClientExplosion]]
*[[onClientChatMessage]]
*[[onClientPreRender]]
*[[onFileDownloadComplete]]
<noinclude>[[Category:Events templates]]</noinclude>

Template:Admin functions

2012-02-22T11:15:56Z

OpenIDUser34:

*[[banPlayer]]
*[[kickPlayer]]
{{New items|3|1.0|
*[[addBan]]
*[[getBanAdmin]]
*[[getBanIP]]
*[[getBanNick]]
*[[getBanReason]]
*[[getBans]]
*[[getBanSerial]]
*[[getBanTime]]
*[[getBanUsername]]
*[[getUnbanTime]]
*[[removeBan]]
}}
{{Deprecated items|3|1.0|
*[[banIP]]
*[[banSerial]]
*[[getBansXML]]
*[[unbanIP]]
*[[unbanSerial]]
}}
*[[reloadBans]]
<noinclude>[[Category:Functions templates]]</noinclude>

Template:Admin functions

2012-02-22T11:15:41Z

OpenIDUser34:

*[[banPlayer]]
*[[kickPlayer]]
{{New items|3|1.0|
*[[addBan]]
*[[getBanAdmin]]
*[[getBanIP]]
*[[getBanNick]]
*[[getBanReason]]
*[[getBans]]
*[[getBanSerial]]
*[[getBanTime]]
*[[getBanUsername]]
*[[getUnbanTime]]
*[[removeBan]]
}}
{{Deprecated items|3|1.0|
*[[banIP]]
*[[banSerial]]
*[[getBansXML]]
*[[unbanIP]]
*[[unbanSerial]]
}}
{{New items|4|1.3.1|
*[[reloadBans]]
}}
<noinclude>[[Category:Functions templates]]</noinclude>

Template:Admin functions

2012-02-22T11:12:47Z

OpenIDUser34:

*[[banPlayer]]
*[[kickPlayer]]
{{New items|3|1.0|
*[[addBan]]
*[[getBanAdmin]]
*[[getBanIP]]
*[[getBanNick]]
*[[getBanReason]]
*[[getBans]]
*[[getBanSerial]]
*[[getBanTime]]
*[[getBanUsername]]
*[[getUnbanTime]]
*[[removeBan]]
}}
{{Deprecated items|3|1.0|
*[[banIP]]
*[[banSerial]]
*[[getBansXML]]
*[[unbanIP]]
*[[unbanSerial]]
}}
{{New items|3|1.3.1|
*[[reloadBans]]
}}
<noinclude>[[Category:Functions templates]]</noinclude>

Template:Admin functions

2012-02-22T11:11:59Z

OpenIDUser34:

Template:Client utility functions

2012-02-22T11:11:18Z

OpenIDUser34:

* [[getDistanceBetweenPoints2D]]
* [[getDistanceBetweenPoints3D]]
* [[getEasingValue]]
* [[interpolateBetween]]
* [[getRealTime]]
* [[getTickCount]]
* [[getTimerDetails]]
* [[getNetworkStats]]
* [[setClipboard]]
* [[getTimers]]
* [[gettok]]
* [[killTimer]]
* [[resetTimer]]
* [[setTimer]]
* [[split]]
* [[getVersion]]
* [[isTimer]]
* [[md5]]
* [[tocolor]]

* [[utfChar]]
* [[utfCode]]
* [[utfLen]]
* [[utfSeek]]
* [[utfSub]]
{{New items|3.0120|1.2|
* [[toJSON]]
* [[fromJSON]]
* [[setDevelopmentMode]]
* [[getDevelopmentMode]]
}}
* [[downloadFile]]
<noinclude>[[Category:Functions templates]]</noinclude>

Template:Utility functions

2012-02-22T11:10:48Z

OpenIDUser34:

*[[getColorFromString]]
*[[getDistanceBetweenPoints2D]]
*[[getDistanceBetweenPoints3D]]
{{New items|3.0110|1.1|
* [[getEasingValue]]
* [[interpolateBetween]]
* [[getPerformanceStats]]
* [[getNetworkStats]]
* [[getServerConfigSetting]]
* [[setServerConfigSetting]]
}}

*[[getRealTime]]
*[[getTickCount]]
*[[getTimerDetails]]
*[[getTimers]]
*[[gettok]]
*[[killTimer]]
*[[resetTimer]]
*[[setTimer]]
*[[split]]
*[[isTimer]]
*[[md5]]
{{New items|3.0110|1.1|
* [[utfChar]]
* [[utfCode]]
* [[utfLen]]
* [[utfSeek]]
* [[utfSub]]
}}
<noinclude>[[Category:Functions templates]]</noinclude>

Template:Utility functions

2012-02-22T11:10:02Z

OpenIDUser34:

*[[getColorFromString]]
*[[getDistanceBetweenPoints2D]]
*[[getDistanceBetweenPoints3D]]
{{New items|3.0110|1.1|
* [[getEasingValue]]
* [[interpolateBetween]]
* [[getPerformanceStats]]
* [[getNetworkStats]]
* [[getServerConfigSetting]]
* [[setServerConfigSetting]]
}}

*[[getRealTime]]
*[[getTickCount]]
*[[getTimerDetails]]
*[[getTimers]]
*[[gettok]]
*[[killTimer]]
*[[resetTimer]]
*[[setTimer]]
*[[split]]
*[[isTimer]]
*[[md5]]
{{New items|3.0110|1.1|
* [[utfChar]]
* [[utfCode]]
* [[utfLen]]
* [[utfSeek]]
* [[utfSub]]
}}
*[[downloadFile]]
<noinclude>[[Category:Functions templates]]</noinclude>

Template:Account functions

2012-02-22T11:09:08Z

OpenIDUser34:

*[[addAccount]]
*[[copyAccountData]]
*[[getAccount]]
*[[getAccountData]]
*[[getAccountName]]
{{New items|3|1.0|
*[[getAccountPlayer]]
}}
*[[getAccounts]]
*[[isGuestAccount]]
*[[logIn]]
*[[logOut]]
*[[removeAccount]]
*[[setAccountData]]
*[[setAccountPassword]]
{{Deprecated items|3|1.0|
*[[getAccountClient]]
}}
*[[getAccountAllData]]
<noinclude>
[[Category:Functions templates]]
</noinclude>

OnClientFileDownloadComplete

2012-02-21T23:31:59Z

OpenIDUser34: Created page with "my test example until I get a chance to document properly <syntaxhighlight lang="lua"> function onStart ( ) outputChatBox ( "downloading test.mp3" ) downloadFile ( "test.mp3" ) end addEventH..."

my test example until I get a chance to document properly

<syntaxhighlight lang="lua">
function onStart ( )
outputChatBox ( "downloading test.mp3" )
downloadFile ( "test.mp3" )
end
addEventHandler ( "onClientResourceStart", getRootElement(), onStart )

function onDownloadFinish ( file, success )
if ( success ) then
if ( file == "test.mp3" ) then
outputChatBox ( "test.mp3 downloaded successfully" )
playSound ( "test.mp3" )
outputChatBox ( "playing test.mp3" )
end
else
if ( file == "test.mp3" ) then
outputChatBox ( "test.mp3 failed to download" )
end
end
end
addEventHandler ( "onFileDownloadComplete", getRootElement(), onDownloadFinish )
</syntaxhighlight>

DownloadFile

2012-02-19T17:18:51Z

OpenIDUser34: Created page with "{{Client function}} __NOTOC__ This function downloads a file from the HTTP server. This can only be used on files on the HTTP server associated with the MTA server and will only ..."

{{Client function}}
__NOTOC__
This function downloads a file from the HTTP server. This can only be used on files on the HTTP server associated with the MTA server and will only download files from within the folder of the resource that is calling it. The '''file''' should also be included in meta.xml with the '''download''' attribute set to "false"

'''Will be in 1.4'''

==Syntax==
<syntaxhighlight lang="lua">
bool downloadFile ( string fileName )
</syntaxhighlight>

===Required Arguments===
* '''fileName''': A string referencing the name of the file to download

===Returns===
Returns ''true'' if file download has been queued, ''false'' otherwise.

==Example==
'''Example 1:''' This client side event downloads a file when the resource has started.
<syntaxhighlight lang="lua">
-- the function is called, since the local player never changes)
function onStart ( )
downloadFile ( "test.txt" )
end
addEventHandler ( "onClientResourceStart", getRootElement(), onStart )
</syntaxhighlight>

==See Also==
{{Client_utility_functions}}

GetKeyState

2012-02-16T23:05:11Z

OpenIDUser34:

__NOTOC__
{{Client function}}
This function determines if a certain key is pressed or not.

'ralt' may trigger both 'ralt' and 'lctrl', this is due to AltGr

==Syntax==
<syntaxhighlight lang="lua">
bool getKeyState ( string keyName )
</syntaxhighlight>

===Required Arguments===
*'''keyName:''' The name of the key you're checking state of. See [[Key names]].

===Returns===
Returns ''true'' if the specified key is pressed, ''false'' if it isn't or if an invalid key name is passed.

==Example==
This clientside example prints a message when "p" is pressed, and a different one for the "control+p" combination.
<syntaxhighlight lang="lua">
-- define a function that outputs a message if control is pressed, and a different one if it isn't
function printMessageFunction()
-- if the left or right control keys are pressed, the user has pressed the "control+p" combo
if getKeyState( "lctrl" ) == true or getKeyState( "rctrl" ) == true then
outputChatBox ( "You have pressed 'control+p'." )
-- if none of those were pressed, he just pressed the "p" key
else
outputChatBox ( "You have pressed 'p'." )
end
end
-- bind the "p" key to our function
bindKey( "p", "down", "Print message", printMessageFunction )
</syntaxhighlight>

==See Also==
{{Client_input_functions}}

RemoveAccount

2012-02-09T15:28:22Z

OpenIDUser34:

{{Server function}}
__NOTOC__
This function is used to delete existing player accounts.

==Syntax==
<syntaxhighlight lang="lua">
bool removeAccount ( account theAccount )
</syntaxhighlight>

===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...
<syntaxhighlight lang="lua">
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)
</syntaxhighlight>

==See Also==

{{Account_functions}}

Server Commands

2012-02-04T20:17:31Z

OpenIDUser34:

This page lists all built in commands that the server can process. All these commands can be entered via the server console or the client console depending upon permissions unless otherwise stated.

==Resource commands==
====checkall====
:<ins>Server console only</ins>
:Check all resources for deprecated functions and MTA version issues
====info====
:<ins>Server console only</ins>
:Usage: info ''<resource-name>'' 
:Get info for a resource eg: info admin
====list====
:<ins>Server console only</ins>
:See a list of resources
====refresh====
:Refresh resource list to find new resources
====refreshall====
:Refresh resources and restart any changed resources
====restart====
:Usage: info ''<resource-name>'' 
:Restarts a running resource eg: restart admin
====start====
:Usage: start ''<resource-name>'' 
:Start a loaded resource eg: start admin
====stop====
:Usage: stop ''<resource-name>'' 
:Stop a resource eg: stop admin
====stopall====
:Stop all running resources
====upgrade====
:<ins>Server console only</ins>
:Perform a basic upgrade of all resources that use deprecated functions
====aclrequest====
:Usage: aclrequest [''list''|''allow''|''deny''] ''<resource-name>'' [''<right>''|''all''] 
:Manage ACL requests from resources implementing <aclrequest> in their [[meta.xml]]

==Account commands==
====aexec====
:Usage: aexec ''<nick>'' ''<command>'' 
:Force a player to execute a command eg: aexec playername say hello
====addaccount====
:Usage: addaccount ''<accountname>'' ''<password>'' 
:Add an account eg: addaccount accountname password
====chgpass====
:Usage: chgpass ''<accountname>'' ''<password>'' 
:Change an accounts password eg: chgpass account newpw
====delaccount====
:Usage: delaccount ''<accountname>'' 
:Delete an account eg: delaccount accountname

==Server commands==
====ase====
:<ins>Server console only</ins>
:See the amount of master server list queries
====debugdb====
:Usage: debugdb ''<''0-2''>'' 
:<ins>Server console only</ins>
:Set logging level for database functions. [0-Off  1-Errors only  2-All]
====help====
:<ins>Server console only</ins>
:Displays these list of commands
====loadmodule====
:<ins>Server console only</ins>
:Usage: loadmodule ''<module-filename>'' 
:Load a module eg: loadmodule ml_sockets.dll
====unloadmodule====
:<ins>Server console only</ins>
:Usage: unloadmodule ''<module-filename>'' 
:Unload a module eg: unloadmodule ml_sockets.dll
====reloadmodule====
:<ins>Server console only</ins>
:Usage: reloadmodule ''<module-filename>'' 
:Reload a module eg: reloadmodule ml_sockets.dll
====openports====
:<ins>Server console only</ins>
:Test if server ports are open
====shutdown====
:Usage: shutdown ''<reason>'' 
:Shutdown the server eg: shutdown put reason here
====sver====
:Get the server MTA version

==Other commands==
====say====
:Usage: say ''<text>'' 
:Show a message to all players on the server eg: say hello
====whois====
:Usage: whois ''<nick>'' 
:Get the IP of a player currently connected (use whowas for IP/serial/version)
====whowas====
:Usage: whowas ''<nick>'' 
:Get IP/Serial of a player that was previously connected to the server
====ver====
:Get the MTA version

==Client relevant only==
====chgmypass====
:<ins>Client only</ins>
:Usage: chgmypass ''<oldpass>'' ''<newpass>'' 
:Change your password eg: chgmypass oldpw newpw
====debugscript====
:<ins>Client only</ins>
:Usage: debugscript ''<''0-3''>'' 
:Remove (This does not work "Incorrect client type for this command")
====login====
:<ins>Client only</ins>
:Usage: login ''<accountname>'' ''<password>'' 
:Login to an account eg: login accountname password
====logout====
:<ins>Client only</ins>
:Log out of the current account
====me====
:<ins>Client only</ins>
:Usage: me ''<text>'' 
:Show a message to all players on the server, with your nick prepended
====msg====
:<ins>Client only</ins>
:Usage: msg ''<nick>'' ''<text>'' 
:Send a message to a player eg: msg playername hello
====nick====
:<ins>Client only</ins>
:Usage: nick ''<old-nick>'' ''<new-nick>'' 
:Change your ingame nickname
====teamsay====
:<ins>Client only</ins>
:Usage: teamsay ''<test>'' 
:Send a message to all players on the same team

GetAllAccountData

2012-01-30T18:39:53Z

OpenIDUser34: Created page with "__NOTOC__ {{Server function}} This function returns a table containing all the user data for the account provided ==Syntax== <syntaxhighlight lang="lua"> table getAccountAllData ( account theAcco..."