setMusicEventHandler: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\|s([0-9])\= '''([^' ]+)'''([^ ]+) " to "|s$1= $2$3 ") |
Lou Montana (talk | contribs) m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>") |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
|gr2= Sounds | |gr2= Sounds | ||
|descr= Sets given music track event handler. Will overwrite other music event handlers. Use [[addMusicEventHandler]] | |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.}} | |||
|s1= [[setMusicEventHandler]] [type, function] | |s1= [[setMusicEventHandler]] [type, function] | ||
|p1= | |p1= type: [[String]] - "MusicStart" or "MusicStop" | ||
|p2 | |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 | ||
|r1= [[Number]] - id of the event handler | |r1= [[Number]] - id of the event handler | ||
|x1= < | |x1= <sqf>_ehID = setMusicEventHandler ["MusicStart", "hint str _this"];</sqf> | ||
|x2= < | |x2= <sqf>_ehID = setMusicEventHandler ["MusicStop", "hint str _this"];</sqf> | ||
|seealso= [[addMusicEventHandler]] | |seealso= [[addMusicEventHandler]] [[removeMusicEventHandler]] [[playMusic]] [[removeAllMusicEventHandlers]] | ||
}} | }} | ||
Latest revision as of 10:24, 13 May 2022
Description
- Description:
- Sets given music track event handler. Will overwrite other 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:
- Example 2:
Additional Information
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