setMusicEventHandler: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "<h3 style='display:none'>Notes</h3> <dl class='command_description'> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> <h3 style='display:none'>Bottom Section</h3>" to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...) |
||
| Line 1: | Line 1: | ||
{{Command | {{Command | ||
| arma3 | | arma3 | ||
|1.02 | |1.02 | ||
|gr1 = Event Handlers | |gr1 = Event Handlers | ||
|gr2 = Sounds | |gr2 = Sounds | ||
| Sets given music track event handler. Will overwrite other music event handlers. Use [[addMusicEventHandler]] if you want to stack them. | | Sets given music track event handler. Will overwrite other music event handlers. Use [[addMusicEventHandler]] if you want to stack them. | ||
| '''setMusicEventHandler''' [type, function] | | '''setMusicEventHandler''' [type, function] | ||
|p1= [type, function]: [[Array]] | |p1= [type, function]: [[Array]] | ||
|p2= type: [[String]] - "MusicStart" or "MusicStop" | |p2= type: [[String]] - "MusicStart" or "MusicStop" | ||
|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 | ||
| [[Number]] - id of the event handler | | [[Number]] - id of the event handler | ||
|x1= <code>_ehID = [[setMusicEventHandler]] ["MusicStart", "[[hint]] [[str]] _this"];</code> | |x1= <code>_ehID = [[setMusicEventHandler]] ["MusicStart", "[[hint]] [[str]] _this"];</code> | ||
|x2= <code>_ehID = [[setMusicEventHandler]] ["MusicStop", "[[hint]] [[str]] _this"];</code> | |x2= <code>_ehID = [[setMusicEventHandler]] ["MusicStop", "[[hint]] [[str]] _this"];</code> | ||
| [[addMusicEventHandler]], [[removeMusicEventHandler]], [[playMusic]], [[removeAllMusicEventHandlers]] | | [[addMusicEventHandler]], [[removeMusicEventHandler]], [[playMusic]], [[removeAllMusicEventHandlers]] | ||
| | | | ||
}} | }} | ||
Revision as of 12:10, 18 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