Scripted Event Handlers – Arma 3

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Some wiki formatting)
Line 16: Line 16:


== Examples ==
== Examples ==
=== Create ===
<sqf>
waitUntil { sleep 1; player distance _GG < 10 };
[missionNamespace, "localPlayerNearFourArmedRobot", [player, _GG]] call BIS_fnc_callScriptedEventHandler;
</sqf>


=== Subscribe ===
=== Subscribe ===
Line 36: Line 29:
hint "Player opened the Arsenal"; // hint message to the player when he opens the Arsenal
hint "Player opened the Arsenal"; // hint message to the player when he opens the Arsenal
}] call BIS_fnc_addScriptedEventHandler;
}] call BIS_fnc_addScriptedEventHandler;
</sqf>
=== Trigger ===
<sqf>
waitUntil { sleep 1; player distance _GG < 10 };
[missionNamespace, "localPlayerNearFourArmedRobot", [player, _GG]] call BIS_fnc_callScriptedEventHandler;
</sqf>
</sqf>


Line 44: Line 44:
Each event is listed under the system that calls them whether this be a specific function or a module. List last updated for {{GVI|arma3|2.10}}
Each event is listed under the system that calls them whether this be a specific function or a module. List last updated for {{GVI|arma3|2.10}}


{| class="wikitable"
{| class="wikitable align-left"
! Event namespace
! Event namespace
! Event name
! Event name
! Event passed parameters
! Event passed parameters


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== EG Spectator Display ===
=== EG Spectator Display ===
Line 73: Line 73:
| <sqf>params ["_isMapVisible"];</sqf>
| <sqf>params ["_isMapVisible"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== Player opens pause menu ===
=== Player opens pause menu ===
Line 81: Line 81:
| <sqf>params ["_display"];</sqf>
| <sqf>params ["_display"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== Player exits Game Options menu ===
=== Player exits Game Options menu ===
Line 89: Line 89:
| <sqf>params ["_okButtonPressed"];</sqf>
| <sqf>params ["_okButtonPressed"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== Probing Beam (enoch) ===
=== Probing Beam (enoch) ===
Line 101: Line 101:
| <sqf>params ["_data", "_isEnded"];</sqf>
| <sqf>params ["_data", "_isEnded"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== Respawn Display ===
=== Respawn Display ===
Line 109: Line 109:
| <sqf>params ["_display", "_keyCode", "_shift", "_ctrl", "_alt"];</sqf>
| <sqf>params ["_display", "_keyCode", "_shift", "_ctrl", "_alt"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== Saving of the game, scripted or manual ===
=== Saving of the game, scripted or manual ===
Line 117: Line 117:
| {{n/a}}
| {{n/a}}


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[Event Scripts#teamSwitchedScript.sqs|teamSwitchedScript.sqs]] ===
=== [[Event Scripts#teamSwitchedScript.sqs|teamSwitchedScript.sqs]] ===
Line 125: Line 125:
| <sqf>params ["_originalUnit", "_switchToUnit"];</sqf>
| <sqf>params ["_originalUnit", "_switchToUnit"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[BIS_fnc_addScriptedEventHandler]] ===
=== [[BIS_fnc_addScriptedEventHandler]] ===
Line 133: Line 133:
| <sqf>params ["_namespace", "_name", "_handlerID"];</sqf>
| <sqf>params ["_namespace", "_name", "_handlerID"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[BIS_fnc_animateFlag]] ===
=== [[BIS_fnc_animateFlag]] ===
Line 141: Line 141:
| <sqf>params ["_flag", "_phaseEnd"];</sqf>
| <sqf>params ["_flag", "_phaseEnd"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[BIS_fnc_arsenal]] ===
=== [[BIS_fnc_arsenal]] ===
Line 159: Line 159:
* _toggleSpace: [[Boolean]] - <sqf inline>uiNamespace getVariable ["bis_fnc_arsenal_toggleSpace", false]];</sqf>
* _toggleSpace: [[Boolean]] - <sqf inline>uiNamespace getVariable ["bis_fnc_arsenal_toggleSpace", false]];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[BIS_fnc_bleedTickets]] ===
=== [[BIS_fnc_bleedTickets]] ===
Line 167: Line 167:
| <sqf>params ["_dominantSide", "_dominantSideOld", "_sides"];</sqf>
| <sqf>params ["_dominantSide", "_dominantSideOld", "_sides"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[BIS_fnc_EGSpectatorCamera]] ===
=== [[BIS_fnc_EGSpectatorCamera]] ===
Line 175: Line 175:
| <sqf>params ["_newMode"];</sqf>
| <sqf>params ["_newMode"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[BIS_fnc_garage]] ===
=== [[BIS_fnc_garage]] ===
Line 188: Line 188:
* _toggleSpace: [[Boolean]] - <sqf inline>uiNamespace getVariable ["bis_fnc_arsenal_toggleSpace", false]];</sqf>
* _toggleSpace: [[Boolean]] - <sqf inline>uiNamespace getVariable ["bis_fnc_arsenal_toggleSpace", false]];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
{{ArgTitle|3|[[BIS_fnc_initDisplay]]|{{GVI|arma3|2.04}}}}
{{ArgTitle|3|[[BIS_fnc_initDisplay]]|{{GVI|arma3|2.04}}}}
Line 200: Line 200:
| <sqf>params ["_display", "_class"];</sqf>
| <sqf>params ["_display", "_class"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[BIS_fnc_initInspectable]] ===
=== [[BIS_fnc_initInspectable]] ===
Line 209: Line 209:
any data, shown as used by the [[Arma 3: Leaflets|Leaflets]] system
any data, shown as used by the [[Arma 3: Leaflets|Leaflets]] system


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[BIS_fnc_initIntelObject]] ===
=== [[BIS_fnc_initIntelObject]] ===
Line 221: Line 221:
| <sqf>params ["_curator", "_foundBy", "_object"];</sqf>
| <sqf>params ["_curator", "_foundBy", "_object"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[BIS_fnc_kbTellLocal]] ===
=== [[BIS_fnc_kbTellLocal]] ===
Line 229: Line 229:
| <sqf>params ["_from", "_to", "_sentence", "_channel"];</sqf>
| <sqf>params ["_from", "_to", "_sentence", "_channel"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[BIS_fnc_packStaticWeapon]] ===
=== [[BIS_fnc_packStaticWeapon]] ===
Line 237: Line 237:
| <sqf>params ["_group", "_leader", "_gunner", "_assistant", "_weaponBag", "_baseBag"];</sqf>
| <sqf>params ["_group", "_leader", "_gunner", "_assistant", "_weaponBag", "_baseBag"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[BIS_fnc_playVideo]] ===
=== [[BIS_fnc_playVideo]] ===
Line 249: Line 249:
| <sqf>params ["_video"];</sqf>
| <sqf>params ["_video"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== BIS_fnc_priorityQueue* system ===
=== BIS_fnc_priorityQueue* system ===
Line 261: Line 261:
| <sqf>params ["_handle"];</sqf>
| <sqf>params ["_handle"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[BIS_fnc_removeAllScriptedEventHandlers]] ===
=== [[BIS_fnc_removeAllScriptedEventHandlers]] ===
Line 269: Line 269:
| <sqf>params ["_namespace", "_name", "_handlerID"];</sqf>
| <sqf>params ["_namespace", "_name", "_handlerID"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[BIS_fnc_removeScriptedEventHandler]] ===
=== [[BIS_fnc_removeScriptedEventHandler]] ===
Line 277: Line 277:
| <sqf>params ["_namespace", "_name", "_handlerID"];</sqf>
| <sqf>params ["_namespace", "_name", "_handlerID"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[BIS_fnc_respawnTickets]] ===
=== [[BIS_fnc_respawnTickets]] ===
Line 285: Line 285:
| <sqf>params ["_target"];</sqf>
| <sqf>params ["_target"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== [[BIS_fnc_unpackStaticWeapon]] ===
=== [[BIS_fnc_unpackStaticWeapon]] ===
Line 293: Line 293:
| <sqf>params ["_group", "_leader", "_gunner", "_assistant", "_weapon"];</sqf>
| <sqf>params ["_group", "_leader", "_gunner", "_assistant", "_weapon"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== Module Curator RemoteControl ===
=== Module Curator RemoteControl ===
Line 302: Line 302:
* _isRemoteControlled is [[true]] when entering remote control, [[false]] when exiting
* _isRemoteControlled is [[true]] when entering remote control, [[false]] when exiting


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== Module End Game ===
=== Module End Game ===
Line 342: Line 342:
| <sqf>params ["_BIS_hvt_pickupInfo"];</sqf>
| <sqf>params ["_BIS_hvt_pickupInfo"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== Module Game Master (Zeus) ===
=== Module Game Master (Zeus) ===
Line 358: Line 358:
| <sqf>params ["_curator", "_player"];</sqf>
| <sqf>params ["_curator", "_player"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== Module Rich Curve Key ===
=== Module Rich Curve Key ===
Line 366: Line 366:
| <sqf>params ["_curKey"];</sqf>
| <sqf>params ["_curKey"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== Module Sector ===
=== Module Sector ===
Line 374: Line 374:
| <sqf>params ["_sector", "_owner", "_ownerOld"];</sqf>
| <sqf>params ["_sector", "_owner", "_ownerOld"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== Module Spawn AI: Sector Tactic ===
=== Module Spawn AI: Sector Tactic ===
Line 450: Line 450:
| <sqf>params ["_bis_groundSupport_disembarked", "_group", "_transport"];</sqf>
| <sqf>params ["_bis_groundSupport_disembarked", "_group", "_transport"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== Module Timeline ===
=== Module Timeline ===
Line 466: Line 466:
| <sqf>params ["_timeline"];</sqf>
| <sqf>params ["_timeline"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== Module Trident ===
=== Module Trident ===
Line 474: Line 474:
| <sqf>params ["_sideA", "_sideB", "_areFriendly"];</sqf>
| <sqf>params ["_sideA", "_sideB", "_areFriendly"];</sqf>


|- class="align-left"
|-
! colspan="3" |
! colspan="3" |
=== Module Vehicle Respawn ===
=== Module Vehicle Respawn ===

Revision as of 16:37, 10 June 2023

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


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 logo black.png2.10

Event namespace Event name Event passed parameters

EG Spectator Display

missionNamespace
 "RscDisplayEGSpectator_OnCursorObjectFocused"
params ["_object"];
missionNamespace
 "RscDisplayEGSpectator_OnCursorObjectUnfocused"
params ["_object"];
missionNamespace
 "RscDisplayEGSpectator_OnFocusChanged"
params ["_newFocus"];
missionNamespace
 "RscDisplayEGSpectator_OnUiVisibilityChanged"
params ["_isVisible"];
missionNamespace
 "RscDisplayEGSpectator_MapStateChanged"
params ["_isMapVisible"];

Player opens pause menu

missionNamespace
 "OnGameInterrupt"
params ["_display"];

Player exits Game Options menu

missionNamespace
 "OnGameOptionsExited" Arma 3 logo black.png2.02
params ["_okButtonPressed"];

Probing Beam (enoch)

missionNamespace
 "probingStarted"
params ["_cursorTarget", "_data"];
missionNamespace
 "probingEnded"
params ["_data", "_isEnded"];

Respawn Display

missionNamespace
 "RscDisplayRespawnKeyDown"
params ["_display", "_keyCode", "_shift", "_ctrl", "_alt"];

Saving of the game, scripted or manual

missionNamespace
 "OnSaveGame" N/A

teamSwitchedScript.sqs

missionNamespace
 "teamSwitched"
params ["_originalUnit", "_switchToUnit"];

BIS_fnc_addScriptedEventHandler

missionNamespace
 "ScriptedEventHandlerAdded"
params ["_namespace", "_name", "_handlerID"];

BIS_fnc_animateFlag

_flag
 "FlagAnimationDone"
params ["_flag", "_phaseEnd"];

BIS_fnc_arsenal

missionNamespace
 "arsenalPreOpen" Arma 3 logo black.png2.08 Fires just before Arsenal display is created
params ["_missionDisplay", "_center"];
missionNamespace
 "arsenalOpened"
params ["_display", "_toggleSpace"];
missionNamespace
 "arsenalClosed"
params ["_displayNull", "_toggleSpace"];

BIS_fnc_bleedTickets

missionNamespace
 "dominantSideChanged"
params ["_dominantSide", "_dominantSideOld", "_sides"];

BIS_fnc_EGSpectatorCamera

missionNamespace
 "EGSpectator_OnCameraModeChanged"
params ["_newMode"];

BIS_fnc_garage

missionNamespace
 "garageOpened"
params ["_display", "_toggleSpace"];
missionNamespace
 "garageClosed"
params ["_displayNull", "_toggleSpace"];
missionNamespace
 "OnDisplayRegistered"
params ["_display", "_class"];
missionNamespace
 "OnDisplayUnregistered"
params ["_display", "_class"];

BIS_fnc_initInspectable

missionNamespace
 "objectInspected"
params ["_object", "_texture", "_text", "_sound", "_textureRatio"];

any data, shown as used by the Leaflets system

BIS_fnc_initIntelObject

_object "intelObjectFound"
params ["_object", "_foundBy"];
_curator
 "intelObjectFound"
params ["_curator", "_foundBy", "_object"];

BIS_fnc_kbTellLocal

missionNamespace
 "BIS_fnc_kbTellLocal_played"
params ["_from", "_to", "_sentence", "_channel"];

BIS_fnc_packStaticWeapon

_group
 "StaticWeaponPacked"
params ["_group", "_leader", "_gunner", "_assistant", "_weaponBag", "_baseBag"];

BIS_fnc_playVideo

missionNamespace
 "BIS_fnc_playVideo_started"
params ["_video"];
missionNamespace
 "BIS_fnc_playVideo_stopped"
params ["_video"];

BIS_fnc_priorityQueue* system

missionNamespace
 "BIS_onQueue%1Pop" where %1 is ID returned from BIS_fnc_priorityQueue_Init
params ["_handle"];
missionNamespace
 "BIS_onQueue%1Push" where %1 is ID returned from BIS_fnc_priorityQueue_Init
params ["_handle"];

BIS_fnc_removeAllScriptedEventHandlers

missionNamespace
 "ScriptedEventHandlerRemoved"
params ["_namespace", "_name", "_handlerID"];

BIS_fnc_removeScriptedEventHandler

missionNamespace
 "ScriptedEventHandlerRemoved"
params ["_namespace", "_name", "_handlerID"];

BIS_fnc_respawnTickets

missionNamespace
 "respawnTicketsExhausted"
params ["_target"];

BIS_fnc_unpackStaticWeapon

_group
 "StaticWeaponUnpacked"
params ["_group", "_leader", "_gunner", "_assistant", "_weapon"];

Module Curator RemoteControl

_curator
 "curatorObjectRemoteControlled"
params ["_curator", "_player", "_unit", "_isRemoteControlled"];
  • _isRemoteControlled is true when entering remote control, false when exiting

Module End Game

missionNamespace
 "EndGame_OnStageChanged"
params ["_stage", "_side"];
missionNamespace
 "EndGame_OnStartGameObjectiveCompleted"
params ["_side"];
missionNamespace
 "EndGame_OnObjectiveStateChanged"
params ["_objective", "_side", "_newState"];
missionNamespace
 "EndGame_OnObjectiveCompleted"
params ["_objective"];
missionNamespace
 "EndGame_OnObjectiveEnded"
params ["_objective"];
missionNamespace
 "EndGame_OnDownloadCompleted"
params ["_side", "_isUpload"];
missionNamespace
 "EndGame_Ended"
params ["_winnerSide", "_loserSide", "_isDraw"];
missionNamespace
 "onUploadStateChanged"
params ["_side"]; // can be nil
missionNamespace
 "onPickupInfoChanged"
params ["_BIS_hvt_pickupInfo"];

Module Game Master (Zeus)

_curator
 "curatorGroupPlaced"
params ["_group"];
_curator
 "curatorObjectPlaced"
params ["_object"];
_curator
 "curatorUnitAssigned"
params ["_curator", "_player"];

Module Rich Curve Key

_curKey "reached"
params ["_curKey"];

Module Sector

_sector
 "ownerChanged"
params ["_sector", "_owner", "_ownerOld"];

Module Spawn AI: Sector Tactic

missionNamespace
 "bis_groundSupport_groupSpawned"
params ["_bis_groundSupport_groupSpawned", "_group", "_side"];
missionNamespace
 "bis_groundSupport_wiped"
params ["_bis_groundSupport_wiped", "_group"];
missionNamespace
 "bis_groundSupport_inEnemySector"
params ["_bis_groundSupport_inEnemySector", "_group"];
missionNamespace
 "bis_groundSupport_destinationReached"
params ["_bis_groundSupport_destinationReached", "_group"];
missionNamespace
 "bis_groundSupport_groupTypeChanged"
params ["_bis_groundSupport_groupTypeChanged", "_group", "_type", "_currentType"];
missionNamespace
 "bis_groundSupport_decimated"
params ["_bis_groundSupport_decimated", "_group"];
missionNamespace
 "bis_groundSupport_farFromDestination"
params ["_bis_groundSupport_farFromDestination", "_group"];
missionNamespace
 "bis_groundSupport_needTransport"
params ["_bis_groundSupport_needTransport", "_group"];
missionNamespace
 "bis_groundSupport_joined"
params ["_bis_groundSupport_joined", "_group", "_transportGroup"];
missionNamespace
 "bis_groundSupport_closeToDestination"
params ["_bis_groundSupport_closeToDestination", "_group"];
missionNamespace
 "bis_groundSupport_needEvac"
params ["_bis_groundSupport_needEvac", "_group"];
missionNamespace
 "bis_groundSupport_needAmmo"
params ["_bis_groundSupport_needAmmo", "_group"];
missionNamespace
 "bis_groundSupport_needSupport"
params ["_bis_groundSupport_needSupport", "_group", "_reportedVehicle"];
missionNamespace
 "bis_groundSupport_boarded"
params ["_bis_groundSupport_boarded", "_group", "_transport"];
missionNamespace
 "bis_groundSupport_transportStarted"
params ["_bis_groundSupport_transportStarted", "_group", "_transport"];
missionNamespace
 "bis_groundSupport_transportEnded"
params ["_bis_groundSupport_transportEnded", "_group", "_transport"];
missionNamespace
 "bis_groundSupport_transportAborted"
params ["_bis_groundSupport_transportAborted", "_group", "_transport"];
missionNamespace
 "bis_groundSupport_disembarked"
params ["_bis_groundSupport_disembarked", "_group", "_transport"];

Module Timeline

_timeline
 "finished"
params ["_timeline"];
_timeline
 "played" N/A
_timeline
 "looped"
params ["_timeline"];

Module Trident

missionNamespace
 "BIS_fnc_moduleTrident_updated"
params ["_sideA", "_sideB", "_areFriendly"];

Module Vehicle Respawn

missionNamespace
 "respawn"
params ["_newVeh", "_veh"];
Retrieved from "https://community.bistudio.com/wiki?title=Arma_3:_Scripted_Event_Handlers&oldid=341611"