GetSoundSpeed: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(OOP)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
This function is used to return the playback speed of the specified [[sound]] element.
This function is used to return the playback speed of the specified [[sound]] [[element]].


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">float getSoundSpeed ( element theSound )</syntaxhighlight>  
<syntaxhighlight lang="lua">float getSoundSpeed ( element theSound )</syntaxhighlight>  
 
{{OOP||[[sound]]:getSpeed|speed|setSoundSpeed}}
===Required Arguments===  
===Required Arguments===  
*'''theSound:''' The [[sound]] element which playback speed you want to return.
*'''theSound:''' the [[sound]] [[element]] which playback speed you want to return.


===Returns===
===Returns===
Returns an [[float]] value indicating the playback speed of the [[sound]] element. Default sound playback speed is '''1.0'''.
Returns an [[float]] value indicating the playback speed of the [[sound]] [[element]]. Default sound playback speed is '''1.0'''.


==Example==  
==Example==  

Revision as of 16:54, 17 October 2014

This function is used to return the playback speed of the specified sound element.

Syntax

float getSoundSpeed ( element theSound )

OOP Syntax Help! I don't understand this!

Method: sound:getSpeed(...)
Variable: .speed
Counterpart: setSoundSpeed


Required Arguments

  • theSound: the sound element which playback speed you want to return.

Returns

Returns an float value indicating the playback speed of the sound element. Default sound playback speed is 1.0.

Example

Click to collapse [-]
Client
function outputSpeed(soundname) 
	local sound = playSound("sounds/"..tostring(soundname)..".mp3") --Play the sound from the sounds folder
	setSoundVolume(sound, 0.5) -- set the sound volume to 50%
	outputChatBox("The sound speed : "..getSoundSpeed(sound)) -- output the sound speed
end
addCommandHandler("soundspeed",outputSpeed)

See Also