setMusicEventHandler: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{Command|= Comments ____________________________________________________________________________________________ | arma3 |= Game name |1.02|= Game version ____________________...") |
Killzone Kid (talk | contribs) No edit summary |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Sets given music track event handler |= Description | | Sets given music track event handler. Will overwrite other music event handlers. Use [[addMusicEventHandler]] if you want to stack them. |= Description | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 14: | Line 14: | ||
|p1= [type, function]: [[Array]] |= PARAMETER1 | |p1= [type, function]: [[Array]] |= PARAMETER1 | ||
|p2= | |p2= type: [[String]] - "MusicStart" or "MusicStop" |= PARAMETER2 | ||
|p3= | |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 |= RETURNVALUE | ||
|x1= <code>setMusicEventHandler [" | |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 | | |= MPBEHAVIOUR | ||
Revision as of 22:48, 15 December 2013
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