Multi Theft Auto: Wiki - User contributions [en]

SetWorldSpecialPropertyEnabled

2025-06-05T10:38:58Z

Samr46: Add new property (vehicle_engine_autostart)

__NOTOC__
{{Shared function}}

{{New feature/item|3.0161|1.6.0|22195|Added also as a server-side function. Previously only available as a client-side function.}}

Enables or disables a special world property.

{{Note|
It's recommended to use server-side function with appropriate [[mtaserver.conf#minclientversion|minclientversion]] for properties like "'''underworldwarp'''", "'''burnflippedcars'''", "'''extendedwatercannons'''", "'''flyingcomponents'''", "'''vehicle_engine_autostart'''" to avoid possible data desynchronization.
}}

==Syntax==
<syntaxhighlight lang="lua">bool setWorldSpecialPropertyEnabled ( string propname, bool enable )</syntaxhighlight>
{{OOP||||isWorldSpecialPropertyEnabled}}
[[File:Randomfoliage.jpeg|frame|right|A photo demonstrating ''randomfoliage'' enabled and disabled.]]
[[File:Roadsignstext.png|frame|right|A photo demonstrating ''roadsignstext'' enabled and disabled.]]
[[File:Extendedwatercannons.png|frame|right|A photo demonstrating ''extendedwatercannons'' enabled and disabled.]]
===Required Arguments===
*'''propname:''' the name of the property to set. Possible values are:
**'''hovercars''' - equivalent of the JBGVNB cheat, and allows cars to drive on water. (default: false)
**'''aircars''' - equivalent of the RIPAZHA cheat, and allows cars to fly. (default: false)
**'''extrabunny''' - equivalent of the CJPHONEHOME or JHJOECW cheat, and allows you to bunny hop on bicycles much higher. (default: false)
**'''extrajump''' - equivalent of the KANGAROO cheat, and allows you to jump on foot much higher. (default: false)
**'''randomfoliage''' - toggle randomly generated foliage on the GTA:SA map (default: true)
**'''snipermoon''' - toggle the GTA:SA easter egg, which increases the size of the moon every time you shoot it with a sniper rifle (default: false)
**'''extraairresistance''' - toggle the vehicle speed limit on cross-country roads (default: true)
**{{New feature/item|3.0156|1.5.5|12286|'''underworldwarp''' - toggle warp of peds and vehicles when fall under map (default: true)}}
**{{New feature/item|3.0160|1.5.9|21125|'''vehiclesunglare''' - toggle the vehicle sun glare effect (default: false) }}
**{{New feature/item|3.0160|1.5.9|21313| '''coronaztest''' - disable big sun lensflare effect (default: true) }}
**{{New feature/item|3.0161|1.6.0|21919| '''watercreatures''' - toggle randomly generated underwater creatures (default: true) }}
**{{New feature/item|3.0161|1.6.0|22195| '''burnflippedcars''' - toggle the vehicle to burn when upside down (default: true) }}
**{{New feature/item|3.0161|1.6.0|22199| '''fireballdestruct''' - toggle the aircraft model destruction on explosion ([[Media:FireballDestruct.jpg|preview]]) (default: true) }}
**{{New feature/item|3.0161|1.6.0|22430| '''roadsignstext''' - toggle the drawing of text on road signs. (default: true)}}
**{{New feature/item|3.0161|1.6.0|22485| '''extendedwatercannons''' - Increases the default limit of water cannons used at the same time from 3 to 30. (default: true)}}
**{{New feature/item|3.0161|1.6.0|22596| '''tunnelweatherblend''' - toggle the weather blending effect when the player is in the tunnel. (default: true)}}
**{{New feature/item|3.0161|1.6.0|22815| '''ignorefirestate''' - Allows aiming when the player is on fire and entering burning vehicles. (default: false)}}
**{{New feature/item|3.0161|1.6.0|22909| '''flyingcomponents''' - This property determines whether the detached components such as doors, bumpers, etc., should respawn after a vehicle is recreated (change model or variant) or streamed in. (default: true)}}
**{{New feature/item|3.0161|1.6.0|23223| '''vehicleburnexplosions''' - This property toggles creation of additional explosions ([[Explosion_types|type 2 - rocket]]) when plane or helicopter is burning. (default: true)}}
**{{New feature/item|3.0161|1.6.0|23237| '''vehicle_engine_autostart''' - This property toggles automatic vehicle engine state behavior. (default: true)<br>If you set it to ''false'' then vehicle engine will not start on driver enter and will not stop on driver exit. To control the engine you need to use [[SetVehicleEngineState|setVehicleEngineState]]. Helicopter rotors will spin only if the engine is on (with or without driver inside).}}
*'''enable:''' whether or not to enable the property.

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

==Example==

This code allows you to enable/disable certain property using '''true''' or '''false'''.
<syntaxhighlight lang="lua">
function onClientResourceStart()
local worldSpecialProperties = {
["hovercars"] = false,
["aircars"] = false,
["extrabunny"] = false,
["extrajump"] = false,
["randomfoliage"] = true,
["snipermoon"] = false,
["extraairresistance"] = true,
["underworldwarp"] = true,
["vehiclesunglare"] = false,
["coronaztest"] = true,
["watercreatures"] = true,
["burnflippedcars"] = true,
["fireballdestruct"] = true,
["roadsignstext"] = true,
["extendedwatercannons"] = true,
["tunnelweatherblend"] = true,
["ignorefirestate"] = false,
["flyingcomponents"] = true,
["vehicleburnexplosions"] = true,
["vehicle_engine_autostart"] = true,
}

for propertyName, propertyState in pairs(worldSpecialProperties) do
setWorldSpecialPropertyEnabled(propertyName, propertyState)
end
end
addEventHandler("onClientResourceStart", resourceRoot, onClientResourceStart)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.5-3.12286|Added "underworldwarp" property}}
{{ChangelogItem|1.5.9-1.21125|Added "vehiclesunglare" property}}
{{ChangelogItem|1.5.9-9.21313|Added "coronaztest" property}}
{{ChangelogItem|1.6.0-9.21919|Added "watercreatures" property}}
{{ChangelogItem|1.6.0-9.22195|Added "burnflippedcars" property}}
{{ChangelogItem|1.6.0-9.22199|Added "fireballdestruct" property}}
{{ChangelogItem|1.6.0-9.22430|Added "roadsignstext" property}}
{{ChangelogItem|1.6.0-9.22485|Added "extenedwatercannons" property}}
{{ChangelogItem|1.6.0-9.22596|Added "tunnelweatherblend" property}}
{{ChangelogItem|1.6.0-9.22815|Added "ignorefirestate" property}}
{{ChangelogItem|1.6.0-9.22909|Added "flyingcomponents" property}}
{{ChangelogItem|1.6.0-9.23223|Added "vehicleburnexplosions" property}}
{{ChangelogItem|1.6.0-9.23237|Added "vehicle_engine_autostart" property}}

==See Also==
{{World functions}}

SetWorldSpecialPropertyEnabled

2025-05-28T15:28:20Z

Samr46: Add new property (vehicleburnexplosions)

__NOTOC__
{{Shared function}}

{{New feature/item|3.0161|1.6.0|22195|Added also as a server-side function. Previously only available as a client-side function.}}

Enables or disables a special world property.

{{Note|
It's recommended to use server-side function with appropriate [[mtaserver.conf#minclientversion|minclientversion]] for properties like "'''underworldwarp'''", "'''burnflippedcars'''", "'''extendedwatercannons'''", "'''flyingcomponents'''" to avoid possible data desynchronization.
}}

==Syntax==
<syntaxhighlight lang="lua">bool setWorldSpecialPropertyEnabled ( string propname, bool enable )</syntaxhighlight>
{{OOP||||isWorldSpecialPropertyEnabled}}
[[File:Randomfoliage.jpeg|frame|right|A photo demonstrating ''randomfoliage'' enabled and disabled.]]
[[File:Roadsignstext.png|frame|right|A photo demonstrating ''roadsignstext'' enabled and disabled.]]
[[File:Extendedwatercannons.png|frame|right|A photo demonstrating ''extendedwatercannons'' enabled and disabled.]]
===Required Arguments===
*'''propname:''' the name of the property to set. Possible values are:
**'''hovercars''' - equivalent of the JBGVNB cheat, and allows cars to drive on water. (default: false)
**'''aircars''' - equivalent of the RIPAZHA cheat, and allows cars to fly. (default: false)
**'''extrabunny''' - equivalent of the CJPHONEHOME or JHJOECW cheat, and allows you to bunny hop on bicycles much higher. (default: false)
**'''extrajump''' - equivalent of the KANGAROO cheat, and allows you to jump on foot much higher. (default: false)
**'''randomfoliage''' - toggle randomly generated foliage on the GTA:SA map (default: true)
**'''snipermoon''' - toggle the GTA:SA easter egg, which increases the size of the moon every time you shoot it with a sniper rifle (default: false)
**'''extraairresistance''' - toggle the vehicle speed limit on cross-country roads (default: true)
**{{New feature/item|3.0156|1.5.5|12286|'''underworldwarp''' - toggle warp of peds and vehicles when fall under map (default: true)}}
**{{New feature/item|3.0160|1.5.9|21125|'''vehiclesunglare''' - toggle the vehicle sun glare effect (default: false) }}
**{{New feature/item|3.0160|1.5.9|21313| '''coronaztest''' - disable big sun lensflare effect (default: true) }}
**{{New feature/item|3.0161|1.6.0|21919| '''watercreatures''' - toggle randomly generated underwater creatures (default: true) }}
**{{New feature/item|3.0161|1.6.0|22195| '''burnflippedcars''' - toggle the vehicle to burn when upside down (default: true) }}
**{{New feature/item|3.0161|1.6.0|22199| '''fireballdestruct''' - toggle the aircraft model destruction on explosion ([[Media:FireballDestruct.jpg|preview]]) (default: true) }}
**{{New feature/item|3.0161|1.6.0|22430| '''roadsignstext''' - toggle the drawing of text on road signs. (default: true)}}
**{{New feature/item|3.0161|1.6.0|22485| '''extendedwatercannons''' - Increases the default limit of water cannons used at the same time from 3 to 30. (default: true)}}
**{{New feature/item|3.0161|1.6.0|22596| '''tunnelweatherblend''' - toggle the weather blending effect when the player is in the tunnel. (default: true)}}
**{{New feature/item|3.0161|1.6.0|22815| '''ignorefirestate''' - Allows aiming when the player is on fire and entering burning vehicles. (default: false)}}
**{{New feature/item|3.0161|1.6.0|22909| '''flyingcomponents''' - This property determines whether the detached components such as doors, bumpers, etc., should respawn after a vehicle is recreated (change model or variant) or streamed in. (default: true)}}
**{{New feature/item|3.0161|1.6.0|23223| '''vehicleburnexplosions''' - This property toggles creation of additional explosions ([[Explosion_types|type 2 - rocket]]) when plane or helicopter is burning. (default: true)}}
*'''enable:''' whether or not to enable the property.

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

==Example==

This code allows you to enable/disable certain property using '''true''' or '''false'''.
<syntaxhighlight lang="lua">
function onClientResourceStart()
local worldSpecialProperties = {
["hovercars"] = false,
["aircars"] = false,
["extrabunny"] = false,
["extrajump"] = false,
["randomfoliage"] = true,
["snipermoon"] = false,
["extraairresistance"] = true,
["underworldwarp"] = true,
["vehiclesunglare"] = false,
["coronaztest"] = true,
["watercreatures"] = true,
["burnflippedcars"] = true,
["fireballdestruct"] = true,
["roadsignstext"] = true,
["extendedwatercannons"] = true,
["tunnelweatherblend"] = true,
["ignorefirestate"] = false,
["flyingcomponents"] = true,
}

for propertyName, propertyState in pairs(worldSpecialProperties) do
setWorldSpecialPropertyEnabled(propertyName, propertyState)
end
end
addEventHandler("onClientResourceStart", resourceRoot, onClientResourceStart)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.5-3.12286|Added "underworldwarp" property}}
{{ChangelogItem|1.5.9-1.21125|Added "vehiclesunglare" property}}
{{ChangelogItem|1.5.9-9.21313|Added "coronaztest" property}}
{{ChangelogItem|1.6.0-9.21919|Added "watercreatures" property}}
{{ChangelogItem|1.6.0-9.22195|Added "burnflippedcars" property}}
{{ChangelogItem|1.6.0-9.22199|Added "fireballdestruct" property}}
{{ChangelogItem|1.6.0-9.22430|Added "roadsignstext" property}}
{{ChangelogItem|1.6.0-9.22485|Added "extenedwatercannons" property}}
{{ChangelogItem|1.6.0-9.22596|Added "tunnelweatherblend" property}}
{{ChangelogItem|1.6.0-9.22815|Added "ignorefirestate" property}}
{{ChangelogItem|1.6.0-9.22909|Added "flyingcomponents" property}}

==See Also==
{{World functions}}

DecodeString

2025-05-17T22:39:23Z

Samr46: Add new zlib decoding feature

__NOTOC__
{{Shared function}}
{{New feature/item|3.0156|1.5.5|11849|
This function decodes an encoded [[string]] using the specified algorithm. The counterpart of this function is [[encodeString]].
}}

==Syntax==
<syntaxhighlight lang="lua">
string decodeString ( string algorithm, string input, [table options, function callback] )
</syntaxhighlight>

===Required Arguments===
*'''algorithm:''' The algorithm to use.
*'''input:''' The input to decode.
*'''options:''' A [[table]] with options and other necessary data for the algorithm, as detailed below.

===Options for each algorithm===
* ''tea'' ([https://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm Tiny Encryption Algorithm])
** '''key''': a key to decode the input with.
{{Added feature/item|1.5.9|1.5.8|20898|
* ''aes128'' ([https://en.wikipedia.org/wiki/Advanced_Encryption_Standard Advanced Encryption Standard] in CTR mode)
** '''key''': a key to decode the input with.
** '''iv''': the initialization vector that was generated by [[encodeString]] for this combination of data and encryption algorithm.
}}
{{Added feature/item|1.5.9|1.5.8|21055|
* ''rsa'' ([https://en.wikipedia.org/wiki/RSA_(cryptosystem) Rivest-Shamir-Adleman] in OAEP with SHA-1 mode)
** '''key''': a private key to decode the input.
|21055}}
{{Added feature/item|1.6.0|1.6.1|22408|
* ''base64'' ([https://en.wikipedia.org/wiki/Base64 Base64 Encoding Algorithm])
** '''variant''': a string that defines the encoding variant. (Currently only "URL" is available)
|22408}}
{{Added feature/item|1.6.0|1.6.1|22408|
* ''base32'' ([https://en.wikipedia.org/wiki/Base32 Base32 Encoding Algorithm])
** '''variant''': a string that defines the encoding variant. (Currently only "Hex" is available)
|22408}}
{{Added feature/item|1.6.0|1.6.1|23219|
* ''zlib'' ([https://en.wikipedia.org/wiki/Zlib Zlib Compression Algorithm])
** '''format''': a string or number that defines compression format. (gzip, zlib, raw or [https://www.zlib.net/manual.html#Advanced window size number]) (default: auto) (please note that automatic determination of format may not be reliable in some cases due to the nature of compression algorithm)
|23219}}

===Optional Arguments===
*'''callback:''' providing a callback will run this function asynchronously, the arguments to the callback are the same as the returned values below.
===Returns===
Returns the decoded string if successful, ''false'' otherwise. If a callback was provided, the decoded string is argument to the callback.

==Example==
Adds an ''/decode'' command in which you can provide an algorithm, key and data to decode.

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("decode",
function(player, _, algorithm, key, ...)
if algorithm and key then
local text = table.concat({...}, " ")
if type(text) == "string" and text ~= "" then
local decoded = decodeString(algorithm, text, { key = key })
if decoded then
outputChatBox("The result of " .. algorithm .. " decoding is: " .. decoded, player)
else
outputChatBox("Failed to decode. Make sure that all arguments are valid.", player, 255, 0, 0)
end
else
outputChatBox("Please specify text in the command.", player, 255, 0, 0)
end
else
outputChatBox("Invalid algorithm and/or key.", player, 255, 0, 0)
end
end
)
</syntaxhighlight>
</section>

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

EncodeString

2025-05-17T22:32:30Z

Samr46: Add new zlib encoding feature

__NOTOC__
{{Shared function}}
{{New feature/item|3.0156|1.5.5|11849|
This function encodes a [[string]] using the specified algorithm. The counterpart of this function is [[decodeString]].
}}

{{Tip|If it doesn't matter which algorithm you use for the encoding, keep in mind that ''aes128'' uses hardware acceleration so it may outperform the ''tea'' algorithm on most processors.}}

==Syntax==
<syntaxhighlight lang="lua">
string encodeString ( string algorithm, string input, [table options, function callback] )
</syntaxhighlight>

===Required Arguments===
*'''algorithm:''' The algorithm to use.
*'''input:''' The input to encode.
*'''options:''' A [[table]] with options and other necessary data for the algorithm, as detailed below.

===Options for each algorithm===
* ''tea'' ([https://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm Tiny Encryption Algorithm])
** '''key''': a key to encode the input with.
{{Added feature/item|1.5.9|1.5.8|20898|
* ''aes128'' ([https://en.wikipedia.org/wiki/Advanced_Encryption_Standard Advanced Encryption Standard] in CTR mode)
** '''key''': a key to encode the input with (must be 16 characters long).
|20898}}
{{Added feature/item|1.5.9|1.5.8|21055|
* ''rsa'' ([https://en.wikipedia.org/wiki/RSA_(cryptosystem) Rivest-Shamir-Adleman] in OAEP with SHA-1 mode)
** '''key''': a public key to encode the input. (use [[generateKeyPair]] to create a new private and public key)
|21055}}
{{Added feature/item|1.6.0|1.6.1|22408|
* ''base64'' ([https://en.wikipedia.org/wiki/Base64 Base64 Encoding Algorithm])
** '''variant''': a string that defines the encoding variant. (Currently only "URL" is available)
|22408}}
{{Added feature/item|1.6.0|1.6.1|22408|
* ''base32'' ([https://en.wikipedia.org/wiki/Base32 Base32 Encoding Algorithm])
** '''variant''': a string that defines the encoding variant. (Currently only "Hex" is available)
|22408}}
{{Added feature/item|1.6.0|1.6.1|23219|
* ''zlib'' ([https://en.wikipedia.org/wiki/Zlib Zlib Compression Algorithm])
** '''compression''': a number that defines compression level. (0-9) (9 - the best) (default: 9)
** '''format''': a string or number that defines compression format. (gzip, zlib, raw or [https://www.zlib.net/manual.html#Advanced window size number]) (default: gzip)
** '''strategy''': a string that defines compression strategy. (default, filtered, huffman, rle, fixed)
|23219}}

===Optional Arguments===
*'''callback:''' providing a callback will run this function asynchronously, the arguments to the callback are the same as the returned values below.
===Returns for each algorithm===
{{New items|3.0159|1.5.8|
* ''aes128''
** '''encodedString''': the encoded string if successful, ''false'' otherwise. If a callback was provided, ''true'' is returned immediately, and the encoded string is passed as an argument to the callback.
** '''iv''' ([https://en.wikipedia.org/wiki/Initialization_vector Initialization vector]): this is a string generated by the encryption algorithm that is needed to decrypt the message by [[decodeString]]. If a callback was provided, ''true'' is returned immediately, and the ''iv'' is passed as an argument to the callback.
|20898}}
{{New items|3.0159|1.6.1|
* ''tea''
* ''rsa''
* ''base64''
* ''base32''
* ''zlib''
** '''encodedString''': the encoded string if successful, ''false'' otherwise. If a callback was provided, ''true'' is returned immediately, and the encoded string is passed as an argument to the callback.
|22408}}

==Examples==

<section name="Server" class="server" show="true">
Adds an ''/encode'' command in which you can provide an algorithm, key and data to encode. Below is the example provided as both server-side and client-side variations.
<syntaxhighlight lang="lua">
addCommandHandler("encode", function(player, _, algorithm, key, ...)
if not algorithm or not key then
outputChatBox("Invalid algorithm and/or key.", player, 255, 0, 0)
return
end
local text = table.concat({...}, " ")
if type(text) ~= "string" or text == "" then
outputChatBox("Please specify text in the command.", player, 255, 0, 0)
return
end
local encoded = encodeString(algorithm, text, { key = key })
if not encoded then
outputChatBox("Failed to encode. Make sure that all arguments are valid.", player, 255, 0, 0)
return
end

outputChatBox("The result of " .. algorithm .. " encoding is: " .. encoded, player)
end)
</syntaxhighlight>

This example shows you how to use the RSA encryption with a simple string message.
<syntaxhighlight lang="lua">
local private, public = generateKeyPair("rsa", { size = 2048 })

local input = "Hello, world!"
local encrypted = encodeString("rsa", input, { key = public })
local decrypted = decodeString("rsa", encrypted, { key = private })

outputServerLog("RSA test: ".. tostring(input == decrypted))
</syntaxhighlight>
</section>

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

EncodeString

2025-05-17T22:31:18Z

Samr46: Add new zlib encoding feature

__NOTOC__
{{Shared function}}
{{New feature/item|3.0156|1.5.5|11849|
This function encodes a [[string]] using the specified algorithm. The counterpart of this function is [[decodeString]].
}}

{{Tip|If it doesn't matter which algorithm you use for the encoding, keep in mind that ''aes128'' uses hardware acceleration so it may outperform the ''tea'' algorithm on most processors.}}

==Syntax==
<syntaxhighlight lang="lua">
string encodeString ( string algorithm, string input, [table options, function callback] )
</syntaxhighlight>

===Required Arguments===
*'''algorithm:''' The algorithm to use.
*'''input:''' The input to encode.
*'''options:''' A [[table]] with options and other necessary data for the algorithm, as detailed below.

===Options for each algorithm===
* ''tea'' ([https://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm Tiny Encryption Algorithm])
** '''key''': a key to encode the input with.
{{Added feature/item|1.5.9|1.5.8|20898|
* ''aes128'' ([https://en.wikipedia.org/wiki/Advanced_Encryption_Standard Advanced Encryption Standard] in CTR mode)
** '''key''': a key to encode the input with (must be 16 characters long).
|20898}}
{{Added feature/item|1.5.9|1.5.8|21055|
* ''rsa'' ([https://en.wikipedia.org/wiki/RSA_(cryptosystem) Rivest-Shamir-Adleman] in OAEP with SHA-1 mode)
** '''key''': a public key to encode the input. (use [[generateKeyPair]] to create a new private and public key)
|21055}}
{{Added feature/item|1.6.0|1.6.1|22408|
* ''base64'' ([https://en.wikipedia.org/wiki/Base64 Base64 Encoding Algorithm])
** '''variant''': a string that defines the encoding variant. (Currently only "URL" is available)
|22408}}
{{Added feature/item|1.6.0|1.6.1|22408|
* ''base32'' ([https://en.wikipedia.org/wiki/Base32 Base32 Encoding Algorithm])
** '''variant''': a string that defines the encoding variant. (Currently only "Hex" is available)
|22408}}
{{Added feature/item|1.6.0|1.6.1|23219|
* ''zlib'' ([https://en.wikipedia.org/wiki/Zlib Zlib Compression Algorithm])
** '''compression''': a number that defines compression level. (0-9) (9 - the best) (default: 9)
** '''format''': a string or number that defines compression format. (gzip, zlib, raw or [https://www.zlib.net/manual.html#Advanced window size number]) (default: gzip)
** '''strategy''': a string that defines compression strategy. (default, filtered, huffman, rle, fixed)
|23219}}

===Optional Arguments===
*'''callback:''' providing a callback will run this function asynchronously, the arguments to the callback are the same as the returned values below.
===Returns for each algorithm===
{{New items|3.0159|1.5.8|
* ''aes128''
** '''encodedString''': the encoded string if successful, ''false'' otherwise. If a callback was provided, ''true'' is returned immediately, and the encoded string is passed as an argument to the callback.
** '''iv''' ([https://en.wikipedia.org/wiki/Initialization_vector Initialization vector]): this is a string generated by the encryption algorithm that is needed to decrypt the message by [[decodeString]]. If a callback was provided, ''true'' is returned immediately, and the ''iv'' is passed as an argument to the callback.
|20898}}
{{New items|3.0159|1.6.1|
* ''tea''
* ''rsa''
* ''base64''
* ''base32''
** '''encodedString''': the encoded string if successful, ''false'' otherwise. If a callback was provided, ''true'' is returned immediately, and the encoded string is passed as an argument to the callback.
|22408}}

==Examples==

<section name="Server" class="server" show="true">
Adds an ''/encode'' command in which you can provide an algorithm, key and data to encode. Below is the example provided as both server-side and client-side variations.
<syntaxhighlight lang="lua">
addCommandHandler("encode", function(player, _, algorithm, key, ...)
if not algorithm or not key then
outputChatBox("Invalid algorithm and/or key.", player, 255, 0, 0)
return
end
local text = table.concat({...}, " ")
if type(text) ~= "string" or text == "" then
outputChatBox("Please specify text in the command.", player, 255, 0, 0)
return
end
local encoded = encodeString(algorithm, text, { key = key })
if not encoded then
outputChatBox("Failed to encode. Make sure that all arguments are valid.", player, 255, 0, 0)
return
end

outputChatBox("The result of " .. algorithm .. " encoding is: " .. encoded, player)
end)
</syntaxhighlight>

This example shows you how to use the RSA encryption with a simple string message.
<syntaxhighlight lang="lua">
local private, public = generateKeyPair("rsa", { size = 2048 })

local input = "Hello, world!"
local encrypted = encodeString("rsa", input, { key = public })
local decrypted = decodeString("rsa", encrypted, { key = private })

outputServerLog("RSA test: ".. tostring(input == decrypted))
</syntaxhighlight>
</section>

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

GetWorldProperty

2024-07-01T17:21:49Z

Samr46: Use Client world functions

__NOTOC__
{{Client function}}
{{New feature/item|3.0161|1.6.0|22592|This function is used to get the values of time cycle and weather related properties.}}

==Syntax==
<syntaxhighlight lang="lua">
mixed getWorldProperty ( string property )
</syntaxhighlight>
{{OOP||||setWorldProperty}}
===Required Arguments===
*'''property:''' The property you wish to retrieve.
{{World Properties}}

===Returns===
Returns the value of property represented by either 1 or 3 numbers (RGB, FLOAT, INT) if successful, ''false'' otherwise.

==Example==
This example prints the value of AmbientColor:
<syntaxhighlight lang="lua">
local r, g, b = getWorldProperty("AmbientColor")
outputChatBox("Ambient Color: "..table.concat({r, g, b}, ", "))
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.6.0-9.22592|}}

==See Also==
{{Client world functions}}

ResetWorldProperty

2024-07-01T17:21:34Z

Samr46: Use Client world functions

__NOTOC__
{{Client function}}
{{New feature/item|3.0161|1.6.0|22592|This function is used to reset the values of time cycle and weather related properties.}}
{{Note|Some properties (like '''RainFog''' and '''Sandstorm''') are not reset immediately. The game resets it smoothly over small period of time.}}

==Syntax==
<syntaxhighlight lang="lua">
bool resetWorldProperty ( string property )
</syntaxhighlight>
===Required Arguments===
*'''property:''' The property you wish to retrieve.
{{World Properties}}

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

==Requirements==
{{Requirements|n/a|1.6.0-9.22592|}}

==See Also==
{{Client world functions}}

SetWorldProperty

2024-07-01T17:21:03Z

Samr46: Use Client world functions

__NOTOC__
{{Client function}}
{{New feature/item|3.0161|1.6.0|22592|This function is used to override time cycle and weather related properties. Preview (album): https://imgur.com/a/jeUxx7L}}
{{Note|This function only adds remaining time cycle properties. You need to use existing world functions to override other properties (like sun color).}}
{{Tip|This function can be used to implement custom time cycles and other advanced weather features. It allows you to override values set by the game for weathers (timecyc.dat).
The downside of overriding is the need to implement custom blending (to change weather properties over time creating night / day cycle).}}
{{Tip|Test resource: [https://github.com/multitheftauto/mtasa-blue/files/11375576/worldprops.zip worldprops.zip]}}

==Syntax==
<syntaxhighlight lang="lua">
bool setWorldProperty ( string property, var value [, var value, var value] )
</syntaxhighlight>
{{OOP||||getWorldProperty}}
===Required Arguments===
*'''property:''' The property you wish to override.
{{World Properties}}
*'''value:''' At least one value has to be provided.

Example arguments for</br>RGB: 255, 255, 255</br>FLOAT: 0.5</br>INT: 100

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

==Example==
This example makes volumetric shadows darker:
<syntaxhighlight lang="lua">
setWorldProperty("ShadowStrength", 500)
</syntaxhighlight>
This example turns off street lights:
<syntaxhighlight lang="lua">
setWorldProperty("SpriteBrightness", 0)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.6.0-9.22592|}}

==See Also==
{{Client world functions}}

Template:World functions

2024-06-30T16:00:24Z

Samr46: Add new world property functions

'''Server-side'''
<ul>
<li>[[getJetpackWeaponEnabled]]</li>
<li>[[setJetpackWeaponEnabled]]</li>
</ul>

'''Client-side'''
<ul>
<li>[[getWorldProperty]]</li>
<li>[[resetWorldProperty]]</li>
<li>[[setWorldProperty]]</li>
</ul>

'''Shared'''
{{Shared_world_functions}}

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

Template:Client world functions

2024-06-30T15:51:10Z

Samr46: Add new world property functions

<ul>
<li>[[createSWATRope]]</li>
<li>[[getBirdsEnabled]]</li>
{{New feature/item|3.0161|1.6.0|22188|
<li>[[getColorFilter]]</li>
}}
<li>[[getCoronaReflectionsEnabled]]</li>
<li>[[getGarageBoundingBox]]</li>
<li>[[getGaragePosition]]</li>
<li>[[getGarageSize]]</li>
<li>[[getGroundPosition]]</li>
<li>[[getInteriorFurnitureEnabled]]</li>
<li>[[getNearClipDistance]]</li>
<li>[[getPedsLODDistance]]</li>
{{Added feature/item|1.5.9|1.5.8|20675|
<li>[[getRoofPosition]]</li>
}}
<li>[[getScreenFromWorldPosition]]</li>
<li>[[getVehiclesLODDistance]]</li>
<li>[[getWorldFromScreenPosition]]</li>
{{New feature/item|3.0161|1.6.0|22592|
<li>[[getWorldProperty]]</li>
}}
<li>[[isAmbientSoundEnabled]]</li>
<li>[[isLineOfSightClear]]</li>
<li>[[isWorldSoundEnabled]]</li>
{{New feature/item|3.0161|1.6.0|22219|
<li>[[processLineAgainstMesh]]</li>
}}
<li>[[processLineOfSight]]</li>
<li>[[resetAmbientSounds]]</li>
<li>[[resetBlurLevel]]</li>
<li>[[resetColorFilter]]</li>
<li>[[resetCoronaReflectionsEnabled]]</li>
<li>[[resetNearClipDistance]]</li>
<li>[[resetPedsLODDistance]]</li>
<li>[[resetVehiclesLODDistance]]</li>
{{New feature/item|3.0161|1.6.0|22592|
<li>[[resetWorldProperty]]</li>
}}
<li>[[resetWorldSounds]]</li>
<li>[[setAmbientSoundEnabled]]</li>
<li>[[setBirdsEnabled]]</li>
<li>[[setColorFilter]]</li>
<li>[[setCoronaReflectionsEnabled]]</li>
<li>[[setInteriorFurnitureEnabled]]</li>
<li>[[setInteriorSoundsEnabled]]</li>
<li>[[setNearClipDistance]]</li>
<li>[[setPedsLODDistance]]</li>
<li>[[setVehiclesLODDistance]]</li>
{{New feature/item|3.0161|1.6.0|22592|
<li>[[setWorldProperty]]</li>
}}
<li>[[setWorldSoundEnabled]]</li>
{{New feature/item|3.0161|1.6.0|21902|
<li>[[setGrainLevel]]</li>
}}
{{New feature/item|3.0161|1.6.0|21902|
<li>[[setGrainMultiplier]]</li>
}}
<li>[[testLineAgainstWater]]</li>
</ul>

'''Shared'''
{{Shared_world_functions}}

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

ResetWorldProperty

2024-06-30T15:46:50Z

Samr46: Add resetWorldProperty

GetWorldProperty

2024-06-30T15:46:01Z

Samr46: Add getWorldProperty

SetWorldProperty

2024-06-30T15:44:54Z

Samr46: Add setWorldProperty

Template:World Properties

2024-06-30T13:36:13Z

Samr46: World Properties Table (initial release)

{| border="1" cellpadding="4" cellspacing="0" align="center"
|-
! scope="col" style="background:#afafaf;"|Property
! scope="col" style="background:#afafaf;"|Type
! scope="col" style="background:#afafaf;"|Description
|-
| scope="row"|'''AmbientColor'''
| align="center"|RGB
| |The color of ambient light on map objects (including custom objects)
|-
| scope="row"|'''AmbientObjColor'''
| align="center"|RGB
| |The color of ambient light on dynamically created elements (peds, vehicles)
|-
| scope="row"|'''DirectionalColor'''
| align="center"|RGB
| |The color of direct light on dynamically created elements (peds, vehicles)
|-
| scope="row"|'''Illumination'''
| align="center"|FLOAT
| |Multiplier for the directional light (DirectionalColor)
|-
| scope="row"|'''SpriteSize'''
| align="center"|FLOAT
| |Point lights corona size (traffic lights)
|-
| scope="row"|'''SpriteBrightness'''
| align="center"|FLOAT
| |Point lights corona brightness (also affects light on ground for light poles)
|-
| scope="row"|'''LightsOnGround'''
| align="center"|FLOAT
| |Point lights ground reflection brightness (traffic lights)
|-
| scope="row"|'''PoleShadowStrength'''
| align="center"|INT
| |Pole shadows alpha (used if volumetric shadows are disabled)
|-
| scope="row"|'''ShadowStrength'''
| align="center"|INT
| |Shadows alpha (all shadows)
|-
| scope="row"|'''ShadowsOffset'''
| align="center"|FLOAT
| |Shadows height
|-
| scope="row"|'''BottomCloudsColor'''
| align="center"|RGB
| |Bottom (normal) clouds color
|-
| scope="row"|'''CloudsAlpha'''
| align="center"|INT
| |Bottom (normal) clouds alpha
|-
| scope="row"|'''LowCloudsColor'''
| align="center"|RGB
| |Low (skyline) clouds color (dependent on game hours)
|-
| scope="row"|'''WetRoads'''
| align="center"|FLOAT
| |Wet roads weather effect (noticeable during driving)</br>Turns on lights on ground during daytime
|-
| scope="row"|'''Foggyness'''
| align="center"|FLOAT
| |Adds light fog effect for headlights and turns on lights on ground during daytime</br>Also affects skyline clouds and shadows visibility
|-
| scope="row"|'''Fog'''
| align="center"|FLOAT
| |Fog weather effect alpha
|-
| scope="row"|'''RainFog'''
| align="center"|FLOAT
| |Rain fog weather effect alpha (different fog; used in rain weathers) (reset is smooth)
|-
| scope="row"|'''WaterFog'''
| align="center"|FLOAT
| |Water fog alpha
|-
| scope="row"|'''Rainbow'''
| align="center"|FLOAT
| |Rainbow alpha
|-
| scope="row"|'''Sandstorm'''
| align="center"|FLOAT
| |Sandstorm sound volume (reset is smooth)
|}

SetWorldSpecialPropertyEnabled

2023-09-10T17:40:45Z

Samr46: Added "fireballdestruct" property

File:FireballDestruct.jpg

2023-09-10T17:36:10Z

Samr46: fireballdestruct

== Summary ==
fireballdestruct

Template:Client world functions

2023-09-09T08:48:16Z

Samr46: Undo revision 77620 by Samr46 (talk)

<ul>
<li>[[areTrafficLightsLocked]]</li>
<li>[[createSWATRope]]</li>
<li>[[getAircraftMaxHeight]]</li>
<li>[[getAircraftMaxVelocity]]</li>
<li>[[getBirdsEnabled]]</li>
{{New feature/item|3.0161|1.6.0|22188|
<li>[[getColorFilter]]</li>
}}
<li>[[getCloudsEnabled]]</li>
<li>[[getCoronaReflectionsEnabled]]</li>
<li>[[getFarClipDistance]]</li>
<li>[[getFogDistance]]</li>
<li>[[getGameSpeed]]</li>
<li>[[getGarageBoundingBox]]</li>
<li>[[getGaragePosition]]</li>
<li>[[getGarageSize]]</li>
<li>[[getGravity]]</li>
<li>[[getGroundPosition]]</li>
<li>[[getHeatHaze]]</li>
<li>[[getInteriorFurnitureEnabled]]</li>
<li>[[getInteriorSoundsEnabled]]</li>
<li>[[getJetpackMaxHeight]]</li>
<li>[[getMinuteDuration]]</li>
<li>[[getMoonSize]]</li>
<li>[[getNearClipDistance]]</li>
<li>[[getOcclusionsEnabled]]</li>
<li>[[getPedsLODDistance]]</li>
<li>[[getPlayerBlurLevel]]</li>
<li>[[getRainLevel]]</li>
{{Added feature/item|1.5.9|1.5.8|20675|
<li>[[getRoofPosition]]</li>
}}
<li>[[getScreenFromWorldPosition]]</li>
<li>[[getSunColor]]</li>
<li>[[getSunSize]]</li>
<li>[[getTime]]</li>
<li>[[getTrafficLightState]]</li>
<li>[[getVehiclesLODDistance]]</li>
<li>[[getWeather]]</li>
<li>[[getWindVelocity]]</li>
<li>[[getWorldFromScreenPosition]]</li>
<li>[[getZoneName]]</li>
<li>[[isAmbientSoundEnabled]]</li>
<li>[[isGarageOpen]]</li>
<li>[[isLineOfSightClear]]</li>
<li>[[isWorldSoundEnabled]]</li>
<li>[[isWorldSpecialPropertyEnabled]]</li>
<li>[[processLineOfSight]]</li>
<li>[[removeWorldModel]]</li>
<li>[[resetAmbientSounds]]</li>
<li>[[resetBlurLevel]]</li>
<li>[[resetColorFilter]]</li>
<li>[[resetCoronaReflectionsEnabled]]</li>
<li>[[resetFarClipDistance]]</li>
<li>[[resetFogDistance]]</li>
<li>[[resetHeatHaze]]</li>
<li>[[resetMoonSize]]</li>
<li>[[resetNearClipDistance]]</li>
<li>[[resetPedsLODDistance]]</li>
<li>[[resetRainLevel]]</li>
<li>[[resetSkyGradient]]</li>
<li>[[resetSunColor]]</li>
<li>[[resetSunSize]]</li>
<li>[[resetVehiclesLODDistance]]</li>
<li>[[resetWindVelocity]]</li>
<li>[[resetWorldSounds]]</li>
<li>[[restoreAllWorldModels]]</li>
<li>[[restoreWorldModel]]</li>
<li>[[setAircraftMaxHeight]]</li>
<li>[[setAircraftMaxVelocity]]</li>
<li>[[setAmbientSoundEnabled]]</li>
<li>[[setBirdsEnabled]]</li>
<li>[[setCloudsEnabled]]</li>
<li>[[setColorFilter]]</li>
<li>[[setCoronaReflectionsEnabled]]</li>
<li>[[setFarClipDistance]]</li>
<li>[[setFogDistance]]</li>
<li>[[setGameSpeed]]</li>
<li>[[setGarageOpen]]</li>
<li>[[setGravity]]</li>
<li>[[setHeatHaze]]</li>
<li>[[setInteriorFurnitureEnabled]]</li>
<li>[[setInteriorSoundsEnabled]]</li>
<li>[[setJetpackMaxHeight]]</li>
<li>[[setMinuteDuration]]</li>
<li>[[setMoonSize]]</li>
<li>[[setNearClipDistance]]</li>
<li>[[setOcclusionsEnabled]]</li>
<li>[[setPedsLODDistance]]</li>
<li>[[setPlayerBlurLevel]]</li>
<li>[[setRainLevel]]</li>
<li>[[setSkyGradient]]</li>
<li>[[setSunColor]]</li>
<li>[[setSunSize]]</li>
<li>[[setTime]]</li>
<li>[[setTrafficLightsLocked]]</li>
<li>[[setTrafficLightState]]</li>
<li>[[setVehiclesLODDistance]]</li>
<li>[[setWeather]]</li>
<li>[[setWeatherBlended]]</li>
<li>[[setWindVelocity]]</li>
<li>[[setWorldSoundEnabled]]</li>
<li>[[setWorldSpecialPropertyEnabled]]</li>
{{New feature/item|3.0161|1.6.0|21902|
<li>[[setGrainLevel]]</li>
}}
{{New feature/item|3.0161|1.6.0|21902|
<li>[[setGrainMultiplier]]</li>
}}
<li>[[testLineAgainstWater]]</li>
</ul>

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

Template:Client world functions

2023-09-09T08:46:21Z

Samr46: Remove is/setWorldSpecialPropertyEnabled

<ul>
<li>[[areTrafficLightsLocked]]</li>
<li>[[createSWATRope]]</li>
<li>[[getAircraftMaxHeight]]</li>
<li>[[getAircraftMaxVelocity]]</li>
<li>[[getBirdsEnabled]]</li>
{{New feature/item|3.0161|1.6.0|22188|
<li>[[getColorFilter]]</li>
}}
<li>[[getCloudsEnabled]]</li>
<li>[[getCoronaReflectionsEnabled]]</li>
<li>[[getFarClipDistance]]</li>
<li>[[getFogDistance]]</li>
<li>[[getGameSpeed]]</li>
<li>[[getGarageBoundingBox]]</li>
<li>[[getGaragePosition]]</li>
<li>[[getGarageSize]]</li>
<li>[[getGravity]]</li>
<li>[[getGroundPosition]]</li>
<li>[[getHeatHaze]]</li>
<li>[[getInteriorFurnitureEnabled]]</li>
<li>[[getInteriorSoundsEnabled]]</li>
<li>[[getJetpackMaxHeight]]</li>
<li>[[getMinuteDuration]]</li>
<li>[[getMoonSize]]</li>
<li>[[getNearClipDistance]]</li>
<li>[[getOcclusionsEnabled]]</li>
<li>[[getPedsLODDistance]]</li>
<li>[[getPlayerBlurLevel]]</li>
<li>[[getRainLevel]]</li>
{{Added feature/item|1.5.9|1.5.8|20675|
<li>[[getRoofPosition]]</li>
}}
<li>[[getScreenFromWorldPosition]]</li>
<li>[[getSunColor]]</li>
<li>[[getSunSize]]</li>
<li>[[getTime]]</li>
<li>[[getTrafficLightState]]</li>
<li>[[getVehiclesLODDistance]]</li>
<li>[[getWeather]]</li>
<li>[[getWindVelocity]]</li>
<li>[[getWorldFromScreenPosition]]</li>
<li>[[getZoneName]]</li>
<li>[[isAmbientSoundEnabled]]</li>
<li>[[isGarageOpen]]</li>
<li>[[isLineOfSightClear]]</li>
<li>[[isWorldSoundEnabled]]</li>
<li>[[processLineOfSight]]</li>
<li>[[removeWorldModel]]</li>
<li>[[resetAmbientSounds]]</li>
<li>[[resetBlurLevel]]</li>
<li>[[resetColorFilter]]</li>
<li>[[resetCoronaReflectionsEnabled]]</li>
<li>[[resetFarClipDistance]]</li>
<li>[[resetFogDistance]]</li>
<li>[[resetHeatHaze]]</li>
<li>[[resetMoonSize]]</li>
<li>[[resetNearClipDistance]]</li>
<li>[[resetPedsLODDistance]]</li>
<li>[[resetRainLevel]]</li>
<li>[[resetSkyGradient]]</li>
<li>[[resetSunColor]]</li>
<li>[[resetSunSize]]</li>
<li>[[resetVehiclesLODDistance]]</li>
<li>[[resetWindVelocity]]</li>
<li>[[resetWorldSounds]]</li>
<li>[[restoreAllWorldModels]]</li>
<li>[[restoreWorldModel]]</li>
<li>[[setAircraftMaxHeight]]</li>
<li>[[setAircraftMaxVelocity]]</li>
<li>[[setAmbientSoundEnabled]]</li>
<li>[[setBirdsEnabled]]</li>
<li>[[setCloudsEnabled]]</li>
<li>[[setColorFilter]]</li>
<li>[[setCoronaReflectionsEnabled]]</li>
<li>[[setFarClipDistance]]</li>
<li>[[setFogDistance]]</li>
<li>[[setGameSpeed]]</li>
<li>[[setGarageOpen]]</li>
<li>[[setGravity]]</li>
<li>[[setHeatHaze]]</li>
<li>[[setInteriorFurnitureEnabled]]</li>
<li>[[setInteriorSoundsEnabled]]</li>
<li>[[setJetpackMaxHeight]]</li>
<li>[[setMinuteDuration]]</li>
<li>[[setMoonSize]]</li>
<li>[[setNearClipDistance]]</li>
<li>[[setOcclusionsEnabled]]</li>
<li>[[setPedsLODDistance]]</li>
<li>[[setPlayerBlurLevel]]</li>
<li>[[setRainLevel]]</li>
<li>[[setSkyGradient]]</li>
<li>[[setSunColor]]</li>
<li>[[setSunSize]]</li>
<li>[[setTime]]</li>
<li>[[setTrafficLightsLocked]]</li>
<li>[[setTrafficLightState]]</li>
<li>[[setVehiclesLODDistance]]</li>
<li>[[setWeather]]</li>
<li>[[setWeatherBlended]]</li>
<li>[[setWindVelocity]]</li>
<li>[[setWorldSoundEnabled]]</li>
{{New feature/item|3.0161|1.6.0|21902|
<li>[[setGrainLevel]]</li>
}}
{{New feature/item|3.0161|1.6.0|21902|
<li>[[setGrainMultiplier]]</li>
}}
<li>[[testLineAgainstWater]]</li>
</ul>

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

Template:World functions

2023-09-09T08:44:17Z

Samr46: Add is/setWorldSpecialPropertyEnabled

<ul>
<li>[[areTrafficLightsLocked]]</li>
<li>[[getAircraftMaxVelocity]]</li>
<li>[[getCloudsEnabled]]</li>
<li>[[getFarClipDistance]]</li>
<li>[[getFogDistance]]</li>
<li>[[getGameSpeed]]</li>
<li>[[getGravity]]</li>
<li>[[getHeatHaze]]</li>
<li>[[getJetpackMaxHeight]]</li>
<li>[[getJetpackWeaponEnabled]]</li>
<li>[[getMinuteDuration]]</li>
<li>[[getMoonSize]]</li>
<li>[[getOcclusionsEnabled]]</li>
<li>[[getRainLevel]]</li>
<li>[[getSkyGradient]]</li>
<li>[[getSunColor]]</li>
<li>[[getSunSize]]</li>
<li>[[getTime]]</li>
<li>[[getTrafficLightState]]</li>
<li>[[getWeather]]</li>
<li>[[getWindVelocity]]</li>
{{New items|3.0161|1.6.0|
<li>[[isWorldSpecialPropertyEnabled]]</li>
|22195}}
<li>[[getZoneName]]</li>
<li>[[isGarageOpen]]</li>
<li>[[removeWorldModel]]</li>
{{Added feature/item|1.5.9|1.5.8|20718|
<li>[[resetColorFilter]]</li>
}}
<li>[[resetFarClipDistance]]</li>
<li>[[resetFogDistance]]</li>
<li>[[resetHeatHaze]]</li>
<li>[[resetMoonSize]]</li>
<li>[[resetRainLevel]]</li>
<li>[[resetSkyGradient]]</li>
<li>[[resetSunColor]]</li>
<li>[[resetSunSize]]</li>
<li>[[resetWindVelocity]]</li>
<li>[[restoreAllWorldModels]]</li>
<li>[[restoreWorldModel]]</li>
<li>[[setAircraftMaxVelocity]]</li>
<li>[[setCloudsEnabled]]</li>
{{Added feature/item|1.5.9|1.5.8|20718|
<li>[[setColorFilter]]</li>
}}
<li>[[setFarClipDistance]]</li>
<li>[[setFogDistance]]</li>
<li>[[setGameSpeed]]</li>
<li>[[setGarageOpen]]</li>
<li>[[setGravity]]</li>
<li>[[setHeatHaze]]</li>
<li>[[setInteriorSoundsEnabled]]</li>
<li>[[setJetpackWeaponEnabled]]</li>
<li>[[setMinuteDuration]]</li>
<li>[[setMoonSize]]</li>
<li>[[setOcclusionsEnabled]]</li>
<li>[[setRainLevel]]</li>
<li>[[setSkyGradient]]</li>
<li>[[setSunColor]]</li>
<li>[[setSunSize]]</li>
<li>[[setTime]]</li>
<li>[[setTrafficLightState]]</li>
<li>[[setTrafficLightsLocked]]</li>
<li>[[setWeather]]</li>
<li>[[setWeatherBlended]]</li>
<li>[[setWindVelocity]]</li>
{{New items|3.0161|1.6.0|
<li>[[setWorldSpecialPropertyEnabled]]</li>
|22195}}
</ul>

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

Template:Shared world functions

2023-09-09T08:42:05Z

Samr46: Add is/setWorldSpecialPropertyEnabled

<ul>
<li>[[areTrafficLightsLocked]]</li>
<li>[[getAircraftMaxVelocity]]</li>
<li>[[getCloudsEnabled]]</li>
<li>[[getFarClipDistance]]</li>
<li>[[getFogDistance]]</li>
<li>[[getGameSpeed]]</li>
<li>[[getGravity]]</li>
<li>[[getHeatHaze]]</li>
<li>[[getJetpackMaxHeight]]</li>
<li>[[getMinuteDuration]]</li>
<li>[[getMoonSize]]</li>
<li>[[getOcclusionsEnabled]]</li>
<li>[[getRainLevel]]</li>
<li>[[getSunColor]]</li>
<li>[[getSunSize]]</li>
<li>[[getTime]]</li>
<li>[[getTrafficLightState]]</li>
<li>[[getWeather]]</li>
<li>[[getWindVelocity]]</li>
<li>[[isWorldSpecialPropertyEnabled]]</li>
<li>[[getZoneName]]</li>
<li>[[isGarageOpen]]</li>
<li>[[removeWorldModel]]</li>
<li>[[resetFarClipDistance]]</li>
<li>[[resetFogDistance]]</li>
<li>[[resetHeatHaze]]</li>
<li>[[resetMoonSize]]</li>
<li>[[resetRainLevel]]</li>
<li>[[resetSkyGradient]]</li>
<li>[[resetSunColor]]</li>
<li>[[resetSunSize]]</li>
<li>[[resetWindVelocity]]</li>
<li>[[restoreAllWorldModels]]</li>
<li>[[restoreWorldModel]]</li>
<li>[[setAircraftMaxVelocity]]</li>
<li>[[setCloudsEnabled]]</li>
<li>[[setFarClipDistance]]</li>
<li>[[setFogDistance]]</li>
<li>[[setGameSpeed]]</li>
<li>[[setGarageOpen]]</li>
<li>[[setGravity]]</li>
<li>[[setHeatHaze]]</li>
<li>[[setInteriorSoundsEnabled]]</li>
<li>[[setMinuteDuration]]</li>
<li>[[setMoonSize]]</li>
<li>[[setOcclusionsEnabled]]</li>
<li>[[setRainLevel]]</li>
<li>[[setSkyGradient]]</li>
<li>[[setSunColor]]</li>
<li>[[setSunSize]]</li>
<li>[[setTime]]</li>
<li>[[setTrafficLightState]]</li>
<li>[[setTrafficLightsLocked]]</li>
<li>[[setWeather]]</li>
<li>[[setWeatherBlended]]</li>
<li>[[setWindVelocity]]</li>
<li>[[setWorldSpecialPropertyEnabled]]</li>
</ul>

IsWorldSpecialPropertyEnabled

2023-09-09T08:34:51Z

Samr46: Added to server-side

__NOTOC__
{{Shared function}}

{{New feature/item|3.0161|1.6.0|22195|Added also as a server-side function. Previously only available as a client-side function.}}

Checks if a special world property (cheat) is enabled or not.

==Syntax==
<syntaxhighlight lang="lua">bool isWorldSpecialPropertyEnabled ( string propname )</syntaxhighlight>
{{OOP||||setWorldSpecialPropertyEnabled}}

===Required Arguments===
*'''propname:''' the name of the property to retrieve. Possible values are listed on [[SetWorldSpecialPropertyEnabled]].

===Returns===
Returns ''true'' if the property is enabled, ''false'' if it is disabled or the specified property name is invalid.

==Example==
<section name="Clientside example" class="client" show="true">
This example detects any cheaters using these cheats on your server and sends them to hell, or you could kick them if you trigger a server event which does that.
<syntaxhighlight lang="lua">
function clientCheatScan()
glp = getLocalPlayer()
if isWorldSpecialPropertyEnabled("aircars") then
clientCheat()
end
if isWorldSpecialPropertyEnabled("hovercars") then
clientCheat()
end
if isWorldSpecialPropertyEnabled("extrabunny") then
clientCheat()
end
if isWorldSpecialPropertyEnabled("extrajump") then
clientCheat()
end
end
setTimer(clientCheatScan, 15000, 0)

function clientCheat() -- This function will send them to hell.
fadeCamera(false, 1, 255, 0, 0)
x,y,z = getElementPosition(glp)
createExplosion(x,y,z, 1)
toggleAllControls(false, true, true)
createMarker(x,y,z, "cylinder", 1, 1, 1, 1)
setTimer(clientCheat, 200, 1)
outputChatBox("WELCOME TO CHEATERS HELL LMAO!")
end
</syntaxhighlight>
</section>

==See Also==
{{Shared world functions}}

SetWorldSpecialPropertyEnabled

2023-09-09T08:32:51Z

Samr46: Added to server-side + "burnflippedcars" property

DxGetTexturePixels

2023-08-29T14:47:19Z

Samr46:

{{Client function}}
__NOTOC__
This function fetches the [[Texture_pixels|pixels]] from a [[texture]] element. It can be used with a standard texture, render target or screen source.
{{Important Note|dxGetTexturePixels will not work on a screen source or render target if the player has disabled screen upload.}}
{{Note|
*This function is slow and not something you want to be doing once a frame.
*It is slower when reading pixels from a render target or screen source.
*And is very slow indeed if the texture format is not ''' 'argb' ''' (unless the native ''''dds'''' format is used with correct options).
}}

==Syntax==
<syntaxhighlight lang="lua">
string dxGetTexturePixels ( [ int surfaceIndex = 0, ] element texture [, string pixelsFormat = "plain" [, string textureFormat = "unknown"] [, bool mipmaps = true] ] [, int x = 0, int y = 0, int width = 0, int height = 0 ] )
</syntaxhighlight>
{{OOP||[[texture]]:getPixels}}
===Required Arguments===
*'''texture :''' The texture element to get the pixels from

===Optional Arguments===
*'''surfaceIndex:''' Desired slice to get if the texture is a volume texture, or desired face to get if the texture is a cube map. <nowiki>(Cube map faces: 0=+X 1=-X 2=+Y 3=-Y 4=+Z 5=-Z)</nowiki>
{{New feature/item|3.0161|1.6.0|22185|
*'''pixelsFormat:''' "plain", "dds"
*'''textureFormat:''' A string representing the desired texture format for "'''dds'''" pixels, which can be one of:
**'''"unknown"''': Determined automatically based on texture format (default).
**'''"argb"''': ARGB uncompressed 32 bit color.
**'''"dxt1"''': DXT1 compressed - Can take a fraction of a second longer to create (unless the texture is already in DXT1). Uses 8 times less video memory than ARGB and ''can speed up drawing''. Quality not as good as ARGB. ''It supports alpha blending, but it can only be on or off, that is: either 0 or 255.''
**'''"dxt3"''': DXT3 compressed - Can take a fraction of a second longer to create (unless the texture is already in DXT3). Uses 4 times less video memory than ARGB and ''can speed up drawing''. Quality slightly better than DXT1 and supports crisp alpha blending.
**'''"dxt5"''': DXT5 compressed - Can take a fraction of a second longer to create (unless the texture is already in DXT5). Uses 4 times less video memory than ARGB and ''can speed up drawing''. Quality slightly better than DXT1 and supports smooth alpha blending.
*'''mipmaps:''' True to create a mip-map chain for "'''dds'''" pixels so the texture looks good when drawn at various sizes.
}}
By default the pixels from the whole texture is returned. To get only a portion of the texture, define a rectangular area using all four of these optional arguments:
*'''x:''' Rectangle left position
*'''y:''' Rectangle top position
*'''width:''' Rectangle width
*'''height :''' Rectangle height

==Returns==
Returns pixels string if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<syntaxhighlight lang="lua">
local mtaLogo = dxCreateTexture("mta-logo.png")
outputChatBox("MTA logo pixels is: "..dxGetTexturePixels(mtaLogo))
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04021|Added surfaceIndex argument}}
{{ChangelogItem|1.6.0-9.22185|Added dds pixels format}}

==See Also==
{{Drawing_functions}}

[[hu:dxGetTexturePixels]]

DxGetTexturePixels

2023-08-29T14:35:45Z

Samr46: Move dds pixels arguments to proper position

{{Client function}}
__NOTOC__
This function fetches the [[Texture_pixels|pixels]] from a [[texture]] element. It can be used with a standard texture, render target or screen source.
{{Important Note|dxGetTexturePixels will not work on a screen source or render target if the player has disabled screen upload.}}
{{Note|
*This function is slow and not something you want to be doing once a frame.
*It is slower when reading pixels from a render target or screen source.
*And is very slow indeed if the texture format is not ''' 'argb' '''.
}}

==Syntax==
<syntaxhighlight lang="lua">
string dxGetTexturePixels ( [ int surfaceIndex = 0, ] element texture [, string pixelsFormat = "plain" [, string textureFormat = "unknown"] [, bool mipmaps = true] ] [, int x = 0, int y = 0, int width = 0, int height = 0 ] )
</syntaxhighlight>
{{OOP||[[texture]]:getPixels}}
===Required Arguments===
*'''texture :''' The texture element to get the pixels from

===Optional Arguments===
*'''surfaceIndex:''' Desired slice to get if the texture is a volume texture, or desired face to get if the texture is a cube map. <nowiki>(Cube map faces: 0=+X 1=-X 2=+Y 3=-Y 4=+Z 5=-Z)</nowiki>
{{New feature/item|3.0161|1.6.0|22185|
*'''pixelsFormat:''' "plain", "dds"
*'''textureFormat:''' A string representing the desired texture format for "'''dds'''" pixels, which can be one of:
**'''"unknown"''': Determined automatically based on texture format (default).
**'''"argb"''': ARGB uncompressed 32 bit color.
**'''"dxt1"''': DXT1 compressed - Can take a fraction of a second longer to create (unless the texture is already in DXT1). Uses 8 times less video memory than ARGB and ''can speed up drawing''. Quality not as good as ARGB. ''It supports alpha blending, but it can only be on or off, that is: either 0 or 255.''
**'''"dxt3"''': DXT3 compressed - Can take a fraction of a second longer to create (unless the texture is already in DXT3). Uses 4 times less video memory than ARGB and ''can speed up drawing''. Quality slightly better than DXT1 and supports crisp alpha blending.
**'''"dxt5"''': DXT5 compressed - Can take a fraction of a second longer to create (unless the texture is already in DXT5). Uses 4 times less video memory than ARGB and ''can speed up drawing''. Quality slightly better than DXT1 and supports smooth alpha blending.
*'''mipmaps:''' True to create a mip-map chain for "'''dds'''" pixels so the texture looks good when drawn at various sizes.
}}
By default the pixels from the whole texture is returned. To get only a portion of the texture, define a rectangular area using all four of these optional arguments:
*'''x:''' Rectangle left position
*'''y:''' Rectangle top position
*'''width:''' Rectangle width
*'''height :''' Rectangle height

==Returns==
Returns pixels string if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<syntaxhighlight lang="lua">
local mtaLogo = dxCreateTexture("mta-logo.png")
outputChatBox("MTA logo pixels is: "..dxGetTexturePixels(mtaLogo))
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04021|Added surfaceIndex argument}}
{{ChangelogItem|1.6.0-9.22185|Added dds pixels format}}

==See Also==
{{Drawing_functions}}

[[hu:dxGetTexturePixels]]

DxGetTexturePixels

2023-08-29T14:32:03Z

Samr46: Add dds pixels format

{{Client function}}
__NOTOC__
This function fetches the [[Texture_pixels|pixels]] from a [[texture]] element. It can be used with a standard texture, render target or screen source.
{{Important Note|dxGetTexturePixels will not work on a screen source or render target if the player has disabled screen upload.}}
{{Note|
*This function is slow and not something you want to be doing once a frame.
*It is slower when reading pixels from a render target or screen source.
*And is very slow indeed if the texture format is not ''' 'argb' '''.
}}

==Syntax==
<syntaxhighlight lang="lua">
string dxGetTexturePixels ( [ int surfaceIndex = 0, ] element texture [, string pixelsFormat = "plain" [, string textureFormat = "unknown"] [, bool mipmaps = true] ] [, int x = 0, int y = 0, int width = 0, int height = 0 ] )
</syntaxhighlight>
{{OOP||[[texture]]:getPixels}}
===Required Arguments===
*'''texture :''' The texture element to get the pixels from

===Optional Arguments===
{{New feature/item|3.0161|1.6.0|22185|
*'''pixelsFormat:''' "plain", "dds"
*'''textureFormat:''' A string representing the desired texture format for "'''dds'''" pixels, which can be one of:
**'''"unknown"''': Determined automatically based on texture format (default).
**'''"argb"''': ARGB uncompressed 32 bit color.
**'''"dxt1"''': DXT1 compressed - Can take a fraction of a second longer to create (unless the texture is already in DXT1). Uses 8 times less video memory than ARGB and ''can speed up drawing''. Quality not as good as ARGB. ''It supports alpha blending, but it can only be on or off, that is: either 0 or 255.''
**'''"dxt3"''': DXT3 compressed - Can take a fraction of a second longer to create (unless the texture is already in DXT3). Uses 4 times less video memory than ARGB and ''can speed up drawing''. Quality slightly better than DXT1 and supports crisp alpha blending.
**'''"dxt5"''': DXT5 compressed - Can take a fraction of a second longer to create (unless the texture is already in DXT5). Uses 4 times less video memory than ARGB and ''can speed up drawing''. Quality slightly better than DXT1 and supports smooth alpha blending.
*'''mipmaps:''' True to create a mip-map chain for "'''dds'''" pixels so the texture looks good when drawn at various sizes.
}}
*'''surfaceIndex:''' Desired slice to get if the texture is a volume texture, or desired face to get if the texture is a cube map. <nowiki>(Cube map faces: 0=+X 1=-X 2=+Y 3=-Y 4=+Z 5=-Z)</nowiki>
By default the pixels from the whole texture is returned. To get only a portion of the texture, define a rectangular area using all four of these optional arguments:
*'''x:''' Rectangle left position
*'''y:''' Rectangle top position
*'''width:''' Rectangle width
*'''height :''' Rectangle height

==Returns==
Returns pixels string if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<syntaxhighlight lang="lua">
local mtaLogo = dxCreateTexture("mta-logo.png")
outputChatBox("MTA logo pixels is: "..dxGetTexturePixels(mtaLogo))
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04021|Added surfaceIndex argument}}
{{ChangelogItem|1.6.0-9.22185|Added dds pixels format}}

==See Also==
{{Drawing_functions}}

[[hu:dxGetTexturePixels]]

Texture pixels

2023-08-29T14:22:02Z

Samr46: Add dds pixels format

__NOTOC__====Pixels====
-----------------
'''*''' MTA refers to the raw information that a [[texture]] contains as 'pixels'.

'''*''' Pixels can be retrieved from any [[texture]] type including [[dxCreateRenderTarget|render targets]] and [[dxCreateScreenSource|screen sources]] by using the function [[dxGetTexturePixels]].

'''*''' Pixels are just a string to Lua, so they can be saved to a file or even sent over the 'internet'.

====Pixels properties====
-----------------
Pixels have two properties:
*'''dimensions''' (width and height) which is retrieved by using the function [[dxGetPixelsSize]]
*'''format''' (plain,jpeg,png,dds) which is retrieved by using the function [[dxGetPixelsFormat]]
**''plain'' - Fastest and simplest - It's default format of the pixels returned by [[dxGetTexturePixels]] and the only one that can be used with [[dxSetTexturePixels]], [[dxGetPixelColor]] and [[dxSetPixelColor]]. But it also uses a lot of bytes, so internet transfers will be longer. Also can't be read by Photoshop or browsers etc.
**''png'' - A few less bytes, still quite big for net transfers. Can be saved to a file and read by Photoshop and browsers etc.
**''jpeg'' - A lot less bytes, so best for net transfers. Can be saved to a file and read by Photoshop and browsers etc.
**''dds'' - DirectDraw Surface. Game's native texture format with various compressed and uncompressed options. Used to store standard, cube or volume textures. Compressed pixels in this format can be loaded nearly instantly by [[dxCreateTexture]].

To convert between the 3 different formats, use the function [[dxConvertPixels]]

====Pixels more====
-----------
Pixels can also be loaded from any png/jpeg file just like this:
fh = fileOpen( "hello.jpg" )
pixels = fileRead(fh,fileGetSize ( fh ))
fileClose(fh)

Pixels can be used to create textures just like this:
myNewTexture = dxCreateTexture(pixels)

Pixels can be used to save textures just like this:
pixels = dxGetTexturePixels(myRenderTarget)
pixels = dxConvertPixels(pixels, 'jpeg')
fh = fileCreate( "piccy.jpg" )
fileWrite(fh, pixels)
fileClose(fh)

====Pixels performance====
------------------
Getting/setting pixels from textures is not quick and not something you want to be doing every frame (in onClientRender for example).
Setting pixels to a render target is especially slow. Pixels are ideal however for transferring composite images built on a render target into a normal texture for later use. For example, making a custom radar map.

DxGetPixelsFormat

2023-08-29T14:19:47Z

Samr46: Add dds pixels format

{{Client function}}
__NOTOC__
This function returns the format of [[Texture_pixels|pixels]] contained in a string.

==Syntax==
<syntaxhighlight lang="lua">
string dxGetPixelsFormat ( string pixels )
</syntaxhighlight>

===Required Arguments===
*'''pixels :''' The pixels to get the format of

==Returns==
Returns the format of the pixels if successful (''''plain'''' or ''''png'''' or ''''jpeg'''' or ''''dds''''), ''false'' if invalid arguments were passed to the function.

==Example==
The example loads an image, gets its pixels, and outputs the pixels format. (You can use [http://i1325.photobucket.com/albums/u630/Tourmalinelisa2/128x128.jpg this] image to test.)
<syntaxhighlight lang="lua">
addEventHandler('onClientResourceStart', resourceRoot, function()
local img = fileOpen('img.jpg')
local pixels = fileRead(img, fileGetSize(img))
local pixelsFormat = dxGetPixelsFormat(pixels)
outputChatBox('Pixels format is: ' .. pixelsFormat)
fileClose(img)
end)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.3|}}

==See Also==
{{Drawing_functions}}

[[hu:dxGetPixelsFormat]]

SetWorldSpecialPropertyEnabled

2023-08-02T07:16:23Z

Samr46: Add "watercreatures" property

__NOTOC__
{{Client function}}

Enables or disables a special world property.

==Syntax==
<syntaxhighlight lang="lua">bool setWorldSpecialPropertyEnabled ( string propname, bool enable )</syntaxhighlight>
{{OOP||||isWorldSpecialPropertyEnabled}}
[[File:Randomfoliage.jpeg|frame|right|A photo demonstrating ''randomfoliage'' enabled and disabled.]]
===Required Arguments===
*'''propname:''' the name of the property to set. Possible values are:
**'''hovercars''' - equivalent of the JBGVNB cheat, and allows cars to drive on water. (default: false)
**'''aircars''' - equivalent of the RIPAZHA cheat, and allows cars to fly. (default: false)
**'''extrabunny''' - equivalent of the CJPHONEHOME or JHJOECW cheat, and allows you to bunny hop on bicycles much higher. (default: false)
**'''extrajump''' - equivalent of the KANGAROO cheat, and allows you to jump on foot much higher. (default: false)
**'''randomfoliage''' - toggle randomly generated foliage on the GTA:SA map (default: true)
**'''snipermoon''' - toggle the GTA:SA easter egg, which increases the size of the moon every time you shoot it with a sniper rifle (default: false)
**'''extraairresistance''' - toggle the vehicle speed limit on cross-country roads (default: true)
**{{New feature/item|3.0156|1.5.5|12286|'''underworldwarp''' - toggle warp of peds and vehicles when fall under map (default: true)}}
**{{New feature/item|3.0160|1.5.9|21125|'''vehiclesunglare''' - toggle the vehicle sun glare effect (default: false) }}
**{{New feature/item|3.0160|1.5.9|21313| '''coronaztest''' - disable big sun lensflare effect (default: true) }}
**{{New feature/item|3.0161|1.6.0|21919| '''watercreatures''' - toggle randomly generated underwater creatures (default: true) }}
*'''enable:''' whether or not to enable the property.

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

==Example==

This code allows you to enable/disable certain property using '''true''' or '''false'''.
<syntaxhighlight lang="lua">
function onClientResourceStart()
local worldSpecialProperties = {
["hovercars"] = false,
["aircars"] = false,
["extrabunny"] = false,
["extrajump"] = false,
["randomfoliage"] = true,
["snipermoon"] = false,
["extraairresistance"] = true,
["underworldwarp"] = true,
["vehiclesunglare"] = false,
["coronaztest"] = true,
["watercreatures"] = true,
}

for propertyName, propertyState in pairs(worldSpecialProperties) do
setWorldSpecialPropertyEnabled(propertyName, propertyState)
end
end
addEventHandler("onClientResourceStart", resourceRoot, onClientResourceStart)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.5-3.12286|Added "underworldwarp" property}}
{{ChangelogItem|1.5.9-1.21125|Added "vehiclesunglare" property}}
{{ChangelogItem|1.5.9-9.21313|Added "coronaztest" property}}
{{ChangelogItem|1.6.0-9.21919|Added "watercreatures" property}}

==See Also==
{{Client world functions}}

SetGlitchEnabled

2023-07-25T22:00:13Z

Samr46: Undo revision 77198 by Samr46 (talk)

__NOTOC__
{{Server function}}
This function enables or disables glitches that are found in the original Single Player game that can be used to gain an advantage in multiplayer.
{{Note|By default all these glitches are disabled - use this function to '''enable''' them.}}

Users of the '''fastmove''' glitch may additionally want to install [https://community.mtasa.com/index.php?p=resources&s=details&id=13368 this resource to disable crouchsliding].

==Syntax==
<syntaxhighlight lang="lua">bool setGlitchEnabled ( string glitchName, bool enable )</syntaxhighlight>

===Required Arguments===
*'''glitchName:''' the name of the property to set. Possible values are:
{{Glitches}}
*'''enable:''' whether or not to enable the glitch.

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

==Example==
This example enables all glitches in the server once the resource is loaded.
<syntaxhighlight lang="lua">
local glitches = {"quickreload", "fastmove", "fastfire", "crouchbug", "highcloserangedamage", "hitanim", "fastsprint", "baddrivebyhitbox", "quickstand", "kickoutofvehicle_onmodelreplace"}

function enableGlitches()
for _, glitch in ipairs(glitches) do
setGlitchEnabled(glitch, true)
end
end
addEventHandler("onResourceStart", resourceRoot, enableGlitches)
</syntaxhighlight>

==See Also==
{{Server functions}}

Template:Glitches

2023-07-25T21:59:56Z

Samr46: Undo revision 77197 by Samr46 (talk)

<div style="border:3px solid red;margin-bottom:3px;padding-left:5px;"><div style="float:right;padding-right:5px;font-weight:bold;"></div>
*'''quickreload:''' This is the glitch where switching weapons auto-reloads your weapon, without actually performing the reload animation.
*'''fastmove:''' This is the glitch that can be achieved by a certain key combinations whilst standing up after crouching, which allows you to move quickly with slow weapons (e.g. deagle). Side effect: also enables the "crouchslide" bug - use [https://community.mtasa.com/index.php?p=resources&s=details&id=13368 the "NoCrouchSlide" resource] to remedy this.
*'''fastfire:''' This is the glitch that can be achieved by cancelling the full fire animation, allowing you to shoot with slow-fire weapons (e.g. deagle) much faster.
*'''crouchbug:''' This is the glitch where the post shooting animation can be aborted by using the crouch key.
*'''highcloserangedamage:''' Enabling this removes the extremely high damage guns inflict when fired at very close range.
*'''hitanim:''' Enabling this allows 'hit by bullet' animations to interrupt player aiming.
*{{New feature|3.0136|1.3.5-6277|'''fastsprint:''' Enabling fastsprint allows players to tap space with a macro to boost their speed beyond normal speeds of GTASA.}}
*{{New feature|3.0136|1.3.5-6419|'''baddrivebyhitbox:''' This glitch leaves players invulnerable to gun fire when performing certain driveby animations.}}
*{{New feature/item|3.0150|1.5|7345|'''quickstand:''' This glitch allows players to quickly stand up by pressing the crouch, sprint or jump controls just after realasing the aim weapon button while using one and being ducked.}}
*'''kickoutofvehicle_onmodelreplace:''' This glitch enables the old behavior where players get warped out of a vehicle when the model is replaced.
</div>

SetGlitchEnabled

2023-07-25T15:38:30Z

Samr46: /* Example */

__NOTOC__
{{Server function}}
This function enables or disables glitches that are found in the original Single Player game that can be used to gain an advantage in multiplayer.
{{Note|By default all these glitches are disabled - use this function to '''enable''' them.}}

Users of the '''fastmove''' glitch may additionally want to install [https://community.mtasa.com/index.php?p=resources&s=details&id=13368 this resource to disable crouchsliding].

==Syntax==
<syntaxhighlight lang="lua">bool setGlitchEnabled ( string glitchName, bool enable )</syntaxhighlight>

===Required Arguments===
*'''glitchName:''' the name of the property to set. Possible values are:
{{Glitches}}
*'''enable:''' whether or not to enable the glitch.

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

==Example==
This example enables all glitches in the server once the resource is loaded.
<syntaxhighlight lang="lua">
local glitches = {"quickreload", "fastmove", "fastfire", "crouchbug", "highcloserangedamage", "hitanim", "fastsprint", "baddrivebyhitbox", "quickstand", "kickoutofvehicle_onmodelreplace", "dontburnflippedcars"}

function enableGlitches()
for _, glitch in ipairs(glitches) do
setGlitchEnabled(glitch, true)
end
end
addEventHandler("onResourceStart", resourceRoot, enableGlitches)
</syntaxhighlight>

==See Also==
{{Server functions}}

Template:Glitches

2023-07-25T15:36:18Z

Samr46:

GetElementLighting

2022-10-22T13:50:56Z

Samr46: Fix "See Also"

{{Client function}}
__NOTOC__
{{Added feature/item|1.5.9|1.5.9|21367|This function returns the lighting value for the specified [[element]]. This can be a [[player]], [[ped]], [[vehicle]], [[object]].}}

==Syntax==
<syntaxhighlight lang="lua">
float getElementLighting ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:getLighting|lighting}}

===Required Arguments===
*'''theElement:''' The [[element]] whose lighting you want to retrieve.

===Returns===
Returns a float (0.0-0.5; 0 = dark; 0.5 = light) indicating the element's lighting, or ''false'' if invalid arguments were passed. This function will fail if called right after element creation.

==Example==
<section name="Clientside example" class="client" show="true">
This example displays lighting values of streamed in players.
<syntaxhighlight lang="lua">
addEventHandler("onClientRender", root, function()
for _, pl in ipairs(getElementsByType("player", root, true)) do
local sX, sY = getScreenFromWorldPosition(getElementPosition(pl))
if sX then
dxDrawText("Lighting: "..tostring(getElementLighting(pl)), sX, sY)
end
end
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|n/a|1.5.9-9.21367|}}

==See Also==
{{Client element functions}}

Template:Client element functions

2022-10-22T13:48:15Z

Samr46:

* [[attachElements]]
* [[createElement]]
* [[destroyElement]]
* [[detachElements]]
* [[getAttachedElements]]
* [[getElementAlpha]]
* [[getElementAngularVelocity]]
* [[getElementAttachedOffsets]]
* [[getElementAttachedTo]]
{{Added feature/item|1.5.9|1.5.8|20704|
* [[getElementBoneMatrix]]
* [[getElementBonePosition]]
* [[getElementBoneRotation]]
}}
* [[getElementBoundingBox]]
* [[getElementByID]]
* [[getElementChild]]
* [[getElementChildren]]
* [[getElementChildrenCount]]
* [[getElementCollisionsEnabled]]
* [[getElementColShape]]
* [[getElementData]]
* [[getElementDimension]]
* [[getElementDistanceFromCentreOfMassToBaseOfModel]]
* [[getElementHealth]]
* [[getElementID]]
* [[getElementInterior]]
{{Added feature/item|1.5.9|1.5.8|21367|
* [[getElementLighting]]
}}
* [[getElementMatrix]]
* [[getElementModel]]
* [[getElementParent]]
* [[getElementPosition]]
* [[getElementRadius]]
* [[getElementRotation]]
* [[getElementsByType]]
* [[getElementsWithinColShape]]
* [[getElementsWithinRange]]
* [[getElementType]]
* [[getElementVelocity]]
* [[getLowLODElement]]
* [[getRootElement]]
* [[isElement]]
* [[isElementAttached]]
* [[isElementCallPropagationEnabled]]
* [[isElementCollidableWith]]
* [[isElementDoubleSided]]
* [[isElementFrozen]]
* [[isElementInWater]]
* [[isElementLocal]]
* [[isElementLowLOD]]
* [[isElementOnScreen]]
* [[isElementStreamable]]
* [[isElementStreamedIn]]
* [[isElementSyncer]]
* [[isElementWaitingForGroundToLoad]]
* [[isElementWithinColShape]]
* [[setElementAlpha]]
* [[setElementAngularVelocity]]
* [[setElementAttachedOffsets]]
{{Added feature/item|1.5.9|1.5.8|20704|
* [[setElementBoneMatrix]]
* [[setElementBonePosition]]
* [[setElementBoneRotation]]
}}
* [[setElementCallPropagationEnabled]]
* [[setElementCollidableWith]]
* [[setElementCollisionsEnabled]]
* [[setElementData]]
* [[setElementDimension]]
* [[setElementDoubleSided]]
* [[setElementFrozen]]
* [[setElementHealth]]
* [[setElementID]]
* [[setElementInterior]]
* [[setElementMatrix]]
* [[setElementModel]]
* [[setElementParent]]
* [[setElementPosition]]
* [[setElementRotation]]
* [[setElementStreamable]]
* [[setElementVelocity]]
* [[setLowLODElement]]
{{Added feature/item|1.5.9|1.5.8|20704|
* [[updateElementRpHAnim]]
}}

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

Changes in 1.5.9

2022-10-22T13:45:00Z

Samr46: New function getElementLighting()

<pageclass class="#39dd57" subcaption="Current release"></pageclass>
{{Changelogs}}
__NOTOC__
1.5.9 was released on October 1, 2021.

* GitHub commit log: https://github.com/multitheftauto/mtasa-blue/compare/1.5.8...1.5.9
* GitHub milestone: https://github.com/multitheftauto/mtasa-blue/milestone/7
* Resources GitHub commit log: https://github.com/multitheftauto/mtasa-resources/compare/1.5.8...1.5.9
* Release announcement on forums: https://forum.mtasa.com/topic/132708-multi-theft-auto-san-andreas-159-is-released/

== Notable Changes ==
<section show="true">
* You can now use the new [[onPlayerResourceStart]] server-side event to trigger when client is ready! Thanks to Lpsd.
* You can now detect element interior or dimension change through two new client and server-side events [[onElementInteriorChange]] and [[onElementDimensionChange]] – should reduce some of your code! Thanks to Patrick and Strix.
* You can now edit element bone behavior through 7 new bone manipulation functions! Great for some dynamic animations. Get started at [[setElementBonePosition]] and [[setElementBoneRotation]]. Thanks to Saml1er.
* More vehicle customisation options! You can now edit vehicle dummy positions per vehicle. See [[setVehicleDummyPosition]]. Thanks to botder.
* More audio customisation with sound effect parameters! See [[setSoundEffectParameter]]. Thanks to Strix and Sarrum.
* More client download transfer box customisation options! See for example [[onClientTransferBoxProgressChange]]. Thanks to botder and CrosRoad95.
* You can now allocate custom objects and vehicles through [[engineRequestModel]]. One of the most sought after features in a long time. Thanks to TheNormalnij.
* You can now use scalable vector graphics (SVG) in MTA! See [[svgCreate]] for more info. Thanks to Lpsd.
* You can now use peds and vehicles as the camera target. Thanks to TheNormalnij.
* A lot more features for scripters to build even more immersive experiences with!
* Many synchronization improvements!
* Many varying size fixes, quality of life improvements, updates and security enhancements!
* Many default resource fixes, refactors and upgrades, including ''webmap'' working once again! We have also improved the detection of world objects in map editor (''editor_main'' resource), so you can select many more objects that you couldn't before - such as bushes, fences and many more! You can now also remove world objects inside interiors. This should help mappers a lot.
</section>

== Backwards Compatibility ==
<section show="true">
=== 5 Backwards Incompatible Changes ===
These changes will take effect in '''1.6.0''':
* [[callRemote]] callbacks currently set the error code to '''nil''' when there is no error. In 1.6.0, to be consistent with [[fetchRemote]], the error code reported will be '''0'''. See [https://github.com/multitheftauto/mtasa-blue/issues/294 GitHub #294].
* Since July 2016 if you provide an invalid string like '''"randomstring"''' when a function expects a number, the string will be treated as '''0''' and raise a script warning. In 1.6.0 this will be an error. You will still be able to provide strings containing numbers (e.g. '''"100"''' and '''"12.34"'''), this change only affects invalid strings. See [https://github.com/multitheftauto/mtasa-blue/issues/1043 GitHub #1043].
* When providing a width and height of (0, 0) to [[createBrowser]] or [[guiCreateBrowser]] you will encounter a script error instead of a warning. The warning was introduced Feb 2019. See [https://github.com/multitheftauto/mtasa-blue/issues/1069 GitHub #1069].
* Some functions expect only unsigned integers (positive numbers), and since Jan 2016 providing negative numbers would be a warning. This will now be an error. See [https://github.com/multitheftauto/mtasa-blue/issues/1070 GitHub #1070].
* Since Aug 2015, we replaced the custom '''mtalocal://''' URL scheme with '''http://mta/resourceName/blah.html'''. This '''mtalocal://''' URL scheme will now be removed. See [https://github.com/multitheftauto/mtasa-blue/issues/1071 GitHub #1071].

This list is incomplete and we may introduce more changes later.
</section>

== Statistics ==
<section show="true">
These are some statistics since the [[Changes in 1.5.8|previous release]].
* This is the '''26<sup>th</sup>''' 1.x.x release
* '''{{date difference|2020|10|11|2021|10|1}}''' days
* '''49''' new functions
* '''16''' new events
* '''0''' deprecations
* '''77+''' bug fixes and changes
* '''334''' commits ([https://github.com/multitheftauto/mtasa-blue/compare/1.5.8...1.5.9 see comparison])
* '''189''' new open GitHub issues ([https://github.com/multitheftauto/mtasa-blue/issues?q=is%3Aopen+is%3Aissue+created%3A2020-10-11..2021-10-01 see list])
* '''81''' resolved GitHub issues ([https://github.com/multitheftauto/mtasa-blue/issues?q=is%3Aclosed+is%3Aissue+milestone%3A%22Next+Release+%281.5.9%29%22 see list])
* '''135''' closed GitHub issues ([https://github.com/multitheftauto/mtasa-blue/issues?q=is%3Aclosed+is%3Aissue+closed%3A2020-10-11..2021-10-01+no%3Amilestone see list])
* '''71''' new open GitHub pull requests ([https://github.com/multitheftauto/mtasa-blue/pulls?q=is%3Aopen+is%3Apr+created%3A2020-10-11..2021-10-01 see list])
* '''207''' merged GitHub pull requests ([https://github.com/multitheftauto/mtasa-blue/pulls?q=is%3Apr+is%3Amerged+milestone%3A%22Next+Release+%281.5.9%29%22 see list])
* '''53''' closed GitHub pull requests ([https://github.com/multitheftauto/mtasa-blue/pulls?q=is%3Apr+is%3Aunmerged+closed%3A2020-10-11..2021-10-01 see list])
* '''38''' contributors of which '''11''' are new ([https://github.com/multitheftauto/mtasa-blue/graphs/contributors?from=2020-10-11&to=2021-10-01&type=c see list])
* '''94+''' total contributors ([https://github.com/multitheftauto/mtasa-blue/graphs/contributors see list])
* '''13''' vendor updates

<sub>'''Note:''' Last update to these statistics was made {{date difference human friendly|2021|10|1}}.</sub>
</section>

== Client ==
<section show="true">
=== 44 New Functions ===
* Added [[getRoofPosition]] ([https://github.com/multitheftauto/mtasa-blue/pull/1518 #1518] by '''Pirulax''')
* Added [[setVehicleVariant]] (previously available server-side only) ([https://github.com/multitheftauto/mtasa-blue/pull/1599 #1599] by '''StrixG''')
* Added [[engineRestreamWorld]] ([https://github.com/multitheftauto/mtasa-blue/pull/1735 #1735] by '''TheNormalnij''')
* Added functions to modify element bones behavior ([https://github.com/multitheftauto/mtasa-blue/pull/1673 #1673] by '''Saml1er''')
** [[setElementBonePosition]]
** [[setElementBoneRotation]]
** [[getElementBonePosition]]
** [[getElementBoneRotation]]
** [[setElementBoneMatrix]]
** [[getElementBoneMatrix]]
** [[updateElementRpHAnim]]
* Added [[engineSetModelVisibleTime]] and [[engineGetModelVisibleTime]] ([https://github.com/multitheftauto/mtasa-blue/pull/1766 #1766] by ''' TheNormalnij''')
* Added [[setColorFilter]] and [[resetColorFilter]] ([https://github.com/multitheftauto/mtasa-blue/pull/1611 #1611] by '''tederis''')
* Added [[getVehicleWheelFrictionState]] ([https://github.com/multitheftauto/mtasa-blue/pull/1839 #1839] by '''drop-club''')
* Added [[setPedEnterVehicle]] and [[setPedExitVehicle]] ([https://github.com/multitheftauto/mtasa-blue/pull/1748 #1748] by '''Zangomangu''')
* Added [[setSoundLooped]] and [[isSoundLooped]] ([https://github.com/multitheftauto/mtasa-blue/pull/657 #657] by '''FileEX''')
* Added [[isTransferBoxAlwaysVisible]] ([https://github.com/multitheftauto/mtasa-blue/pull/1955 #1955] by '''botder''' and '''CrosRoad95''')
* Added vehicle dependent dummy positions with functions ([https://github.com/multitheftauto/mtasa-blue/pull/1982 #1982] by '''botder''')
** [[getVehicleDummyPosition]]
** [[getVehicleModelDummyDefaultPosition]]
** [[setVehicleDummyPosition]]
** [[resetVehicleDummyPositions]]
* Added [[isBrowserRenderingPaused]] ([https://github.com/multitheftauto/mtasa-blue/pull/1999 #1999] by '''cleoppa''')
* Added [[isObjectMoving]] ([https://github.com/multitheftauto/mtasa-blue/pull/2023 #2023] by '''cleoppa''')
* Added [[showCol]], [[isShowCollisionsEnabled]], [[showSound]] and [[isShowSoundEnabled]] ([https://github.com/multitheftauto/mtasa-blue/pull/2025 #2025] by '''cleoppa''')
* Added [[clearDebugBox]] ([https://github.com/multitheftauto/mtasa-blue/pull/2160 #2160] by '''cleoppa''')
* Added [[isChatInputBlocked]] ([https://github.com/multitheftauto/mtasa-blue/pull/2170 #2170] by '''Pieter-Dewachter''')
* Added [[engineStreamingGetUsedMemory]] ([https://github.com/multitheftauto/mtasa-blue/pull/2269 #2269] by '''Pirulax''')
* Added [[engineStreamingFreeUpMemory]] ([https://github.com/multitheftauto/mtasa-blue/pull/2268 #2268] by '''Pirulax''')
* Added [[setSoundEffectParameter]] and [[getSoundEffectParameters]] ([https://github.com/multitheftauto/mtasa-blue/commit/449c5c329732d77ea36ce0abc9595f1577dd1304 449c5c3] by '''StrixG''')
* Added [[setPedBleeding]] and [[isPedBleeding]] ([https://github.com/multitheftauto/mtasa-blue/pull/2308 #2308] and [https://github.com/multitheftauto/mtasa-blue/pull/2365 #2365] by '''StrixG''' and '''theSarrum''')
* Added [[getPlayerMapOpacity]] ([https://github.com/multitheftauto/mtasa-blue/pull/2315 #2315] by '''theSarrum''')
* Added new SVG functions ([https://github.com/multitheftauto/mtasa-blue/pull/2026 #2026] by '''Lpsd''')
** [[svgCreate]]
** [[svgGetDocumentXML]]
** [[svgSetDocumentXML]]
** [[svgGetSize]]
** [[svgSetSize]]
* Added [[getElementLighting]] ([https://github.com/multitheftauto/mtasa-blue/pull/2783 #2783] by '''samr46''')

=== 10 New Events ===
* Added [[onClientPedsProcessed]] ([https://github.com/multitheftauto/mtasa-blue/pull/1673 #1673] by '''Saml1er''')
* Added [[onClientElementDimensionChange]] ([https://github.com/multitheftauto/mtasa-blue/pull/1553 #1553] by '''StrixG''')
* Added [[onClientPedVehicleEnter]] and [[onClientPedVehicleExit]] ([https://github.com/multitheftauto/mtasa-blue/pull/1748 #1748] by '''Zangomangu''')
* Added [[onClientResourceFileDownload]], [[onClientTransferBoxProgressChange]] and [[onClientTransferBoxVisibilityChange]] ([https://github.com/multitheftauto/mtasa-blue/pull/1955 #1955] by '''botder''' and '''CrosRoad95''')
* Added [[onClientObjectMoveStart]] and [[onClientObjectMoveStop]] ([https://github.com/multitheftauto/mtasa-blue/pull/2023 #2023] by '''cleoppa''')
* Added [[onClientElementInteriorChange]] ([https://github.com/multitheftauto/mtasa-blue/pull/2058 #2058] by '''Patrick2562''')

=== 8 New Arguments & Parameters ===
* Added ''macros'' argument to [[dxCreateShader]] ([https://github.com/multitheftauto/mtasa-blue/pull/1573 #1573] by '''tederis''')
* Added ''forceOverrideNextFrame'' argument to [[setAnalogControlState]] ([https://github.com/multitheftauto/mtasa-blue/pull/1852 #1852] by '''LosFaul''')
* Added ''interior'' and ''dimension'' arguments to [[getElementsWithinRange]] ([https://github.com/multitheftauto/mtasa-blue/pull/1915 #1915] by '''Pirulax''')
* Added ''pedCameraMode'' argument to [[setCameraViewMode]] ([https://github.com/multitheftauto/mtasa-blue/pull/1418 #1418] by '''TheNormalnij''')
* Added ''flipUV'' argument to [[dxDrawMaterialLine3D]] and [[dxDrawMaterialSectionLine3D]] ([https://github.com/multitheftauto/mtasa-blue/pull/2193 #2193] by '''tederis''')
* Added ''messageType'' parameter to [[onClientChatMessage]] ([https://github.com/multitheftauto/mtasa-blue/pull/1020 #1020] by '''Lpsd''')
* Added ''lineHeight'' argument to [[dxDrawText]] ([https://github.com/multitheftauto/mtasa-blue/pull/2355 #2355] by '''Allerek''')

=== 40 Bug Fixes & Changes ===
* Fixed crash when deleting a chatbox bind too early ([https://github.com/multitheftauto/mtasa-blue/commit/be577116f191526111e06487c8322c7799e03564 be57711] by '''sbx320''')
* Added minimum version check for [[resetBlurLevel]] ([https://github.com/multitheftauto/mtasa-blue/pull/1755 #1755] by '''StrixG''')
* Included skins added through [[engineRequestModel]] in [[getValidPedModels]] ([https://github.com/multitheftauto/mtasa-blue/pull/1437 #1437] by '''Pirulax''')
* Allow allocating new object models using [[engineRequestModel]] ([https://github.com/multitheftauto/mtasa-blue/pull/1684 #1684] by '''TheNormalnij''')
* Allow allocating new vehicle models using [[engineRequestModel]] ([https://github.com/multitheftauto/mtasa-blue/pull/1701 #1701] by '''TheNormalnij''')
* Events [[onClientVehicleStartEnter]], [[onClientVehicleEnter]], [[onClientVehicleStartExit]] and [[onClientVehicleExit]] now return [[ped|peds]] as well ([https://github.com/multitheftauto/mtasa-blue/pull/1748 #1748] by '''Zangomangu''')
* Fixed hectic bike rotation by filling CBikeSAInterface class ([https://github.com/multitheftauto/mtasa-blue/pull/1884 #1884] by '''TheNormalnij''')
* Fixed [[setSoundPanningEnabled|Sound.setPanningEnabled]] OOP-method not working due to typo in definition ([https://github.com/multitheftauto/mtasa-blue/pull/1923 #1923] by '''StrixG''')
* Fixed ped task bug when special fighting near to a vehicle causing abnormal behavior ([https://github.com/multitheftauto/mtasa-blue/pull/1943 #1943] by '''Zangomangu''')
* Fixed [[getKeyState]] not working with gamepad buttons ([https://github.com/multitheftauto/mtasa-blue/pull/1944 #1944] by '''botder''')
* Disable gamepad controls if disabled by [[showCursor]] ([https://github.com/multitheftauto/mtasa-blue/commit/c4b9a844c3dc8f8fd16776370dcdac12f189d32f c4b9a84] by '''botder''')
* Keep console position and size when changing locale ([https://github.com/multitheftauto/mtasa-blue/pull/1970 #1970] by '''xLuxy''')
* Fixed network trouble if falling into water while attempting to enter a vehicle ([https://github.com/multitheftauto/mtasa-blue/pull/1986 #1986] by '''Zangomangu''')
* Abort vehicle entering for incompatible vehicles if ped is in water ([https://github.com/multitheftauto/mtasa-blue/commit/b3ba15bad3a0943d83cefb90cddc6f9191667fa8 b3ba15b] by '''botder''')
* Lowered shadows and lights more towards ground level ([https://github.com/multitheftauto/mtasa-blue/pull/2018 #2018] by '''patrikjuvonen''' and '''botder''')
* Fixed objects not returning world model position in [[processLineOfSight]] ([https://github.com/multitheftauto/mtasa-blue/pull/2083 #2083] by '''STR6''')
* Added keybind queue to improve performance ([https://github.com/multitheftauto/mtasa-blue/pull/2123 #2123] by '''patrikjuvonen''')
* Added ped camera mode return value to [[getCameraViewMode]] ([https://github.com/multitheftauto/mtasa-blue/pull/1418 #1418] by '''TheNormalnij''')
* Fixed [[setMarkerType]] resetting marker position ([https://github.com/multitheftauto/mtasa-blue/commit/586d6d6fa202de43e633c20f757e2b1282529106 586d6d] by '''botder''')
* Fixed [[testLineAgainstWater]] working incorrectly outside of game boundaries ([https://github.com/multitheftauto/mtasa-blue/pull/2192 #2192] by '''Allerek''')
* Fixed client vehicles blocking entry to server vehicle ([https://github.com/multitheftauto/mtasa-blue/pull/2188 #2188] by '''Zangomangu''')
* Removed obsolete entry from forbodenList ([https://github.com/multitheftauto/mtasa-blue/commit/ff93fec93cb20c25577950c47bc22c0f9730a459 ff93fec] by '''Dutchman101''')
* Reset vehicle explosion timer in CVehicleSA::SetHealth ([https://github.com/multitheftauto/mtasa-blue/commit/8b30d7a4e43e6460a8203bb89b7133365a3e6a85 8b30d7a] and [https://github.com/multitheftauto/mtasa-blue/commit/546beabf70a896ccf87c3138f028e8ef34f84c7d 546beab] by '''botder''')
* Set game thread affinity to first CPU core ([https://github.com/multitheftauto/mtasa-blue/commit/dbc792b3d433378217c96b6b1418a21888ed1d5a dbc792b] by '''botder''')
* Added "TotalPhysicalMemory" to [[dxGetStatus]] ([https://github.com/multitheftauto/mtasa-blue/pull/2265 #2265] by '''Pirulax''')
* Added a UI button to delete servers from the "Recent" tab ([https://github.com/multitheftauto/mtasa-blue/pull/2253 #2253] by '''iDannz1''')
* Trim keybind whitespace to avoid duplicates ([https://github.com/multitheftauto/mtasa-blue/pull/2124 #2124] by '''patrikjuvonen''')
* Fixed a typo in the sa.dat file ([https://github.com/multitheftauto/mtasa-blue/commit/eff97c8ad3e725691d182c239997caeca51eba4d eff97c8] by '''ccw808''')
* Resolved remaining collisionless objects ([https://github.com/multitheftauto/mtasa-blue/pull/2296 #2296] by '''Saml1er''', '''TheNormalnij''', '''ccw808''', '''thisdp''' and '''botder''')
* Fixed attached players desync after reconnect ([https://github.com/multitheftauto/mtasa-blue/pull/2290 #2290] by '''theSarrum''')
* Check clothes type parameter in several cases ([https://github.com/multitheftauto/mtasa-blue/commit/ce9d3deab8ec7905264b3492bf11d3565ee5c149 ce9d3de] by '''Inder00''' and '''botder''')
* Updated some images ([https://github.com/multitheftauto/mtasa-blue/commit/f00c1a38934b28eff8201708dd4b956272d27f13 f00c1a3] by '''patrikjuvonen''')
* Set CEF cache path ([https://github.com/multitheftauto/mtasa-blue/commit/adff688e77c16d0c5a63e047b60da97529f2b111 adff688] by '''patrikjuvonen''')
* Fixed some capital letters not working in CEF ([https://github.com/multitheftauto/mtasa-blue/commit/6ed00b324a980d43c342d87916d1a78bfd352d86 6ed00b3] by '''patrikjuvonen''' and '''botder''')
* Fixed domain permission window labels overflowing in some languages ([https://github.com/multitheftauto/mtasa-blue/commit/f7dcd6f249a367ddb9b81b07bea35b4fcb6145ee f7dcd6f] by '''patrikjuvonen''')
* Updated client translations ([https://github.com/multitheftauto/mtasa-blue/commit/6db5ba4454a7f764871aae561b17898fd4e82318 6db5ba4] by '''patrikjuvonen''')
* Updated credits ([https://github.com/multitheftauto/mtasa-blue/pull/2125 #2125] by '''patrikjuvonen''')

=== 7 Vendor Updates ===
* Updated and replaced CEGUI-integrated [https://www.freetype.org/ FreeType] by adding it as its own dependency ([https://github.com/multitheftauto/mtasa-blue/commit/def86d01971d84522803052f68374a92bd68fad4 def86d0] and [https://github.com/multitheftauto/mtasa-blue/commit/2b70f96da7e4fb07effc371929e7e8f6297b8105 2b70f96] by '''Jusonex''')
* Updated libjpeg from 9b to 9d ([https://github.com/multitheftauto/mtasa-blue/pull/1963 #1963] by '''patrikjuvonen''')
* Updated Unifont from 5.1 to 13.0.06 ([https://github.com/multitheftauto/mtasa-blue/commit/8eeac9a6465b2d6af7055cab01eb24beb72b8d2d 8eeac9a] by '''patrikjuvonen''')
* Updated BASS libraries ([https://github.com/multitheftauto/mtasa-blue/pull/2377 #2377] by '''Dutchman101''')
* Updated CEF from 85.3.12+g3e94ebf (Chromium 85.0.4183.121) to 94.4.2+g6a963ca ([https://chromereleases.googleblog.com/2021/09/stable-channel-update-for-desktop_24.html Chromium 94.0.4606.61]) (See commit [https://github.com/multitheftauto/mtasa-blue/commit/ae6caa92c81b37ca29c7af0fbb7dffb4c57b14b6 ae6caa9] by '''patrikjuvonen''')
* Added lunasvg 2.3.0 ([https://github.com/multitheftauto/mtasa-blue/pull/2026 #2026] by '''Lpsd''')
* Updated unrar from 5.91 to 6.02 ([https://github.com/multitheftauto/mtasa-blue/pull/2384 #2384] by '''patrikjuvonen''')

</section>

== Server ==
<section show="true">
=== 6 New Events ===
* Added [[onElementDimensionChange]] ([https://github.com/multitheftauto/mtasa-blue/pull/1553 #1553] by '''StrixG''')
* Added [[onPedVehicleEnter]] and [[onPedVehicleExit]] ([https://github.com/multitheftauto/mtasa-blue/pull/1748 #1748] by '''Zangomangu''')
* Added [[onResourceLoadStateChange]] ([https://github.com/multitheftauto/mtasa-blue/pull/1651 #1651] by '''TeteX1''')
* Added [[onElementInteriorChange]] ([https://github.com/multitheftauto/mtasa-blue/pull/2058 #2058] by '''Patrick2562''')
* Added [[onPlayerResourceStart]] ([https://github.com/multitheftauto/mtasa-blue/pull/2150 #2150] by '''Lpsd''')

=== New Arguments & Parameters ===
* Added ''exitCode'' to [[shutdown]] ([https://github.com/multitheftauto/mtasa-blue/pull/2298 #2298] by '''botder''')

=== 16 Bug Fixes & Changes ===
* Fixed wrong SQLite column in [[getAccountsByIP]] ([https://github.com/multitheftauto/mtasa-blue/pull/1734 #1734] by '''emre1702''')
* Improved ''help'' command in server console ([https://github.com/multitheftauto/mtasa-blue/pull/1639 #1639] by '''Unde-R''')
* Improved checksum error messages for internal HTTP servers ([https://github.com/multitheftauto/mtasa-blue/pull/1778 #1778] by '''qaisjp''')
* Events [[onVehicleStartEnter]], [[onVehicleEnter]], [[onVehicleStartExit]] and [[onVehicleExit]] now return [[ped|peds]] as well ([https://github.com/multitheftauto/mtasa-blue/pull/1748 #1748] by '''Zangomangu''')
* Fixed CLuaArgument not comparing tables recursively, causing unnecessary [[setElementData]] resyncs even if values match ([https://github.com/multitheftauto/mtasa-blue/commit/76e52f820e4dadce75df6de0ea3378d02cc1bbb5 76e52f8] by '''botder''')
* Enforce existing username length limit in account code ([https://github.com/multitheftauto/mtasa-blue/pull/1995 #1995] by '''patrikjuvonen''')
* Refactored vehicle blowup code to fix [[onVehicleExplode]] triggering twice server-side ([https://github.com/multitheftauto/mtasa-blue/pull/1997 #1997] by '''botder''')
* Added source map compatibility in CResourceHTMLItem ([https://github.com/multitheftauto/mtasa-blue/pull/2207 #2207] by '''PauloKim1246''')
* Added missing [[GetElementsWithinColShape|ColShape.elementsWithin]] ([https://github.com/multitheftauto/mtasa-blue/pull/2186 #2186] by '''Pirulax''')
* Fixed info command displaying two statuses of a running resource ([https://github.com/multitheftauto/mtasa-blue/pull/2292 #2292] by '''theSarrum''')
* Fixed respawning of blown vehicles ([https://github.com/multitheftauto/mtasa-blue/commit/796399704b1e0a2147bb7ba52ea95c34245ceebe 7963997] by '''botder''')
* Don't allow dead peds to enter vehicles ([https://github.com/multitheftauto/mtasa-blue/pull/2344 #2344] by '''Zangomangu''')
* Fixed missing new lines when outputting long messages in server console ([https://github.com/multitheftauto/mtasa-blue/commit/6256bb05ea752d2e2f406c516448ae948f493c79 6256bb0] by '''patrikjuvonen''')

=== 1 Vendor Update ===
* Updated sqlite from 3.32.3 to 3.36.0 ([https://github.com/multitheftauto/mtasa-blue/pull/2284 #2284] by '''patrikjuvonen''')
</section>

== Shared (''Client & Server'') ==
<section show="true">
=== 5 New Functions ===
* Added transfer box customization functions [[setTransferBoxVisible]] and [[isTransferBoxVisible]] ([https://github.com/multitheftauto/mtasa-blue/pull/1955 #1955] by '''botder''' and '''CrosRoad95''')
* Added [[setColPolygonHeight]] and [[getColPolygonHeight]] ([https://github.com/multitheftauto/mtasa-blue/pull/1908 #1908] by '''CrosRoad95''')
* Added ''intersectsSegmentTriangle'' method to [[Vector3]] ([https://github.com/multitheftauto/mtasa-blue/pull/1711 #1711] by '''Pirulax''')

=== 3 New Arguments & Parameters ===
* Added ''bIncludeWorldSeaLevel'' and ''bIncludeOutsideWorldLevel'' to [[setWaterLevel]] ([https://github.com/multitheftauto/mtasa-blue/pull/1402 #1402] by '''TheNormalnij''')
* Added new optional ''inputBlocked'' argument for [[showChat]] ([https://github.com/multitheftauto/mtasa-blue/pull/2170 #2170] by '''Pieter-Dewachter''')

=== 9 Bug Fixes & Changes ===
* Fixed vehicle driver desynchronization after carjacker dies ([https://github.com/multitheftauto/mtasa-blue/pull/1907 #1907] by '''Zangomangu''')
* Disabled train track functions ([https://github.com/multitheftauto/mtasa-blue/pull/1920 #1920] by '''qaisjp''')
* Added request body and method to HTTP scripts ([https://github.com/multitheftauto/mtasa-blue/pull/2053 #2053] by '''Disinterpreter''')
* Added aes128 encryption support to [[encodeString]] and [[decodeString]] ([https://github.com/multitheftauto/mtasa-blue/pull/2235 #2235] by '''drop-club''')
* Fixed empty files returning an invalid checksum ([https://github.com/multitheftauto/mtasa-blue/commit/966de4e209b4ce6b3e4e6a7ea0f53650038a049c 966de4e] by '''botder''')
* Added extra checks in CXMLImpl::ParseString to avoid crash when invalid XML data supplied ([https://github.com/multitheftauto/mtasa-blue/pull/2282 #2282] by '''Lpsd''')
* Added ability to use peds and vehicles as a camera target using [[setCameraTarget]] ([https://github.com/multitheftauto/mtasa-blue/pull/1753 #1753] by '''TheNormalnij''')
</section>

=== 5 Vendor Updates ===
* Updated detours from 1.2 to 4.0.1 ([https://github.com/multitheftauto/mtasa-blue/pull/2022 #2022] by '''botder''')
* Updated mbedtls from 2.4.2 to 2.27.0 ([https://github.com/multitheftauto/mtasa-blue/pull/2085 #2085] and [https://github.com/multitheftauto/mtasa-blue/commit/38e92079643779a0a1ef3b25ca5cfb4c99be2e52 38e9207] by '''botder''' and '''patrikjuvonen''')
* Updated curl from 7.72.0 to 7.79.1 ([https://github.com/multitheftauto/mtasa-blue/pull/2373 #2373] by '''patrikjuvonen''')
* Updated pcre from 8.39 to 8.45 ([https://github.com/multitheftauto/mtasa-blue/commit/7d517586c71a940f52cfa5ee1443b628882c9eed 7d51758] by '''patrikjuvonen''')
* Updated cryptopp from 8.2.0 to 8.6.0 ([https://github.com/multitheftauto/mtasa-blue/pull/2385 #2385] by '''patrikjuvonen''')

== Resources ==

=== 37+ Bug Fixes & Changes ===

* [admin] added an option to hide sensitive data. (works like streamer mode in some apps) (thanks to iDannz)
* [admin] added an option make the camera collide while spectate. (thanks to iDannz)
* [admin] added a command to send messages in admin chat (/a message). (thanks to rickchesterhd123)
* [admin] added an option to teleport to the selected position on the map. (thanks to Patrick2562)
* [admin] added save to some infos, so you don't have to reselect some options after reconnecting. (thanks to iDannz)
* [admin] fixed error in output messages (case the player has a nickname with more than 1 hex color). (thanks to androksi)
* [admin] fixed a bug that occurred when trying to restart a resource that wasn't running. (thanks to Dante386)
* [admin] fixed an error that occurred when clicking on the "Maps" tab if the resource 'mapmanager' was not running. (thanks to cleoppa and iDannz)
* [admin] improved the lists of 'give vehicle', 'give weapon' and 'slap'. (thanks to iDannz)
* [admin] replace 'give admin' button with permissions selection widget. (thanks to iDannz)
* [admin] tweaks to the interface. (thanks to iDannz)
* [cdm] removed the cdm resource from the official resources package.
* [editor] added an option to 'lock' elements. (thanks to xLive)
* [editor] added an option to choose the output directory before saving new maps. (thanks to umithyo, xLive and iDannz)
* [editor] added option to select some objects that do not have collisions. (thanks to Zangomangu and Tut)
* [editor] fixed an issue that occurred when saving element's dimension. (thanks to FileEX)
* [editor] fixed bug that made the camera be locked after clicking some buttons too fast. (thanks to androksi and iDannz)
* [editor] interior world models are now removable. (thanks to Zangomango)
* [freeroam] fixed an error in the command '/addclothes'. (thanks to xLive)
* [freeroam] fixed error when using negative numbers in the command '/color'. (thanks to xLive)
* [freeroam] improved the map image quality. (thanks to patrikjuvonen)
* [hedit] resource added to the official resources package.
* [ipb] fixed filter input-box that did not work. (thanks to iDannz)
* [killmessages] rewritten resource. (now detects deaths caused by vehicles (eg hydra), and also detects deaths caused by vehicle explosions). (thanks to iDannz)
* [mapcycler] added an option to pause cycling while the server is empty. (thanks to jlillis)
* [race] added configuration of transparency level during the ghost mode. (thanks to AfuSensi)
* [race] added fade car addon. (thanks to AfuSensi)
* [race] fix bug in pickup respawn. (thanks to LosFaul)
* [race] finish the map when there are only spectators. (thanks to xLive)
* [race] added possibility to use rotation attributes. (thanks to xLive)
* [resourcemanager] fixed problems on the dates of some information. (thanks to Dezash)
* [runcode] fixed a problem that caused the 'srun' command show the results to everyone. (thanks to Yamsha75)
* [speedometer] resource added to the official resources package.
* [trainhorn] resource added to the official resources package.
* [webmap] fixed and updated. (thanks to patrikjuvonen)
* [webstats] updated. (thanks to patrikjuvonen)

== Extra information ==
''More detailed information available on our GitHub repositories:
:* [https://github.com/multitheftauto/mtasa-blue MTA:SA Blue]
:* [https://github.com/multitheftauto/mtasa-resources MTA:SA Official Resources]

[[Category:Changelog]]
[[Category:Incomplete]]

GetElementLighting

2022-10-22T13:35:06Z

Samr46: Created page with "{{Client function}} __NOTOC__ {{Added feature/item|1.5.9|1.5.9|21367|This function returns the lighting value for the specified element. This can be a player, ped, vehicle, object.}} ==Syntax== <syntaxhighlight lang="lua"> float getElementLighting ( element theElement ) </syntaxhighlight> {{OOP||element:getLighting|lighting}} ===Required Arguments=== *'''theElement:''' The element whose lighting you want to retrieve. ===Returns=== Returns a..."

CreateTrayNotification

2019-05-11T10:59:54Z

Samr46:

__NOTOC__
{{Client function}}
This functions creates a notification ballon on the desktop.

{{Note|MTA won't show any tray notifications if the MTA window is focused, because there is no reason to show tray notifications if you are ingame. If you want to test this function you should use a Timer and switch to your desktop.}}
{{Note|You can only show a tray notification every 30 seconds.}}

==Syntax==
<syntaxhighlight lang="lua">bool createTrayNotification ( string notificationText, [ string iconType = "default", bool useSound = true ] )</syntaxhighlight>

===Required Arguments===
*'''notificationText:''' The text to send in the notification.

===Optional Arguments===
*'''iconType:''' The notification icon type. Possible values are: '''"default" (the MTA icon), "info", "warning", "error"'''
*'''useSound:''' A boolean value indicating whether or not to play a sound when receiving the notification.

===Returns===
Returns ''true'' if the notification is correctly created, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
-- Note: You have to wait 30 seconds before showing another tray notification, there is no queuing

-- Show a 'Hello World' notification
createTrayNotification( "Hello World" )

-- Show a notification with a warning symbol
createTrayNotification( "Hello World", "warning" )

-- Show a default notification without sound
createTrayNotification( "Hello World", "default", false )
</syntaxhighlight>

==Example of notification on minimize MTA application==
<syntaxhighlight lang="lua">
function setTrayOnMinimize( )
createTrayNotification( "We are waiting for you again...", "warning" )
end
addEventHandler( "onClientMinimize", getRootElement( ), setTrayOnMinimize )
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.6-9.16925|Added support for Windows 10}}

==See Also==
{{Client_utility_functions}}

Template:Client object functions

2018-11-04T01:14:35Z

Samr46:

*[[breakObject]]
*[[createObject]]
*[[getObjectMass]]
*[[getObjectScale]]
*[[isObjectBreakable]]
*[[moveObject]]
*[[respawnObject]]
*[[setObjectBreakable]]
*[[setObjectMass]]
*[[setObjectScale]]
*[[stopObject]]
*[[toggleObjectRespawn]]
{{New items|3.0157|1.5.6|
*[[getObjectProperty]]
*[[setObjectProperty]]
|14370}}

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

GetObjectProperty

2018-11-04T01:08:30Z

Samr46: Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0157|1.5.6|14370|This function gets a property of the specified object.}} ==Syntax== <syntaxhighlight lang="lua">mixe..."

__NOTOC__
{{Client function}}
{{New feature/item|3.0157|1.5.6|14370|This function gets a property of the specified [[object]].}}

==Syntax==
<syntaxhighlight lang="lua">mixed getObjectProperty ( object theObject, string property )</syntaxhighlight>
{{OOP||[[object]]:getProperty||setProperty}}
===Required Arguments===
*'''theObject''': the [[object]] you wish to get a property of.
*'''property:''': the property you want to get the value of:
<div style="padding-left:20px">
* "all" - ''table'' with values of all properties below (OOP method: ''getProperties'')
</div>
{{Object Properties}}

===Returns===
On success: [[table]] for '''all''', 3 [[float|floats]] for '''center_of_mass''' or [[float]] for other properties

On failure: ''false''

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot, function()
local theObject = createObject(980, 0, 0, 0) -- create an object
if theObject then
setObjectProperty(theObject, "center_of_mass", 0, -1, 0) -- set it's center of mass

local x, y, z = getObjectProperty(theObject, "center_of_mass") -- get it's center of mass
outputChatBox("Object's center of mass: "..tostring(x)..", "..tostring(y)..", "..tostring(z))
end
end)
</syntaxhighlight>
</section>

==See Also==
{{Client_object_functions}}

SetObjectProperty

2018-11-04T01:08:14Z

Samr46: Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0157|1.5.6|14370|This function sets a property of the specified object.}} ==Syntax== <syntaxhighlight lang="lua">bool..."

__NOTOC__
{{Client function}}
{{New feature/item|3.0157|1.5.6|14370|This function sets a property of the specified [[object]].}}

==Syntax==
<syntaxhighlight lang="lua">bool setObjectProperty ( object theObject, string property, var value )</syntaxhighlight>
{{OOP||[[object]]:setProperty||getProperty}}
===Required Arguments===
*'''theObject''': the [[object]] you wish to change a property of.
*'''property:''': the property you want to set the value of:
{{Object Properties}}
*'''value:''': the new value for the property.

===Returns===
Returns ''true'' if the property was set successfully, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot, function()
local theObject = createObject(980, 0, 0, 0) -- create an object
if theObject then
setObjectProperty(theObject, "center_of_mass", 0, -1, 0) -- set it's center of mass
end
end)
</syntaxhighlight>
</section>

==See Also==
{{Client_object_functions}}

Template:Object Properties

2018-11-04T01:06:40Z

Samr46: Created page with "<div style="padding-left:20px"> * "mass" - ''float'' * "turn_mass" - ''float'' * "accuracy" - ''float'' * "air_resistance" - ''float'' * "elasticity" - ''float'' * "center_of_..."

<div style="padding-left:20px">
* "mass" - ''float''
* "turn_mass" - ''float''
* "accuracy" - ''float''
* "air_resistance" - ''float''
* "elasticity" - ''float''
* "center_of_mass" - ''Vector3D'' - '''(x, y, z)'''
* "buoyancy" - ''float''
</div>

DxCreateShader

2018-10-30T12:20:13Z

Samr46: /* Example */

{{Client function}}
__NOTOC__
This function creates a [[shader]] element that can be used in the dxDraw functions. Successful shader creation is not guaranteed unless the [[shader|Effect File]] contains a fallback technique which will work on every PC in the universe.

<h5>It is highly recommended that [[dxSetTestMode]] is used when writing and testing scripts using dxCreateShader.</h5>

==Syntax==
<syntaxhighlight lang="lua">
element, string dxCreateShader ( string filepath / string raw_data [, float priority = 0, float maxDistance = 0, bool layered = false, string elementTypes = "world,vehicle,object,other" ] )
</syntaxhighlight>
{{OOP||[[Shader|DxShader]]}}
===Required Arguments===
*'''filepath / raw_data:''' The filepath of the [[shader|shader Effect File]] (.fx) file or whole data buffer of the shader file

===Optional Arguments===
''All the following optional arguments are only relevant when the shader is used with [[engineApplyShaderToWorldTexture]]''
*'''priority:''' If more than one shader is matched to a world texture, the shader with the highest priority will be used. If there is more than one shader with the same highest priority, the most recently created shader is used.
*'''maxDistance:''' If non-zero, the shader will be applied to textures nearer than maxDistance only. This can speed up rendering, but (to look good) may require the shader to fade out it's own effect as the texture reaches maxDistance.
*'''layered:''' When set to true, the shader will be drawn in a separate render pass. Several layered shaders can be drawn on the same world texture. (To avoid [http://en.wikipedia.org/wiki/Z-fighting Z fighting] artifacts, you may have to add '''DepthBias<nowiki>=</nowiki>-0.0002;''' to the technique pass, but this might cause visual artifacts when applied on vehicles)
*'''elementTypes:''' A comma seperated list of element types to restrict this shader to. Valid element types are:
** world - Textures in the GTA world
** ped - Player and ped textures
** vehicle - Vehicles textures
** object - Objects textures
** other - Element textures which are not peds, vehicles or objects
** all - Everything

===Returns===
*'''element:''' A [[shader]] element if successful, ''false'' if invalid arguments were passed to the function. '''You should always check to see if this function has returned false.'''
*'''string:''' The name of the technique that will be used.

==Example==
<syntaxhighlight lang="lua">
addEventHandler( "onClientRender", root,
function()
if myShader then
dxDrawImage( 100, 350, 300, 350, myShader )
end
end
)

-- Use 'toggle' command to switch shader on and off
addCommandHandler( "toggle",
function()
if not myShader then
myShader = dxCreateShader( "fancything.fx" ) -- Create shader
else
destroyElement( myShader ) -- Destroy shader
myShader = nil
end
end
)
</syntaxhighlight>
<br/>
{{New items|5.0156|1.5.6-9.14403|
This example creates basic shader from raw data (without i/o) on resource start:
<syntaxhighlight lang="lua">
local myShader_raw_data = [[
texture tex;
technique replace {
pass P0 {
Texture[0] = tex;
}
}
]]

addEventHandler("onClientResourceStart", resourceRoot, function()
local myShader = dxCreateShader(myShader_raw_data) -- create shader from raw data
if isElement(myShader) then
local myTexture = dxCreateTexture("some_image.png") -- create texture from image file
if isElement(myTexture) then
-- apply image to world texture via shader
dxSetShaderValue(myShader, "tex", myTexture)
engineApplyShaderToWorldTexture(myShader, "shad_ped")
else
outputDebugString("Unable to load texture", 1)
end
else
outputDebugString("Unable to create shader", 1)
end
end)
</syntaxhighlight>
You can pass raw data (shader code) directly into the function (example uses variable ''myShader_raw_data'').
}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04435|Added layered and elementTypes arguments}}
{{ChangelogItem|1.5.6-9.14403|Added option to use raw data instead of a file name}}

==See Also==
{{Drawing_functions}}

[[hu:dxCreateShader]]

PregReplace

2018-10-30T02:17:48Z

Samr46:

__NOTOC__
{{Server client function}}
{{New items|3.0135|1.3.5|
This function performs a regular expression search and replace and returns the replaced string.
}}
{{Warning|When declaring a pattern string in quotes, the backslash character should be doubled up. e.g. "\\(" will match a single bracket. This also applies to the replacement string.}}
{{Warning|Multiline flag does not work correctly}}

==Syntax==
<syntaxhighlight lang="lua">
string pregReplace ( string subject, string pattern, string replacement [, int/string flags ] )
</syntaxhighlight>

===Required Arguments===
*'''subject:''' The input [[string]].
*'''pattern:''' The pattern [[string]] to search for in the input [[string]].
*'''replacement:''' The replacement [[string]] to replace all matches within the input [[string]].

===Optional Arguments===
*'''flags:''' Conjuncted value that contains flags ( 1 - ignorecase, 2 - multiline, 4 - dotall, 8 - extended, 16 - unicode ) or ( i - Ignore case, m - Multiline, d - Dotall, e - Extended, u - Unicode )

===Returns===
Returns the replaced ''[[string]]'', or [[bool]] ''false'' otherwise.

==Example==
<section name="Shared ( client and server )" class="both" show="true">
Some examples:
<syntaxhighlight lang="lua">
addCommandHandler('examples',
function ()
-- Replace doh with done
outputDebugString( pregReplace( 'I doh this, guys.', 'doh', 'done' ) or 'not replaced' ) -- Result: I done this, guys

-- Remove all uppercase alphabetic characters
outputDebugString( pregReplace( 'AaaBbbZzz', '[A-Z]{1,}', '' ) or 'not replaced' ) -- Result: aabbzz

-- Use simple backreference in replacement string
outputDebugString( pregReplace( "I love Lua!", "(Lua)", "Moon\\1" ) ) -- Result: I love MoonLua!

-- Remove repeated characters
outputDebugString( pregReplace( "Keeeeeep this shooooooort.", "((.)\\2{2})\\2+", "\\1" ) ) -- Result: Keeep this shooort.
end
)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.3.5-9.06056|1.3.5-9.06056|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.0-9.07315|Added flag "u" in regular expressions}}

==See Also==
{{Utility_functions}}

PregMatch

2018-10-30T02:17:44Z

Samr46:

__NOTOC__
{{Server client function}}
{{New items|3.0135|1.3.5|
This function returns all matches.
}}
{{Warning|When declaring a pattern string in quotes, the backslash character should be doubled up. e.g. "\\(" will match a single bracket.}}
{{Warning|Multiline flag does not work correctly}}
==Syntax==
<syntaxhighlight lang="lua">
table pregMatch ( string base, string pattern [, int/string flags = 0, int maxResults = 100000 ] )
</syntaxhighlight>

===Required Arguments===
*'''base:''' The base [[string]] for replace.
*'''pattern:''' The pattern for match in base string.

===Optional Arguments===
*'''flags:''' Conjuncted value that contains flags ( 1 - ignorecase, 2 - multiline, 4 - dotall, 8 - extended, 16 - unicode ) or ( i - Ignore case, m - Multiline, d - Dotall, e - Extended, u - Unicode )
*'''maxResults:''' Maximum number of results to return

===Returns===
Returns a ''[[table]]'' if one or more match is found, ''false'' otherwise.

==Example==
<section name="Shared ( client and server )" class="both" show="true">
Some examples:
<syntaxhighlight lang="lua">
addCommandHandler( 'example',
function( )
--[[
Will print:
Match: 1, hello
Match: 2, hello
]]
for i, v in ipairs( pregMatch( "hello hello", "(hello)" ) ) do
outputDebugString( "Match: " .. i .. ", " .. v );
end
end
);

addCommandHandler( 'example2',
function( )
--[[
Will print:
Match: 1, somebodyWWw
Match: 2, 228
]]
for i, v in ipairs( pregMatch( "somebodyWWw\n228", "([a-z0-9]+)", "im" ) ) do
outputDebugString( "Match: " .. i .. ", " .. v );
end
end
);

</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.3.5-9.06056|1.3.5-9.06056|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.0-9.07315|Added flag "u" in regular expressions}}

==See Also==
{{Utility_functions}}

PregFind

2018-10-30T02:17:42Z

Samr46:

__NOTOC__
{{Server client function}}
{{New items|3.0135|1.3.5|
This function stops at the first occurrence of the pattern in the input string and returns the result of the search.
}}
{{Warning|When declaring a pattern string in quotes, the backslash character should be doubled up. e.g. "\\(" will match a single bracket.}}
{{Warning|Multiline flag does not work correctly}}

==Syntax==
<syntaxhighlight lang="lua">
bool pregFind ( string subject, string pattern [, int/string flags ] )
</syntaxhighlight>

===Required Arguments===
*'''subject:''' The input [[string]]
*'''pattern:''' The pattern [[string]] to search for in the input [[string]].

===Optional Arguments===
*'''flags:''' Conjuncted value that contains flags ( 1 - ignorecase, 2 - multiline, 4 - dotall, 8 - extended, 16 - unicode ) or ( i - Ignore case, m - Multiline, d - Dotall, e - Extended, u - Unicode )

===Returns===
Returns ''true'' if the pattern was found in the input string, ''false'' otherwise.

==Example==
<section name="Shared ( client and server )" class="both" show="true">
Some examples:
<syntaxhighlight lang="lua">
addCommandHandler( 'examples',
function( )
-- find the first occurrence of 'hello world' in a string
outputDebugString( pregFind( 'hello world, hello world, hello world', 'hello world' ) and 'found' or 'not found' ) -- found
-- find the first occurrence of an integer in a string
outputDebugString( pregFind( '123', '^-{0,1}\\d+$' ) and 'found' or 'not found' ) -- found
-- check if the input string consists of at least 3 letters from a to z (both uppercase and lowercase) and does not contain any whitespace characters
outputDebugString( pregFind( 'Kenix', '^[a-zA-Z]{3,}$' ) and 'found' or 'not found' ) -- found
-- check if the input string matches the format of a role-play name
outputDebugString( pregFind( 'Garry_Newman', '([A-Z]{1,1})[a-z]{2,9}_([A-Z]{1,1})[a-z]{2,9}' ) and 'found' or 'not found' ) -- found
-- example of a search for non-ASCII characters (i.e. cyrillic) - привет
outputDebugString( pregFind( 'Всем привет парни, ещё раз привет :D', 'привет' ) and 'found' or 'not found' ) -- found
-- example of a search for a specific sequence of numbers
outputDebugString( pregFind( '5, 10', '^([1-9]{1}[0-9]{0,})+(((,\s|,)[1-9]{1}[0-9]{0,}){0,1}){1,1}' ) and 'found' or 'not found' ) -- found

end
)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.3.5-9.06056|1.3.5-9.06056|}}

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.0-9.07315|Added flag "u" in regular expressions}}

==See Also==
{{Utility_functions}}

DxCreateShader

2018-10-27T16:58:51Z

Samr46:

{{Client function}}
__NOTOC__
This function creates a [[shader]] element that can be used in the dxDraw functions. Successful shader creation is not guaranteed unless the [[shader|Effect File]] contains a fallback technique which will work on every PC in the universe.

<h5>It is highly recommended that [[dxSetTestMode]] is used when writing and testing scripts using dxCreateShader.</h5>

==Syntax==
<syntaxhighlight lang="lua">
element, string dxCreateShader ( string filepath / string raw_data [, float priority = 0, float maxDistance = 0, bool layered = false, string elementTypes = "world,vehicle,object,other" ] )
</syntaxhighlight>
{{OOP||[[Shader|DxShader]]}}
===Required Arguments===
*'''filepath / raw_data:''' The filepath of the [[shader|shader Effect File]] (.fx) file or whole data buffer of the shader file

===Optional Arguments===
''All the following optional arguments are only relevant when the shader is used with [[engineApplyShaderToWorldTexture]]''
*'''priority:''' If more than one shader is matched to a world texture, the shader with the highest priority will be used. If there is more than one shader with the same highest priority, the most recently created shader is used.
*'''maxDistance:''' If non-zero, the shader will be applied to textures nearer than maxDistance only. This can speed up rendering, but (to look good) may require the shader to fade out it's own effect as the texture reaches maxDistance.
*'''layered:''' When set to true, the shader will be drawn in a separate render pass. Several layered shaders can be drawn on the same world texture. (To avoid [http://en.wikipedia.org/wiki/Z-fighting Z fighting] artifacts, you may have to add '''DepthBias<nowiki>=</nowiki>-0.0002;''' to the technique pass, but this might cause visual artifacts when applied on vehicles)
*'''elementTypes:''' A comma seperated list of element types to restrict this shader to. Valid element types are:
** world - Textures in the GTA world
** ped - Player and ped textures
** vehicle - Vehicles textures
** object - Objects textures
** other - Element textures which are not peds, vehicles or objects
** all - Everything

===Returns===
*'''element:''' A [[shader]] element if successful, ''false'' if invalid arguments were passed to the function. '''You should always check to see if this function has returned false.'''
*'''string:''' The name of the technique that will be used.

==Example==
<syntaxhighlight lang="lua">
addEventHandler( "onClientRender", root,
function()
if myShader then
dxDrawImage( 100, 350, 300, 350, myShader )
end
end
)

-- Use 'toggle' command to switch shader on and off
addCommandHandler( "toggle",
function()
if not myShader then
myShader = dxCreateShader( "fancything.fx" ) -- Create shader
else
destroyElement( myShader ) -- Destroy shader
myShader = nil
end
end
)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04435|Added layered and elementTypes arguments}}
{{ChangelogItem|1.5.6-9.14403|Added option to use raw data instead of a file name}}

==See Also==
{{Drawing_functions}}

[[hu:dxCreateShader]]