setMusicEventHandler: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) No edit summary |
m (template:command argument fix) |
||
| Line 12: | Line 12: | ||
| '''setMusicEventHandler''' [type, function] |= Syntax | | '''setMusicEventHandler''' [type, function] |= Syntax | ||
|p1= [type, function]: [[Array]] |= | |p1= [type, function]: [[Array]] |PARAMETER1= | ||
|p2= type: [[String]] - "MusicStart" or "MusicStop" |= | |p2= type: [[String]] - "MusicStart" or "MusicStop" |PARAMETER2= | ||
|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|= | |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= | ||
| [[Number]] - id of the event handler |= | | [[Number]] - id of the event handler |RETURNVALUE= | ||
|x1= <code>_ehID = [[setMusicEventHandler]] ["MusicStart", "[[hint]] [[str]] _this"];</code>|= | |x1= <code>_ehID = [[setMusicEventHandler]] ["MusicStart", "[[hint]] [[str]] _this"];</code>|EXAMPLE1= | ||
|x2= <code>_ehID = [[setMusicEventHandler]] ["MusicStop", "[[hint]] [[str]] _this"];</code>|= | |x2= <code>_ehID = [[setMusicEventHandler]] ["MusicStop", "[[hint]] [[str]] _this"];</code>|EXAMPLE2= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[addMusicEventHandler]], [[removeMusicEventHandler]], [[playMusic]], [[removeAllMusicEventHandlers]] |= | | [[addMusicEventHandler]], [[removeMusicEventHandler]], [[playMusic]], [[removeAllMusicEventHandlers]] |SEEALSO= | ||
| |= | | |MPBEHAVIOUR= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
}} | }} | ||
Revision as of 11:37, 7 April 2019
Description
- Description:
- Sets given music track event handler. Will overwrite other music event handlers. Use addMusicEventHandler if you want to stack them.
- Groups:
- Uncategorised
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