setMusicEventHandler: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\{\{GameCategory\|(arma[0123])\|[ _]?New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 9: | Line 8: | ||
|gr2 = Sounds |GROUP2= | |gr2 = Sounds |GROUP2= | ||
| Sets given music track event handler. Will overwrite other music event handlers. Use [[addMusicEventHandler]] if you want to stack them. |DESCRIPTION= | | Sets given music track event handler. Will overwrite other music event handlers. Use [[addMusicEventHandler]] if you want to stack them. |DESCRIPTION= | ||
| '''setMusicEventHandler''' [type, function] |SYNTAX= | | '''setMusicEventHandler''' [type, function] |SYNTAX= | ||
| Line 29: | Line 26: | ||
|x2= <code>_ehID = [[setMusicEventHandler]] ["MusicStop", "[[hint]] [[str]] _this"];</code>|EXAMPLE2= | |x2= <code>_ehID = [[setMusicEventHandler]] ["MusicStop", "[[hint]] [[str]] _this"];</code>|EXAMPLE2= | ||
| [[addMusicEventHandler]], [[removeMusicEventHandler]], [[playMusic]], [[removeAllMusicEventHandlers]] |SEEALSO= | | [[addMusicEventHandler]], [[removeMusicEventHandler]], [[playMusic]], [[removeAllMusicEventHandlers]] |SEEALSO= | ||
| |MPBEHAVIOUR= | | |MPBEHAVIOUR= | ||
}} | }} | ||
Revision as of 04:04, 17 January 2021
Description
- Description:
- Sets given music track event handler. Will overwrite other music event handlers. Use addMusicEventHandler if you want to stack them.
- Groups:
- Event HandlersSounds
Syntax
- Syntax:
- setMusicEventHandler [type, function]
- Parameters:
- [type, function]: Array
- 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