Vehicle audio settings

[TheNormalnij]

Hi, everybody. It's a old feature, that provide vehicle audio settings interface.

-- All functions are clinet-side
setVehicleModelAudioSetting( number modelID, eVehicleSoundSetting parameter, var value ) 
getVehicleModelAudioSettings( number modelID )
resetVehicleModelAudioSettings( number modelID )

setVehicleAudioSetting( vehicle theVehicle, eVehicleSoundSetting parameter, var value ) 
getVehicleAudioSettings( vehicle theVehicle )
resetVehicleAudioSettings( vehicle theVehicle )

Possible parameters:

• door-sound
• engine-off-soundbank-id
• engine-on-soundbank-id
• horn-high (float)
• horn-ton
• horn-volume-delta (float)
• radion-num
• radio-type
• sound-type
• bass-setting
• engine-upgrade
• bass-eq
• filed-c // unknown
• vehicle-type-for-audio

I didn't check this code last time. Maybe it can cause crash with wrong *-soundbank-id parameters

[Inder00]

What about RC Rider or RC Plane sound ?

[Allerek]

What about RC Rider or RC Plane sound ?

They're just vehicles like infernus, dodo, jetmax etc, there should not be a problem with those.

[patrikjuvonen]

Merge conflicts must be resolved.

[github-actions]

This draft pull request is stale because it has been open for at least 90 days with no activity. Please continue on your draft pull request or it will be closed in 30 days automatically.

[TheNormalnij]

Merge conflicts solved

[Fernando-A-Rocha]

Nice feature. I think this should be added. Radio sync (#2781) is a different feature that can be added later.

[Dutchman101]

@TheNormalnij Please resolve conflicts and see if there's anything you would have done differently if you'd make this feature in 2024

[Fernando-A-Rocha]

Will it work with allocated model IDs (engineRequestModel) ?

[Fernando-A-Rocha]

Bump?

[TheNormalnij]

Will it work with allocated model IDs (engineRequestModel) ?

yes

[ghost]

Is it still in progress?

[Fernando-A-Rocha]

It would be nice to have this new feature, does it need testing?

[ghost]

It seems that there is still some script left to work, that's what I think

[tederis]

I'd love to see it merged. @TheNormalnij please, resolve the conflicts.

[Fernando-A-Rocha]

Works with engine request model ids?

[TheNormalnij]

Works with engine request model ids?

setVehicleAudioSetting and getVehicleAudioSetting should work with aloocated models.

[Dutchman101]

Thank you for all the work on this, it will be nice to present for MTA 1.6.1
Please add it to wiki, @TheNormalnij

[Fernando-A-Rocha]

Nice that this got added

[Dutchman101]

Nice that this got added

yes, it's huge for MTA

[Dutchman101]

Also, i didnt see TheNormalnij active so much in recent weeks, it would be better if someone else adds documentation to wiki? Anyone interested?

[Xenius97]

Works well for me, here is a small snippet if anyone wants to test it:

local replaceDefaultSoundsEnabled = (type(setVehicleModelAudioSetting) == "function" and true or false)
local customParameters = {
	[478] = getVehicleModelAudioSettings(411) -- # walton <> infernus
}

local possibleValues = {
	["sound-type"] = true, ["engine-on-soundbank-id"] = true, ["engine-off-soundbank-id"] = true, ["bass-setting"] = true, ["bass-eq"] = true, ["field-c"] = true,
	["horn-ton"] = true, ["horn-high"] = true, ["engine-upgrade"] = true, ["door-sound"] = true, ["vehicle-type-for-audio"] = true, ["horn-volume-delta"] = true
}

addEventHandler("onClientResourceStart", resourceRoot, function()
	if not replaceDefaultSoundsEnabled then
		return
	end

	for modelId, values in pairs(customParameters) do
		for key, value in pairs(values) do
			if possibleValues[key] then
				setVehicleModelAudioSetting(modelId, key, value)
			end
		end
	end

	-- # fix streaming after resource start [instantly change sound of vehicle, otherwise you need to use engineRestreamWorld()]
	for _, vehicle in ipairs(getElementsByType("vehicle", root, true)) do
		local model = getElementModel(vehicle)
		if customParameters[model] then
			local values = customParameters[model]
			for key, value in pairs(values) do
				if possibleValues[key] then
					setVehicleAudioSetting(vehicle, key, value)
				end
			end
		end
	end
end)

addEventHandler("onClientResourceStop", resourceRoot, function()
	if not replaceDefaultSoundsEnabled then
		return
	end
	
	for modelId in pairs(customParameters) do
		resetVehicleModelAudioSettings(modelId)
	end
end)

[PlatinMTA]

You broke custom vehicles default sounds, I will open an issue.

[Dutchman101]

Please document the new features on wiki

Pages don't exist:
https://wiki.multitheftauto.com/wiki/setVehicleModelAudioSetting
https://wiki.multitheftauto.com/wiki/getVehicleModelAudioSettings
https://wiki.multitheftauto.com/wiki/resetVehicleModelAudioSettings
https://wiki.multitheftauto.com/wiki/setVehicleAudioSetting
https://wiki.multitheftauto.com/wiki/getVehicleAudioSettings
https://wiki.multitheftauto.com/wiki/resetVehicleAudioSettings

Would be a shame if it saw no use..

[MohabCodeX]

Documented. ✅