Scripted Event Handlers are triggered by some of BI's modules and functions. When triggered any code registered for one of these events via BIS_fnc_addScriptedEventHandler will be executed. All the events exists as variables within a namespace, whether this is one of the main Namespaces like missionNamespace or uiNamespace or it could be a specific namespace like a Group or Object etc. The event also has a set of parameters passed to the executed code. You can even implement your own scripted eventHandlers by using BIS_fnc_callScriptedEventHandler. For all other available Event Handlers, see Arma 3: Event Handlers.
Functions
- BIS_fnc_addScriptedEventHandler
- BIS_fnc_removeScriptedEventHandler
- BIS_fnc_removeAllScriptedEventHandlers
- BIS_fnc_callScriptedEventHandler
Examples
Subscribe
[missionNamespace, "localPlayerNearFourArmedRobot", {
hint "Hello there";
}] call BIS_fnc_addScriptedEventHandler;
[missionNamespace, "arsenalOpened", {
hint "Player opened the Arsenal"; // hint message to the player when he opens the Arsenal
}] call BIS_fnc_addScriptedEventHandler;
Trigger
waitUntil { sleep 1; player distance _GG < 10 };
[missionNamespace, "localPlayerNearFourArmedRobot", [player, _GG]] call BIS_fnc_callScriptedEventHandler;
Events
This is a list of all available scripted events that exist through BI's functions and modules. Each event is listed under the system that calls them whether this be a specific function or a module. List last updated for Arma 3 v2.10
| Event namespace | Event name | Event passed parameters |
|---|---|---|
| #### EG Spectator Display | ||
sqf |
"RscDisplayEGSpectator_OnCursorObjectFocused" | sqf |
sqf |
"RscDisplayEGSpectator_OnCursorObjectUnfocused" | sqf |
sqf |
"RscDisplayEGSpectator_OnFocusChanged" | sqf |
sqf |
"RscDisplayEGSpectator_OnUiVisibilityChanged" | sqf |
sqf |
"RscDisplayEGSpectator_MapStateChanged" | sqf |
| #### Player opens pause menu | ||
sqf |
"OnGameInterrupt" | sqf |
| #### Player exits Game Options menu | ||
sqf |
"OnGameOptionsExited" Arma 3 v2.02 | sqf |
| #### Probing Beam (enoch) | ||
sqf |
"probingStarted" | sqf |
sqf |
"probingEnded" | sqf |
| #### Respawn Display | ||
sqf |
"RscDisplayRespawnKeyDown" | sqf |
| #### Saving of the game, scripted or manual | ||
sqf |
"OnSaveGame" | N/A |
| #### teamSwitchedScript.sqs | ||
sqf |
"teamSwitched" | sqf |
| #### BIS_fnc_addScriptedEventHandler | ||
sqf |
"ScriptedEventHandlerAdded" | sqf |
| #### BIS_fnc_animateFlag | ||
sqf |
"FlagAnimationDone" | sqf |
| #### BIS_fnc_arsenal | ||
sqf |
"arsenalPreOpen" Arma 3 v2.08 Fires just before Arsenal display is created | sqf |
sqf |
"arsenalOpened" | sqf- _toggleSpace: Boolean - uiNamespace getVariable ["bis_fnc_arsenal_toggleSpace", false]]; |
sqf |
"arsenalClosed" | sqf- _toggleSpace: Boolean - uiNamespace getVariable ["bis_fnc_arsenal_toggleSpace", false]]; |
| #### BIS_fnc_bleedTickets | ||
sqf |
"dominantSideChanged" | sqf |
| #### BIS_fnc_EGSpectatorCamera | ||
sqf |
"EGSpectator_OnCameraModeChanged" | sqf |
| #### BIS_fnc_garage | ||
sqf |
"garageOpened" | sqf |
sqf |
"garageClosed" | sqf- _toggleSpace: Boolean - uiNamespace getVariable ["bis_fnc_arsenal_toggleSpace", false]]; |
| #### BIS_fnc_initDisplay (Arma 3 v2.04) | ||
sqf |
"OnDisplayRegistered" | sqf |
sqf |
"OnDisplayUnregistered" | sqf |
| #### BIS_fnc_initInspectable | ||
sqf |
"objectInspected" | sqfany data, shown as used by the Leaflets system |
| #### BIS_fnc_initIntelObject | ||
| _object | "intelObjectFound" | sqf |
sqf |
"intelObjectFound" | sqf |
| #### BIS_fnc_kbTellLocal | ||
sqf |
"BIS_fnc_kbTellLocal_played" | sqf |
| #### BIS_fnc_packStaticWeapon | ||
sqf |
"StaticWeaponPacked" | sqf |
| #### BIS_fnc_playVideo | ||
sqf |
"BIS_fnc_playVideo_started" | sqf |
sqf |
"BIS_fnc_playVideo_stopped" | sqf |
| #### BIS_fnc_priorityQueue* system | ||
sqf |
"BIS_onQueue%1Pop" where %1 is ID returned from BIS_fnc_priorityQueue_Init | sqf |
sqf |
"BIS_onQueue%1Push" where %1 is ID returned from BIS_fnc_priorityQueue_Init | sqf |
| #### BIS_fnc_removeAllScriptedEventHandlers | ||
sqf |
"ScriptedEventHandlerRemoved" | sqf |
| #### BIS_fnc_removeScriptedEventHandler | ||
sqf |
"ScriptedEventHandlerRemoved" | sqf |
| #### BIS_fnc_respawnTickets | ||
sqf |
"respawnTicketsExhausted" | sqf |
| #### BIS_fnc_unpackStaticWeapon | ||
sqf |
"StaticWeaponUnpacked" | sqf |
| #### Structures | ||
sqf |
"StructureDamaged" Arma 3 v2.22 | sqf |
sqf |
"StructureDestroyed" Arma 3 v2.22 | sqf |
| #### Module Curator RemoteControl | ||
sqf |
"curatorObjectRemoteControlled" | sqf- _isRemoteControlled is true when entering remote control, false when exiting |
| #### Module End Game | ||
sqf |
"EndGame_OnStageChanged" | sqf |
sqf |
"EndGame_OnStartGameObjectiveCompleted" | sqf |
sqf |
"EndGame_OnObjectiveStateChanged" | sqf |
sqf |
"EndGame_OnObjectiveCompleted" | sqf |
sqf |
"EndGame_OnObjectiveEnded" | sqf |
sqf |
"EndGame_OnDownloadCompleted" | sqf |
sqf |
"EndGame_Ended" | sqf |
sqf |
"onUploadStateChanged" | sqf |
sqf |
"onPickupInfoChanged" | sqf |
| #### Module Game Master (Zeus) | ||
sqf |
"curatorGroupPlaced" | sqf |
sqf |
"curatorObjectPlaced" | sqf |
sqf |
"curatorUnitAssigned" | sqf |
| #### Module Rich Curve Key | ||
| _curKey | "reached" | sqf |
| #### Module Sector | ||
sqf |
"ownerChanged" | sqf |
| #### Module Spawn AI: Sector Tactic | ||
sqf |
"bis_groundSupport_groupSpawned" | sqf |
sqf |
"bis_groundSupport_wiped" | sqf |
sqf |
"bis_groundSupport_inEnemySector" | sqf |
sqf |
"bis_groundSupport_destinationReached" | sqf |
sqf |
"bis_groundSupport_groupTypeChanged" | sqf |
sqf |
"bis_groundSupport_decimated" | sqf |
sqf |
"bis_groundSupport_farFromDestination" | sqf |
sqf |
"bis_groundSupport_needTransport" | sqf |
sqf |
"bis_groundSupport_joined" | sqf |
sqf |
"bis_groundSupport_closeToDestination" | sqf |
sqf |
"bis_groundSupport_needEvac" | sqf |
sqf |
"bis_groundSupport_needAmmo" | sqf |
sqf |
"bis_groundSupport_needSupport" | sqf |
sqf |
"bis_groundSupport_boarded" | sqf |
sqf |
"bis_groundSupport_transportStarted" | sqf |
sqf |
"bis_groundSupport_transportEnded" | sqf |
sqf |
"bis_groundSupport_transportAborted" | sqf |
sqf |
"bis_groundSupport_disembarked" | sqf |
| #### Module Timeline | ||
sqf |
"finished" | sqf |
sqf |
"played" | N/A |
sqf |
"looped" | sqf |
| #### Module Trident | ||
sqf |
"BIS_fnc_moduleTrident_updated" | sqf |
| #### Module Vehicle Respawn | ||
sqf |
"respawn" | sqf |
| #### Spectrum Analyzer Device | ||
sqf |
"SpectrumAnalyzerOpened" | sqf |
sqf |
"SpectrumAnalyzerClosed" | sqf |
Arma 3 Contact Events
Note
This content is exclusive to the Arma 3 Contact Expansion.
- "antennaAdded"
- "antennaDeleted"
- "arsenalPreOpen"
- "behaviourChanged"
- "currentSignalChanged"
- "dangerZoneEntered"
- "dangerZoneExited"
- "diaryRecordSet"
- "dominantSideChanged"
- "gravitPulseHit"
- "gravitPulseRewarded"
- "handleCombat"
- "handleWarningShot"
- "moveToModelSpaceCompleted"
- "puzzleReset"
- "puzzleStepCompleted"
- "puzzleTerminated"
- "refresh"
- "respawnTicketsExhausted"
- "rotationChanged"
- "signalEnded"
- "signalScanned"
- "signalStartedPassive"
- "siteSpawned"
- "taskSet"
- "translationChanged"
- "transmittingEnded"
- "transmittingStarted"
- "wpPatrolEnded"
- "wpPatrolStarted"