addMusicEventHandler: Difference between revisions
Jump to navigation
Jump to search
m (format) |
Killzone Kid (talk | contribs) m (format) |
||
Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | Adds [[playMusic]] event handler. Returns id of the handler or -1 when failed. Just like [[addMissionEventHandler]], music EH is also attached to the mission. |= Description | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Line 16: | Line 16: | ||
|p2= type: [[String]] - "MusicStart" or "MusicStop" |= PARAMETER2 | |p2= type: [[String]] - "MusicStart" or "MusicStop" |= PARAMETER2 | ||
|p3= function: [[String]] or [[Code]]. Passed params array 0: [[Description.ext#Music|CfgMusic]] class name | |p3= function: [[String]] or [[Code]]. Passed params array: | ||
* 0: [[Description.ext#Music|CfgMusic]] class name | |||
* 1: this event handler id |= PARAMETER3 | |||
| [[Number]] - event handler id |= RETURNVALUE | | [[Number]] - event handler id |= RETURNVALUE |
Revision as of 21:41, 22 January 2017
Description
- Description:
- Adds playMusic event handler. Returns id of the handler or -1 when failed. Just like addMissionEventHandler, music EH is also attached to the mission.
- Groups:
- Uncategorised
Syntax
- Syntax:
- addMusicEventHandler [type, function]
- Parameters:
- [type, function]: Array
- type: String - "MusicStart" or "MusicStop"
- function: String or Code. Passed params array:
- 0: CfgMusic class name
- 1: this event handler id
- Return Value:
- Number - event handler id
Examples
- Example 1:
_ehID = addMusicEventHandler ["MusicStart", {hint str _this}];
- Example 2:
_ehID = addMusicEventHandler ["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
Notes
- Posted on March 4, 2013 - 13:30
- Druid
- There are these two types at this time:
MusicStart - It is triggered when the music is started (command playMusic). In variable _this is stored class name from CfgMusic.
MusicStop - It is triggered when the music is ended (command playMusic). In variable _this is stored class name from CfgMusic.