setMusicEventHandler

From Bohemia Interactive Community
Revision as of 11:38, 18 January 2021 by R3vo (talk | contribs) (Text replacement - "<h3 style='display:none'>Notes</h3> <dl class='command_description'> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> <h3 style='display:none'>Bottom Section</h3>" to "")
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. 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