Event Scripts

From Bohemia Interactive Community
Revision as of 03:03, 22 December 2006 by Hardrock (talk | contribs)
Jump to navigation Jump to search

Event scripts are scripts which are fired by the game engine upon specific events. These scripts can be written in SQS syntax or SQF syntax (Armed Assault only, recommended).

The file extensions of the script depend on the used syntax. If you are using SQS syntax, the file extension is .sqs, else .sqf.

init
Launched when mission is started (before briefing screen).
initIntro (since version 1.50)
Launched when intro is started .
exit (since version 1.50)
Launched when mission is finished (before debriefing screen).
One argument of type Number is passed to the script: The number of game end.
onFlare (since version 1.45)
Launched when illuminating shell is lit.
An array is passed to the script: [[r, g, b], gunner]
r, g, b: Number - the light color
gunner: Object - the unit who fired the flare shell
onPlayerKilled
Launched when the player is killed.
This script replaces the default death sequence. Make sure you place the command enableEndDialog somewhere in your script, as this will then cause the dialog that allows you to load, retry, or quit to appear.