Event Scripts

From Bohemia Interactive Community
Revision as of 09:56, 22 October 2013 by Str (talk | contribs)
Jump to navigation Jump to search

Event scripts are scripts which are executed by the game engine upon specific events.

To use an event script, create a file of given name in the mission directory.

Available Scripts

File Description Arguments ofp 1.00.gif ofpr 1.75.gif arma 1.00.gif arma2 1.00.gif arma2oa 1.51.gif arma3 0.50.gif TKOH 1.00.gif
init.sqs Executed when mission is started (before briefing screen)
init.sqf Executed when mission is started (before briefing screen)
initIntro.sqf Executed when intro, outro win or outro lose is started.
exit.sqs Executed when mission is finished (before debriefing screen). In Arma 3, "ended" mission event handler has the same functionality. [endType:String]
onFlare.sqs Executed when a flare is lit after being fired from grenade launcher. [colorRGB:Array,shooter:Object]
pauseOnLoad.sqf Executed when pause menu is activated.

To make it work in MP, use onPauseScript = "myScript.sqf" in description.ext

[pauseMenuDisplay:Display]
onPlayerKilled.sqs Executed when player is killed in singleplayer or in multiplayer mission with "NONE" respawn type. [player:Object, killer:Object]
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. [player:Object, killer:Object, seagull:Object]
onPlayerRespawnOtherUnit.sqs Executed when player is killed in multiplayer mission with "GROUP" or "SIDE" respawn type. This script will replace the default respawn sequence. [player:Object, killer:Object, newPlayer:Object]


See also