Multi Theft Auto: Wiki - User contributions [en]

Deref

2020-04-13T23:51:47Z

Audifire:

__NOTOC__
{{Server client function}}
This function will take a reference and returns its Lua element.

==Syntax==
<syntaxhighlight lang="lua">
mixed deref( int reference )
</syntaxhighlight>

===Required Arguments===
*'''reference:''' The valid reference, which you want to dereference

===Returns===
Returns ''mixed'' if the reference were valid. Returns ''false'' if the reference were invalid.

==See Also==
{{Utility functions}}

Deref

2020-04-13T23:50:50Z

Audifire: Created page with "__NOTOC__ {{Server client function}} This function will take a reference returns its Lua element. ==Syntax== <syntaxhighlight lang="lua"> mixed deref( int reference )..."

__NOTOC__
{{Server client function}}
This function will take a reference returns its Lua element.

==Syntax==
<syntaxhighlight lang="lua">
mixed deref( int reference )
</syntaxhighlight>

===Required Arguments===
*'''reference:''' The valid reference, which you want to dereference

===Returns===
Returns ''mixed'' if the reference were valid. Returns ''false'' if the reference were invalid.

==See Also==
{{Utility functions}}

Ref

2020-04-13T23:47:28Z

Audifire: Created page with "__NOTOC__ {{Server client function}} This function will create a reference to the given argument. ==Syntax== <syntaxhighlight lang="lua"> int ref( mixed objectToReference..."

__NOTOC__
{{Server client function}}
This function will create a reference to the given argument.

==Syntax==
<syntaxhighlight lang="lua">
int ref( mixed objectToReference )
</syntaxhighlight>

===Required Arguments===
*'''objectToReference :''' The Lua element, which you want to reference

===Returns===
Returns an ''int'' if the reference were successfully created. Returns ''false'' if the parameter were invalid.

==See Also==
{{Utility functions}}

Template:Utility functions

2020-04-13T23:47:10Z

Audifire:

*[[addDebugHook]]
*[[base64Decode]]
*[[base64Encode]]
{{Bit_functions}}
*[[debugSleep]]
{{New items|3.0156|1.5.5|
*[[decodeString]]
|11849}}
*[[deref]]
{{New items|3.0156|1.5.5|
*[[encodeString]]
|11849}}
*[[fromJSON]]
*[[getColorFromString]]
*[[getDevelopmentMode]]
*[[getDistanceBetweenPoints2D]]
*[[getDistanceBetweenPoints3D]]
*[[getEasingValue]]
*[[getFPSLimit]]
*[[getNetworkStats]]
*[[getNetworkUsageData]]
*[[getPerformanceStats]]
*[[getRealTime]]
*[[getServerConfigSetting]]
*[[getTickCount]]
*[[getTimerDetails]]
*[[getTimers]]
*[[gettok]]
*[[getUserdataType]]
*[[getVersion]]
*[[hash]]
*[[inspect]]
*[[interpolateBetween]]
*[[iprint]]
*[[isOOPEnabled]]
*[[isTimer]]
*[[killTimer]]
*[[md5]]
*[[passwordHash]]
*[[passwordVerify]]
*[[pregFind]]
*[[pregMatch]]
*[[pregReplace]]
*[[removeDebugHook]]
*[[ref]]
*[[resetTimer]]
*[[setDevelopmentMode]]
*[[setFPSLimit]]
*[[setServerConfigSetting]]
*[[setTimer]]
*[[sha256]]
*[[split]]
*[[teaDecode]]
*[[teaEncode]]
{{New items|3.0156|1.5.5|
*[[tocolor]]
|13977}}
*[[toJSON]]
*[[utfChar]]
*[[utfCode]]
*[[utfLen]]
*[[utfSeek]]
*[[utfSub]]

<noinclude>[[Category:Functions templates]]</noinclude>

SetDebugViewActive

2017-04-22T20:03:14Z

Audifire: /* Example */

{{Client function}}
__NOTOC__
This function enables or disables the debug window.

==Syntax==
<syntaxhighlight lang="lua">
bool setDebugViewActive ( bool enabled )
</syntaxhighlight>

===Required Arguments===
* '''enabled:''' true if debug window should be visible, false otherwise.

===Returns===
Returns ''true'', ''false'' if invalid parameters are passed.

==Example==
This example enables or disables the debug window.
<syntaxhighlight lang="lua">
function enableDebug()
local state = not isDebugViewActive()
setDebugViewActive(state)
end
addCommandHandler("debug", enableDebug)
</syntaxhighlight>

==See Also==
{{GUI_functions}}

InjectBrowserMouseWheel

2015-07-26T01:46:56Z

Audifire: /* Example */

__NOTOC__
{{Client_function}}
{{New feature/item|3.0150|1.5||
This function injects mouse wheel events.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool injectBrowserMouseWheel ( browser webBrowser, int verticalScroll, int horizontalScroll )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:injectMouseWheel||injectBrowserMouseWheel}}

===Required arguments===
*'''webBrowser:''' The web browser
*'''verticalScroll''': Amount of units you want the browser to scroll along the Y-axe.
*'''horizontalScroll''': Amount of units you want the browser to scroll along the X-axe.

===Returns===
Returns ''true'' if the mouse action was successfully injected, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">local webBrowser = createBrowser(1000, 1000, false, false)
showCursor(true)

function webBrowserRender()
dxDrawImage(0, 0, 1000, 1000, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end

addEventHandler("onClientBrowserCreated", webBrowser,
function()
loadBrowserURL(webBrowser, "https://www.youtube.com/tv#/watch?mode=transport&v=jofNR_WkoCE")
addEventHandler("onClientRender", root, webBrowserRender)
addEventHandler("onClientKey", root, onKey)
end
)

function onKey(button)
if button == "mouse_wheel_down" then
injectBrowserMouseWheel(webBrowser, -40, 0)
elseif button == "mouse_wheel_up" then
injectBrowserMouseWheel(webBrowser, 40, 0)
end
end</syntaxhighlight>

==See Also==
Todo

==See also==
{{CEF_functions}}

InjectBrowserMouseWheel

2015-07-26T01:46:33Z

Audifire: /* Example */

__NOTOC__
{{Client_function}}
{{New feature/item|3.0150|1.5||
This function injects mouse wheel events.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool injectBrowserMouseWheel ( browser webBrowser, int verticalScroll, int horizontalScroll )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:injectMouseWheel||injectBrowserMouseWheel}}

===Required arguments===
*'''webBrowser:''' The web browser
*'''verticalScroll''': Amount of units you want the browser to scroll along the Y-axe.
*'''horizontalScroll''': Amount of units you want the browser to scroll along the X-axe.

===Returns===
Returns ''true'' if the mouse action was successfully injected, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">local webBrowser = createBrowser(1000, 1000, false, false)
showCursor(true)

function webBrowserRender()
dxDrawImage(0, 0, 1000, 1000, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end

addEventHandler("onClientBrowserCreated", webBrowser,
function()
loadBrowserURL(webBrowser, "https://www.youtube.com/tv#/watch?mode=transport&v=jofNR_WkoCE")
addEventHandler("onClientRender", root, webBrowserRender)
addEventHandler("onClientKey", root, onKey)
end
)

function onKey(button)
if button == "mouse_wheel_down" then
injectBrowserMouseWheel(webbrowser, -40, 0)
elseif button == "mouse_wheel_up" then
injectBrowserMouseWheel(webbrowser, 40, 0)
end
end</syntaxhighlight>

==See Also==
Todo

==See also==
{{CEF_functions}}

ToJSON

2015-06-11T21:38:35Z

Audifire: /* Optional Arguments */

__NOTOC__
{{Server client function}}
{{New feature/item|3.0120|1.2||
Available client side in 1.2 and onwards.
}}

This function converts a '''single''' value (preferably a Lua table) into a [[JSON]] encoded string. You can use this to store the data and then load it again using [[fromJSON]].

==Syntax==

<syntaxhighlight lang="lua">
string toJSON ( var value, [ bool compact = false ] )
</syntaxhighlight>

===Required Arguments===
*'''var:''' An argument of any type. Arguments that are elements will be stored as element IDs that are liable to change between sessions. As such, do not save elements across sessions as you will get unpredictable results.

===Optional Arguments===
{{OptionalArg}}
{{New feature/item|3.0150|1.5||
*'''compact:''' a [[boolean]] representing whether the string will contain whitespaces. To remove whitespaces from JSON string, use ''true''. String will contain whitespaces per default.
}}

===Returns===
Returns a JSON formatted string.

==Example==
This example shows how you can encode an array. The string json should equal ''"[ { "1": "dogs", "mouse": "food", "cat": "hungry", "birds": 4 } ]" after executed.
<syntaxhighlight lang="lua">
local json = toJSON ( { "dogs", cat = "hungry", mouse = "food", birds = 4 } )
</syntaxhighlight>

==Requirements==
{{Requirements|1.0|1.1.1-9.03316|}}

==See Also==
{{Server_functions}}

ToJSON

2015-06-11T21:37:39Z

Audifire: /* Syntax */

__NOTOC__
{{Server client function}}
{{New feature/item|3.0120|1.2||
Available client side in 1.2 and onwards.
}}

This function converts a '''single''' value (preferably a Lua table) into a [[JSON]] encoded string. You can use this to store the data and then load it again using [[fromJSON]].

==Syntax==

<syntaxhighlight lang="lua">
string toJSON ( var value, [ bool compact = false ] )
</syntaxhighlight>

===Required Arguments===
*'''var:''' An argument of any type. Arguments that are elements will be stored as element IDs that are liable to change between sessions. As such, do not save elements across sessions as you will get unpredictable results.

===Optional Arguments===
{{OptionalArg}}
{{New feature/item|3.0150|1.5||
*'''compact:''' a [[boolean]] representing whether the string will contain whitespaces. To remove whitespaces from JSON stirng, use ''true''. String will contain whitespaces per default.
}}

===Returns===
Returns a JSON formatted string.

==Example==
This example shows how you can encode an array. The string json should equal ''"[ { "1": "dogs", "mouse": "food", "cat": "hungry", "birds": 4 } ]" after executed.
<syntaxhighlight lang="lua">
local json = toJSON ( { "dogs", cat = "hungry", mouse = "food", birds = 4 } )
</syntaxhighlight>

==Requirements==
{{Requirements|1.0|1.1.1-9.03316|}}

==See Also==
{{Server_functions}}

PlaySound3D

2015-05-25T11:36:15Z

Audifire: /* Syntax */

__NOTOC__
{{Client function}}
Creates a [[sound]] [[element]] in the GTA world and plays it immediately after creation for the local player. [[setElementPosition]] can be used to move the [[sound]] element around after it has been created. Remember to use [[setElementDimension]] after creating the sound to play it outside of dimension 0.<br />
<br />
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.
{{Note|For performance reasons, when using playSound3D for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}
==Syntax==
<syntaxhighlight lang="lua">element playSound3D ( string soundPath, float x, float y, float z, [ bool looped = false, bool throttled = true ] )</syntaxhighlight>
{{OOP||[[Sound|Sound3D]].create}}
===Required Arguments===
*'''soundPath:''' the [[filepath]] to the sound file you want to play. (Sound file has to be predefined in the [[meta.xml]] file with <file /> tag. And also can use url instead of [[filepath]] )
*'''x:''' a [[float]]ing point number representing the X coordinate on the map.
*'''y:''' a [[float]]ing point number representing the Y coordinate on the map.
*'''z:''' a [[float]]ing point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
*'''looped:''' A [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''.
{{New feature/item|3.0150|1.5||
*'''throttled:''' a [[boolean]] representing whether the sound will be throttled. To throttle the sound, use ''true''. Sounds will be throttled per default and only for URLs.
}}

===Returns===
Returns a [[sound]] [[element]] if the sound was successfully created, ''false'' otherwise.

==Example==
This example creates a looping sound within a pizza shop. The pizza shop is in san fierro near pier 69
<section name="Example" class="client" show="true">
<syntaxhighlight lang="lua">
function onResourceStart()
local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)
end
addEventHandler("onClientResourceStart", getResourceRootElement(), onResourceStart)
</syntaxhighlight>
</section>
This example play internet radio in groove street.
<section name="Example 2" class="client" show="true" >
<syntaxhighlight lang="lua">
addEventHandler( 'onClientResourceStart', resourceRoot,
function( )
local uSound = playSound3D( 'http://193.34.51.25:80', 2498, -1659, 12 )
setSoundMaxDistance( uSound, 100 )
end
)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}
[[AR:playSound3D]]
[[DE:playSound3D]]
[[RU:playSound3D]]

PlaySound3D

2015-05-25T11:35:46Z

Audifire: /* Optional Arguments */

__NOTOC__
{{Client function}}
Creates a [[sound]] [[element]] in the GTA world and plays it immediately after creation for the local player. [[setElementPosition]] can be used to move the [[sound]] element around after it has been created. Remember to use [[setElementDimension]] after creating the sound to play it outside of dimension 0.<br />
<br />
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT and S3M.
{{Note|For performance reasons, when using playSound3D for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}
==Syntax==
<syntaxhighlight lang="lua">element playSound3D ( string soundPath, float x, float y, float z, [ bool looped = false ] )</syntaxhighlight>
{{OOP||[[Sound|Sound3D]].create}}
===Required Arguments===
*'''soundPath:''' the [[filepath]] to the sound file you want to play. (Sound file has to be predefined in the [[meta.xml]] file with <file /> tag. And also can use url instead of [[filepath]] )
*'''x:''' a [[float]]ing point number representing the X coordinate on the map.
*'''y:''' a [[float]]ing point number representing the Y coordinate on the map.
*'''z:''' a [[float]]ing point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
*'''looped:''' A [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''.
{{New feature/item|3.0150|1.5||
*'''throttled:''' a [[boolean]] representing whether the sound will be throttled. To throttle the sound, use ''true''. Sounds will be throttled per default and only for URLs.
}}

===Returns===
Returns a [[sound]] [[element]] if the sound was successfully created, ''false'' otherwise.

==Example==
This example creates a looping sound within a pizza shop. The pizza shop is in san fierro near pier 69
<section name="Example" class="client" show="true">
<syntaxhighlight lang="lua">
function onResourceStart()
local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)
end
addEventHandler("onClientResourceStart", getResourceRootElement(), onResourceStart)
</syntaxhighlight>
</section>
This example play internet radio in groove street.
<section name="Example 2" class="client" show="true" >
<syntaxhighlight lang="lua">
addEventHandler( 'onClientResourceStart', resourceRoot,
function( )
local uSound = playSound3D( 'http://193.34.51.25:80', 2498, -1659, 12 )
setSoundMaxDistance( uSound, 100 )
end
)
</syntaxhighlight>
</section>

==See Also==
{{Client_audio_functions}}
[[AR:playSound3D]]
[[DE:playSound3D]]
[[RU:playSound3D]]

PlaySound

2015-05-10T22:04:02Z

Audifire:

__NOTOC__
{{Client function}}
Creates a [[sound]] [[element]] and plays it immediately after creation for the local player.<br />
<br />
'''Note:''' The only supported audio formats are MP3, WAV, OGG, RIFF, MOD, XM, IT, S3M and PLS(e.g. Webstream).
{{Note|For performance reasons, when using playSound for effects that will be played lots (i.e. weapon fire), it is recommend that you convert your audio file to a one channel (mono) WAV with sample rate of 22050 Hz or less. Also consider adding a limit on how often the effect can be played e.g. once every 50ms.}}
==Syntax==
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false ] )</syntaxhighlight>
{{New feature/item|3.0150|1.5||
<syntaxhighlight lang="lua">element playSound ( string soundPath, [ bool looped = false, [ bool throttled = true ] ] )</syntaxhighlight>
}}
{{OOP||[[Sound]].create}}
===Required Arguments===
*'''soundPath:''' the [[filepath]] or URL of the sound file you want to play. (Sound specified by filepath has to be predefined in the [[meta.xml]] file with <file /> tag.)

===Optional Arguments===
{{OptionalArg}}
*'''looped:''' a [[boolean]] representing whether the sound will be looped. To loop the sound, use ''true''. Loop is not available for streaming sounds, only for sound files.
*'''throttled:''' a [[boolean]] representing whether the sound will be throttled. To throttle the sound, use ''true''. Sounds will be throttled per default and only for URLs.

===Returns===
Returns a [[sound]] [[element]] if the sound was successfully created, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function wasted (killer, weapon, bodypart)
local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
setSoundVolume(sound, 0.5) -- set the sound volume to 50%
end

addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}
[[AR:playSound]]
[[DE:playSound]]

Template:Client event functions

2013-07-06T17:42:23Z

Audifire:

* [[addEvent]]
* [[addEventHandler]]
{{New feature/item|4.0140|1.4|4973|
* [[getEventHandlers]]
}}
* [[cancelEvent]]
* [[removeEventHandler]]
* [[triggerEvent]]
* [[triggerServerEvent]]
* [[wasEventCancelled]]
* [[triggerLatentServerEvent]]
* [[getLatentEventHandles]]
* [[getLatentEventStatus]]
* [[cancelLatentEvent]]