SetSoundMaxDistance: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (fix distance defvalue)
m (Changed the OOP syntax of the function to the setter instead of the getter.)
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}}
{{OOP||[[sound]]:setMaxDistance|maxDistance|getSoundMaxDistance}}
===Required Arguments===  
===Required Arguments===  
*'''sound:''' a [[sound]] element.
*'''sound:''' a [[sound]] element.

Revision as of 01:31, 22 August 2017

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:setMaxDistance(...)
Variable: .maxDistance
Counterpart: getSoundMaxDistance


Required Arguments

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

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

Retrieved from "https://wiki.multitheftauto.com/wiki/SetSoundMaxDistance?oldid=52058"