Multi Theft Auto: Wiki - User contributions [en]

SetAccountSerial

2025-07-26T08:09:13Z

Mohab:

{{server function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|23232|This function sets the serial number for a specified player account. It allows administrators to update or assign a new [[serial]] to registered accounts.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountSerial ( account theAccount, string serial )
</syntaxhighlight>
{{OOP||[[account]]:setSerial|serial|}}
===Required Arguments===
*'''theAccount:''' The account element to set the serial for
*'''serial:''' A valid 32-character hexadecimal string representing the new serial number

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

==Example==

<syntaxhighlight lang="lua">
-- Simple example: Set a serial for a player's account
local player = getPlayerFromName("John")
local account = getPlayerAccount(player)
local newSerial = "A1B2C3D4E5F6789012345678901234AB"

if setAccountSerial(account, newSerial) then
outputChatBox("Serial updated successfully!")
else
outputChatBox("Failed to update serial!")
end
</syntaxhighlight>

<syntaxhighlight lang="lua">
-- Advanced example: Administrative command system
function changePlayerSerial(player, newSerial)
local account = getPlayerAccount(player)
if account and not isGuestAccount(account) then
if setAccountSerial(account, newSerial) then
outputChatBox("Serial number updated successfully!", player, 0, 255, 0)
return true
else
outputChatBox("Failed to update serial number. Invalid format!", player, 255, 0, 0)
return false
end
else
outputChatBox("You must be logged into a registered account.", player, 255, 0, 0)
return false
end
end

-- Command to set a player's account serial
addCommandHandler("setserial", function(player, cmd, targetPlayer, newSerial)
if not targetPlayer or not newSerial then
outputChatBox("Usage: /setserial <player> <32-char-hex-serial>", player)
return
end

local target = getPlayerFromName(targetPlayer)
if target then
if string.len(newSerial) == 32 and string.match(newSerial, "^[A-Fa-f0-9]+$") then
changePlayerSerial(target, newSerial)
else
outputChatBox("Serial must be 32 hexadecimal characters!", player, 255, 0, 0)
end
else
outputChatBox("Player not found!", player, 255, 0, 0)
end
end)
</syntaxhighlight>

==See Also==
*[[getAccountSerial]]
*[[getAccountsBySerial]]
*[[addAccount]]
*[[removeAccount]]
*[[isGuestAccount]]
*[[getPlayerAccount]]
{{Account functions}}

SetAccountSerial

2025-07-26T08:02:34Z

Mohab:

{{server function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|23232|This function sets the serial number for a specified player account. It allows administrators to update or assign a new [[serial]] to registered accounts.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountSerial ( account theAccount, string serial )
</syntaxhighlight>

===Required Arguments===
*'''theAccount:''' The account element to set the serial for
*'''serial:''' A valid 32-character hexadecimal string representing the new serial number

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

==Example==

<syntaxhighlight lang="lua">
-- Simple example: Set a serial for a player's account
local player = getPlayerFromName("John")
local account = getPlayerAccount(player)
local newSerial = "A1B2C3D4E5F6789012345678901234AB"

if setAccountSerial(account, newSerial) then
outputChatBox("Serial updated successfully!")
else
outputChatBox("Failed to update serial!")
end
</syntaxhighlight>

<syntaxhighlight lang="lua">
-- Advanced example: Administrative command system
function changePlayerSerial(player, newSerial)
local account = getPlayerAccount(player)
if account and not isGuestAccount(account) then
if setAccountSerial(account, newSerial) then
outputChatBox("Serial number updated successfully!", player, 0, 255, 0)
return true
else
outputChatBox("Failed to update serial number. Invalid format!", player, 255, 0, 0)
return false
end
else
outputChatBox("You must be logged into a registered account.", player, 255, 0, 0)
return false
end
end

-- Command to set a player's account serial
addCommandHandler("setserial", function(player, cmd, targetPlayer, newSerial)
if not targetPlayer or not newSerial then
outputChatBox("Usage: /setserial <player> <32-char-hex-serial>", player)
return
end

local target = getPlayerFromName(targetPlayer)
if target then
if string.len(newSerial) == 32 and string.match(newSerial, "^[A-Fa-f0-9]+$") then
changePlayerSerial(target, newSerial)
else
outputChatBox("Serial must be 32 hexadecimal characters!", player, 255, 0, 0)
end
else
outputChatBox("Player not found!", player, 255, 0, 0)
end
end)
</syntaxhighlight>

==See Also==
*[[getAccountSerial]]
*[[getAccountsBySerial]]
*[[addAccount]]
*[[removeAccount]]
*[[isGuestAccount]]
*[[getPlayerAccount]]
{{Account functions}}

SetAccountSerial

2025-07-26T08:02:15Z

Mohab:

{{server function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|23232|This function sets the serial number for a specified player account. It allows administrators to update or assign a [[serial]] to registered accounts.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountSerial ( account theAccount, string serial )
</syntaxhighlight>

===Required Arguments===
*'''theAccount:''' The account element to set the serial for
*'''serial:''' A valid 32-character hexadecimal string representing the new serial number

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

==Example==

<syntaxhighlight lang="lua">
-- Simple example: Set a serial for a player's account
local player = getPlayerFromName("John")
local account = getPlayerAccount(player)
local newSerial = "A1B2C3D4E5F6789012345678901234AB"

if setAccountSerial(account, newSerial) then
outputChatBox("Serial updated successfully!")
else
outputChatBox("Failed to update serial!")
end
</syntaxhighlight>

<syntaxhighlight lang="lua">
-- Advanced example: Administrative command system
function changePlayerSerial(player, newSerial)
local account = getPlayerAccount(player)
if account and not isGuestAccount(account) then
if setAccountSerial(account, newSerial) then
outputChatBox("Serial number updated successfully!", player, 0, 255, 0)
return true
else
outputChatBox("Failed to update serial number. Invalid format!", player, 255, 0, 0)
return false
end
else
outputChatBox("You must be logged into a registered account.", player, 255, 0, 0)
return false
end
end

-- Command to set a player's account serial
addCommandHandler("setserial", function(player, cmd, targetPlayer, newSerial)
if not targetPlayer or not newSerial then
outputChatBox("Usage: /setserial <player> <32-char-hex-serial>", player)
return
end

local target = getPlayerFromName(targetPlayer)
if target then
if string.len(newSerial) == 32 and string.match(newSerial, "^[A-Fa-f0-9]+$") then
changePlayerSerial(target, newSerial)
else
outputChatBox("Serial must be 32 hexadecimal characters!", player, 255, 0, 0)
end
else
outputChatBox("Player not found!", player, 255, 0, 0)
end
end)
</syntaxhighlight>

==See Also==
*[[getAccountSerial]]
*[[getAccountsBySerial]]
*[[addAccount]]
*[[removeAccount]]
*[[isGuestAccount]]
*[[getPlayerAccount]]
{{Account functions}}

SetAccountSerial

2025-07-26T08:00:16Z

Mohab: Created page with "{{server function}} __NOTOC__ {{New feature/item|3.0161|1.6.0|23232|This function sets the serial number for a specified player account. It allows administrators to update or assign a new 32-character hexadecimal serial identifier to registered accounts.}} ==Syntax== <syntaxhighlight lang="lua"> bool setAccountSerial ( account theAccount, string serial ) </syntaxhighlight> ===Required Arguments=== *'''theAccount:''' The account element to set the serial for *'''serial:..."

{{server function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|23232|This function sets the serial number for a specified player account. It allows administrators to update or assign a new 32-character hexadecimal serial identifier to registered accounts.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountSerial ( account theAccount, string serial )
</syntaxhighlight>

===Required Arguments===
*'''theAccount:''' The account element to set the serial for
*'''serial:''' A valid 32-character hexadecimal string representing the new serial number

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

==Example==

<syntaxhighlight lang="lua">
-- Simple example: Set a serial for a player's account
local player = getPlayerFromName("John")
local account = getPlayerAccount(player)
local newSerial = "A1B2C3D4E5F6789012345678901234AB"

if setAccountSerial(account, newSerial) then
outputChatBox("Serial updated successfully!")
else
outputChatBox("Failed to update serial!")
end
</syntaxhighlight>

<syntaxhighlight lang="lua">
-- Advanced example: Administrative command system
function changePlayerSerial(player, newSerial)
local account = getPlayerAccount(player)
if account and not isGuestAccount(account) then
if setAccountSerial(account, newSerial) then
outputChatBox("Serial number updated successfully!", player, 0, 255, 0)
return true
else
outputChatBox("Failed to update serial number. Invalid format!", player, 255, 0, 0)
return false
end
else
outputChatBox("You must be logged into a registered account.", player, 255, 0, 0)
return false
end
end

-- Command to set a player's account serial
addCommandHandler("setserial", function(player, cmd, targetPlayer, newSerial)
if not targetPlayer or not newSerial then
outputChatBox("Usage: /setserial <player> <32-char-hex-serial>", player)
return
end

local target = getPlayerFromName(targetPlayer)
if target then
if string.len(newSerial) == 32 and string.match(newSerial, "^[A-Fa-f0-9]+$") then
changePlayerSerial(target, newSerial)
else
outputChatBox("Serial must be 32 hexadecimal characters!", player, 255, 0, 0)
end
else
outputChatBox("Player not found!", player, 255, 0, 0)
end
end)
</syntaxhighlight>

==See Also==
*[[getAccountSerial]]
*[[getAccountsBySerial]]
*[[addAccount]]
*[[removeAccount]]
*[[isGuestAccount]]
*[[getPlayerAccount]]
{{Account functions}}

ResetVehicleModelAudioSettings

2025-07-25T18:01:16Z

Mohab:

{{client function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|23140|This function resets all audio settings for a specific vehicle model back to their original GTA San Andreas values. This will undo any modifications made with [[setVehicleModelAudioSetting]].}}

==Syntax==
<syntaxhighlight lang="lua">
bool resetVehicleModelAudioSettings ( int modelID )
</syntaxhighlight>

===Required Arguments===
*'''modelID:''' The vehicle model ID to reset audio settings for

===Returns===
Returns ''true'' if the audio settings were successfully reset, ''false'' otherwise.

{{Note|This function only works with standard vehicle models and cannot reset audio settings for allocated vehicles. Changes only affect newly created vehicles. Existing vehicles will retain their current audio settings.}}

==Example==
<syntaxhighlight lang="lua">
-- Modify engine sound for Infernus (model 411)
setVehicleModelAudioSetting(411, "engineOnSoundBankID", 200)
setVehicleModelAudioSetting(411, "hornHigh", 2.0)

-- Reset all audio settings back to original
resetVehicleModelAudioSettings(411)

-- New vehicles will now use original audio settings
local vehicle = createVehicle(411, 0, 0, 3)
</syntaxhighlight>

==See Also==
*[[setVehicleModelAudioSetting]]
*[[getVehicleModelAudioSettings]]
*[[setVehicleAudioSetting]]
*[[getVehicleAudioSettings]]
*[[resetVehicleAudioSettings]]
{{Vehicle functions|client}}

SetVehicleModelAudioSetting

2025-07-25T18:01:06Z

Mohab:

{{client function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|23140|This function sets audio properties for a specific vehicle model. It allows customization of various vehicle sound settings such as engine sounds, horn characteristics, door sounds, and radio settings.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleModelAudioSetting ( int modelID, string property, float value )
</syntaxhighlight>

===Required Arguments===
*'''modelID:''' The vehicle model ID to modify audio settings for
*'''property:''' The audio property to set. Valid properties are:
**"doorSound" - Door sound effects
**"engineOffSoundBankID" - Engine off sound bank ID (0-410)
**"engineOnSoundBankID" - Engine on sound bank ID (0-410)
**"hornHigh" - Horn high frequency
**"hornTon" - Horn tone
**"hornVolumeDelta" - Horn volume delta
**"radioNum" - Radio number
**"radioType" - Radio type
*'''value:''' The numerical value to set for the specified property

===Returns===
Returns ''true'' if the audio setting was successfully applied, ''false'' otherwise.

{{Note|Sound bank IDs for engine sounds must be 410 or lower. Values above this limit will be rejected. Changes only affect newly created vehicles. Existing vehicles will retain their original audio settings. This function only works with standard vehicle models and cannot modify audio settings for vehicles that are already spawned.}}
{{Tip|This function modifies the audio settings for a '''specific vehicle model''', affecting all newly created vehicles of that model. In contrast, [[setVehicleAudioSetting]] modifies the audio settings for a '''specific vehicle instance'''. Changes made with this function do not affect vehicles that are already spawned.}}

==Examples==

===Example 1: Basic Engine Sound Modification===
<syntaxhighlight lang="lua">
-- Modify the engine sound for Infernus (model 411)
setVehicleModelAudioSetting(411, "engineOnSoundBankID", 150)
local vehicle = createVehicle(411, 0, 0, 3)
</syntaxhighlight>

===Example 2: Custom Horn Settings===
<syntaxhighlight lang="lua">
-- Customize horn settings for Sultan (model 560)
local modelID = 560

-- Set horn properties
setVehicleModelAudioSetting(modelID, "hornHigh", 1.5)
setVehicleModelAudioSetting(modelID, "hornTon", 0.8)
setVehicleModelAudioSetting(modelID, "hornVolumeDelta", 2.0)

outputChatBox("Sultan horn settings customized!")

-- Spawn a Sultan to test the new horn
local testVehicle = createVehicle(modelID, 100, 100, 3)
</syntaxhighlight>

===Example 3: Radio and Door Sound Configuration===
<syntaxhighlight lang="lua">
-- Configure radio and door sounds for Elegy (model 562)
local elegytModel = 562

-- Set radio properties
local radioSuccess = setVehicleModelAudioSetting(elegytModel, "radioNum", 5)
local radioTypeSuccess = setVehicleModelAudioSetting(elegytModel, "radioType", 2)

-- Set door sound
local doorSuccess = setVehicleModelAudioSetting(elegytModel, "doorSound", 1.2)

if radioSuccess and radioTypeSuccess and doorSuccess then
outputChatBox("Elegy audio settings configured successfully!")

-- Create vehicle to test settings
local elegy = createVehicle(elegytModel, 200, 200, 3)
else
outputChatBox("Some audio settings failed to apply.")
end
</syntaxhighlight>

===Example 4: Batch Audio Modification===
<syntaxhighlight lang="lua">
-- Function to apply custom audio profile to multiple vehicles
function applyCustomAudioProfile(models, profile)
local successCount = 0

for _, modelID in ipairs(models) do
local modelSuccess = true

for property, value in pairs(profile) do
if not setVehicleModelAudioSetting(modelID, property, value) then
modelSuccess = false
outputChatBox("Failed to set " .. property .. " for model " .. modelID)
end
end

if modelSuccess then
successCount = successCount + 1
outputChatBox("Audio profile applied to model " .. modelID)
end
end

return successCount
end

-- Define custom audio profile
local sportCarProfile = {
["engineOnSoundBankID"] = 200,
["engineOffSoundBankID"] = 180,
["hornHigh"] = 1.8,
["hornVolumeDelta"] = 1.5,
["radioType"] = 3
}

-- Apply to multiple sports cars
local sportsCars = {411, 506, 451, 602} -- Infernus, Super GT, Turismo, Alpha
local modifiedCount = applyCustomAudioProfile(sportsCars, sportCarProfile)

outputChatBox("Modified audio for " .. modifiedCount .. " vehicle models")
</syntaxhighlight>

==See Also==
*[[getVehicleModelAudioSettings]]
*[[resetVehicleModelAudioSettings]]
*[[setVehicleAudioSetting]]
*[[getVehicleAudioSettings]]
*[[resetVehicleAudioSettings]]
{{Vehicle functions|client}}

GetVehicleModelAudioSettings

2025-07-25T18:00:57Z

Mohab:

SetVehicleAudioSetting

2025-07-25T18:00:49Z

Mohab:

{{client function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|23140|This function sets audio properties for a '''specific vehicle instance'''. It allows customization of various vehicle sound settings such as engine sounds, horn characteristics, door sounds, and radio settings.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleAudioSetting ( element vehicle, string property, float value )
</syntaxhighlight>

===Required Arguments===
*'''vehicle:''' The vehicle element to modify audio settings for
*'''property:''' The audio property to set. Valid properties are:
**"doorSound" - Door sound effects
**"engineOffSoundBankID" - Engine off sound bank ID (0-410)
**"engineOnSoundBankID" - Engine on sound bank ID (0-410)
**"hornHigh" - Horn high frequency
**"hornTon" - Horn tone
**"hornVolumeDelta" - Horn volume delta
**"radioNum" - Radio number
**"radioType" - Radio type
*'''value:''' The numerical value to set for the specified property

===Returns===
Returns ''true'' if the audio setting was successfully applied, ''false'' otherwise.

{{Tip|This function modifies the audio settings for a '''specific vehicle instance''', while [[setVehicleModelAudioSetting]] modifies the audio settings for all vehicles of a specific model. Changes made with setVehicleModelAudioSetting only affect newly created vehicles of that model, while changes made with setVehicleModelAudioSetting affect all newly created vehicles of that model.}}

{{Note|Sound bank IDs for engine sounds must be 410 or lower. Values above this limit will be rejected. Changes only affect the specified vehicle instance. Other vehicles of the same model will retain their original audio settings. This function only works with standard vehicle models and cannot modify audio settings for vehicles that are already spawned.}}

==Examples==

<syntaxhighlight lang="lua">
-- Modify the engine sound for a specific vehicle
local vehicle = createVehicle(411, 0, 0, 3)
setVehicleAudioSetting(vehicle, "engineOnSoundBankID", 150)
</syntaxhighlight>

<syntaxhighlight lang="lua">
-- Customize horn settings for a specific vehicle
local vehicle = createVehicle(560, 100, 100, 3)
setVehicleAudioSetting(vehicle, "hornHigh", 1.5)
setVehicleAudioSetting(vehicle, "hornTon", 0.8)
setVehicleAudioSetting(vehicle, "hornVolumeDelta", 2.0)
</syntaxhighlight>

<syntaxhighlight lang="lua">
-- Configure radio and door sounds for a specific vehicle
local vehicle = createVehicle(562, 200, 200, 3)
setVehicleAudioSetting(vehicle, "radioNum", 5)
setVehicleAudioSetting(vehicle, "radioType", 2)
setVehicleAudioSetting(vehicle, "doorSound", 1.2)
</syntaxhighlight>

==See Also==
*[[getVehicleAudioSettings]]
*[[resetVehicleAudioSettings]]
*[[setVehicleModelAudioSetting]]
*[[getVehicleModelAudioSettings]]
{{Vehicle functions|client}}

GetVehicleAudioSettings

2025-07-25T18:00:31Z

Mohab:

{{client function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|23140|This function retrieves the current audio properties for a specific vehicle instance. It allows inspection of various vehicle sound settings such as engine sounds, horn characteristics, door sounds, and radio settings that may have been customized for this particular vehicle.}}

==Syntax==
<syntaxhighlight lang="lua">
table getVehicleAudioSettings ( vehicle theVehicle )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle element to retrieve audio settings from

===Returns===
Returns a ''table'' containing audio settings if successful, ''false'' otherwise. The returned table contains the following properties:
*'''sound-type''' - Sound effect type (integer)
*'''engine-on-soundbank-id''' - Engine startup sound bank ID (0-410)
*'''engine-off-soundbank-id''' - Engine shutdown sound bank ID (0-410)
*'''bass-setting''' - Bass settings (float)
*'''bass-eq''' - Bass equalizer (float)
*'''field-c''' - Field C parameter (float)
*'''horn-ton''' - Horn tone (float)
*'''horn-high''' - Horn high frequency (float)
*'''engine-upgrade''' - Engine upgrade sound effect (float)
*'''door-sound''' - Door sound effects (float)
*'''radio-num''' - Radio number (float)
*'''radio-type''' - Radio type (float)
*'''vehicle-type-for-audio''' - Audio vehicle type (float)
*'''horn-volume-delta''' - Horn volume delta (float)

{{Note|This function returns the current audio settings for the specific vehicle instance. If the vehicle has custom audio settings applied via [[setVehicleAudioSetting]], those will be returned. Otherwise, it returns the default model audio settings.}}

{{Warning|Sound bank IDs above 410 may cause crashes. The valid range is 0-410 for engine sound bank properties.}}

==Example==

<syntaxhighlight lang="lua">
-- Get the player's current vehicle and display its audio settings
local player = getLocalPlayer()
local vehicle = getPedOccupiedVehicle(player)

if vehicle then
local settings = getVehicleAudioSettings(vehicle)
if settings then
outputChatBox("=== Vehicle Audio Settings ===")
outputChatBox("Sound Type: " .. tostring(settings["sound-type"]))
outputChatBox("Engine On Sound Bank: " .. tostring(settings["engine-on-soundbank-id"]))
outputChatBox("Engine Off Sound Bank: " .. tostring(settings["engine-off-soundbank-id"]))
outputChatBox("Horn Tone: " .. tostring(settings["horn-ton"]))
outputChatBox("Horn High: " .. tostring(settings["horn-high"]))
outputChatBox("Door Sound: " .. tostring(settings["door-sound"]))
outputChatBox("Radio Type: " .. tostring(settings["radio-type"]))
else
outputChatBox("Failed to retrieve vehicle audio settings.")
end
else
outputChatBox("You must be in a vehicle to use this command.")
end
</syntaxhighlight>

==See Also==
*[[getVehicleModelAudioSettings]]
*[[setVehicleAudioSetting]]
*[[resetVehicleAudioSettings]]
*[[setVehicleModelAudioSetting]]
*[[resetVehicleModelAudioSettings]]
{{Vehicle functions|client}}

ResetVehicleAudioSettings

2025-07-25T17:58:54Z

Mohab:

{{client function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|23140|This function resets the audio properties of a specific vehicle instance back to its model's default settings. Any custom audio settings that were applied to the vehicle using [[setVehicleAudioSetting]] will be removed, restoring the original sound characteristics.}}

==Syntax==
<syntaxhighlight lang="lua">
bool resetVehicleAudioSettings ( vehicle theVehicle )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle element to reset audio settings for

===Returns===
Returns ''true'' if the vehicle audio settings were successfully reset, ''false'' otherwise.

{{Note|This function only affects the specific vehicle instance, not the vehicle model's default settings. After calling this function, the vehicle will use the default audio settings for its model.}}

==Example==

<syntaxhighlight lang="lua">
-- Reset audio settings for the player's current vehicle
local player = getLocalPlayer()
local vehicle = getPedOccupiedVehicle(player)

if vehicle then
local success = resetVehicleAudioSettings(vehicle)
if success then
outputChatBox("Vehicle audio settings have been reset to default.")
else
outputChatBox("Failed to reset vehicle audio settings.")
end
else
outputChatBox("You must be in a vehicle to use this command.")
end
</syntaxhighlight>

==See Also==
*[[getVehicleAudioSettings]]
*[[setVehicleAudioSetting]]
*[[getVehicleModelAudioSettings]]
*[[setVehicleModelAudioSetting]]
*[[resetVehicleModelAudioSettings]]
{{Client vehicle functions}}

ResetVehicleAudioSettings

2025-07-25T17:51:13Z

Mohab: Created page with "{{client function}} __NOTOC__ {{New feature/item|3.0161|1.6.0|23140|This function resets the audio properties of a specific vehicle instance back to its model's default settings. Any custom audio settings that were applied to the vehicle using setVehicleAudioSetting will be removed, restoring the original sound characteristics.}} ==Syntax== <syntaxhighlight lang="lua"> bool resetVehicleAudioSettings ( vehicle theVehicle ) </syntaxhighlight> ===Required Arguments===..."

GetVehicleAudioSettings

2025-07-25T17:47:35Z

Mohab: Created page with "{{client function}} __NOTOC__ {{New feature/item|3.0161|1.6.0|23140|This function retrieves the current audio properties for a specific vehicle instance. It allows inspection of various vehicle sound settings such as engine sounds, horn characteristics, door sounds, and radio settings that may have been customized for this particular vehicle.}} ==Syntax== <syntaxhighlight lang="lua"> table getVehicleAudioSettings ( vehicle theVehicle ) </syntaxhighlight> ===Required Ar..."

GetVehicleModelAudioSettings

2025-07-25T17:34:41Z

Mohab: Simplify examples

SetVehicleAudioSetting

2025-07-25T17:31:54Z

Mohab: Created page with "{{client function}} __NOTOC__ {{New feature/item|3.0161|1.6.0|23140|This function sets audio properties for a '''specific vehicle instance'''. It allows customization of various vehicle sound settings such as engine sounds, horn characteristics, door sounds, and radio settings.}} ==Syntax== <syntaxhighlight lang="lua"> bool setVehicleAudioSetting ( element vehicle, string property, float value ) </syntaxhighlight> ===Required Arguments=== *'''vehicle:''' The vehicle el..."

SetVehicleModelAudioSetting

2025-07-25T17:30:48Z

Mohab:

SetVehicleModelAudioSetting

2025-07-25T17:28:59Z

Mohab:

{{client function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|23140|This function sets audio properties for a specific vehicle model. It allows customization of various vehicle sound settings such as engine sounds, horn characteristics, door sounds, and radio settings.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleModelAudioSetting ( int modelID, string property, float value )
</syntaxhighlight>

===Required Arguments===
*'''modelID:''' The vehicle model ID to modify audio settings for
*'''property:''' The audio property to set. Valid properties are:
**"doorSound" - Door sound effects
**"engineOffSoundBankID" - Engine off sound bank ID (0-410)
**"engineOnSoundBankID" - Engine on sound bank ID (0-410)
**"hornHigh" - Horn high frequency
**"hornTon" - Horn tone
**"hornVolumeDelta" - Horn volume delta
**"radioNum" - Radio number
**"radioType" - Radio type
*'''value:''' The numerical value to set for the specified property

===Returns===
Returns ''true'' if the audio setting was successfully applied, ''false'' otherwise.

{{Note|Sound bank IDs for engine sounds must be 410 or lower. Values above this limit will be rejected. Changes only affect newly created vehicles. Existing vehicles will retain their original audio settings. This function only works with standard vehicle models and cannot modify audio settings for vehicles that are already spawned.}}
{{Tip|This function modifies the audio settings for a '''specific vehicle model''', affecting all newly created vehicles of that model. In contrast, [[setVehicleAudioSetting]] modifies the audio settings for a '''specific vehicle instance'''. Changes made with this function do not affect vehicles that are already spawned.}}

==Examples==

===Example 1: Basic Engine Sound Modification===
<syntaxhighlight lang="lua">
-- Modify the engine sound for Infernus (model 411)
local success = setVehicleModelAudioSetting(411, "engineOnSoundBankID", 150)
if success then
outputChatBox("Infernus engine sound modified successfully!")
else
outputChatBox("Failed to modify engine sound.")
end

-- Create an Infernus to hear the new sound
local vehicle = createVehicle(411, 0, 0, 3)
</syntaxhighlight>

===Example 2: Custom Horn Settings===
<syntaxhighlight lang="lua">
-- Customize horn settings for Sultan (model 560)
local modelID = 560

-- Set horn properties
setVehicleModelAudioSetting(modelID, "hornHigh", 1.5)
setVehicleModelAudioSetting(modelID, "hornTon", 0.8)
setVehicleModelAudioSetting(modelID, "hornVolumeDelta", 2.0)

outputChatBox("Sultan horn settings customized!")

-- Spawn a Sultan to test the new horn
local testVehicle = createVehicle(modelID, 100, 100, 3)
</syntaxhighlight>

===Example 3: Radio and Door Sound Configuration===
<syntaxhighlight lang="lua">
-- Configure radio and door sounds for Elegy (model 562)
local elegytModel = 562

-- Set radio properties
local radioSuccess = setVehicleModelAudioSetting(elegytModel, "radioNum", 5)
local radioTypeSuccess = setVehicleModelAudioSetting(elegytModel, "radioType", 2)

-- Set door sound
local doorSuccess = setVehicleModelAudioSetting(elegytModel, "doorSound", 1.2)

if radioSuccess and radioTypeSuccess and doorSuccess then
outputChatBox("Elegy audio settings configured successfully!")

-- Create vehicle to test settings
local elegy = createVehicle(elegytModel, 200, 200, 3)
else
outputChatBox("Some audio settings failed to apply.")
end
</syntaxhighlight>

===Example 4: Batch Audio Modification===
<syntaxhighlight lang="lua">
-- Function to apply custom audio profile to multiple vehicles
function applyCustomAudioProfile(models, profile)
local successCount = 0

for _, modelID in ipairs(models) do
local modelSuccess = true

for property, value in pairs(profile) do
if not setVehicleModelAudioSetting(modelID, property, value) then
modelSuccess = false
outputChatBox("Failed to set " .. property .. " for model " .. modelID)
end
end

if modelSuccess then
successCount = successCount + 1
outputChatBox("Audio profile applied to model " .. modelID)
end
end

return successCount
end

-- Define custom audio profile
local sportCarProfile = {
["engineOnSoundBankID"] = 200,
["engineOffSoundBankID"] = 180,
["hornHigh"] = 1.8,
["hornVolumeDelta"] = 1.5,
["radioType"] = 3
}

-- Apply to multiple sports cars
local sportsCars = {411, 506, 451, 602} -- Infernus, Super GT, Turismo, Alpha
local modifiedCount = applyCustomAudioProfile(sportsCars, sportCarProfile)

outputChatBox("Modified audio for " .. modifiedCount .. " vehicle models")
</syntaxhighlight>

==See Also==
*[[getVehicleModelAudioSettings]]
*[[resetVehicleModelAudioSettings]]
*[[setVehicleAudioSetting]]
*[[getVehicleAudioSettings]]
*[[resetVehicleAudioSettings]]

ResetVehicleModelAudioSettings

2025-07-25T17:03:19Z

Mohab: Created page with "{{client function}} __NOTOC__ {{New feature/item|3.0161|1.6.0|23140|This function resets all audio settings for a specific vehicle model back to their original GTA San Andreas values. This will undo any modifications made with setVehicleModelAudioSetting.}} ==Syntax== <syntaxhighlight lang="lua"> bool resetVehicleModelAudioSettings ( int modelID ) </syntaxhighlight> ===Required Arguments=== *'''modelID:''' The vehicle model ID to reset audio settings for ===Return..."

GetVehicleModelAudioSettings

2025-07-25T17:01:14Z

Mohab:

{{client function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|23140|This function retrieves audio properties for a specific vehicle model. It allows inspection of various vehicle sound settings such as engine sounds, horn characteristics, door sounds, and radio settings.}}

==Syntax==
<syntaxhighlight lang="lua">
table getVehicleModelAudioSettings ( int modelID )
</syntaxhighlight>

===Required Arguments===
*'''modelID:''' The vehicle model ID to retrieve audio settings for

===Returns===
Returns a ''table'' containing audio settings if successful, ''false'' otherwise. The returned table contains the following properties:
*'''sound-type''' - Sound effect type
*'''engine-on-soundbank-id''' - Engine startup sound bank ID (0-410)
*'''engine-off-soundbank-id''' - Engine shutdown sound bank ID (0-410)
*'''bass-setting''' - Bass settings
*'''bass-eq''' - Bass equalizer
*'''field-c''' - Field C parameter
*'''horn-ton''' - Horn tone
*'''horn-high''' - Horn high frequency
*'''engine-upgrade''' - Engine upgrade sound effect
*'''door-sound''' - Door sound effects
*'''radio-num''' - Radio number
*'''radio-type''' - Radio type
*'''vehicle-type-for-audio''' - Audio vehicle type
*'''horn-volume-delta''' - Horn volume delta

{{Note|This function only works with standard vehicle models. For custom models, it will return the audio settings of the parent model.}}

==Examples==

===Example 1: Basic Audio Settings Retrieval===
<syntaxhighlight lang="lua">
-- Get audio settings for Infernus (model 411)
local audioSettings = getVehicleModelAudioSettings(411)
if audioSettings then
outputChatBox("Infernus engine on sound bank: " .. audioSettings["engine-on-soundbank-id"])
outputChatBox("Infernus engine off sound bank: " .. audioSettings["engine-off-soundbank-id"])
outputChatBox("Infernus horn tone: " .. audioSettings["horn-ton"])
else
outputChatBox("Failed to retrieve audio settings for Infernus")
end
</syntaxhighlight>

===Example 2: Compare Audio Settings Between Models===
<syntaxhighlight lang="lua">
-- Compare audio settings between different vehicle models
local models = {411, 506, 451, 602} -- Infernus, Super GT, Turismo, Alpha
local modelNames = {"Infernus", "Super GT", "Turismo", "Alpha"}

outputChatBox("=== Vehicle Audio Comparison ===")
for i, modelID in ipairs(models) do
local audioSettings = getVehicleModelAudioSettings(modelID)
if audioSettings then
outputChatBox(modelNames[i] .. ":")
outputChatBox(" Engine On Bank: " .. audioSettings["engine-on-soundbank-id"])
outputChatBox(" Engine Off Bank: " .. audioSettings["engine-off-soundbank-id"])
outputChatBox(" Horn Volume Delta: " .. audioSettings["horn-volume-delta"])
outputChatBox(" Radio Type: " .. audioSettings["radio-type"])
outputChatBox("---")
end
end
</syntaxhighlight>

===Example 3: Audio Settings Inspector===
<syntaxhighlight lang="lua">
-- Function to display all audio properties of a vehicle model
function inspectVehicleAudio(modelID)
local audioSettings = getVehicleModelAudioSettings(modelID)
if not audioSettings then
outputChatBox("Invalid model ID or failed to retrieve audio settings")
return false
end

outputChatBox("=== Audio Settings for Model " .. modelID .. " ===")
for property, value in pairs(audioSettings) do
outputChatBox(property .. ": " .. tostring(value))
end

return true
end

-- Example usage
inspectVehicleAudio(411) -- Inspect Infernus audio settings
</syntaxhighlight>

===Example 4: Audio Profile Backup System===
<syntaxhighlight lang="lua">
-- Function to backup audio settings for multiple models
function backupAudioSettings(models)
local backup = {}

for _, modelID in ipairs(models) do
local audioSettings = getVehicleModelAudioSettings(modelID)
if audioSettings then
backup[modelID] = audioSettings
outputChatBox("Backed up audio settings for model " .. modelID)
else
outputChatBox("Failed to backup audio settings for model " .. modelID)
end
end

return backup
end

-- Function to display backup information
function displayBackupInfo(backup)
outputChatBox("=== Audio Settings Backup ===")
for modelID, settings in pairs(backup) do
outputChatBox("Model " .. modelID .. " has " .. table.size(settings) .. " audio properties")
end
end

-- Example usage
local sportsCars = {411, 506, 451, 602}
local audioBackup = backupAudioSettings(sportsCars)
displayBackupInfo(audioBackup)
</syntaxhighlight>

===Example 5: Audio Settings Validation===
<syntaxhighlight lang="lua">
-- Function to validate audio settings and check for potential issues
function validateAudioSettings(modelID)
local audioSettings = getVehicleModelAudioSettings(modelID)
if not audioSettings then
outputChatBox("Model " .. modelID .. ": Invalid model or failed to retrieve settings")
return false
end

local issues = {}

-- Check engine sound bank IDs
if audioSettings["engine-on-soundbank-id"] > 410 then
table.insert(issues, "Engine-on sound bank ID exceeds safe limit (410)")
end

if audioSettings["engine-off-soundbank-id"] > 410 then
table.insert(issues, "Engine-off sound bank ID exceeds safe limit (410)")
end

-- Check for unusual values
if audioSettings["horn-volume-delta"] < 0 then
table.insert(issues, "Horn volume delta is negative")
end

if #issues > 0 then
outputChatBox("Model " .. modelID .. " audio issues found:")
for _, issue in ipairs(issues) do
outputChatBox(" - " .. issue)
end
return false
else
outputChatBox("Model " .. modelID .. " audio settings are valid")
return true
end
end

-- Validate audio settings for multiple models
local modelsToCheck = {411, 560, 562, 451}
for _, modelID in ipairs(modelsToCheck) do
validateAudioSettings(modelID)
end
</syntaxhighlight>

==See Also==
*[[setVehicleModelAudioSetting]]
*[[resetVehicleModelAudioSettings]]
*[[setVehicleAudioSetting]]
*[[getVehicleAudioSettings]]
*[[resetVehicleAudioSettings]]

SetVehicleModelAudioSetting

2025-07-25T17:01:01Z

Mohab:

{{client function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|23140|This function sets audio properties for a specific vehicle model. It allows customization of various vehicle sound settings such as engine sounds, horn characteristics, door sounds, and radio settings.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleModelAudioSetting ( int modelID, string property, float value )
</syntaxhighlight>

===Required Arguments===
*'''modelID:''' The vehicle model ID to modify audio settings for
*'''property:''' The audio property to set. Valid properties are:
**"doorSound" - Door sound effects
**"engineOffSoundBankID" - Engine off sound bank ID (0-410)
**"engineOnSoundBankID" - Engine on sound bank ID (0-410)
**"hornHigh" - Horn high frequency
**"hornTon" - Horn tone
**"hornVolumeDelta" - Horn volume delta
**"radioNum" - Radio number
**"radioType" - Radio type
*'''value:''' The numerical value to set for the specified property

===Returns===
Returns ''true'' if the audio setting was successfully applied, ''false'' otherwise.

{{Note|Sound bank IDs for engine sounds must be 410 or lower. Values above this limit will be rejected. Changes only affect newly created vehicles. Existing vehicles will retain their original audio settings. This function only works with standard vehicle models and cannot modify audio settings for vehicles that are already spawned.}}

==Examples==

===Example 1: Basic Engine Sound Modification===
<syntaxhighlight lang="lua">
-- Modify the engine sound for Infernus (model 411)
local success = setVehicleModelAudioSetting(411, "engineOnSoundBankID", 150)
if success then
outputChatBox("Infernus engine sound modified successfully!")
else
outputChatBox("Failed to modify engine sound.")
end

-- Create an Infernus to hear the new sound
local vehicle = createVehicle(411, 0, 0, 3)
</syntaxhighlight>

===Example 2: Custom Horn Settings===
<syntaxhighlight lang="lua">
-- Customize horn settings for Sultan (model 560)
local modelID = 560

-- Set horn properties
setVehicleModelAudioSetting(modelID, "hornHigh", 1.5)
setVehicleModelAudioSetting(modelID, "hornTon", 0.8)
setVehicleModelAudioSetting(modelID, "hornVolumeDelta", 2.0)

outputChatBox("Sultan horn settings customized!")

-- Spawn a Sultan to test the new horn
local testVehicle = createVehicle(modelID, 100, 100, 3)
</syntaxhighlight>

===Example 3: Radio and Door Sound Configuration===
<syntaxhighlight lang="lua">
-- Configure radio and door sounds for Elegy (model 562)
local elegytModel = 562

-- Set radio properties
local radioSuccess = setVehicleModelAudioSetting(elegytModel, "radioNum", 5)
local radioTypeSuccess = setVehicleModelAudioSetting(elegytModel, "radioType", 2)

-- Set door sound
local doorSuccess = setVehicleModelAudioSetting(elegytModel, "doorSound", 1.2)

if radioSuccess and radioTypeSuccess and doorSuccess then
outputChatBox("Elegy audio settings configured successfully!")

-- Create vehicle to test settings
local elegy = createVehicle(elegytModel, 200, 200, 3)
else
outputChatBox("Some audio settings failed to apply.")
end
</syntaxhighlight>

===Example 4: Batch Audio Modification===
<syntaxhighlight lang="lua">
-- Function to apply custom audio profile to multiple vehicles
function applyCustomAudioProfile(models, profile)
local successCount = 0

for _, modelID in ipairs(models) do
local modelSuccess = true

for property, value in pairs(profile) do
if not setVehicleModelAudioSetting(modelID, property, value) then
modelSuccess = false
outputChatBox("Failed to set " .. property .. " for model " .. modelID)
end
end

if modelSuccess then
successCount = successCount + 1
outputChatBox("Audio profile applied to model " .. modelID)
end
end

return successCount
end

-- Define custom audio profile
local sportCarProfile = {
["engineOnSoundBankID"] = 200,
["engineOffSoundBankID"] = 180,
["hornHigh"] = 1.8,
["hornVolumeDelta"] = 1.5,
["radioType"] = 3
}

-- Apply to multiple sports cars
local sportsCars = {411, 506, 451, 602} -- Infernus, Super GT, Turismo, Alpha
local modifiedCount = applyCustomAudioProfile(sportsCars, sportCarProfile)

outputChatBox("Modified audio for " .. modifiedCount .. " vehicle models")
</syntaxhighlight>

===Example 5: Engine Sound Bank Validation===
<syntaxhighlight lang="lua">
-- Function to safely set engine sound with validation
function setEngineSound(modelID, bankID, isEngineOn)
-- Validate sound bank ID (must be <= 410)
if bankID > 410 then
outputChatBox("Error: Sound bank ID must be 410 or lower")
return false
end

local property = isEngineOn and "engineOnSoundBankID" or "engineOffSoundBankID"
local success = setVehicleModelAudioSetting(modelID, property, bankID)

if success then
local stateText = isEngineOn and "on" or "off"
outputChatBox("Engine " .. stateText .. " sound set to bank " .. bankID .. " for model " .. modelID)
else
outputChatBox("Failed to set engine sound for model " .. modelID)
end

return success
end

-- Example usage
setEngineSound(411, 250, true) -- Set engine on sound
setEngineSound(411, 230, false) -- Set engine off sound
setEngineSound(411, 450, true) -- This will fail due to validation
</syntaxhighlight>

==See Also==
*[[getVehicleModelAudioSettings]]
*[[resetVehicleModelAudioSettings]]
*[[setVehicleAudioSetting]]
*[[getVehicleAudioSettings]]
*[[resetVehicleAudioSettings]]

GetVehicleModelAudioSettings

2025-07-25T16:56:19Z

Mohab: Created page with "{{client function}} __NOTOC__ {{New feature/item|3.0161|1.6.0|23140|This function retrieves audio properties for a specific vehicle model. It allows inspection of various vehicle sound settings such as engine sounds, horn characteristics, door sounds, and radio settings.}} ==Syntax== <syntaxhighlight lang="lua"> table getVehicleModelAudioSettings ( int modelID ) </syntaxhighlight> ===Required Arguments=== *'''modelID:''' The vehicle model ID to retrieve audio settings..."

SetVehicleModelAudioSetting

2025-07-25T16:52:27Z

Mohab:

{{client function}}
__NOTOC__
{{New feature/item|3.0161|1.6.0|23140|This function sets audio properties for a specific vehicle model. It allows customization of various vehicle sound settings such as engine sounds, horn characteristics, door sounds, and radio settings.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleModelAudioSetting ( int modelID, string property, float value )
</syntaxhighlight>

===Required Arguments===
*'''modelID:''' The vehicle model ID to modify audio settings for
*'''property:''' The audio property to set. Valid properties are:
**"doorSound" - Door sound effects
**"engineOffSoundBankID" - Engine off sound bank ID (0-410)
**"engineOnSoundBankID" - Engine on sound bank ID (0-410)
**"hornHigh" - Horn high frequency
**"hornTon" - Horn tone
**"hornVolumeDelta" - Horn volume delta
**"radioNum" - Radio number
**"radioType" - Radio type
*'''value:''' The numerical value to set for the specified property

===Returns===
Returns ''true'' if the audio setting was successfully applied, ''false'' otherwise.

{{Note|Sound bank IDs for engine sounds must be 410 or lower. Values above this limit will be rejected. Changes only affect newly created vehicles. Existing vehicles will retain their original audio settings. This function only works with standard vehicle models and cannot modify audio settings for vehicles that are already spawned.}}

==Examples==

===Example 1: Basic Engine Sound Modification===
<syntaxhighlight lang="lua">
-- Modify the engine sound for Infernus (model 411)
local success = setVehicleModelAudioSetting(411, "engineOnSoundBankID", 150)
if success then
outputChatBox("Infernus engine sound modified successfully!")
else
outputChatBox("Failed to modify engine sound.")
end

-- Create an Infernus to hear the new sound
local vehicle = createVehicle(411, 0, 0, 3)
</syntaxhighlight>

===Example 2: Custom Horn Settings===
<syntaxhighlight lang="lua">
-- Customize horn settings for Sultan (model 560)
local modelID = 560

-- Set horn properties
setVehicleModelAudioSetting(modelID, "hornHigh", 1.5)
setVehicleModelAudioSetting(modelID, "hornTon", 0.8)
setVehicleModelAudioSetting(modelID, "hornVolumeDelta", 2.0)

outputChatBox("Sultan horn settings customized!")

-- Spawn a Sultan to test the new horn
local testVehicle = createVehicle(modelID, 100, 100, 3)
</syntaxhighlight>

===Example 3: Radio and Door Sound Configuration===
<syntaxhighlight lang="lua">
-- Configure radio and door sounds for Elegy (model 562)
local elegytModel = 562

-- Set radio properties
local radioSuccess = setVehicleModelAudioSetting(elegytModel, "radioNum", 5)
local radioTypeSuccess = setVehicleModelAudioSetting(elegytModel, "radioType", 2)

-- Set door sound
local doorSuccess = setVehicleModelAudioSetting(elegytModel, "doorSound", 1.2)

if radioSuccess and radioTypeSuccess and doorSuccess then
outputChatBox("Elegy audio settings configured successfully!")

-- Create vehicle to test settings
local elegy = createVehicle(elegytModel, 200, 200, 3)
else
outputChatBox("Some audio settings failed to apply.")
end
</syntaxhighlight>

===Example 4: Batch Audio Modification===
<syntaxhighlight lang="lua">
-- Function to apply custom audio profile to multiple vehicles
function applyCustomAudioProfile(models, profile)
local successCount = 0

for _, modelID in ipairs(models) do
local modelSuccess = true

for property, value in pairs(profile) do
if not setVehicleModelAudioSetting(modelID, property, value) then
modelSuccess = false
outputChatBox("Failed to set " .. property .. " for model " .. modelID)
end
end

if modelSuccess then
successCount = successCount + 1
outputChatBox("Audio profile applied to model " .. modelID)
end
end

return successCount
end

-- Define custom audio profile
local sportCarProfile = {
["engineOnSoundBankID"] = 200,
["engineOffSoundBankID"] = 180,
["hornHigh"] = 1.8,
["hornVolumeDelta"] = 1.5,
["radioType"] = 3
}

-- Apply to multiple sports cars
local sportsCars = {411, 506, 451, 602} -- Infernus, Super GT, Turismo, Alpha
local modifiedCount = applyCustomAudioProfile(sportsCars, sportCarProfile)

outputChatBox("Modified audio for " .. modifiedCount .. " vehicle models")
</syntaxhighlight>

===Example 5: Engine Sound Bank Validation===
<syntaxhighlight lang="lua">
-- Function to safely set engine sound with validation
function setEngineSound(modelID, bankID, isEngineOn)
-- Validate sound bank ID (must be <= 410)
if bankID > 410 then
outputChatBox("Error: Sound bank ID must be 410 or lower")
return false
end

local property = isEngineOn and "engineOnSoundBankID" or "engineOffSoundBankID"
local success = setVehicleModelAudioSetting(modelID, property, bankID)

if success then
local stateText = isEngineOn and "on" or "off"
outputChatBox("Engine " .. stateText .. " sound set to bank " .. bankID .. " for model " .. modelID)
else
outputChatBox("Failed to set engine sound for model " .. modelID)
end

return success
end

-- Example usage
setEngineSound(411, 250, true) -- Set engine on sound
setEngineSound(411, 230, false) -- Set engine off sound
setEngineSound(411, 450, true) -- This will fail due to validation
</syntaxhighlight>

==See Also==
*[[getVehicleModelAudioSettings]]
*[[resetVehicleModelAudioSettings]]
*[[setVehicleAudioSetting]]
*[[getVehicleAudioSettings]]
*[[resetVehicleAudioSettings]]

''author: Mohab''

SetVehicleModelAudioSetting

2025-07-25T16:38:54Z

Mohab: Created page with "{{client function}} __NOTOC__ This function sets audio properties for a specific vehicle model. It allows customization of various vehicle sound settings such as engine sounds, horn characteristics, door sounds, and radio settings. ==Syntax== <syntaxhighlight lang="lua"> bool setVehicleModelAudioSetting ( int modelID, string property, float value ) </syntaxhighlight> ===Required Arguments=== *'''modelID:''' The vehicle model ID to modify audio settings for *'''property..."

{{client function}}
__NOTOC__
This function sets audio properties for a specific vehicle model. It allows customization of various vehicle sound settings such as engine sounds, horn characteristics, door sounds, and radio settings.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleModelAudioSetting ( int modelID, string property, float value )
</syntaxhighlight>

===Required Arguments===
*'''modelID:''' The vehicle model ID to modify audio settings for
*'''property:''' The audio property to set. Valid properties are:
**"doorSound" - Door sound effects
**"engineOffSoundBankID" - Engine off sound bank ID (0-410)
**"engineOnSoundBankID" - Engine on sound bank ID (0-410)
**"hornHigh" - Horn high frequency
**"hornTon" - Horn tone
**"hornVolumeDelta" - Horn volume delta
**"radioNum" - Radio number
**"radioType" - Radio type
*'''value:''' The numerical value to set for the specified property

===Returns===
Returns ''true'' if the audio setting was successfully applied, ''false'' otherwise.

{{Note|Sound bank IDs for engine sounds must be 410 or lower. Values above this limit will be rejected. Changes only affect newly created vehicles. Existing vehicles will retain their original audio settings. This function only works with standard vehicle models and cannot modify audio settings for vehicles that are already spawned.}}

==Examples==

===Example 1: Basic Engine Sound Modification===
<syntaxhighlight lang="lua">
-- Modify the engine sound for Infernus (model 411)
local success = setVehicleModelAudioSetting(411, "engineOnSoundBankID", 150)
if success then
outputChatBox("Infernus engine sound modified successfully!")
else
outputChatBox("Failed to modify engine sound.")
end

-- Create an Infernus to hear the new sound
local vehicle = createVehicle(411, 0, 0, 3)
</syntaxhighlight>

===Example 2: Custom Horn Settings===
<syntaxhighlight lang="lua">
-- Customize horn settings for Sultan (model 560)
local modelID = 560

-- Set horn properties
setVehicleModelAudioSetting(modelID, "hornHigh", 1.5)
setVehicleModelAudioSetting(modelID, "hornTon", 0.8)
setVehicleModelAudioSetting(modelID, "hornVolumeDelta", 2.0)

outputChatBox("Sultan horn settings customized!")

-- Spawn a Sultan to test the new horn
local testVehicle = createVehicle(modelID, 100, 100, 3)
</syntaxhighlight>

===Example 3: Radio and Door Sound Configuration===
<syntaxhighlight lang="lua">
-- Configure radio and door sounds for Elegy (model 562)
local elegytModel = 562

-- Set radio properties
local radioSuccess = setVehicleModelAudioSetting(elegytModel, "radioNum", 5)
local radioTypeSuccess = setVehicleModelAudioSetting(elegytModel, "radioType", 2)

-- Set door sound
local doorSuccess = setVehicleModelAudioSetting(elegytModel, "doorSound", 1.2)

if radioSuccess and radioTypeSuccess and doorSuccess then
outputChatBox("Elegy audio settings configured successfully!")

-- Create vehicle to test settings
local elegy = createVehicle(elegytModel, 200, 200, 3)
else
outputChatBox("Some audio settings failed to apply.")
end
</syntaxhighlight>

===Example 4: Batch Audio Modification===
<syntaxhighlight lang="lua">
-- Function to apply custom audio profile to multiple vehicles
function applyCustomAudioProfile(models, profile)
local successCount = 0

for _, modelID in ipairs(models) do
local modelSuccess = true

for property, value in pairs(profile) do
if not setVehicleModelAudioSetting(modelID, property, value) then
modelSuccess = false
outputChatBox("Failed to set " .. property .. " for model " .. modelID)
end
end

if modelSuccess then
successCount = successCount + 1
outputChatBox("Audio profile applied to model " .. modelID)
end
end

return successCount
end

-- Define custom audio profile
local sportCarProfile = {
["engineOnSoundBankID"] = 200,
["engineOffSoundBankID"] = 180,
["hornHigh"] = 1.8,
["hornVolumeDelta"] = 1.5,
["radioType"] = 3
}

-- Apply to multiple sports cars
local sportsCars = {411, 506, 451, 602} -- Infernus, Super GT, Turismo, Alpha
local modifiedCount = applyCustomAudioProfile(sportsCars, sportCarProfile)

outputChatBox("Modified audio for " .. modifiedCount .. " vehicle models")
</syntaxhighlight>

===Example 5: Engine Sound Bank Validation===
<syntaxhighlight lang="lua">
-- Function to safely set engine sound with validation
function setEngineSound(modelID, bankID, isEngineOn)
-- Validate sound bank ID (must be <= 410)
if bankID > 410 then
outputChatBox("Error: Sound bank ID must be 410 or lower")
return false
end

local property = isEngineOn and "engineOnSoundBankID" or "engineOffSoundBankID"
local success = setVehicleModelAudioSetting(modelID, property, bankID)

if success then
local stateText = isEngineOn and "on" or "off"
outputChatBox("Engine " .. stateText .. " sound set to bank " .. bankID .. " for model " .. modelID)
else
outputChatBox("Failed to set engine sound for model " .. modelID)
end

return success
end

-- Example usage
setEngineSound(411, 250, true) -- Set engine on sound
setEngineSound(411, 230, false) -- Set engine off sound
setEngineSound(411, 450, true) -- This will fail due to validation
</syntaxhighlight>

==See Also==
*[[getVehicleModelAudioSettings]]
*[[resetVehicleModelAudioSettings]]
*[[setVehicleAudioSetting]]
*[[getVehicleAudioSettings]]
*[[resetVehicleAudioSettings]]

''author: Mohab''

OnClientBrowserResourceBlocked

2025-07-15T12:13:53Z

Mohab:

__NOTOC__
{{Client_event}}
{{New feature/item|3.0150|1.5||
This event is executed when a resource (images, sounds etc.) has been blocked.
}}

==Parameters==
<syntaxhighlight lang="lua">
string url, string domain, int reason
</syntaxhighlight>
*'''url''': the blocked URL.
*'''domain''': the blocked domain (part of the URL).
*'''reason''': the reason why the resource was blocked. Possibles values:
** '''0''': not allowed yet
** '''1''': blacklisted
** '''2''': blocked protocol scheme

==Source==
The [[Element/Browser|browser]] element.

==Example==
This example demonstrates how to open a browser window, load a test URL, and handle the onClientBrowserResourceBlocked event. If a resource is blocked, it outputs the details to chat and, if the reason is 0 (not allowed yet), requests the domain and reloads the page if accepted.
<syntaxhighlight lang="lua">
local screenWidth, screenHeight = guiGetScreenSize( )

local browser, theBrowser
local lastBrowser = nil
local testCases = {
{name = "Google (HTTPS, should work)", url = "https://www.google.com/"},
{name = "YouTube (HTTPS, should work)", url = "https://www.youtube.com/"},
{name = "MTA Wiki (HTTPS, should work)", url = "https://wiki.multitheftauto.com/"}
}

addCommandHandler("openbrowser", function(_, case)
if isElement(browser) then destroyElement(browser) end
local sx, sy = guiGetScreenSize()
local bw, bh = math.floor(sx * 0.6), math.floor(sy * 0.6)
local bx, by = math.floor((sx - bw) / 2), math.floor((sy - bh) / 2)
browser = guiCreateBrowser(bx, by, bw, bh, false, false, false)
guiSetVisible(browser, true)
guiBringToFront(browser)
showCursor(true)
theBrowser = guiGetBrowser(browser)

local idx = tonumber(case) or 1
if not testCases[idx] then idx = 1 end
local test = testCases[idx]
outputChatBox("[BrowserTest] Loading test case: "..test.name)

addEventHandler("onClientBrowserCreated", theBrowser, function()
loadBrowserURL(source, test.url)
end)

addEventHandler("onClientBrowserDocumentReady", theBrowser, function(url)
outputChatBox("[BrowserTest] Browser loaded: " .. tostring(url))
end)

addEventHandler("onClientBrowserResourceBlocked", theBrowser, function(url, domain, reason)
outputChatBox("[BrowserTest] Resource blocked! URL="..tostring(url).." DOMAIN="..tostring(domain).." REASON="..tostring(reason), 255, 0, 0)
if (reason == 0) then
lastBrowser = source
requestBrowserDomains({domain}, false, function(accepted, newDomains)
if (accepted == true) then
outputChatBox("[BrowserTest] Domain accepted, reloading page.")
reloadBrowserPage(lastBrowser)
else
outputChatBox("[BrowserTest] Domain NOT accepted.")
end
lastBrowser = nil
end)
elseif (reason == 1) then
outputChatBox("[BrowserTest] Domain is blacklisted.")
elseif (reason == 2) then
outputChatBox("[BrowserTest] Blocked protocol scheme.")
end
end)
end)
</syntaxhighlight>

[[pl:onClientBrowserResourceBlocked]]

==See Also==
{{CEF_events}}

GetCameraMatrix

2025-07-15T10:33:15Z

Mohab:

__NOTOC__
{{Server client function}}
This function gets the position of the camera and the position of the point it is facing.

{{Important Note|Server-side this functions returns false or the latest value set via [[setCameraMatrix]] (called from server or client.) <br> So if you never used setCameraMatrix on serverside for that player, then it will return false.}}

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
float float float float float float float float getCameraMatrix ( player thePlayer )
</syntaxhighlight>
{{OOP||[[player]]:getCameraMatrix|cameraMatrix|setCameraMatrix}}

===Required Arguments===
*'''thePlayer:''' The player whose camera matrix is to be returned.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
float float float float float float float float getCameraMatrix ()
</syntaxhighlight>
{{OOP||[[Camera]].getMatrix|matrix|setCameraMatrix}}
</section>

===Returns===
This function returns 8 [[float|floats]] if the argument is valid (when applicable); the first three indicate the position of the camera, the next three indicate the position of the point it's facing, and the last two are the roll and field of view. Returns ''false'' if the argument is invalid.

===Example===
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local x, y, z, lx, ly, lz = getCameraMatrix ()
x, lx = x + 1, lx + 1

setCameraMatrix (x, y, z, lx, ly, lz)
</syntaxhighlight>
</section>

==See Also==
{{Camera functions}}

[[hu:getCameraMatrix]]
[[RO:getCameraMatrix]]

GetCameraMatrix

2025-07-15T10:32:26Z

Mohab:

__NOTOC__
{{Server client function}}
This function gets the position of the camera and the position of the point it is facing.

{{Important Note|Server-side this functions returns false or the latest value set via [[setCameraMatrix]] (called from server or client <br> So if you never used setCameraMatrix on serverside for that player, then it will return false.}}

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
float float float float float float float float getCameraMatrix ( player thePlayer )
</syntaxhighlight>
{{OOP||[[player]]:getCameraMatrix|cameraMatrix|setCameraMatrix}}

===Required Arguments===
*'''thePlayer:''' The player whose camera matrix is to be returned.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
float float float float float float float float getCameraMatrix ()
</syntaxhighlight>
{{OOP||[[Camera]].getMatrix|matrix|setCameraMatrix}}
</section>

===Returns===
This function returns 8 [[float|floats]] if the argument is valid (when applicable); the first three indicate the position of the camera, the next three indicate the position of the point it's facing, and the last two are the roll and field of view. Returns ''false'' if the argument is invalid.

===Example===
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local x, y, z, lx, ly, lz = getCameraMatrix ()
x, lx = x + 1, lx + 1

setCameraMatrix (x, y, z, lx, ly, lz)
</syntaxhighlight>
</section>

==See Also==
{{Camera functions}}

[[hu:getCameraMatrix]]
[[RO:getCameraMatrix]]

GetCameraMatrix

2025-07-15T10:32:05Z

Mohab:

__NOTOC__
{{Server client function}}
This function gets the position of the camera and the position of the point it is facing.

{{Important Note|Server-side this functions returns false or the latest value set via [[setCameraMatrix]] (called from server or client <br> So if you never used setCameraMatrix on serverside for that player, then it will return false.).}}

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
float float float float float float float float getCameraMatrix ( player thePlayer )
</syntaxhighlight>
{{OOP||[[player]]:getCameraMatrix|cameraMatrix|setCameraMatrix}}

===Required Arguments===
*'''thePlayer:''' The player whose camera matrix is to be returned.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
float float float float float float float float getCameraMatrix ()
</syntaxhighlight>
{{OOP||[[Camera]].getMatrix|matrix|setCameraMatrix}}
</section>

===Returns===
This function returns 8 [[float|floats]] if the argument is valid (when applicable); the first three indicate the position of the camera, the next three indicate the position of the point it's facing, and the last two are the roll and field of view. Returns ''false'' if the argument is invalid.

===Example===
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local x, y, z, lx, ly, lz = getCameraMatrix ()
x, lx = x + 1, lx + 1

setCameraMatrix (x, y, z, lx, ly, lz)
</syntaxhighlight>
</section>

==See Also==
{{Camera functions}}

[[hu:getCameraMatrix]]
[[RO:getCameraMatrix]]

GetMarkerTargetArrowProperties

2025-07-10T09:25:37Z

Mohab:

__NOTOC__
{{Server client function}}
{{New feature/item|9.0161|1.6.0|22620|function returns the color, transparency and size for a checkpoint marker's target arrow.}}

==Syntax==
<syntaxhighlight lang="lua">
int, int, int, int, int getMarkerTargetArrowProperties( marker theMarker )
</syntaxhighlight>
===Required Arguments===
*'''theMarker''': The [[marker]] that you wish to retrieve the color and size of.

===Returns===
Returns five [[int]]s corresponding to the amount of ''red'', ''green'', ''blue'', ''alpha'' and ''size'' of the marker's target arrow, ''false'' if invalid arguments were passed.

==Example==
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot, function()

local myMarker = createMarker(0, 0, 3, "checkpoint", 2.0, 255, 0, 0, 150)

setMarkerTarget(myMarker, 10, 0, 3)

local r, g, b, a, size = getMarkerTargetArrowProperties(myMarker)

if r then
outputChatBox("Marker Target Arrow Properties:")
outputChatBox("Color: R=" .. r .. " G=" .. g .. " B=" .. b)
outputChatBox("Alpha: " .. a)
outputChatBox("Size: " .. size)
else
outputChatBox("Error: Could not retrieve marker target arrow properties.")
end
end)
</syntaxhighlight>

==See Also==
{{Marker functions}}

DgsMenuAddSeparator

2025-07-10T09:09:46Z

Mohab:

{{Client function}}
__NOTOC__
This function adds a separator to a DGS menu. A separator is a visual divider that can be used to organize menu items into logical groups. It can be displayed as a horizontal line or as text.

[[File:Dgs seperator.png|frame|right|alt=Dgs Seperator|A thin horizontal line used to visually divide sections of a DGS Menu]]
[[File:DGS Text Seperator.png|frame|right|alt=DGS Text Seperator|DGS Text Seperator]]

==Syntax==
<syntaxhighlight lang="lua">
int uniqueID, int position dgsMenuAddSeparator ( element menu [, string text, int parentItemID, int position ] )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element to add the separator to

===Optional Arguments===
*'''text:''' The text to display for the separator. If not specified or ''nil'', a horizontal line will be drawn instead
*'''parentItemID:''' The unique ID of the parent item. If not specified, the separator will be added to the root menu
*'''position:''' The position where the separator should be inserted. If not specified, it will be added at the end

===Returns===
Returns the unique ID of the separator and its position if successful, ''false'' otherwise.

==Examples==

===Example 1: Basic Separator (Line)===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with items and separators
local menu = dgsCreateMenu(200, 200, 200, 150, false)

-- Add some menu items
local item1 = dgsMenuAddItem(menu, "New File", "file.new")
local item2 = dgsMenuAddItem(menu, "Open File", "file.open")

-- Add a separator line
dgsMenuAddSeparator(menu)

-- Add more items after the separator
local item3 = dgsMenuAddItem(menu, "Save", "file.save")
local item4 = dgsMenuAddItem(menu, "Save As", "file.saveas")

-- Add another separator
dgsMenuAddSeparator(menu)

-- Add exit item
local item5 = dgsMenuAddItem(menu, "Exit", "file.exit")

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Selected: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

===Example 2: Text Separator===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with text separators (wider menu for better text visibility)
local menu = dgsCreateMenu(200, 200, 300, 250, false)

-- Add file operations
local item1 = dgsMenuAddItem(menu, "New", "file.new")
local item2 = dgsMenuAddItem(menu, "Open", "file.open")
local item3 = dgsMenuAddItem(menu, "Save", "file.save")

-- Add a text separator
dgsMenuAddSeparator(menu, "--- Edit Operations ---")

-- Add edit operations
local item4 = dgsMenuAddItem(menu, "Copy", "edit.copy")
local item5 = dgsMenuAddItem(menu, "Paste", "edit.paste")
local item6 = dgsMenuAddItem(menu, "Cut", "edit.cut")

-- Add another text separator
dgsMenuAddSeparator(menu, "--- View Options ---")

-- Add view operations
local item7 = dgsMenuAddItem(menu, "Zoom In", "view.zoomin")
local item8 = dgsMenuAddItem(menu, "Zoom Out", "view.zoomout")

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Selected: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

===Example 3: Separator with Position and Parent Item===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with nested items and separators
local menu = dgsCreateMenu(200, 200, 200, 200, false)

-- Add main menu items
local fileItem = dgsMenuAddItem(menu, "File", "file")
local editItem = dgsMenuAddItem(menu, "Edit", "edit")

-- Add items to the File submenu
local newItem = dgsMenuAddItem(menu, "New", "file.new", fileItem)
local openItem = dgsMenuAddItem(menu, "Open", "file.open", fileItem)

-- Add a separator in the File submenu at position 3
local separatorID = dgsMenuAddSeparator(menu, nil, fileItem, 3)

-- Add more items to the File submenu
local saveItem = dgsMenuAddItem(menu, "Save", "file.save", fileItem)
local exitItem = dgsMenuAddItem(menu, "Exit", "file.exit", fileItem)

-- Add another separator with text in the File submenu
dgsMenuAddSeparator(menu, "Recent Files", fileItem)

-- Add recent file items
local recent1 = dgsMenuAddItem(menu, "document1.txt", "file.recent1", fileItem)
local recent2 = dgsMenuAddItem(menu, "document2.txt", "file.recent2", fileItem)

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Selected: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

===Example 4: Context Menu with Separators===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a context menu that appears on right-click
local contextMenu = dgsCreateMenu(200, 200, 180, 150, false)

-- Add context menu items
local cutItem = dgsMenuAddItem(contextMenu, "Cut", "cut")
local copyItem = dgsMenuAddItem(contextMenu, "Copy", "copy")
local pasteItem = dgsMenuAddItem(contextMenu, "Paste", "paste")

-- Add separator
dgsMenuAddSeparator(contextMenu)

-- Add more options
local selectAllItem = dgsMenuAddItem(contextMenu, "Select All", "selectall")

-- Add separator with text
dgsMenuAddSeparator(contextMenu, "Properties")

-- Add properties item
local propertiesItem = dgsMenuAddItem(contextMenu, "Item Properties", "properties")

-- Create a button that shows the context menu
local button = dgsCreateButton(400, 400, 200, 50, "Right Click Me", false)

addEventHandler("onDgsMouseClickUp", button, function(mouseButton)
if mouseButton == "right" then
local x, y = dgsGetCursorPosition()
dgsMenuShow(contextMenu, x, y)
end
end)

-- Handle context menu selections
addEventHandler("onDgsMenuSelect", contextMenu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Context action: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

==See Also==
*[[dgsMenuAddItem]]
*[[dgsMenuRemoveItem]]
*[[dgsCreateMenu]]
*[[dgsMenuShow]]
*[[dgsMenuHide]]

==Author==
[[User:Mohab|Mohab]].

DgsMenuRemoveItem

2025-07-10T08:53:12Z

Mohab: Created page with "{{Client function}} __NOTOC__ This function removes an item from a DGS menu element. ==Syntax== <syntaxhighlight lang="lua"> bool dgsMenuRemoveItem ( element menu, int uniqueID ) </syntaxhighlight> ===Required Arguments=== *'''menu:''' The DGS menu element from which to remove the item *'''uniqueID:''' The unique ID of the menu item to remove (returned by dgsMenuAddItem) ===Returns=== Returns ''true'' if the item was successfully removed, ''false'' if the item wit..."

{{Client function}}
__NOTOC__
This function removes an item from a DGS menu element.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsMenuRemoveItem ( element menu, int uniqueID )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element from which to remove the item
*'''uniqueID:''' The unique ID of the menu item to remove (returned by [[dgsMenuAddItem]])

===Returns===
Returns ''true'' if the item was successfully removed, ''false'' if the item with the specified uniqueID was not found.

==Examples==
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with items
local menu = dgsCreateMenu(200, 200, 200, 150, false)
local item1 = dgsMenuAddItem(menu, "Option 1", "command1")
local item2 = dgsMenuAddItem(menu, "Option 2", "command2")
local item3 = dgsMenuAddItem(menu, "Option 3", "command3")

-- Remove the second item
local removeItem = dgsMenuRemoveItem(menu, item2)

-- Show the menu (item2 will not be visible)
dgsMenuShow(menu)
</syntaxhighlight>

==See Also==
*[[dgsMenuAddItem]]
*[[dgsMenuAddSeparator]]
*[[dgsCreateMenu]]
*[[dgsMenuGetItemText]]
*[[dgsMenuSetItemText]]
*[[dgsMenuGetItemCommand]]
*[[dgsMenuSetItemCommand]]

==Author==
[[User:Mohab|Mohab]].

DgsMenuAddSeparator

2025-07-10T08:32:41Z

Mohab:

{{Client function}}
__NOTOC__
This function adds a separator to a DGS menu. A separator is a visual divider that can be used to organize menu items into logical groups. It can be displayed as a horizontal line or as text.

[[File:Dgs seperator.png|frame|right|alt=Dgs Seperator|A thin horizontal line or vertical line used to visually divide sections of a DGS Menu]]
[[File:DGS Text Seperator.png|frame|right|alt=DGS Text Seperator|DGS Text Seperator]]

==Syntax==
<syntaxhighlight lang="lua">
int uniqueID, int position dgsMenuAddSeparator ( element menu [, string text, int parentItemID, int position ] )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element to add the separator to

===Optional Arguments===
*'''text:''' The text to display for the separator. If not specified or ''nil'', a horizontal line will be drawn instead
*'''parentItemID:''' The unique ID of the parent item. If not specified, the separator will be added to the root menu
*'''position:''' The position where the separator should be inserted. If not specified, it will be added at the end

===Returns===
Returns the unique ID of the separator and its position if successful, ''false'' otherwise.

==Examples==

===Example 1: Basic Separator (Line)===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with items and separators
local menu = dgsCreateMenu(200, 200, 200, 150, false)

-- Add some menu items
local item1 = dgsMenuAddItem(menu, "New File", "file.new")
local item2 = dgsMenuAddItem(menu, "Open File", "file.open")

-- Add a separator line
dgsMenuAddSeparator(menu)

-- Add more items after the separator
local item3 = dgsMenuAddItem(menu, "Save", "file.save")
local item4 = dgsMenuAddItem(menu, "Save As", "file.saveas")

-- Add another separator
dgsMenuAddSeparator(menu)

-- Add exit item
local item5 = dgsMenuAddItem(menu, "Exit", "file.exit")

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Selected: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

===Example 2: Text Separator===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with text separators (wider menu for better text visibility)
local menu = dgsCreateMenu(200, 200, 300, 250, false)

-- Add file operations
local item1 = dgsMenuAddItem(menu, "New", "file.new")
local item2 = dgsMenuAddItem(menu, "Open", "file.open")
local item3 = dgsMenuAddItem(menu, "Save", "file.save")

-- Add a text separator
dgsMenuAddSeparator(menu, "--- Edit Operations ---")

-- Add edit operations
local item4 = dgsMenuAddItem(menu, "Copy", "edit.copy")
local item5 = dgsMenuAddItem(menu, "Paste", "edit.paste")
local item6 = dgsMenuAddItem(menu, "Cut", "edit.cut")

-- Add another text separator
dgsMenuAddSeparator(menu, "--- View Options ---")

-- Add view operations
local item7 = dgsMenuAddItem(menu, "Zoom In", "view.zoomin")
local item8 = dgsMenuAddItem(menu, "Zoom Out", "view.zoomout")

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Selected: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

===Example 3: Separator with Position and Parent Item===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with nested items and separators
local menu = dgsCreateMenu(200, 200, 200, 200, false)

-- Add main menu items
local fileItem = dgsMenuAddItem(menu, "File", "file")
local editItem = dgsMenuAddItem(menu, "Edit", "edit")

-- Add items to the File submenu
local newItem = dgsMenuAddItem(menu, "New", "file.new", fileItem)
local openItem = dgsMenuAddItem(menu, "Open", "file.open", fileItem)

-- Add a separator in the File submenu at position 3
local separatorID = dgsMenuAddSeparator(menu, nil, fileItem, 3)

-- Add more items to the File submenu
local saveItem = dgsMenuAddItem(menu, "Save", "file.save", fileItem)
local exitItem = dgsMenuAddItem(menu, "Exit", "file.exit", fileItem)

-- Add another separator with text in the File submenu
dgsMenuAddSeparator(menu, "Recent Files", fileItem)

-- Add recent file items
local recent1 = dgsMenuAddItem(menu, "document1.txt", "file.recent1", fileItem)
local recent2 = dgsMenuAddItem(menu, "document2.txt", "file.recent2", fileItem)

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Selected: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

===Example 4: Context Menu with Separators===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a context menu that appears on right-click
local contextMenu = dgsCreateMenu(200, 200, 180, 150, false)

-- Add context menu items
local cutItem = dgsMenuAddItem(contextMenu, "Cut", "cut")
local copyItem = dgsMenuAddItem(contextMenu, "Copy", "copy")
local pasteItem = dgsMenuAddItem(contextMenu, "Paste", "paste")

-- Add separator
dgsMenuAddSeparator(contextMenu)

-- Add more options
local selectAllItem = dgsMenuAddItem(contextMenu, "Select All", "selectall")

-- Add separator with text
dgsMenuAddSeparator(contextMenu, "Properties")

-- Add properties item
local propertiesItem = dgsMenuAddItem(contextMenu, "Item Properties", "properties")

-- Create a button that shows the context menu
local button = dgsCreateButton(400, 400, 200, 50, "Right Click Me", false)

addEventHandler("onDgsMouseClickUp", button, function(mouseButton)
if mouseButton == "right" then
local x, y = dgsGetCursorPosition()
dgsMenuShow(contextMenu, x, y)
end
end)

-- Handle context menu selections
addEventHandler("onDgsMenuSelect", contextMenu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Context action: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

==See Also==
*[[dgsMenuAddItem]]
*[[dgsMenuRemoveItem]]
*[[dgsCreateMenu]]
*[[dgsMenuShow]]
*[[dgsMenuHide]]

==Author==
[[User:Mohab|Mohab]].

File:DGS Text Seperator.png

2025-07-10T08:32:11Z

Mohab:

DGS Text Seperator

DgsMenuAddSeparator

2025-07-10T08:28:58Z

Mohab: Created page with "{{Client function}} __NOTOC__ This function adds a separator to a DGS menu. A separator is a visual divider that can be used to organize menu items into logical groups. It can be displayed as a horizontal line or as text. ==Syntax== <syntaxhighlight lang="lua"> int uniqueID, int position dgsMenuAddSeparator ( element menu [, string text, int parentItemID, int position ] ) </syntaxhighlight> ===Required Arguments=== *'''menu:''' The DGS menu element to add the separator..."

{{Client function}}
__NOTOC__
This function adds a separator to a DGS menu. A separator is a visual divider that can be used to organize menu items into logical groups. It can be displayed as a horizontal line or as text.

==Syntax==
<syntaxhighlight lang="lua">
int uniqueID, int position dgsMenuAddSeparator ( element menu [, string text, int parentItemID, int position ] )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element to add the separator to

===Optional Arguments===
*'''text:''' The text to display for the separator. If not specified or ''nil'', a horizontal line will be drawn instead
*'''parentItemID:''' The unique ID of the parent item. If not specified, the separator will be added to the root menu
*'''position:''' The position where the separator should be inserted. If not specified, it will be added at the end

===Returns===
Returns the unique ID of the separator and its position if successful, ''false'' otherwise.

==Examples==

===Example 1: Basic Separator (Line)===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with items and separators
local menu = dgsCreateMenu(200, 200, 200, 150, false)

-- Add some menu items
local item1 = dgsMenuAddItem(menu, "New File", "file.new")
local item2 = dgsMenuAddItem(menu, "Open File", "file.open")

-- Add a separator line
dgsMenuAddSeparator(menu)

-- Add more items after the separator
local item3 = dgsMenuAddItem(menu, "Save", "file.save")
local item4 = dgsMenuAddItem(menu, "Save As", "file.saveas")

-- Add another separator
dgsMenuAddSeparator(menu)

-- Add exit item
local item5 = dgsMenuAddItem(menu, "Exit", "file.exit")

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Selected: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

===Example 2: Text Separator===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with text separators (wider menu for better text visibility)
local menu = dgsCreateMenu(200, 200, 300, 250, false)

-- Add file operations
local item1 = dgsMenuAddItem(menu, "New", "file.new")
local item2 = dgsMenuAddItem(menu, "Open", "file.open")
local item3 = dgsMenuAddItem(menu, "Save", "file.save")

-- Add a text separator
dgsMenuAddSeparator(menu, "--- Edit Operations ---")

-- Add edit operations
local item4 = dgsMenuAddItem(menu, "Copy", "edit.copy")
local item5 = dgsMenuAddItem(menu, "Paste", "edit.paste")
local item6 = dgsMenuAddItem(menu, "Cut", "edit.cut")

-- Add another text separator
dgsMenuAddSeparator(menu, "--- View Options ---")

-- Add view operations
local item7 = dgsMenuAddItem(menu, "Zoom In", "view.zoomin")
local item8 = dgsMenuAddItem(menu, "Zoom Out", "view.zoomout")

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Selected: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

===Example 3: Separator with Position and Parent Item===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with nested items and separators
local menu = dgsCreateMenu(200, 200, 200, 200, false)

-- Add main menu items
local fileItem = dgsMenuAddItem(menu, "File", "file")
local editItem = dgsMenuAddItem(menu, "Edit", "edit")

-- Add items to the File submenu
local newItem = dgsMenuAddItem(menu, "New", "file.new", fileItem)
local openItem = dgsMenuAddItem(menu, "Open", "file.open", fileItem)

-- Add a separator in the File submenu at position 3
local separatorID = dgsMenuAddSeparator(menu, nil, fileItem, 3)

-- Add more items to the File submenu
local saveItem = dgsMenuAddItem(menu, "Save", "file.save", fileItem)
local exitItem = dgsMenuAddItem(menu, "Exit", "file.exit", fileItem)

-- Add another separator with text in the File submenu
dgsMenuAddSeparator(menu, "Recent Files", fileItem)

-- Add recent file items
local recent1 = dgsMenuAddItem(menu, "document1.txt", "file.recent1", fileItem)
local recent2 = dgsMenuAddItem(menu, "document2.txt", "file.recent2", fileItem)

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Selected: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

===Example 4: Context Menu with Separators===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a context menu that appears on right-click
local contextMenu = dgsCreateMenu(200, 200, 180, 150, false)

-- Add context menu items
local cutItem = dgsMenuAddItem(contextMenu, "Cut", "cut")
local copyItem = dgsMenuAddItem(contextMenu, "Copy", "copy")
local pasteItem = dgsMenuAddItem(contextMenu, "Paste", "paste")

-- Add separator
dgsMenuAddSeparator(contextMenu)

-- Add more options
local selectAllItem = dgsMenuAddItem(contextMenu, "Select All", "selectall")

-- Add separator with text
dgsMenuAddSeparator(contextMenu, "Properties")

-- Add properties item
local propertiesItem = dgsMenuAddItem(contextMenu, "Item Properties", "properties")

-- Create a button that shows the context menu
local button = dgsCreateButton(400, 400, 200, 50, "Right Click Me", false)

addEventHandler("onDgsMouseClickUp", button, function(mouseButton)
if mouseButton == "right" then
local x, y = dgsGetCursorPosition()
dgsMenuShow(contextMenu, x, y)
end
end)

-- Handle context menu selections
addEventHandler("onDgsMenuSelect", contextMenu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Context action: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

==See Also==
*[[dgsMenuAddItem]]
*[[dgsMenuRemoveItem]]
*[[dgsCreateMenu]]
*[[dgsMenuShow]]
*[[dgsMenuHide]]

==Author==
[[User:Mohab|Mohab]].

File:Dgs seperator.png

2025-07-10T07:53:03Z

Mohab:

A thin horizontal line or vertical line used to visually divide sections of a DGS Menu

DgsMenuGetItemColor

2025-07-10T06:43:44Z

Mohab: Created page with "{{Client function}} __NOTOC__ This function gets the color of a specific menu item. You can retrieve the colors either as separate RGBA components or as color values. ==Syntax== <syntaxhighlight lang="lua"> int r, int g, int b, int a, int hr, int hg, int hb, int ha dgsMenuGetItemColor ( element menu, int uniqueID ) int normalColor, int hoverColor dgsMenuGetItemColor ( element menu, int uniqueID, bool notSplitColor ) </syntaxhighlight> ===Required Arguments=== *'''menu:..."

{{Client function}}
__NOTOC__
This function gets the color of a specific menu item. You can retrieve the colors either as separate RGBA components or as color values.

==Syntax==
<syntaxhighlight lang="lua">
int r, int g, int b, int a, int hr, int hg, int hb, int ha dgsMenuGetItemColor ( element menu, int uniqueID )
int normalColor, int hoverColor dgsMenuGetItemColor ( element menu, int uniqueID, bool notSplitColor )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element containing the item
*'''uniqueID:''' The unique ID of the menu item (returned by [[dgsMenuAddItem]])

===Optional Arguments===
*'''notSplitColor:''' If set to ''true'', returns the color values as they are stored (two color values). If ''false'' or not specified, returns 8 separate RGBA components

===Returns===
When '''notSplitColor''' is ''false'' or not specified:
Returns 8 integers representing the RGBA components: normal red, normal green, normal blue, normal alpha, hover red, hover green, hover blue, hover alpha. Returns ''false'' if the operation failed.

When '''notSplitColor''' is ''true'':
Returns two color values: normalColor, hoverColor. Returns ''false'' if the operation failed.

==Examples==

===Example 1: Getting RGBA Components===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with items
local menu = dgsCreateMenu(200, 200, 200, 150, false)
local item1 = dgsMenuAddItem(menu, "Red Item", "red")
local item2 = dgsMenuAddItem(menu, "Custom Item", "custom")

-- Set colors for the items
dgsMenuSetItemColor(menu, item1, 255, 0, 0, 200) -- Red with alpha
local normalColor = tocolor(100, 150, 200)
local hoverColor = tocolor(200, 255, 100)
dgsMenuSetItemColor(menu, item2, {normalColor, hoverColor})

-- Get the colors as RGBA components
local r, g, b, a, hr, hg, hb, ha = dgsMenuGetItemColor(menu, item1)
if r then
outputChatBox("Item 1 - Normal: R=" .. r .. " G=" .. g .. " B=" .. b .. " A=" .. a)
outputChatBox("Item 1 - Hover: R=" .. hr .. " G=" .. hg .. " B=" .. hb .. " A=" .. ha)
end

local r2, g2, b2, a2, hr2, hg2, hb2, ha2 = dgsMenuGetItemColor(menu, item2)
if r2 then
outputChatBox("Item 2 - Normal: R=" .. r2 .. " G=" .. g2 .. " B=" .. b2 .. " A=" .. a2)
outputChatBox("Item 2 - Hover: R=" .. hr2 .. " G=" .. hg2 .. " B=" .. hb2 .. " A=" .. ha2)
end

-- Show the menu
dgsMenuShow(menu)
</syntaxhighlight>

===Example 2: Getting Color Values===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with items
local menu = dgsCreateMenu(200, 200, 200, 150, false)
local item1 = dgsMenuAddItem(menu, "Blue Item", "blue")
local item2 = dgsMenuAddItem(menu, "Yellow Item", "yellow")

-- Set colors for the items
dgsMenuSetItemColor(menu, item1, tocolor(0, 0, 255)) -- Blue for both states
local normalYellow = tocolor(255, 255, 0)
local hoverYellow = tocolor(255, 255, 150)
dgsMenuSetItemColor(menu, item2, {normalYellow, hoverYellow})

-- Get the colors as color values
local normalColor1, hoverColor1 = dgsMenuGetItemColor(menu, item1, true)
if normalColor1 then
outputChatBox("Item 1 - Normal Color: " .. normalColor1)
outputChatBox("Item 1 - Hover Color: " .. hoverColor1)
end

local normalColor2, hoverColor2 = dgsMenuGetItemColor(menu, item2, true)
if normalColor2 then
outputChatBox("Item 2 - Normal Color: " .. normalColor2)
outputChatBox("Item 2 - Hover Color: " .. hoverColor2)
end

-- Show the menu
dgsMenuShow(menu)
</syntaxhighlight>

===Example 3: Color Inspection and Modification===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with items
local menu = dgsCreateMenu(200, 200, 200, 150, false)
local item1 = dgsMenuAddItem(menu, "Inspectable Item", "inspect")

-- Set initial color
dgsMenuSetItemColor(menu, item1, 128, 128, 128, 255) -- Gray

-- Function to inspect and modify colors
function inspectAndModifyColor(menu, uniqueID)
-- Get current colors as RGBA components
local r, g, b, a, hr, hg, hb, ha = dgsMenuGetItemColor(menu, uniqueID)

if r then
outputChatBox("Current colors:")
outputChatBox("Normal - R:" .. r .. " G:" .. g .. " B:" .. b .. " A:" .. a)
outputChatBox("Hover - R:" .. hr .. " G:" .. hg .. " B:" .. hb .. " A:" .. ha)

-- Modify the colors (make them brighter)
local newR = math.min(255, r + 50)
local newG = math.min(255, g + 50)
local newB = math.min(255, b + 50)

-- Set the new colors
dgsMenuSetItemColor(menu, uniqueID, newR, newG, newB, a)
outputChatBox("Colors have been brightened!")
else
outputChatBox("Failed to get item colors")
end
end

-- Show the menu
dgsMenuShow(menu)

-- Inspect and modify colors after 3 seconds
setTimer(inspectAndModifyColor, 3000, 1, menu, item1)
</syntaxhighlight>

==See Also==
*[[dgsMenuSetItemColor]]
*[[dgsMenuAddItem]]
*[[dgsMenuGetItemText]]
*[[dgsMenuGetItemTextSize]]
*[[dgsCreateMenu]]

==Author==
[[User:Mohab|Mohab]].

DgsMenuSetItemColor

2025-07-10T06:18:20Z

Mohab: Created page with "{{Client function}} __NOTOC__ This function sets the color of a specific menu item. You can set both the normal and hover colors for the item. ==Syntax== <syntaxhighlight lang="lua"> bool dgsMenuSetItemColor ( element menu, int uniqueID, int r, int g, int b [, int a ] ) bool dgsMenuSetItemColor ( element menu, int uniqueID, int color ) bool dgsMenuSetItemColor ( element menu, int uniqueID, table colors ) </syntaxhighlight> ===Required Arguments=== *'''menu:''' The DGS..."

{{Client function}}
__NOTOC__
This function sets the color of a specific menu item. You can set both the normal and hover colors for the item.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsMenuSetItemColor ( element menu, int uniqueID, int r, int g, int b [, int a ] )
bool dgsMenuSetItemColor ( element menu, int uniqueID, int color )
bool dgsMenuSetItemColor ( element menu, int uniqueID, table colors )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element containing the item
*'''uniqueID:''' The unique ID of the menu item (returned by [[dgsMenuAddItem]])

===Optional Arguments===
*'''r:''' The red component (0-255)
*'''g:''' The green component (0-255)
*'''b:''' The blue component (0-255)
*'''a:''' The alpha component (0-255). If not specified, 255 is used
*'''color:''' A single color value (created with [[tocolor]])
*'''colors:''' A table containing two color values: {normalColor, hoverColor}. If only one color is provided, it will be used for both states

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

==Examples==

===Example 1: Using RGB Values===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with items
local menu = dgsCreateMenu(200, 200, 200, 150, false)
local item1 = dgsMenuAddItem(menu, "Red Item", "red")
local item2 = dgsMenuAddItem(menu, "Blue Item", "blue")
local item3 = dgsMenuAddItem(menu, "Green Item", "green")

-- Set different colors for each item using RGB values
dgsMenuSetItemColor(menu, item1, 255, 0, 0) -- Red
dgsMenuSetItemColor(menu, item2, 0, 0, 255, 200) -- Blue with alpha
dgsMenuSetItemColor(menu, item3, 0, 255, 0) -- Green

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Selected: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

===Example 2: Using Color Values===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with items
local menu = dgsCreateMenu(200, 200, 200, 150, false)
local item1 = dgsMenuAddItem(menu, "Yellow Item", "yellow")
local item2 = dgsMenuAddItem(menu, "Purple Item", "purple")
local item3 = dgsMenuAddItem(menu, "Orange Item", "orange")

-- Set colors using tocolor function
dgsMenuSetItemColor(menu, item1, tocolor(255, 255, 0)) -- Yellow
dgsMenuSetItemColor(menu, item2, tocolor(128, 0, 128)) -- Purple
dgsMenuSetItemColor(menu, item3, tocolor(255, 165, 0)) -- Orange

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Selected: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

===Example 3: Using Color Tables (Normal and Hover States)===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with items
local menu = dgsCreateMenu(200, 200, 200, 150, false)
local item1 = dgsMenuAddItem(menu, "Custom Colors", "custom")
local item2 = dgsMenuAddItem(menu, "Another Item", "another")

-- Set different colors for normal and hover states
local normalColor = tocolor(100, 100, 100) -- Gray when normal
local hoverColor = tocolor(255, 255, 255) -- White when hovering
dgsMenuSetItemColor(menu, item1, {normalColor, hoverColor})

-- You can also use the same color for both states
local singleColor = tocolor(255, 100, 100) -- Light red
dgsMenuSetItemColor(menu, item2, {singleColor}) -- Will use the same color for both states

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Selected: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

==See Also==
*[[dgsMenuGetItemColor]]
*[[dgsMenuAddItem]]
*[[dgsMenuSetItemText]]
*[[dgsMenuSetItemTextSize]]
*[[dgsCreateMenu]]

==Author==
[[User:Mohab|Mohab]].

DgsMenuGetItemTextSize

2025-07-10T06:06:57Z

Mohab: Created page with "{{Client function}} __NOTOC__ This function gets the text size of a specific menu item. ==Syntax== <syntaxhighlight lang="lua"> float, float dgsMenuGetItemTextSize ( element menu, int uniqueID ) </syntaxhighlight> ===Required Arguments=== *'''menu:''' The DGS menu element containing the item *'''uniqueID:''' The unique ID of the menu item (returned by dgsMenuAddItem) ===Returns=== Returns two floats representing the horizontal and vertical text scale factors, or '..."

{{Client function}}
__NOTOC__
This function gets the text size of a specific menu item.

==Syntax==
<syntaxhighlight lang="lua">
float, float dgsMenuGetItemTextSize ( element menu, int uniqueID )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element containing the item
*'''uniqueID:''' The unique ID of the menu item (returned by [[dgsMenuAddItem]])

===Returns===
Returns two floats representing the horizontal and vertical text scale factors, or ''false'' if the operation failed.

==Examples==
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with items
local menu = dgsCreateMenu(200, 200, 200, 150, false)
local item1 = dgsMenuAddItem(menu, "Normal Size", "normal")
local item2 = dgsMenuAddItem(menu, "Large Text", "large")

-- Set different text sizes
dgsMenuSetItemTextSize(menu, item1, 1.0)
dgsMenuSetItemTextSize(menu, item2, 1.5, 2.0)

-- Get and display the text sizes
local sizeX1, sizeY1 = dgsMenuGetItemTextSize(menu, item1)
local sizeX2, sizeY2 = dgsMenuGetItemTextSize(menu, item2)

outputChatBox("Item 1 text size: " .. sizeX1 .. "x" .. sizeY1)
outputChatBox("Item 2 text size: " .. sizeX2 .. "x" .. sizeY2)

-- Show the menu
dgsMenuShow(menu)
</syntaxhighlight>

==See Also==
*[[dgsMenuSetItemTextSize]]
*[[dgsMenuAddItem]]
*[[dgsMenuSetItemText]]
*[[dgsCreateMenu]]

==Author==
[[User:Mohab|Mohab]].

DgsMenuSetItemTextSize

2025-07-10T05:59:28Z

Mohab: Created page with "{{Client function}} __NOTOC__ This function sets the text size of a specific menu item. ==Syntax== <syntaxhighlight lang="lua"> bool dgsMenuSetItemTextSize ( element menu, int uniqueID, float textSizeX [, float textSizeY ] ) </syntaxhighlight> ===Required Arguments=== *'''menu:''' The DGS menu element containing the item *'''uniqueID:''' The unique ID of the menu item (returned by dgsMenuAddItem) *'''textSizeX:''' The horizontal scale of the text ===Optional Argum..."

{{Client function}}
__NOTOC__
This function sets the text size of a specific menu item.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsMenuSetItemTextSize ( element menu, int uniqueID, float textSizeX [, float textSizeY ] )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element containing the item
*'''uniqueID:''' The unique ID of the menu item (returned by [[dgsMenuAddItem]])
*'''textSizeX:''' The horizontal scale of the text

===Optional Arguments===
*'''textSizeY:''' The vertical scale of the text. If not specified, textSizeX is used for both dimensions

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

==Examples==
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with different text sizes
local menu = dgsCreateMenu(200, 200, 200, 150, false)
local item1 = dgsMenuAddItem(menu, "Normal Size", "normal")
local item2 = dgsMenuAddItem(menu, "Large Text", "large")
local item3 = dgsMenuAddItem(menu, "Small Text", "small")

-- Set different text sizes for each item
dgsMenuSetItemTextSize(menu, item1, 1.0) -- Normal size
dgsMenuSetItemTextSize(menu, item2, 1.5) -- Large text
dgsMenuSetItemTextSize(menu, item3, 0.8, 0.8) -- Small text

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
outputChatBox("Selected: " .. command)
dgsMenuHide(source)
end, false)
</syntaxhighlight>

==See Also==
*[[dgsMenuGetItemTextSize]]
*[[dgsMenuAddItem]]
*[[dgsMenuSetItemText]]
*[[dgsCreateMenu]]

==Author==
[[User:Mohab|Mohab]].

DgsMenuGetItemText

2025-07-10T04:52:05Z

Mohab:

{{Client function}}
__NOTOC__
This function retrieves the displayed text of a menu item.

==Syntax==
<syntaxhighlight lang="lua">
string dgsMenuGetItemText ( element menu, int uniqueID )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element containing the item
*'''uniqueID:''' The unique ID of the menu item (returned by [[dgsMenuAddItem]])

===Returns===
Returns the text string if successful, ''false'' if the item doesn't exist.

==Examples==
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with some items
local menu = dgsCreateMenu(200, 200, 150, 100, false)
local item1 = dgsMenuAddItem(menu, "New Game", "new")
local item2 = dgsMenuAddItem(menu, "Load Game", "load")
local item3 = dgsMenuAddItem(menu, "Exit", "exit")

-- Show the menu
dgsMenuShow(menu)

-- Get and display the text of menu items
local text1 = dgsMenuGetItemText(menu, item1)
local text2 = dgsMenuGetItemText(menu, item2)
local text3 = dgsMenuGetItemText(menu, item3)

outputChatBox("Menu items: " .. text1 .. ", " .. text2 .. ", " .. text3)
-- Output: "Menu items: New Game, Load Game, Exit"
</syntaxhighlight>

==See Also==
*[[dgsMenuSetItemText]]
*[[dgsMenuAddItem]]
*[[dgsMenuGetItemCommand]]
*[[dgsCreateMenu]]

==Author==
[[User:Mohab|Mohab]].

DgsMenuGetItemCommand

2025-07-10T04:51:47Z

Mohab:

{{Client function}}
__NOTOC__
This function retrieves the command identifier of a menu item. The command is used to identify which action should be performed when the item is selected.

==Syntax==
<syntaxhighlight lang="lua">
string dgsMenuGetItemCommand ( element menu, int uniqueID )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element containing the item
*'''uniqueID:''' The unique ID of the menu item (returned by [[dgsMenuAddItem]])

===Returns===
Returns the command string if successful, ''false'' if the item doesn't exist.

==Examples==
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with different types of items
local menu = dgsCreateMenu(200, 200, 180, 150, false)
local fileItem = dgsMenuAddItem(menu, "File", "file")
dgsMenuAddItem(menu, "New", "file_new", fileItem)
dgsMenuAddItem(menu, "Open", "file_open", fileItem)
dgsMenuAddItem(menu, "Save", "file_save", fileItem)
dgsMenuAddSeparator(menu)
dgsMenuAddItem(menu, "Exit", "exit")

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selections by checking commands
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

-- Get the command of the selected item
local command = dgsMenuGetItemCommand(source, uniqueID)

-- Perform actions based on command
if command == "file_new" then
outputChatBox("Creating new file...")
elseif command == "file_open" then
outputChatBox("Opening file...")
elseif command == "file_save" then
outputChatBox("Saving file...")
elseif command == "exit" then
outputChatBox("Goodbye!")
dgsMenuHide(source)
return
end

-- Close menu after action
dgsMenuHide(source)
end, false)
</syntaxhighlight>

==See Also==
*[[dgsMenuSetItemCommand]]
*[[dgsMenuAddItem]]
*[[dgsCreateMenu]]
*[[onDgsMenuSelect]]

==Author==
[[User:Mohab|Mohab]].

DgsMenuSetItemCommand

2025-07-10T04:51:28Z

Mohab:

{{client function}}
__NOTOC__
This function changes the command identifier of an existing menu item. The command is used to identify the item when it's selected.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsMenuSetItemCommand ( element menu, int uniqueID, string command )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element containing the item
*'''uniqueID:''' The unique ID of the menu item (returned by [[dgsMenuAddItem]])
*'''command:''' The new command identifier for this item

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

==Examples==
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with some items
local menu = dgsCreateMenu(200, 200, 150, 120, false)
local item1 = dgsMenuAddItem(menu, "Save", "save")
local item2 = dgsMenuAddItem(menu, "Load", "load")
local item3 = dgsMenuAddItem(menu, "Toggle", "mode_normal")

-- Show the menu
dgsMenuShow(menu)

-- Change the toggle item command based on current state
local isAdvancedMode = false

function toggleMode()
isAdvancedMode = not isAdvancedMode

if isAdvancedMode then
dgsMenuSetItemCommand(menu, item3, "mode_advanced")
dgsMenuSetItemText(menu, item3, "Advanced Mode")
outputChatBox("Switched to advanced mode")
else
dgsMenuSetItemCommand(menu, item3, "mode_normal")
dgsMenuSetItemText(menu, item3, "Normal Mode")
outputChatBox("Switched to normal mode")
end
end

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
if command == "save" then
outputChatBox("Saving...")
elseif command == "load" then
outputChatBox("Loading...")
elseif command == "mode_normal" or command == "mode_advanced" then
toggleMode()
end
end, false)
</syntaxhighlight>

==Notes==
{{Note|The menu automatically resizes when item commands are changed}}

==See Also==
*[[dgsMenuGetItemCommand]]
*[[dgsMenuAddItem]]
*[[dgsMenuSetItemText]]
*[[dgsCreateMenu]]

==Author==
[[User:Mohab|Mohab]].

DgsMenuGetItemCommand

2025-07-10T04:51:23Z

Mohab:

DgsMenuSetItemText

2025-07-10T04:51:07Z

Mohab:

{{Client function}}
__NOTOC__
This function changes the displayed text of an existing menu item.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsMenuSetItemText ( element menu, int uniqueID, string text )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element containing the item
*'''uniqueID:''' The unique ID of the menu item (returned by [[dgsMenuAddItem]])
*'''text:''' The new text to display for this menu item

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

==Examples==
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with a toggle option
local menu = dgsCreateMenu(200, 200, 160, 120, false)
dgsMenuAddItem(menu, "Start Game", "start")
local soundItem = dgsMenuAddItem(menu, "Sound: ON", "toggle_sound")
dgsMenuAddItem(menu, "Exit", "exit")

-- Show the menu
dgsMenuShow(menu)

-- Track sound state
local soundEnabled = true

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
if command == "start" then
outputChatBox("Starting game...")
elseif command == "toggle_sound" then
-- Toggle sound state and update menu text
soundEnabled = not soundEnabled
if soundEnabled then
dgsMenuSetItemText(source, soundItem, "Sound: ON")
outputChatBox("Sound enabled")
else
dgsMenuSetItemText(source, soundItem, "Sound: OFF")
outputChatBox("Sound disabled")
end
return -- Don't hide menu for toggle
elseif command == "exit" then
dgsMenuHide(source)
return
end

dgsMenuHide(source)
end, false)
</syntaxhighlight>

==See Also==
*[[dgsMenuGetItemText]]
*[[dgsMenuAddItem]]
*[[dgsMenuSetItemCommand]]
*[[dgsCreateMenu]]

==Author==
[[User:Mohab|Mohab]].

DgsMenuHide

2025-07-10T04:50:45Z

Mohab:

{{client function}}
__NOTOC__
This function hides a DGS menu and cleans up any associated submenus.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsMenuHide ( element menu )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element to hide

===Returns===
Returns ''true'' if the menu was hidden successfully, ''false'' otherwise.

==Examples==
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu
local menu = dgsCreateMenu(200, 200, 150, 120, false)
dgsMenuAddItem(menu, "New File", "new")
dgsMenuAddItem(menu, "Open File", "open")
dgsMenuAddSeparator(menu)
dgsMenuAddItem(menu, "Exit", "exit")

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selection
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
if command == "exit" then
dgsMenuHide(source)
outputChatBox("Menu closed!")
else
outputChatBox("Selected: " .. command)
end
end, false)
</syntaxhighlight>

==Notes==
{{Note|This function automatically cleans up submenus and removes focus from the menu}}
{{Note|Menus are automatically hidden when losing focus if autoHide property is enabled (default)}}

==See Also==
*[[dgsMenuShow]]
*[[dgsCreateMenu]]
*[[dgsMenuClean]]
*[[dgsMenuAddItem]]

==Author==
[[User:Mohab|Mohab]].

DgsMenuAddItem

2025-07-10T04:50:19Z

Mohab:

{{client function}}
__NOTOC__
This function adds a new item to a DGS menu. Each item can have text, a command identifier, and can optionally be a child of another item to create submenus.

==Syntax==
<syntaxhighlight lang="lua">
int, int dgsMenuAddItem ( element menu, string text, string command [, int parentItemID, int position ] )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element to add the item to
*'''text:''' The text that will be displayed for this menu item
*'''command:''' A string identifier for this item (used to identify it when selected)

===Optional Arguments===
*'''parentItemID:''' The unique ID of a parent item to create a submenu. If not specified, the item is added to the root menu
*'''position:''' The position where to insert the item. If not specified, the item is added at the end

===Returns===
Returns the unique item ID and position if the item was added successfully, ''false'' otherwise.

==Examples==
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu
local menu = dgsCreateMenu(200, 200, 180, 150, false)

-- Add root level items
local timeItem = dgsMenuAddItem(menu, "Time", "time")
local weatherItem = dgsMenuAddItem(menu, "Weather", "weather")
dgsMenuAddItem(menu, "Exit", "exit")

-- Add submenu items under "Time"
dgsMenuAddItem(menu, "Day", "set_day", timeItem)
dgsMenuAddItem(menu, "Night", "set_night", timeItem)

-- Add submenu items under "Weather"
dgsMenuAddItem(menu, "Clear", "clear_weather", weatherItem)
dgsMenuAddItem(menu, "Rain", "rain_weather", weatherItem)

-- Show the menu
dgsMenuShow(menu)

-- Handle menu selections
addEventHandler("onDgsMenuSelect", menu, function(subMenu, uniqueID)
if uniqueID == -1 then return end

local command = dgsMenuGetItemCommand(source, uniqueID)
if command == "set_day" then
setTime(12, 0)
outputChatBox("Time set to day")
elseif command == "set_night" then
setTime(0, 0)
outputChatBox("Time set to night")
elseif command == "clear_weather" then
setWeather(0)
outputChatBox("Weather set to clear")
elseif command == "rain_weather" then
setWeather(8)
outputChatBox("Weather set to rain")
elseif command == "exit" then
dgsMenuHide(source)
outputChatBox("Menu closed")
return
end

-- Hide menu after most selections
dgsMenuHide(source)
end, false)
</syntaxhighlight>

==Notes==
{{Tip|Each item gets a unique ID that can be used with other menu functions like [[dgsMenuGetItemCommand]]}}
{{Note|Parent items automatically display a ">" indicator when they have child items}}

==See Also==
*[[dgsCreateMenu]]
*[[dgsMenuAddSeparator]]
*[[dgsMenuRemoveItem]]
*[[dgsMenuGetItemCommand]]
*[[dgsMenuShow]]

==Author==
[[User:Mohab|Mohab]].

DgsMenuGetItemText

2025-07-10T04:49:42Z

Mohab: Created page with "{{Client function}} __NOTOC__ This function retrieves the displayed text of a menu item. ==Syntax== <syntaxhighlight lang="lua"> string dgsMenuGetItemText ( element menu, int uniqueID ) </syntaxhighlight> ===Required Arguments=== *'''menu:''' The DGS menu element containing the item *'''uniqueID:''' The unique ID of the menu item (returned by dgsMenuAddItem) ===Returns=== Returns the text string if successful, ''false'' if the item doesn't exist. ==Examples== <sy..."

DgsMenuSetItemText

2025-07-10T04:47:47Z

Mohab:

DgsMenuSetItemText

2025-07-10T04:47:38Z

Mohab: Created page with "{{Client function}} __NOTOC__ This function changes the displayed text of an existing menu item. ==Syntax== <syntaxhighlight lang="lua"> bool dgsMenuSetItemText ( element menu, int uniqueID, string text ) </syntaxhighlight> ===Required Arguments=== *'''menu:''' The DGS menu element containing the item *'''uniqueID:''' The unique ID of the menu item (returned by dgsMenuAddItem) *'''text:''' The new text to display for this menu item ===Returns=== Returns ''true'' i..."

DgsMenuGetItemCommand

2025-07-10T04:44:06Z

Mohab: Created page with "{{Client function}} __NOTOC__ This function retrieves the command identifier of a menu item. The command is used to identify which action should be performed when the item is selected. ==Syntax== <syntaxhighlight lang="lua"> string dgsMenuGetItemCommand ( element menu, int uniqueID ) </syntaxhighlight> ===Required Arguments=== *'''menu:''' The DGS menu element containing the item *'''uniqueID:''' The unique ID of the menu item (returned by dgsMenuAddItem) ===Retur..."

DgsMenuSetItemCommand

2025-07-10T04:40:37Z

Mohab: Created page with "{{client function}} __NOTOC__ This function changes the command identifier of an existing menu item. The command is used to identify the item when it's selected. ==Syntax== <syntaxhighlight lang="lua"> bool dgsMenuSetItemCommand ( element menu, int uniqueID, string command ) </syntaxhighlight> ===Required Arguments=== *'''menu:''' The DGS menu element containing the item *'''uniqueID:''' The unique ID of the menu item (returned by dgsMenuAddItem) *'''command:''' Th..."

DgsMenuAddItem

2025-07-10T04:32:40Z

Mohab: Created page with "{{client function}} __NOTOC__ This function adds a new item to a DGS menu. Each item can have text, a command identifier, and can optionally be a child of another item to create submenus. ==Syntax== <syntaxhighlight lang="lua"> int, int dgsMenuAddItem ( element menu, string text, string command [, int parentItemID, int position ] ) </syntaxhighlight> ===Required Arguments=== *'''menu:''' The DGS menu element to add the item to *'''text:''' The text that will be display..."