Multi Theft Auto: Wiki - User contributions [en]

SetSoundVolume

2015-02-17T13:26:00Z

MFGRHOM: /* Example */

__NOTOC__
{{Client function}}
This function is used to change the volume level of the specified [[sound]] [[element]].
Use a player element to control a players voice with this function.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundVolume ( element theSound, float volume )</syntaxhighlight>
{{OOP||[[sound]]:setVolume|volume|getSoundVolume}}
===Required Arguments===
*'''theSound:''' The [[sound]] [[element]] which volume you want to modify.
*'''volume:''' A [[float]]ing point number representing the desired volume level. Range is from '''0.0''' to '''1.0'''

===Returns===
Returns ''true'' if the [[sound]] [[element]] volume was successfully changed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">=addEventHandler("onClientGUIScroll",ScrollName,
function( )
local Scroll = guiScrollBarGetScrollPosition(ScrollName)
Volume = Scroll / 100
if not isElement( iSound ) then
return
end
setSoundVolume(iSound,Volume)
end,false
) </syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element for voice control}}

==See Also==
{{Client_audio_functions}}
[[AR:setSoundVolume]]

SetSoundVolume

2015-02-17T13:25:27Z

MFGRHOM: /* Example */

__NOTOC__
{{Client function}}
This function is used to change the volume level of the specified [[sound]] [[element]].
Use a player element to control a players voice with this function.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundVolume ( element theSound, float volume )</syntaxhighlight>
{{OOP||[[sound]]:setVolume|volume|getSoundVolume}}
===Required Arguments===
*'''theSound:''' The [[sound]] [[element]] which volume you want to modify.
*'''volume:''' A [[float]]ing point number representing the desired volume level. Range is from '''0.0''' to '''1.0'''

===Returns===
Returns ''true'' if the [[sound]] [[element]] volume was successfully changed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">="addEventHandler("onClientGUIScroll",ScrollName,
function( )
local Scroll = guiScrollBarGetScrollPosition(ScrollName)
Volume = Scroll / 100
if not isElement( iSound ) then
return
end
setSoundVolume(iSound,Volume)
end,false
) </syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element for voice control}}

==See Also==
{{Client_audio_functions}}
[[AR:setSoundVolume]]

SetSoundVolume

2015-02-17T13:24:05Z

MFGRHOM: /* Example */

__NOTOC__
{{Client function}}
This function is used to change the volume level of the specified [[sound]] [[element]].
Use a player element to control a players voice with this function.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundVolume ( element theSound, float volume )</syntaxhighlight>
{{OOP||[[sound]]:setVolume|volume|getSoundVolume}}
===Required Arguments===
*'''theSound:''' The [[sound]] [[element]] which volume you want to modify.
*'''volume:''' A [[float]]ing point number representing the desired volume level. Range is from '''0.0''' to '''1.0'''

===Returns===
Returns ''true'' if the [[sound]] [[element]] volume was successfully changed, ''false'' otherwise.

==Example==
<section name="Client" addEventHandler("onClientGUIScroll",ScrollName,
function( )
local Scroll = guiScrollBarGetScrollPosition(ScrollName)
Volume = Scroll / 100
if not isElement( iSound ) then
return
end
setSoundVolume(iSound,Volume)
end,false
) </syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element for voice control}}

==See Also==
{{Client_audio_functions}}
[[AR:setSoundVolume]]

SetSoundVolume

2015-02-17T13:23:41Z

MFGRHOM: /* Example */

__NOTOC__
{{Client function}}
This function is used to change the volume level of the specified [[sound]] [[element]].
Use a player element to control a players voice with this function.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundVolume ( element theSound, float volume )</syntaxhighlight>
{{OOP||[[sound]]:setVolume|volume|getSoundVolume}}
===Required Arguments===
*'''theSound:''' The [[sound]] [[element]] which volume you want to modify.
*'''volume:''' A [[float]]ing point number representing the desired volume level. Range is from '''0.0''' to '''1.0'''

===Returns===
Returns ''true'' if the [[sound]] [[element]] volume was successfully changed, ''false'' otherwise.

==Example==
<section name="Client" addEventHandler("onClientGUIScroll",ScrollName,
function( )
local Scroll = guiScrollBarGetScrollPosition(ScrollName)
Volume = Scroll / 100
if not isElement( iSound ) then
return
end
setSoundVolume(iSound,Volume)
end,false
)
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element for voice control}}

==See Also==
{{Client_audio_functions}}
[[AR:setSoundVolume]]

SetSoundSpeed

2015-02-17T13:21:07Z

MFGRHOM: /* Example */

__NOTOC__
{{Client function}}
This function can be used to change the playback speed of the specified [[sound]] [[element]].

==Syntax==
<syntaxhighlight lang="lua">bool setSoundSpeed ( element theSound, float speed )</syntaxhighlight>
{{OOP||[[sound]]:setSpeed|speed|getSoundSpeed}}
===Required Arguments===
*'''theSound:''' the [[sound]] [[element]] which volume you want to modify.
*'''speed:''' a [[float]]ing point number representing the desired sound playback speed.

===Returns===
Returns ''true'' if the [[sound]] element playback speed was successfully changed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function soundSpeed ( Scrolled )
if ( source == element ) then
if ( isElement ( Sound ) ) then
local ScrollPosition_ = ( guiScrollBarGetScrollPosition ( Scrolled ) / 2 ) / 30
setSoundSpeed ( Sound, ScrollPosition_ )
end
end
end
addEventHandler( "onClientGUIScroll", resourceRoot, soundSpeed )
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}

[[ar:setSoundSpeed]]

SetSoundSpeed

2015-02-17T13:20:36Z

MFGRHOM: /* Example */

__NOTOC__
{{Client function}}
This function can be used to change the playback speed of the specified [[sound]] [[element]].

==Syntax==
<syntaxhighlight lang="lua">bool setSoundSpeed ( element theSound, float speed )</syntaxhighlight>
{{OOP||[[sound]]:setSpeed|speed|getSoundSpeed}}
===Required Arguments===
*'''theSound:''' the [[sound]] [[element]] which volume you want to modify.
*'''speed:''' a [[float]]ing point number representing the desired sound playback speed.

===Returns===
Returns ''true'' if the [[sound]] element playback speed was successfully changed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function soundSpeed ( Scrolled )
if ( source == element ) then
if ( isElement ( Sound ) ) then
local ScrollPosition_ = ( guiScrollBarGetScrollPosition ( Scrolled ) / 2 ) / 30
setSoundSpeed ( Sound, ScrollPosition_ )
end
end
end
addEventHandler( "onClientGUIScroll", resourceRoot, soundSpeed )
</syntaxhighlight>
-- Example By MFGR7OM

==See Also==
{{Client_audio_functions}}

[[ar:setSoundSpeed]]

SetSoundSpeed

2015-02-17T13:19:38Z

MFGRHOM: /* Example */