Event Handlers
47 scripting commands. Also as Markdown for agents.
- add3DENEventHandlerAdds an Eden Editor Event Handler.
- addEventHandlerAdds an Event Handler to the given object. - As many Event Handlers of any type can be added - existing Event Handlers do not get overwritten - Use…
- addMissionEventHandlerAdds event handler attached to the current mission and returns event handler handle. For the list of available mission event handlers see: Arma 3:…
- addMPEventHandlerAdds a multiplayer event handler (EH) to the given object and returns EH handle. See Event Handlers.
- addMusicEventHandlerAdds playMusic event handler. Returns id of the handler or -1 when failed. Like addMissionEventHandler, the music event handler is attached to the…
- addPublicVariableEventHandlerThis event handler will detect if a missionNamespace variable (it is attached to) has been broadcast over network with publicVariable,…
- addUserActionEventHandlerAdds a user action event handler to the current mission and returns its event handler index.
- ctrlAddEventHandlerAdd an event handler to the given control.
- ctrlRemoveAllEventHandlersRemove all event handlers from the given control.
- ctrlRemoveEventHandlerRemove a given event handler from the given control.
- ctrlSetEventHandlerSets given event handler of given control: any previously added event handler is removed.
- diag_allMissionEventHandlersReturns an array with all mission event handlers.
- displayAddEventHandlerAdds an event handler to the given display. See User Interface Event Handlers for the full list of event names.
- displayRemoveAllEventHandlersRemove all event handlers from the given display.
- displayRemoveEventHandlerRemove a given event handler from the given display.
- displaySetEventHandlerSets given event handler of given display. The return code of the provided function should indicate whether this event was handled correctly.
- editorSetEventHandlerSets given event handler of given editor.
- getEventHandlerInfoQueries given event handler's information.
- inGameUISetEventHandlerSets given event handler of in-game UI. If EH function returns true, performed action is overridden.
- onBriefingGroupSelect a sound declared in the Description.ext of the mission to be played the first time the Group tab is selected in the briefing.
- onBriefingNotesSelect a sound declared in the Description.ext of the mission to be played the first time the Notes tab is selected in the briefing.
- onBriefingPlanSelect a sound declared in the Description.ext of the mission to be played the first time the Plan tab is selected in the briefing.
- onBriefingTeamSwitchSelect a sound defined in the CfgSounds of the mission to be played the first time the TeamSwitch tab is selected in the briefing.
- onCommandModeChangedDefines code performed when hc command mode changes either because of (Left Ctrl + Space) shortcut or hcShowBar scripting command.
- onEachFrameRuns given statement every frame in an unscheduled environment.
- onGroupIconClickDefines an action performed when player clicked on group marker (3D or in a map). The code executed once.
- onGroupIconOverEnterDefines an action performed when player moves pointer over group marker (3D or in a map). The code will execute continuously while pointer is over…
- onGroupIconOverLeaveDefines an action performed when pointer, previously positioned over icon, is moved away from it (3D or in a map). The code is executed once.
- onHCGroupSelectionChangedDefines an action performed when high command group selection has been changed.
- onMapSingleClickDefines the action performed when user clicks in map by executing command string.
- onPlayerConnectedThis command will execute the provided code on the server whenever a player connects to a multiplayer session.
- onPlayerDisconnectedThis command will execute attached code whenever a player is leaving an MP session. The code will receive a number of special variables:
- onPreloadFinishedDefines an action performed after the preload screen finished. Preload event occurs after briefing screen on mission start.
- onPreloadStartedDefines an action performed just before the preload screen started. Preload event occurs after briefing screen on mission start.
- onTeamSwitchDefines an action performed when the team switch is finished. Commandset receives the following special variables: *_from* object previous unit,…
- remove3DENEventHandlerRemoves Eden Editor event handler of given type and ID.
- removeAll3DENEventHandlersRemoves all Eden Editor event handlers of given type.
- removeAllEventHandlersRemoves all event handlers of given type that were added by addEventHandler and resets event handler's creation index to 0.
- removeAllMissionEventHandlersRemoves all mission event handlers of the given type which were added by addMissionEventHandler.
- removeAllMusicEventHandlersRemoves all music track event handlers of given type.
- removeAllUserActionEventHandlersRemoves all UserAction event handlers of the given type which were added by addUserActionEventHandler.
- removeEventHandlerRemoves a given Event Handler that was added with addEventHandler.
- removeMissionEventHandlerRemoves mission event handler added by addMissionEventHandler.
- removeMPEventHandlerRemoves MP event handler added by addMPEventHandler.
- removeMusicEventHandlerRemoves specified music track event handler. See Arma 3: Event Handlers#Music Event Handlers.
- removeUserActionEventHandlerRemoves a UserAction event handler. For a list of available UserAction event handlers, see: Arma 3: Mission Event Handlers.
- setMusicEventHandlerSets given music track event handler. Will overwrite other music event handlers.