SetSoundMinDistance: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(OOP)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool setSoundMinDistance ( element sound, int distance )</syntaxhighlight>  
<syntaxhighlight lang="lua">bool setSoundMinDistance ( element sound, int distance )</syntaxhighlight>  
 
{{OOP||[[sound]]:setMinDistance|minDistance|getSoundMinDistance}}
===Required Arguments===  
===Required Arguments===  
*'''sound:''' a [[sound]] element.
*'''sound:''' a [[sound]] element.

Revision as of 16:47, 17 October 2014

Sets a custom sound Minimum distance at which the sound stops getting louder.

Syntax

bool setSoundMinDistance ( element sound, int distance )

OOP Syntax Help! I don't understand this!

Method: sound:setMinDistance(...)
Variable: .minDistance
Counterpart: getSoundMinDistance


Required Arguments

  • sound: a sound element.
  • distance: an integer representing the distance the sound stops getting louder. the default value for this is 1

Returns

Returns a true if the minimum distance was set, false otherwise.

Example

Click to collapse [-]
Client
local sound = playSound3D("sounds/song.mp3", 373.14, -125.21, 1001, true)

function distanceFunc(command, param)
  setSoundMinDistance(sound, tonumber(param))
end
addCommandHandler("setdistance", distanceFunc)

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/SetSoundMinDistance?oldid=42629"