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 (Obsoleted) |
||
| 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= <code>_ehID = [[setMusicEventHandler]] ["MusicStart", " | |x1= <code>_ehID = [[setMusicEventHandler]] ["MusicStart", "hint str _this"];</code> | ||
|x2= <code>_ehID = [[setMusicEventHandler]] ["MusicStop", " | |x2= <code>_ehID = [[setMusicEventHandler]] ["MusicStop", "hint str _this"];</code> | ||
|seealso= [[addMusicEventHandler]], [[removeMusicEventHandler]], [[playMusic]], [[removeAllMusicEventHandlers]] | |seealso= [[addMusicEventHandler]], [[removeMusicEventHandler]], [[playMusic]], [[removeAllMusicEventHandlers]] | ||
}} | }} | ||
Revision as of 16:30, 16 November 2021
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:
_ehID = setMusicEventHandler ["MusicStart", "hint str _this"];- Example 2:
_ehID = setMusicEventHandler ["MusicStop", "hint str _this"];
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