removeMusicEventHandler: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Comments" to "|Comments=")
m (Add EH link)
 
(34 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
____________________________________________________________________________________________


| Removes specified music track event handler.  |DESCRIPTION=
|gr2= Sounds
____________________________________________________________________________________________


| [[removeMusicEventHandler]] [type, id] |SYNTAX=
|descr= Removes specified music track event handler. See {{Link|Arma 3: Event Handlers#Music Event Handlers}}.


|p1= [type, id]: [[Array]]  |PARAMETER1=
|s1= [[removeMusicEventHandler]] [type, id]


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


|p3= id: [[Number]] - event handler id |PARAMETER3=
|p2= id: [[Number]] - event handler id


| [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]


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


| [[addMusicEventHandler]], [[setMusicEventHandler]], [[removeAllMusicEventHandlers]], [[playMusic]] |SEEALSO=
|x2= <sqf>removeMusicEventHandler ["MusicStop", 12];</sqf>


| |MPBEHAVIOUR=  
|x3= <sqf>private _stopMusicEH = addMusicEventHandler ["MusicStop", {}];
____________________________________________________________________________________________
// ...
removeMusicEventHandler ["MusicStop", _stopMusicEH];</sqf>
 
|seealso= [[addMusicEventHandler]] {{Link|Arma 3: Event Handlers#Music Event Handlers}} [[setMusicEventHandler]] [[removeAllMusicEventHandlers]] [[playMusic]]
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[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