addMusicEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<br/>" to "<br>")
m (fix typo)
 
(44 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 0.50


|0.50|Game version=
|eff= local
____________________________________________________________________________________________


| 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=
|gr1= Event Handlers
____________________________________________________________________________________________


| '''addMusicEventHandler''' [type, function] |SYNTAX=
|gr2= Sounds


|p1= [type, function]: [[Array]] |PARAMETER1=
|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}}.


|p2= type: [[String]] - "MusicStart" or "MusicStop" |PARAMETER2=
|s1= [[addMusicEventHandler]] [type, function]


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


| [[Number]] - event handler id |RETURNVALUE=  
|p2= function: [[String]] or [[Code]] - passed params array is [musicClassname, eventHandlerId] where:
<sqf>params ["_musicClassname", "_eventHandlerId", "_currentPosition", "_totalLength"];</sqf>
* musicClassName: [[String]] - [[Description.ext#Music|CfgMusic]] class name of the music that started
* eventHandlerId: [[Number]] - event handler id (same as returned by [[addMusicEventHandler]] usage)
* {{GVI|arma3|2.18|size= 0.75}} currentPosition: [[Number]] - current playback position in 0..1 range (see [[getMusicPlayedTime]])
* {{GVI|arma3|2.18|size= 0.75}} totalLength: [[Number]] - track total length in seconds


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


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


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


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


| |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>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 13:01, 6 November 2024

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", "_eventHandlerId", "_currentPosition", "_totalLength"];
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.