addMusicEventHandler: Difference between revisions

Latest revision as of 19:31, 21 May 2023

0.50

LELocal

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 Handlers Sounds

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"];

musicClassname: String - CfgMusic class name
eventHandlerId: Number - event handler id

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.

@@ Line 1: / Line 1: @@
-{{Command|Comments=
+{{RV|type=command
-____________________________________________________________________________________________
-| arma3 |Game name=
+|game1= arma3
+|version1= 0.50
-|0.50|Game version=
+|eff= local
-|gr1 = Event Handlers |GROUP1=
+|gr1= Event Handlers
-|gr2 = Sounds |GROUP2=
+|gr2= Sounds
-____________________________________________________________________________________________
-| Adds [[playMusic]] event handler. Returns id of the handler or -1 when failed. Just like [[addMissionEventHandler]], music EH is also attached to the mission. |DESCRIPTION=
+|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}}.
-| '''addMusicEventHandler''' [type, function] |SYNTAX=
+|s1= [[addMusicEventHandler]] [type, function]
-|p1= [type, function]: [[Array]]  |PARAMETER1=
+|p1= type: [[String]] - "MusicStart" or "MusicStop"
-|p2= type: [[String]] - "MusicStart" or "MusicStop" |PARAMETER2=
+|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
+* eventHandlerId: [[Number]] - event handler id
-|p3= function: [[String]] or [[Code]]. Passed params array:
+|r1= [[Number]] - event handler id
-* 0: [[Description.ext#Music|CfgMusic]] class name
-* 1: this event handler id  |PARAMETER3=
-| [[Number]] - event handler id |RETURNVALUE=
+|x1= <sqf>private _ehID = addMusicEventHandler ["MusicStart", { hint str _this }];</sqf>
+|x2= <sqf>private _ehID = addMusicEventHandler ["MusicStop", { hint str _this }];</sqf>
-|x1= <code>_ehID = [[addMusicEventHandler]] ["MusicStart", {[[hint]] [[str]] _this}];</code>|EXAMPLE1=
+|seealso= [[removeMusicEventHandler]] [[playMusic]] {{Link|Arma 3: Event Handlers#Music Event Handlers}} [[removeAllMusicEventHandlers]] [[getEventHandlerInfo]]
+}}
-|x2= <code>_ehID = [[addMusicEventHandler]] ["MusicStop", {[[hint]] [[str]] _this}];</code>|EXAMPLE2=
-____________________________________________________________________________________________
-| [[setMusicEventHandler]], [[playMusic]], [[removeMusicEventHandler]], [[removeAllMusicEventHandlers]] |SEEALSO=
-|  |MPBEHAVIOUR=
+{{Note
-____________________________________________________________________________________________
+|user= Druid
+|timestamp= 20130304133000
+|text= 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 [[Description.ext#Music|CfgMusic]].
+* '''MusicStop''' - It is triggered when the music is ended (command [[playMusic]]). In variable _this is stored class name from [[Description.ext#Music|CfgMusic]].
 }}
-<h3 style='display:none'>Notes</h3>
-<dl class='command_description'>
-<!-- Note Section BEGIN -->
-<dd class="notedate">Posted on March 4, 2013 - 13:30
-<dt class="note">[[User:Druid|Druid]]<dd class="note">There are these two types at this time:<br>
-'''MusicStart''' - It is triggered when the music is started (command [[playMusic]]). In variable _this is stored class name from [[Description.ext#Music|CfgMusic]].<br>
-'''MusicStop''' - It is triggered when the music is ended (command [[playMusic]]). In variable _this is stored class name from [[Description.ext#Music|CfgMusic]].
-<!-- Note Section END -->
-</dl>
-<h3 style='display:none'>Bottom Section</h3>
-{{GameCategory|arma3|New_Scripting_Commands_List}}
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]