setMusicEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{Command|= Comments ____________________________________________________________________________________________ | arma3 |= Game name |1.02|= Game version ____________________...")
 
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(33 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.02


|1.02|= Game version
|gr1= Event Handlers
____________________________________________________________________________________________


| Sets given music track event handler |= Description
|gr2= Sounds
____________________________________________________________________________________________


| '''setMusicEventHandler''' [type, function] |= Syntax
|descr= Sets given music track event handler. Will overwrite other music event handlers.
{{Feature|obsolete|Use [[addMusicEventHandler]] instead as it can stack music event handlers.}}


|p1= [type, function]: [[Array]] |= PARAMETER1
|s1= [[setMusicEventHandler]] [type, function]


|p2= |= PARAMETER2
|p1= type: [[String]] - "MusicStart" or "MusicStop"


|p3= |= PARAMETER3
|p2= function: [[String]] - script to be executed. Passes params array 0: class name of the sound in [[Description.ext#Music|CfgMusic]], 1: event handler id


| [[Nothing]] |= RETURNVALUE
|r1= [[Number]] - id of the event handler


|x1= <sqf>_ehID = setMusicEventHandler ["MusicStart", "hint str _this"];</sqf>


|x1= <code>setMusicEventHandler ["MusicTerminate", ""];</code>|= EXAMPLE1
|x2= <sqf>_ehID = setMusicEventHandler ["MusicStop", "hint str _this"];</sqf>


____________________________________________________________________________________________
|seealso= [[addMusicEventHandler]] [[removeMusicEventHandler]] [[playMusic]] [[removeAllMusicEventHandlers]]
 
|  |= SEEALSO
 
|  |= MPBEHAVIOUR
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- 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 10:24, 13 May 2022

Arma 3 logo black.png1.02
Hover & click on the images for description

Description

Description:
Sets given music track event handler. Will overwrite other music event handlers.
🕖
This information is obsolete. Reason: Use addMusicEventHandler instead as it can stack music event handlers.
Groups:
Event HandlersSounds

Syntax

Syntax:
setMusicEventHandler [type, function]
Parameters:
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:
addMusicEventHandler removeMusicEventHandler playMusic removeAllMusicEventHandlers

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
Retrieved from "https://community.bistudio.com/wiki?title=setMusicEventHandler&oldid=319639"