addMusicEventHandler

0.50

LELocal

Hover & click on the images for description

Description

Description:

Adds playMusic event handler. Returns id of the handler or -1 when failed. Like addMissionEventHandler, the music event handler is attached to the mission. See Arma 3: Event Handlers - Music Event Handlers.

ⓘ

Music events do not apply to interface-less machines (dedicated server, headless client).

Groups:

Event HandlersSounds

Syntax

Syntax:

addMusicEventHandler [type, function]

Parameters:

type: String - "MusicStart" or "MusicStop"

function: String or Code - passed params array is [musicClassname, eventHandlerId] where:

params ["_musicClassname", "_eventHandlerId", "_currentPosition", "_toralLength"];

• musicClassName: String - CfgMusic class name of the music that started
• eventHandlerId: Number - event handler id (same as returned by addMusicEventHandler usage)
• 2.18 currentPosition: Number - current playback position in 0..1 range (see getMusicPlayedTime)
• 2.18 totalLength: Number - track total length in seconds

Return Value:

Number - event handler id

Examples

Example 1:

private _ehID = addMusicEventHandler ["MusicStart", { hint str _this }];

Example 2:

private _ehID = addMusicEventHandler ["MusicStop", { hint str _this }];

Additional Information

See also:

removeMusicEventHandler playMusic Arma 3: Event Handlers - Music Event Handlers removeAllMusicEventHandlers getEventHandlerInfo

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

Druid - c

Posted on Mar 04, 2013 - 13:30 (UTC)

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.