setMusicEventHandler

From Bohemia Interactive Community
Revision as of 11:24, 13 May 2022 by Lou Montana (talk | contribs) (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Sets given music track event handler. Will overwrite other music event handlers.
🕖
The following information is obsolete. Reason: Use addMusicEventHandler instead as it can stack music event handlers.
Groups:
Event HandlersSounds

Syntax

Syntax:
setMusicEventHandler [type, function]
Parameters:
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:
addMusicEventHandler removeMusicEventHandler playMusic removeAllMusicEventHandlers

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