removeMusicEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)\]\]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Add EH link)
 
(27 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 0.50


|0.50|Game version=
|gr1= Event Handlers


|gr1= Event Handlers |GROUP1=
|gr2= Sounds


|gr2= Sounds |GROUP2=
|descr= Removes specified music track event handler. See {{Link|Arma 3: Event Handlers#Music Event Handlers}}.
____________________________________________________________________________________________


| Removes specified music track event handler.  |DESCRIPTION=
|s1= [[removeMusicEventHandler]] [type, id]
____________________________________________________________________________________________


| [[removeMusicEventHandler]] [type, id] |SYNTAX=
|p1= type: [[String]] - "MusicStart" or "MusicStop"


|p1= [type, id]: [[Array]] |PARAMETER1=
|p2= id: [[Number]] - event handler id


|p2= type: [[String]] - "MusicStart" or "MusicStop"  |PARAMETER2=
|r1= [[Nothing]]


|p3= id: [[Number]] - event handler id  |PARAMETER3=
|x1= <sqf>removeMusicEventHandler ["MusicStart", 12];</sqf>


| [[Nothing]] |RETURNVALUE=
|x2= <sqf>removeMusicEventHandler ["MusicStop", 12];</sqf>


|x1= <code>[[removeMusicEventHandler]] ["MusicStart", 12];</code>|EXAMPLE1=
|x3= <sqf>private _stopMusicEH = addMusicEventHandler ["MusicStop", {}];
|x2= <code>[[removeMusicEventHandler]] ["MusicStop", 12];</code>|EXAMPLE2=
// ...
|x3= <code>
removeMusicEventHandler ["MusicStop", _stopMusicEH];</sqf>
hnd_stop = [[addMusicEventHandler]] ["MusicStop",{}];
[[removeMusicEventHandler]] ["MusicStop",hnd_stop];
</code>|EXAMPLE3=
____________________________________________________________________________________________


| [[addMusicEventHandler]], [[setMusicEventHandler]], [[removeAllMusicEventHandlers]], [[playMusic]] |SEEALSO=
|seealso= [[addMusicEventHandler]] {{Link|Arma 3: Event Handlers#Music Event Handlers}} [[setMusicEventHandler]] [[removeAllMusicEventHandlers]] [[playMusic]]
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma3|New_Scripting_Commands_List}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 20:29, 21 May 2023

Hover & click on the images for description

Description

Description:
Removes specified music track event handler. See Arma 3: Event Handlers - Music Event Handlers.
Groups:
Event HandlersSounds

Syntax

Syntax:
removeMusicEventHandler [type, id]
Parameters:
type: String - "MusicStart" or "MusicStop"
id: Number - event handler id
Return Value:
Nothing

Examples

Example 1:
removeMusicEventHandler ["MusicStart", 12];
Example 2:
removeMusicEventHandler ["MusicStop", 12];
Example 3:
private _stopMusicEH = addMusicEventHandler ["MusicStop", {}]; // ... removeMusicEventHandler ["MusicStop", _stopMusicEH];

Additional Information

See also:
addMusicEventHandler Arma 3: Event Handlers - Music Event Handlers setMusicEventHandler removeAllMusicEventHandlers playMusic

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