addMusicEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|s([0-9])\= '''([^' ]+)'''([^ ]+) " to "|s$1= $2$3 ")
m (Updated formatting of parameters to be consistent)
Line 16: Line 16:
|p2= type: [[String]] - "MusicStart" or "MusicStop"
|p2= type: [[String]] - "MusicStart" or "MusicStop"


|p3= function: [[String]] or [[Code]]. Passed params array:
|p3= function: [[String]] or [[Code]] - Passed params array:
* 0: [[Description.ext#Music|CfgMusic]] class name
* 0: [[Description.ext#Music|CfgMusic]] class name
* 1: this event handler id
* 1: this event handler id


|r1= [[Number]] - event handler id
|r1= [[Number]] - Event handler id


|x1= <code>_ehID = [[addMusicEventHandler]] ["MusicStart", {[[hint]] [[str]] _this}];</code>
|x1= <code>_ehID = [[addMusicEventHandler]] ["MusicStart", {[[hint]] [[str]] _this}];</code>

Revision as of 11:51, 8 October 2021

Hover & click on the images for description

Description

Description:
Adds playMusic event handler. Returns id of the handler or -1 when failed. Just like addMissionEventHandler, music EH is also attached to the mission.
Groups:
Event HandlersSounds

Syntax

Syntax:
addMusicEventHandler [type, function]
Parameters:
[type, function]: Array
type: String - "MusicStart" or "MusicStop"
function: String or Code - Passed params array:
  • 0: CfgMusic class name
  • 1: this event handler id
Return Value:
Number - Event handler id

Examples

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

Additional Information

See also:
setMusicEventHandlerplayMusicremoveMusicEventHandlerremoveAllMusicEventHandlers

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
Posted on March 4, 2013 - 13:30
Druid
There are these two types at this time:
MusicStart - It is triggered when the music is started (command playMusic). In variable _this is stored class name from CfgMusic.
MusicStop - It is triggered when the music is ended (command playMusic). In variable _this is stored class name from CfgMusic.