Event Scripts: Difference between revisions
m (Some wiki formatting) |
Lou Montana (talk | contribs) m (Text replacement - "[[Script (File)|" to "[[Script File|") |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
__NOEDITSECTION__ | __NOEDITSECTION__ | ||
Event Scripts are [[Script | Event Scripts are [[Script File|scripts]] that 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 Editor: External|mission directory]]. | To use an Event Script, create a file of the given name in the [[Mission Editor: External|mission directory]]. |
Revision as of 18:21, 28 August 2021
Event Scripts are scripts that 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 | ||||||
---|---|---|---|---|---|---|---|
1.00 | 1.75 | 1.00 | 1.00 | 1.50 | 1.00 | 1.00 | |
exit.sqfExecuted when mission is finished (before debriefing screen). In Arma 3, "ended" mission event handler has the same functionality. params ["_endType"];
|
|||||||
exit.sqsExecuted when mission is finished (before debriefing screen). In Arma 3, "ended" mission event handler has the same functionality. params ["_endType"];
|
|||||||
init.sqfExecuted when mission is started (before briefing screen) |
|||||||
init.sqsExecuted when mission is started (before briefing screen) |
|||||||
init3DEN.sqfExecuted when loading a scenario in Eden Editor if the file is present. Useful for executing scenario-specific editor functionality. |
|||||||
initIntro.sqfExecuted when intro, outro win or outro lose is started. |
|||||||
initIntro.sqsExecuted when intro, outro win or outro lose is started. |
|||||||
initJIPcompatible.sqfExecuted 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.sqfExecuted 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.sqfExecuted 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. params ["_playerUnit", "_didJIP"];
|
|||||||
initServer.sqfExecuted only on server when mission is started. See Initialization Order for details about when exactly the script is executed. |
|||||||
missionFlow.fsmExecuted on post-init when mission is started. See BIS_fnc_missionFlow. |
|||||||
onFlare.sqsExecuted when a flare is lit after being fired from grenade launcher. params ["_colorRGB", "_shooter"];
|
|||||||
onPlayerKilled.sqfExecuted when player is killed in singleplayer or in multiplayer mission. params ["_oldUnit", "_killer", "_respawn", "_respawnDelay"];
|
|||||||
onPlayerKilled.sqsExecuted when player is killed in singleplayer or in multiplayer mission with "NONE" respawn type. params ["_player", "_killer"];
|
|||||||
onPlayerRespawn.sqfExecuted 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.sqsExecuted 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.sqsExecuted 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. params ["_player", "_killer", "_seagull"];
|
|||||||
onPlayerRespawnOtherUnit.sqsExecuted when player is killed in multiplayer mission with "GROUP" or "SIDE" respawn type. This script will replace the default respawn sequence. params ["_player", "_killer", "_newUnit"];
|
|||||||
onPlayerResurrect.sqsExecuted 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. params ["_player"];
|
|||||||
pauseOnLoad.sqfExecuted when pause menu is activated. To make it work in MP or Arma 3, useonPauseScript = "pauseOnLoad.sqf";
params ["_pauseMenuDisplay"];
|
|||||||
playerKilledScript.sqsExecuted 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.sqsExecuted 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.sqsExecuted after a Team Switch is done. Not triggered by selectPlayer. params ["_oldUnit", "_newUnit"];
|
Default Scripts Location
Game | Path |
---|---|
1.00 | DTA/scripts.pbo |
1.00 | Ca.pbo/data/scripts |
1.00 | |
1.50 | |
1.00 | functions_f.pbo/scripts |
1.00 | data_h.pbo/data/scripts |