addMusicEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
(Add EH link)
 
(9 intermediate revisions by 2 users not shown)
Line 11: Line 11:


|descr= Adds [[playMusic]] event handler. Returns id of the handler or -1 when failed. Like [[addMissionEventHandler]], the music event handler is attached to the mission.
|descr= Adds [[playMusic]] event handler. Returns id of the handler or -1 when failed. Like [[addMissionEventHandler]], the music event handler is attached to the mission.
See {{Link|Arma 3: Event Handlers#Music Event Handlers}}.


|s1= [[addMusicEventHandler]] [type, function]
|s1= [[addMusicEventHandler]] [type, function]
Line 17: Line 18:


|p2= function: [[String]] or [[Code]] - passed params array is [musicClassname, eventHandlerId] where:
|p2= function: [[String]] or [[Code]] - passed params array is [musicClassname, eventHandlerId] where:
<sqf>params ["_musicClassname", "_ehId"];</sqf>
* musicClassname: [[String]] - [[Description.ext#Music|CfgMusic]] class name
* musicClassname: [[String]] - [[Description.ext#Music|CfgMusic]] class name
* eventHandlerId: [[Number]] - event handler id
* eventHandlerId: [[Number]] - event handler id
<syntaxhighlight lang="cpp">params ["_musicClassname", "_ehId"];</syntaxhighlight>


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


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


|x2= <code>[[private]] _ehID = [[addMusicEventHandler]] ["MusicStop", { [[hint]] [[str]] _this }];</code>
|x2= <sqf>private _ehID = addMusicEventHandler ["MusicStop", { hint str _this }];</sqf>


|seealso= [[setMusicEventHandler]], [[playMusic]], [[removeMusicEventHandler]], [[removeAllMusicEventHandlers]]
|seealso= [[removeMusicEventHandler]] [[playMusic]] {{Link|Arma 3: Event Handlers#Music Event Handlers}} [[removeAllMusicEventHandlers]] [[getEventHandlerInfo]]
}}
}}



Latest revision as of 19:31, 21 May 2023

Hover & click on the images for description

Description

Description:
Adds playMusic event handler. Returns id of the handler or -1 when failed. Like addMissionEventHandler, the music event handler is attached to the mission. See Arma 3: Event Handlers - Music Event Handlers.
Groups:
Event HandlersSounds

Syntax

Syntax:
addMusicEventHandler [type, function]
Parameters:
type: String - "MusicStart" or "MusicStop"
function: String or Code - passed params array is [musicClassname, eventHandlerId] where:
params ["_musicClassname", "_ehId"];
Return Value:
Number - event handler id

Examples

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

Additional Information

See also:
removeMusicEventHandler playMusic Arma 3: Event Handlers - Music Event Handlers removeAllMusicEventHandlers getEventHandlerInfo

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
Druid - c
Posted on Mar 04, 2013 - 13:30 (UTC)
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.