setMusicEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= ")
m (Text replacement - "\|s([0-9])\= '''([^' ]+)'''([^ ]+) " to "|s$1= $2$3 ")
Line 10: Line 10:
|descr= Sets given music track event handler. Will overwrite other music event handlers. Use [[addMusicEventHandler]] if you want to stack them.
|descr= Sets given music track event handler. Will overwrite other music event handlers. Use [[addMusicEventHandler]] if you want to stack them.


|s1= '''setMusicEventHandler''' [type, function]
|s1= [[setMusicEventHandler]] [type, function]


|p1= [type, function]: [[Array]]
|p1= [type, function]: [[Array]]

Revision as of 17:12, 20 June 2021

Hover & click on the images for description

Description

Description:
Sets given music track event handler. Will overwrite other music event handlers. Use addMusicEventHandler if you want to stack them.
Groups:
Event HandlersSounds

Syntax

Syntax:
setMusicEventHandler [type, function]
Parameters:
[type, function]: Array
type: String - "MusicStart" or "MusicStop"
function: String - script to be executed. Passes params array 0: class name of the sound in CfgMusic, 1: event handler id
Return Value:
Number - id of the event handler

Examples

Example 1:
_ehID = setMusicEventHandler ["MusicStart", "hint str _this"];
Example 2:
_ehID = setMusicEventHandler ["MusicStop", "hint str _this"];

Additional Information

See also:
addMusicEventHandlerremoveMusicEventHandlerplayMusicremoveAllMusicEventHandlers

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note