SetSoundProperties: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (simple ex.)
Line 25: Line 25:
<section name="Client" class="client" show="true">
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- not done yet
function editSongSound()
local sound = playSound("song.wav", false) -- Play the file 'song.wav' and make it play only once
setSoundProperties(sound, 48000.0, 128.00, 440.0, false) -- Set its samplerate to 48,000 Hz, tempo to 128.00, pitch to 440 Hz and not reversed
end
addEventHandler("onClientResourceStart", resourceRoot, editSongSound) -- Execute the function when the resource is started
</syntaxhighlight>
</syntaxhighlight>
</section>
</section>

Revision as of 13:52, 14 March 2013

ADDED/UPDATED IN VERSION 1.3.0 r4097:

This function edit's the properties of a specific sound.

Syntax

bool setSoundProperties(element sound, float fSampleRate, float fTempo, float fPitch, bool bReverse )

Required Arguments

  • fSampleRate: A float that defines the new sound's sample rate
  • fTempo: A float that defines the new sound tempo
  • fPitch: A float that defines the new sound pitch
  • bReverse: A boolean representing whether the sound will be reversed or not.

Returns

Returns true if the properties sucessfully set, false otherwise.

Example

Click to collapse [-]
Client
function editSongSound()
	local sound = playSound("song.wav", false) -- Play the file 'song.wav' and make it play only once
	setSoundProperties(sound, 48000.0, 128.00, 440.0, false) -- Set its samplerate to 48,000 Hz, tempo to 128.00, pitch to 440 Hz and not reversed
end
addEventHandler("onClientResourceStart", resourceRoot, editSongSound) -- Execute the function when the resource is started

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/SetSoundProperties?oldid=35155"