SetSoundMaxDistance: 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 setSoundMaxDistance ( element sound, int distance )</syntaxhighlight>  
<syntaxhighlight lang="lua">bool setSoundMaxDistance ( element sound, int distance )</syntaxhighlight>  
 
{{OOP||[[sound]]:getMaxDistance|maxDistance|getSoundMaxDistance}}
===Required Arguments===  
===Required Arguments===  
*'''sound:''' a [[sound]] element.
*'''sound:''' a [[sound]] element.
Line 26: Line 26:
==See Also==
==See Also==
{{Client_audio_functions}}
{{Client_audio_functions}}
[[AR:setSoundMaxDistance]]
 
[[ar:setSoundMaxDistance]]

Revision as of 16:46, 17 October 2014

Sets a custom sound max distance at which the sound stops.

Syntax

bool setSoundMaxDistance ( element sound, int distance )

OOP Syntax Help! I don't understand this!

Method: sound:getMaxDistance(...)
Variable: .maxDistance
Counterpart: getSoundMaxDistance


Required Arguments

  • sound: a sound element.
  • distance: the default value for this is 10

Returns

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

Example

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

function maxdistanceFunc(command, param)
  setSoundMaxDistance(sound, tonumber(param))
end
addCommandHandler("setmaxdistance", maxdistanceFunc)

See Also