setMusicEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style='display:none'>Notes</h3> <dl class='command_description'> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> <h3 style='display:none'>Bottom Section</h3>" to "")
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(20 intermediate revisions by the same user 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


|gr1 = Event Handlers |GROUP1=
|gr2= Sounds


|gr2 = Sounds |GROUP2=
|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.}}


| Sets given music track event handler. Will overwrite other music event handlers. Use [[addMusicEventHandler]] if you want to stack them. |DESCRIPTION=
|s1= [[setMusicEventHandler]] [type, function]


| '''setMusicEventHandler''' [type, function] |SYNTAX=
|p1= type: [[String]] - "MusicStart" or "MusicStop"


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


|p2= type: [[String]] - "MusicStart" or "MusicStop" |PARAMETER2=
|r1= [[Number]] - id of the event handler


|p3= function: [[String]] - script to be executed. Passes params array 0: class name of the sound in [[Description.ext#Music|CfgMusic]], 1: event handler id|PARAMETER3=
|x1= <sqf>_ehID = setMusicEventHandler ["MusicStart", "hint str _this"];</sqf>


| [[Number]] - id of the event handler |RETURNVALUE=
|x2= <sqf>_ehID = setMusicEventHandler ["MusicStop", "hint str _this"];</sqf>


 
|seealso= [[addMusicEventHandler]] [[removeMusicEventHandler]] [[playMusic]] [[removeAllMusicEventHandlers]]
|x1= <code>_ehID = [[setMusicEventHandler]] ["MusicStart", "[[hint]] [[str]] _this"];</code>|EXAMPLE1=
 
|x2= <code>_ehID = [[setMusicEventHandler]] ["MusicStop", "[[hint]] [[str]] _this"];</code>|EXAMPLE2=
 
 
| [[addMusicEventHandler]], [[removeMusicEventHandler]], [[playMusic]], [[removeAllMusicEventHandlers]] |SEEALSO=
 
|  |MPBEHAVIOUR=
}}
}}
{{GameCategory|arma3|New Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[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"