Event Scripts

From Bohemia Interactive Community
Revision as of 17:25, 27 December 2020 by Lou Montana (talk | contribs) (Text replacement - "\{\{Feature[ _]arma3" to "{{Feature|arma3")
Jump to navigation Jump to search


Event Scripts are scripts which are executed upon specific events. Not all event scripts are executed directly by the engine.

To use an Event Script, create a file of the given name in the mission directory.

init* scripts (on)Player* scripts other scripts

Available Scripts

File Present in
Logo A0.png1.00 ofpr version.gif1.75 Logo A1 black.png1.00 Logo A2.png1.00 A2 OA Logo.png1.51 Arma 3 logo black.png1.00 tkoh logo small.png1.00

exit.sqf

Executed when mission is finished (before debriefing screen). In Arma 3, "ended" mission event handler has the same functionality. 

params ["_endType"];
✔ ✔ ✔ ✔

exit.sqs

Executed when mission is finished (before debriefing screen). In Arma 3, "ended" mission event handler has the same functionality. 

params ["_endType"];
✔ ✔ ✔ ✔ ✔ ✔

init.sqf

Executed when mission is started (before briefing screen)

✔ ✔ ✔ ✔ ✔

init.sqs

Executed when mission is started (before briefing screen)

✔ ✔ ✔ ✔ ✔ ✔ ✔

init3DEN.sqf

Executed when loading a scenario in Eden Editor if the file is present. Useful for executing scenario-specific editor functionality.

✔

initIntro.sqf

Executed when intro, outro win or outro lose is started.

✔ ✔ ✔

initIntro.sqs

Executed when intro, outro win or outro lose is started.

✔ ✔ ✔ ✔ ✔ ✔

initJIPcompatible.sqf

Executed locally by Arma 2: Multiplayer Framework when a player joins mission (includes both mission start and JIP). Also executed locally on server at mission start.

✔ ✔

initPlayerLocal.sqf

Executed locally when player joins mission (includes both mission start and JIP). See Initialization Order for details about when exactly the script is executed. 

params ["_player", "_didJIP"];
✔

initPlayerServer.sqf

Executed only on server when a player joins mission (includes both mission start and JIP). See Initialization Order for details about when exactly the script is executed.
This script relies on BIS_fnc_execVM and remoteExec. If CfgRemoteExec's class Functions is set to mode = 0 or 1, the script will never be executed. Therefore, initPlayerServer.sqf should be avoided. 

params ["_playerUnit", "_didJIP"];
✔

initServer.sqf

Executed only on server when mission is started. See Initialization Order for details about when exactly the script is executed.

✔

missionFlow.fsm

Executed on post-init when mission is started. See BIS_fnc_missionFlow.

✔

onFlare.sqs

Executed when a flare is lit after being fired from grenade launcher. 

params ["_colorRGB", "_shooter"];
✔ ✔ ✔ ✔ ✔ ✔

onPlayerKilled.sqf

Executed when player is killed in singleplayer or in multiplayer mission. 

params ["_oldUnit", "_killer", "_respawn", "_respawnDelay"];
✔

onPlayerKilled.sqs

Executed when player is killed in singleplayer or in multiplayer mission with "NONE" respawn type. 

params ["_player", "_killer"];
✔ ✔ ✔ ✔ ✔ ✔

onPlayerRespawn.sqf

Executed locally when player respawns in a multiplayer mission. This event script will also fire at the beginning of a mission if respawnOnStart is 0 or 1, oldUnit will be objNull in this instance. This script will not fire at mission start if respawnOnStart equals -1. 

params ["_newUnit", "_oldUnit", "_respawn", "_respawnDelay"];
✔

onPlayerRespawn.sqs

Executed when player is killed in multiplayer mission with "INSTANT" or "BASE" respawn type. It will not work if dta\scripts\onPlayerRespawn.sqs does not exist. 

params ["_player", "_killer", "_respawnDelay"];
✔

onPlayerRespawnAsSeagull.sqs

Executed when player is killed in multiplayer mission with "SEAGULL" respawn type, or when the type is "GROUP" or "SIDE", but no remaining respawn slots are left. This script will replace the default respawn sequence.

Arma 3
playerRespawnSeagullScript.sqs in Arma 3.
params ["_player", "_killer", "_seagull"];
✔ ✔ ✔ ✔ ✔ ✔ ✔

onPlayerRespawnOtherUnit.sqs

Executed when player is killed in multiplayer mission with "GROUP" or "SIDE" respawn type. This script will replace the default respawn sequence.

Arma 3
playerRespawnOtherUnit.sqs in Arma 3.
params ["_player", "_killer", "_newUnit"];
✔ ✔ ✔ ✔ ✔ ✔ ✔

onPlayerResurrect.sqs

Executed when player is respawned in multiplayer mission with "INSTANT" or "BASE" respawn type. It will not work if dta\scripts\onPlayerResurrect.sqs does not exist.

Arma 3
playerResurrectScript.sqs in Arma 3.
params ["_player"];
✔ ✔

pauseOnLoad.sqf

Executed when pause menu is activated.

To make it work in MP or Arma 3, use 
onPauseScript = "pauseOnLoad.sqf";
in Description.ext 
params ["_pauseMenuDisplay"];
✔ ✔ ✔

playerKilledScript.sqs

Executed locally when player is killed in singleplayer or in multiplayer mission with "NONE" respawn type. Overrides default behavior of mission death screen in single player. Game may become unplayable if not scripted correctly. Avoid use if not experienced with this script. 

params ["_player", "_killer"];
? ? ? ? ? ✔ ?

playerRespawnScript.sqs

Executed locally and immediately when player is killed in multiplayer mission with "BASE" or "INSTANT" respawn type. Overrides default behavior of multiplayer respawn. Game may become unplayable if not scripted correctly. Avoid use if not experienced with this script. 

params ["_player", "_killer", "_respawnDelay"];
? ? ? ? ? ✔ ?

teamSwitchScript.sqs

Executed after a Team Switch is done. Not triggered by selectPlayer. 

params ["_oldUnit", "_newUnit"];
✔
ⓘ
Additional init scripts can be executed using functions with preInit or postInit attribute.


Default scripts location

Game Path
Logo A0.png1.00 DTA/scripts.pbo
Logo A1 black.png1.00 Ca.pbo/data/scripts
Logo A2.png1.00
A2 OA Logo.png1.51
Arma 3 logo black.png1.00 functions_f.pbo/scripts
tkoh logo small.png1.00 data_h.pbo/data/scripts


See also

Retrieved from "https://community.bistudio.com/wiki?title=Event_Scripts&oldid=173108"