Event Scripts: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<br/>" to "<br>")
m (Some wiki formatting)
 
(60 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Event Scripts]] are [[Script (Handle)|scripts]] which are executed upon specific events. Not all event scripts are executed directly by the engine.<br>
__NOTOC____NOEDITSECTION__
{| class="wikitable float-right"
|+ Default Scripts Location
! Game
! Path
|-
| {{GVI|ofp|1.00}}
| {{hl|DTA/scripts.pbo}}
|-
| {{GVI|arma1|1.00}}
| rowspan="3" | {{hl|Ca.pbo/data/scripts}}
|-
| {{GVI|arma2|1.00}}
|-
| {{GVI|arma2oa|1.50}}
|-
| {{GVI|arma3|1.00}}
| {{hl|functions_f.pbo/scripts}}
|-
| {{GVI|TKOH|1.00}}
| {{hl|data_h.pbo/data/scripts}}
|}
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]].
 
{| class="wikitable valign-top-row-2"
! init* scripts
! (on)Player* scripts
! Other Scripts
|-
| style="padding-right: 2em" |
{{Columns|2|
* {{Link|#init.sqf}}
* {{Link|#init.sqs}}
* {{Link|#init3DEN.sqf}}
* {{Link|#initIntro.sqf}}
* {{Link|#initIntro.sqs}}
* {{Link|#initJIPcompatible.sqf}}
* {{Link|#initPlayerLocal.sqf}}
* {{Link|#initPlayerServer.sqf}}
* {{Link|#initServer.sqf}}
}}
| style="padding-right: 2em" |
{{Columns|2|
* {{Link|#onPlayerKilled.sqf}}
* {{Link|#onPlayerKilled.sqs}}
* {{Link|#onPlayerRespawn.sqf}}
* {{Link|#onPlayerRespawn.sqs}}
* {{Link|#onPlayerRespawnAsSeagull.sqs}}
* {{Link|#onPlayerRespawnOtherUnit.sqs}}
* {{Link|#onPlayerResurrect.sqs}}
* {{Link|#playerKilledScript.sqs}}
* {{Link|#playerRespawnScript.sqs}}
* {{Link|#playerRespawnSeagullScript.sqs}}
* {{Link|#playerRespawnOtherUnit.sqs}}
* {{Link|#playerResurrectScript.sqs}}
 
 
}}
| style="padding-right: 2em" |
* {{Link|#exit.sqf}}
* {{Link|#exit.sqs}}
* {{Link|#missionFlow.fsm}}
* {{Link|#onFlare.sqs}}
* {{Link|#pauseOnLoad.sqf}}
* {{Link|#teamSwitchScript.sqs}}
|}


To use an '''Event Script''', create a file of the given name in the [[Mission_Editor:_External|mission directory]].
{{Feature|informative|
* See [[Initialisation Order]] to learn when initialisation scripts are executed.
* Additional initialisation scripts can be executed using functions with [[Arma 3: Functions Library#Attributes|preInit or postInit]] attribute.
}}




== Available Scripts ==
== Available Scripts ==


{| class="bikitable" style="text-align: center"
{| class="wikitable sortable align-center align-left-col-1"
! rowspan="2" | File
! rowspan="2" style="text-align: center" | File
! rowspan="2" | Description
! rowspan="2" | Arguments
! colspan="7" | Present in
! colspan="7" | Present in
|-
! Details
|- class="sticky-top"
! {{GVI|ofp|1.00}}
! {{GVI|ofp|1.00}}
! {{GVI|ofpr|1.75}}
! {{GVI|ofpr|1.75}}
! {{GVI|arma|1.00}}
! {{GVI|arma1|1.00}}
! {{GVI|arma2|1.00}}
! {{GVI|arma2|1.00}}
! {{GVI|arma2oa|1.50}}
! {{GVI|arma2oa|1.50}}
! {{GVI|arma3|1.00}}
! {{GVI|arma3|1.00}}
! {{GVI|TKOH|1.00}}
! {{GVI|tkoh|1.00}}
 
! Can&nbsp;[[canSuspend|suspend]]
|-
|-
| ''init.sqs''
|
| style="text-align: left" | Executed when mission is started (before briefing screen)
=== exit.sqf ===
|
Executed when mission is finished (before debriefing screen).
| ✔ <!-- OFP -->
In {{arma3}}, see also [[Arma 3: Mission Event Handlers#Ended|"Ended"]] and [[Arma 3: Mission Event Handlers#MPEnded|"MPEnded"]] [[Arma 3: Mission Event Handlers|Mission Event Handlers]].
| ✔ <!-- OFPR -->
<sqf>params ["_endType"];</sqf>
| ✔ <!-- A1 -->
| ✔ <!-- A2 -->
| ✔ <!-- A2OA -->
| ✔ <!-- A3 -->
| ✔ <!-- TKOH -->
 
|-
| ''init.sqf''
| style="text-align: left" | Executed when mission is started (before briefing screen)
|
| <!-- OFP -->
| <!-- OFPR -->
| ✔ <!-- A1 -->
| ✔ <!-- A2 -->
| ✔ <!-- A2OA -->
| ✔ <!-- A3 -->
| ✔ <!-- TKOH -->
 
|-
| ''initIntro.sqs''
| style="text-align: left" | Executed when intro, outro win or outro lose is started.
|
| <!-- OFP -->
| ✔ <!-- OFPR -->
| ✔ <!-- A1 -->
| ✔ <!-- A2 -->
| ✔ <!-- A2OA -->
| ✔ <!-- A3 -->
| ✔ <!-- TKOH -->
 
|-
| ''initIntro.sqf''
| style="text-align: left" | Executed when intro, outro win or outro lose is started.
|
| <!-- OFP -->
| <!-- OFPR -->
| <!-- A1 -->
| <!-- A2 -->
| ✔ <!-- A2OA -->
| ✔ <!-- A3 -->
| ✔ <!-- TKOH -->
 
|-
| ''exit.sqs''
| style="text-align: left" | Executed when mission is finished (before debriefing screen). In Arma 3, "ended" [[addMissionEventHandler|mission event handler]] has the same functionality.
| style="text-align: left" | <syntaxhighlight lang="cpp">params ["_endType"];</syntaxhighlight>
* endType: [[String]]
|  <!-- OFP -->
| ✔ <!-- OFPR -->
| ✔ <!-- A1 -->
| ✔ <!-- A2 -->
| ✔ <!-- A2OA -->
| ✔ <!-- A3 -->
| ✔ <!-- TKOH -->
 
|-
| ''exit.sqf''
| style="text-align: left" | Executed when mission is finished (before debriefing screen). In Arma 3, "ended" [[addMissionEventHandler|mission event handler]] has the same functionality.
| style="text-align: left" | <syntaxhighlight lang="cpp">params ["_endType"];</syntaxhighlight>
* endType: [[String]]
* endType: [[String]]
|  <!-- OFP -->
|  <!-- OFP -->
|  <!-- OFPR -->
|  <!-- OFPR -->
|  <!-- A1 -->
|  <!-- A1 -->
| ✔ <!-- A2 -->
| {{Icon|checked}} <!-- A2 -->
| ✔ <!-- A2OA -->
| {{Icon|checked}} <!-- A2OA -->
| ✔ <!-- A3 -->
| {{Icon|checked}} <!-- A3 -->
| ✔ <!-- TKOH -->
| {{Icon|checked}} <!-- TKOH -->
| {{Icon|checked}} <!-- suspension -->


|-
|-
| ''onFlare.sqs''
|
| style="text-align: left" | Executed when a flare is lit after being fired from grenade launcher.
=== exit.sqs ===
| style="text-align: left" | <syntaxhighlight lang="cpp">params ["_colorRGB", "_shooter"];</syntaxhighlight>
Executed when mission is finished (before debriefing screen).
* colorRGB: [[Color]]
In {{arma3}}, see also [[Arma 3: Mission Event Handlers#Ended|"Ended"]] and [[Arma 3: Mission Event Handlers#MPEnded|"MPEnded"]] [[Arma 3: Mission Event Handlers|Mission Event Handlers]].
* shooter: [[Object]]
<sqf>params ["_endType"];</sqf>
* endType: [[String]]
|  <!-- OFP -->
|  <!-- OFP -->
| ✔ <!-- OFPR -->
| {{Icon|checked}} <!-- OFPR -->
| ✔ <!-- A1 -->
| {{Icon|checked}} <!-- A1 -->
| ✔ <!-- A2 -->
| {{Icon|checked}} <!-- A2 -->
| ✔ <!-- A2OA -->
| {{Icon|checked}} <!-- A2OA -->
| ✔ <!-- A3 -->
| {{Icon|checked}} <!-- A3 -->
| ✔ <!-- TKOH -->
| {{Icon|checked}} <!-- TKOH -->


|-
|-
| ''pauseOnLoad.sqf''
|
| style="text-align: left" | Executed when pause menu is activated.
=== init.sqf ===
 
Executed when mission is started (before briefing screen).
To make it work in MP or Arma 3, use <syntaxhighlight lang="cpp">onPauseScript = "pauseOnLoad.sqf";</syntaxhighlight> in [[Description.ext#onPauseScript|Description.ext]]
| <!-- OFP -->
| style="text-align: left" | <syntaxhighlight lang="cpp">params ["_pauseMenuDisplay"];</syntaxhighlight>
| <!-- OFPR -->
* pauseMenuDisplay: [[Display]]
| {{Icon|checked}} <!-- A1 -->
| <!-- OFP -->
| {{Icon|checked}} <!-- A2 -->
| <!-- OFPR -->
| {{Icon|checked}} <!-- A2OA -->
| <!-- A1 -->
| {{Icon|checked}} <!-- A3 -->
| ✔ <!-- A2 -->
| {{Icon|checked}} <!-- TKOH -->
| ✔ <!-- A2OA -->
| {{Icon|checked}} <!-- suspension -->
| <!-- A3 -->
| ✔ <!-- TKOH -->


|-
|-
| ''onPlayerKilled.sqs''
|
| style="text-align: left" | Executed when player is killed in singleplayer or in multiplayer mission with "NONE" [[Description.ext#respawn|respawn type]].
=== init.sqs ===
| style="text-align: left" | <syntaxhighlight lang="cpp">params ["_player", "_killer"];</syntaxhighlight>
Executed when mission is started (before briefing screen).
* player: [[Object]]
| {{Icon|checked}} <!-- OFP -->
* killer: [[Object]]
| {{Icon|checked}} <!-- OFPR -->
| ✔ <!-- OFP -->
| {{Icon|checked}} <!-- A1 -->
| ✔ <!-- OFPR -->
| {{Icon|checked}} <!-- A2 -->
| ✔ <!-- A1 -->
| {{Icon|checked}} <!-- A2OA -->
| ✔ <!-- A2 -->
| {{Icon|checked}} <!-- A3 -->
| ✔ <!-- A2OA -->
| {{Icon|checked}} <!-- TKOH -->
| <!-- A3 -->
| <!-- suspension -->
| ✔ <!-- TKOH -->


|-
|-
| ''onPlayerRespawnAsSeagull.sqs''
|
| style="text-align: left" | Executed when player is killed in multiplayer mission with "SEAGULL" [[Description.ext#respawn|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.
=== init3DEN.sqf ===
| style="text-align: left" | <syntaxhighlight lang="cpp">params [
Executed when loading a scenario in [[:Category:Eden Editor|Eden Editor]] if the file is present. Useful for executing scenario-specific editor functionality.
"_player",
"_killer",
"_seagull"
];</syntaxhighlight>
* player: [[Object]]
* killer: [[Object]]
* seagull: [[Object]]
| ✔ <!-- OFP -->
| ✔ <!-- OFPR -->
| ✔ <!-- A1 -->
| ✔ <!-- A2 -->
| ✔ <!-- A2OA -->
|  <!-- A3 -->
| ✔ <!-- TKOH -->
 
|-
| ''onPlayerRespawnOtherUnit.sqs''
| style="text-align: left" | Executed when player is killed in multiplayer mission with "GROUP" or "SIDE" [[Description.ext#respawn|respawn type]]. This script will replace the default respawn sequence.
| style="text-align: left" | <syntaxhighlight lang="cpp">params [
"_player",
"_killer",
"_newUnit"
];</syntaxhighlight>
* player: [[Object]]
* killer: [[Object]]
* newUnit: [[Object]]
| ✔ <!-- OFP -->
| ✔ <!-- OFPR -->
| ✔ <!-- A1 -->
| ✔ <!-- A2 -->
| ✔ <!-- A2OA -->
|  <!-- A3 -->
| ✔ <!-- TKOH -->
 
|-
| ''onPlayerRespawn.sqs''
| style="text-align: left" | Executed when player is killed in multiplayer mission with "INSTANT" or "BASE" [[Description.ext#respawn|respawn type]]. It will not work if ''dta\scripts\onPlayerRespawn.sqs'' does not exist.
| style="text-align: left" | <syntaxhighlight lang="cpp">params [
"_player",
"_killer",
"_respawnDelay"
];</syntaxhighlight>
* player: [[Object]]
* killer: [[Object]]
* respawnDelay: [[Number]]
| <!-- OFP -->
| <!-- OFP -->
| ✔ <!-- OFPR -->
| <!-- OFPR -->
| <!-- A1 -->
| <!-- A1 -->
| <!-- A2 -->
| <!-- A2 -->
| <!-- A2OA -->
| <!-- A2OA -->
| <!-- A3 -->
| {{Icon|checked}} <!-- A3 -->
| <!-- TKOH -->
| <!-- TKOH -->
| {{Icon|unchecked}} <!-- suspension -->


|-
|-
| ''onPlayerResurrect.sqs''
|
| style="text-align: left" | Executed when player is respawned in multiplayer mission with "INSTANT" or "BASE" [[Description.ext#respawn|respawn type]]. It will not work if ''dta\scripts\onPlayerResurrect.sqs'' does not exist.
=== initIntro.sqf ===
| style="text-align: left" | <syntaxhighlight lang="cpp">params ["_player"];</syntaxhighlight>
Executed when intro, outro win or outro lose is started.
* player: [[Object]]
{{Feature|arma3|Functional in {{arma3}} only for intro.}}
| <!-- OFP -->
| <!-- OFPR -->
| {{Icon|checked}} <!-- A1 -->
| {{Icon|checked}} <!-- A2 -->
| {{Icon|checked}} <!-- A2OA -->
| {{Icon|checked}} <!-- A3 -->
| {{Icon|checked}} <!-- TKOH -->
| {{Icon|checked}} <!-- suspension -->
 
|-
|
=== initIntro.sqs ===
Executed when intro, outro win or outro lose is started.
{{Feature|arma3|Functional in {{arma3}} only for intro.}}
| <!-- OFP -->
| <!-- OFP -->
| ✔ <!-- OFPR -->
| {{Icon|checked}} <!-- OFPR -->
| <!-- A1 -->
| {{Icon|checked}} <!-- A1 -->
| <!-- A2 -->
| {{Icon|checked}} <!-- A2 -->
| <!-- A2OA -->
| {{Icon|checked}} <!-- A2OA -->
| <!-- A3 -->
| {{Icon|checked}} <!-- A3 -->
| <!-- TKOH -->
| {{Icon|checked}} <!-- TKOH -->
| <!-- suspension -->


|-
|-
| ''initJIPcompatible.sqf''
|
| style="text-align: left" | Executed locally by [[Multiplayer framework]] when a player joins mission (includes both mission start and JIP). Also executed locally on server at mission start.
=== 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.
| <!-- OFP -->
| <!-- OFP -->
| <!-- OFPR -->
| <!-- OFPR -->
| <!-- A1 -->
| <!-- A1 -->
| ✔ <!-- A2 -->
| {{Icon|checked}} <!-- A2 -->
| ✔ <!-- A2OA -->
| {{Icon|checked}} <!-- A2OA -->
| <!-- A3 -->
| <!-- A3 -->
| <!-- TKOH -->
| <!-- TKOH -->


|-
|-
| ''initServer.sqf''
| style="text-align: left" | Executed only on server when mission is started. See [[Initialization Order]] for details about when the script is exactly executed.
|
|
=== initPlayerLocal.sqf ===
Executed locally when player joins mission (includes both mission start and JIP). See [[Initialisation Order]] for details about when exactly the script is executed.
<sqf>params ["_player", "_didJIP"];</sqf>
* player: [[Object]]
* didJIP: [[Boolean]]
| <!-- OFP -->
| <!-- OFP -->
| <!-- OFPR -->
| <!-- OFPR -->
Line 228: Line 211:
| <!-- A2 -->
| <!-- A2 -->
| <!-- A2OA -->
| <!-- A2OA -->
| ✔ <!-- A3 -->
| {{Icon|checked}} <!-- A3 -->
| <!-- TKOH -->
| <!-- TKOH -->
| {{Icon|checked}} <!-- suspension -->


|-
|-
| ''initPlayerServer.sqf''
|
| style="text-align: left" | Executed only on server when a player joins mission (includes both mission start and JIP). See [[Initialization Order]] for details about when the script is exactly executed.<br>
=== initPlayerServer.sqf ===
This script relies on [[BIS_fnc_execVM]] and [[remoteExec]]. If [[CfgRemoteExec]]'s <tt>class Functions</tt> is set to mode = 0 or 1, the script will never be executed. Therefore, initPlayerServer.sqf should be avoided.
Executed only on server when a player joins mission (includes both mission start and JIP). See [[Initialisation Order]] for details about when exactly the script is executed.<br>
| style="text-align: left" | <syntaxhighlight lang="cpp">params ["_playerUnit", "_didJIP"];</syntaxhighlight>
This script relies on [[BIS_fnc_execVM]] and [[remoteExec]]. If [[CfgRemoteExec]]'s {{hl|class Functions}} is set to mode = 0 or 1, the script will never be executed.
Therefore, {{hl|initPlayerServer.sqf}} should be avoided - use {{Link|https://www.reddit.com/r/armadev/comments/8fkitd/initplayerserversqf_therefore_initplayerserversqf/dy5k5pf/|this method}} instead.
<sqf>params ["_playerUnit", "_didJIP"];</sqf>
* playerUnit: [[Object]]
* playerUnit: [[Object]]
* didJIP: [[Boolean]]
* didJIP: [[Boolean]]
Line 243: Line 229:
| <!-- A2 -->
| <!-- A2 -->
| <!-- A2OA -->
| <!-- A2OA -->
| ✔ <!-- A3 -->
| {{Icon|checked}} <!-- A3 -->
| <!-- TKOH -->
| <!-- TKOH -->
| {{Icon|checked}} <!-- suspension -->


|-
|-
| ''init3DEN.sqf''
|
| style="text-align: left" | Executed when loading a scenario in [[Eden Editor]] if the file is present. Useful for executing scenario-specific editor functionality.
=== initServer.sqf ===
|
Executed only on server when mission is started. See [[Initialisation Order]] for details about when exactly the script is executed.
| <!-- OFP -->
| <!-- OFP -->
| <!-- OFPR -->
| <!-- OFPR -->
Line 255: Line 242:
| <!-- A2 -->
| <!-- A2 -->
| <!-- A2OA -->
| <!-- A2OA -->
| ✔ <!-- A3 -->
| {{Icon|checked}} <!-- A3 -->
| <!-- TKOH -->
| <!-- TKOH -->
| {{Icon|checked}} <!-- suspension -->


|-
|-
| ''initPlayerLocal.sqf''
|
| style="text-align: left" | Executed locally when player joins mission (includes both mission start and JIP). See [[Functions_Library_(Arma_3)#Initialization_Order|initialization order]] for details about when the script is exactly executed.
=== missionFlow.fsm ===
| style="text-align: left" | <syntaxhighlight lang="cpp">params ["_player", "_didJIP"];</syntaxhighlight>
Executed on post-init when mission is started. See [[BIS_fnc_missionFlow]].
* player: [[Object]]
* didJIP: [[Boolean]]
| <!-- OFP -->
| <!-- OFP -->
| <!-- OFPR -->
| <!-- OFPR -->
Line 269: Line 255:
| <!-- A2 -->
| <!-- A2 -->
| <!-- A2OA -->
| <!-- A2OA -->
| ✔ <!-- A3 -->
| {{Icon|checked}} <!-- A3 -->
| <!-- TKOH -->
| <!-- TKOH -->
| <!-- suspension -->


|-
|-
| ''onPlayerKilled.sqf''
|
| style="text-align: left" | Executed when player is [[Arma_3_Respawn#Files|killed]] in singleplayer or in multiplayer mission.
=== onFlare.sqs ===
| style="text-align: left" | <syntaxhighlight lang="cpp">params [
Executed when a flare is lit after being fired from grenade launcher.
"_oldUnit",
<sqf>params ["_colorRGB", "_shooter", "_projectile", "_instigator"];</sqf>
"_killer",
* colorRGB: [[Color|Color (RGBA)]]
"_respawn",
* shooter: [[Object]]
"_respawnDelay"
* {{GVI|arma3|2.10|size= 0.75}} projectile: [[Object]] - the flare itself
];</syntaxhighlight>
* {{GVI|arma3|2.18|size= 0.75}} instigator: [[Object]] - shot instigator
|  <!-- OFP -->
| {{Icon|checked}} <!-- OFPR -->
| {{Icon|checked}} <!-- A1 -->
| {{Icon|checked}} <!-- A2 -->
| {{Icon|checked}} <!-- A2OA -->
| {{Icon|checked}} <!-- A3 -->
| {{Icon|checked}} <!-- TKOH -->
| <!-- suspension -->
 
|-
|
=== onPlayerKilled.sqf ===
Executed when player is [[Arma 3: Respawn#Files|killed]] in singleplayer or in multiplayer mission.
<sqf>params ["_oldUnit", "_killer", "_respawn", "_respawnDelay"];</sqf>
* oldUnit: [[Object]]
* oldUnit: [[Object]]
* killer: [[Object]]
* killer: [[Object]]
* respawn: ''[[String]]?''
* respawnType: [[Number]]
* respawnDelay: [[Number]]
* respawnDelay: [[Number]]
|  <!-- OFP -->
|  <!-- OFP -->
Line 290: Line 291:
|  <!-- A2 -->
|  <!-- A2 -->
|  <!-- A2OA -->
|  <!-- A2OA -->
| ✔ <!-- A3 -->
| {{Icon|checked}} <!-- A3 -->
|  <!-- TKOH -->
|  <!-- TKOH -->
| {{Icon|checked}} <!-- suspension -->
|-
|
=== onPlayerKilled.sqs ===
Executed when player is killed in singleplayer or in multiplayer mission with "NONE" [[Description.ext#respawn|respawn type]].
<sqf>params ["_player", "_killer"];</sqf>
* player: [[Object]]
* killer: [[Object]]
| {{Icon|checked}} <!-- OFP -->
| {{Icon|checked}} <!-- OFPR -->
| {{Icon|checked}} <!-- A1 -->
| {{Icon|checked}} <!-- A2 -->
| {{Icon|checked}} <!-- A2OA -->
| {{Icon|unchecked}} <!-- A3 -->
| {{Icon|checked}} <!-- TKOH -->
| <!-- suspension -->


|-
|-
| ''onPlayerRespawn.sqf''
|
| style="text-align: left" | Executed locally when player [[Arma_3_Respawn#Files|respawns]] in a multiplayer mission. This event script will also fire at the beginning of a mission if [[Description.ext#respawnOnStart|respawnOnStart]] is 0 or 1, oldUnit will be [[objNull]] in this instance. This script will not fire at mission start if [[Description.ext#respawnOnStart|respawnOnStart]] equals -1.
=== onPlayerRespawn.sqf ===
| style="text-align: left" | <syntaxhighlight lang="cpp">params [
Executed locally when player [[Arma 3: Respawn#Files|respawns]] in a multiplayer mission.
"_newUnit",
This event script will also fire at the beginning of a mission if [[Description.ext#respawnOnStart|respawnOnStart]] is 0 or 1, oldUnit will be [[objNull]] in this instance.
"_oldUnit",
This script will not fire at mission start if [[Description.ext#respawnOnStart|respawnOnStart]] equals -1.
"_respawn",
<sqf>params ["_newUnit", "_oldUnit", "_respawn", "_respawnDelay"];</sqf>
"_respawnDelay"
];</syntaxhighlight>
* newUnit: [[Object]]
* newUnit: [[Object]]
* oldUnit: [[Object]]
* oldUnit: [[Object]]
* respawn: ''[[String]]?''
* respawnType: [[Number]]
* respawnDelay: [[Number]]
* respawnDelay: [[Number]]
|  <!-- OFP -->
|  <!-- OFP -->
Line 311: Line 327:
|  <!-- A2 -->
|  <!-- A2 -->
|  <!-- A2OA -->
|  <!-- A2OA -->
| ✔ <!-- A3 -->
| {{Icon|checked}} <!-- A3 -->
|  <!-- TKOH -->
|  <!-- TKOH -->
| {{Icon|checked}} <!-- suspension -->


|-
|-
| ''playerKilledScript.sqs''
|
| style="text-align: left" | Executed locally when player is killed in singleplayer or in multiplayer mission with "NONE" [[Description.ext#respawn|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.  
=== onPlayerRespawn.sqs ===
| style="text-align: left" | <syntaxhighlight lang="cpp">params ["_player", "_killer"];</syntaxhighlight>
Executed when player is killed in multiplayer mission with "INSTANT" or "BASE" [[Description.ext#respawn|respawn type]]. It will not work if ''dta\scripts\onPlayerRespawn.sqs'' does not exist.
<sqf>params ["_player", "_killer", "_respawnDelay"];</sqf>
* player: [[Object]]
* player: [[Object]]
* killer: [[Object]]
* killer: [[Object]]
| ? <!-- OFP --><!-- Untested -->
* respawnDelay: [[Number]]
| ? <!-- OFPR --><!-- Untested -->
| <!-- OFP -->
| ? <!-- A1 --><!-- Untested -->
| {{Icon|checked}} <!-- OFPR -->
| ? <!-- A2 --><!-- Untested -->
| <!-- A1 -->
| ? <!-- A2OA --><!-- Untested -->
| <!-- A2 -->
| ✔ <!-- A3 -->
| <!-- A2OA -->
| ? <!-- TKOH --><!-- Untested -->
| <!-- A3 -->
| <!-- TKOH -->
| <!-- suspension -->


|-
|-
| ''playerRespawnScript.sqs''
|
| style="text-align: left" | Executed locally and immediately when player is killed in multiplayer mission with "BASE" or "INSTANT" [[Description.ext#respawn|respawn type]]. Overrides default behavior of multiplayer respawn. Game may become unplayable if not scripted correctly. Avoid use if not experienced with this script.  
=== onPlayerRespawnAsSeagull.sqs ===
| style="text-align: left" | <syntaxhighlight lang="cpp">params [
Executed when player is killed in multiplayer mission with "SEAGULL" [[Description.ext#respawn|respawn type]], or when the type is "GROUP" or "SIDE", but no remaining respawn slots are left.
"_player",
This script will replace the default respawn sequence.
"_killer",
{{Feature|arma3|{{hl|onPlayerRespawnAsSeagull.sqs}} was renamed to {{hl|{{Link|#playerRespawnSeagullScript.sqs}}}} in {{arma3}}.}}
"_respawnDelay"
<sqf>params ["_player", "_killer", "_seagull"];</sqf>
];</syntaxhighlight>
* player: [[Object]]
* killer: [[Object]]
* seagull: [[Object]]
| {{Icon|checked}} <!-- OFP -->
| {{Icon|checked}} <!-- OFPR -->
| {{Icon|checked}} <!-- A1 -->
| {{Icon|checked}} <!-- A2 -->
| {{Icon|checked}} <!-- A2OA -->
| {{Icon|unchecked}} <!-- A3 -->
| {{Icon|checked}} <!-- TKOH -->
| <!-- suspension -->
 
|-
|
=== onPlayerRespawnOtherUnit.sqs ===
Executed when player is killed in multiplayer mission with "GROUP" or "SIDE" [[Description.ext#respawn|respawn type]]. This script will replace the default respawn sequence.
{{Feature|arma3|{{hl|onPlayerRespawnOtherUnit.sqs}} was renamed to {{hl|{{Link|#playerRespawnOtherUnit.sqs}}}} in {{arma3}}.}}
<sqf>params ["_player", "_killer", "_newUnit"];</sqf>
* player: [[Object]]
* killer: [[Object]]
* newUnit: [[Object]]
| {{Icon|checked}} <!-- OFP -->
| {{Icon|checked}} <!-- OFPR -->
| {{Icon|checked}} <!-- A1 -->
| {{Icon|checked}} <!-- A2 -->
| {{Icon|checked}} <!-- A2OA -->
| {{Icon|unchecked}} <!-- A3 -->
| {{Icon|checked}} <!-- TKOH -->
| <!-- suspension -->
 
|-
|
=== onPlayerResurrect.sqs ===
Executed when player is respawned in multiplayer mission with "INSTANT" or "BASE" [[Description.ext#respawn|respawn type]]. It will not work if {{hl|dta\scripts\onPlayerResurrect.sqs}} does not exist.
{{Feature|arma3|{{hl|onPlayerResurrect.sqs}} was renamed to {{hl|{{Link|#playerResurrectScript.sqs}}}} in {{arma3}}.}}
<sqf>params ["_player"];</sqf>
* player: [[Object]]
| <!-- OFP -->
| {{Icon|checked}} <!-- OFPR -->
| <!-- A1 -->
| <!-- A2 -->
| <!-- A2OA -->
| {{Icon|unchecked}} <!-- A3 -->
| <!-- TKOH -->
| <!-- suspension -->
 
|-
|
=== pauseOnLoad.sqf ===
Executed when pause menu is activated.
 
To make it work in MP or {{arma3}}, use <syntaxhighlight lang="cpp" inline>onPauseScript = "pauseOnLoad.sqf";</syntaxhighlight> in [[Description.ext#onPauseScript|Description.ext]].
<sqf>params ["_pauseMenuDisplay"];</sqf>
* pauseMenuDisplay: [[Display]]
|  <!-- OFP -->
|  <!-- OFPR -->
|  <!-- A1 -->
| {{Icon|checked}} <!-- A2 -->
| {{Icon|checked}} <!-- A2OA -->
|  <!-- A3 -->
| {{Icon|checked}} <!-- TKOH -->
| {{Icon|checked}} <!-- suspension -->
 
|-
|
=== playerKilledScript.sqs ===
Executed locally when player is killed in singleplayer or in multiplayer mission with "NONE" [[Description.ext#respawn|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.
<sqf>params ["_player", "_killer"];</sqf>
* player: [[Object]]
* killer: [[Object]]
| {{Icon|unknown}} <!-- OFP --><!-- Untested -->
| {{Icon|unknown}} <!-- OFPR --><!-- Untested -->
| {{Icon|unknown}} <!-- A1 --><!-- Untested -->
| {{Icon|unknown}} <!-- A2 --><!-- Untested -->
| {{Icon|unknown}} <!-- A2OA --><!-- Untested -->
| {{Icon|checked}} <!-- A3 -->
| {{Icon|unknown}} <!-- TKOH --><!-- Untested -->
| <!-- suspension -->
 
|-
|
=== playerRespawnScript.sqs ===
Executed locally and immediately when player is killed in multiplayer mission with "BASE" or "INSTANT" [[Description.ext#respawn|respawn type]].
Overrides default behavior of multiplayer respawn. Game may become unplayable if not scripted correctly. Avoid use if not experienced with this script.
<sqf>params ["_player", "_killer", "_respawnDelay"];</sqf>
* player: [[Object]]
* player: [[Object]]
* killer: [[Object]]
* killer: [[Object]]
* respawnDelay: [[Number]]
* respawnDelay: [[Number]]
| ? <!-- OFP --><!-- Untested -->
| {{Icon|unknown}} <!-- OFP --><!-- Untested -->
| ? <!-- OFPR --><!-- Untested -->
| {{Icon|unknown}} <!-- OFPR --><!-- Untested -->
| ? <!-- A1 --><!-- Untested -->
| {{Icon|unknown}} <!-- A1 --><!-- Untested -->
| ? <!-- A2 --><!-- Untested -->
| {{Icon|unknown}} <!-- A2 --><!-- Untested -->
| ? <!-- A2OA --><!-- Untested -->
| {{Icon|unknown}} <!-- A2OA --><!-- Untested -->
| ✔ <!-- A3 -->
| {{Icon|checked}} <!-- A3 -->
| ? <!-- TKOH --><!-- Untested -->
| {{Icon|unknown}} <!-- TKOH --><!-- Untested -->
|}
| <!-- suspension -->
 
|-
|
=== playerRespawnSeagullScript.sqs ===
Executed when player is killed in multiplayer mission with "SEAGULL" [[Description.ext#respawn|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.
{{Feature|arma3|{{hl|{{Link|#onPlayerRespawnAsSeagull.sqs}}}} was renamed to {{hl|playerRespawnSeagullScript.sqs}} in {{arma3}}.}}
<sqf>params ["_player", "_killer", "_seagull"];</sqf>
* player: [[Object]]
* killer: [[Object]]
* seagull: [[Object]]
| {{Icon|unchecked}} <!-- OFP -->
| {{Icon|unchecked}} <!-- OFPR -->
| {{Icon|unchecked}} <!-- A1 -->
| {{Icon|unchecked}} <!-- A2 -->
| {{Icon|unchecked}} <!-- A2OA -->
| {{Icon|checked}} <!-- A3 -->
| {{Icon|unchecked}} <!-- TKOH -->
| <!-- suspension -->
 
|-
|
=== playerRespawnOtherUnit.sqs ===
Executed when player is killed in multiplayer mission with "GROUP" or "SIDE" [[Description.ext#respawn|respawn type]]. This script will replace the default respawn sequence.
{{Feature|arma3|{{hl|{{Link|#onPlayerRespawnOtherUnit.sqs}}}} was renamed to {{hl|playerRespawnOtherUnit.sqs}} in {{arma3}}.}}
<sqf>params ["_player", "_killer", "_newUnit"];</sqf>
* player: [[Object]]
* killer: [[Object]]
* newUnit: [[Object]]
| {{Icon|unchecked}} <!-- OFP -->
| {{Icon|unchecked}} <!-- OFPR -->
| {{Icon|unchecked}} <!-- A1 -->
| {{Icon|unchecked}} <!-- A2 -->
| {{Icon|unchecked}} <!-- A2OA -->
| {{Icon|checked}} <!-- A3 -->
| {{Icon|unchecked}} <!-- TKOH -->
| <!-- suspension -->


{{Informative | Additional init scripts can be executed using functions with [[Functions_Library_(Arma_3)#Attributes|preInit or postInit]] attribute.}}
|-
|
=== playerResurrectScript.sqs ===
Executed when player is respawned in multiplayer mission with "INSTANT" or "BASE" [[Description.ext#respawn|respawn type]]. It will not work if {{hl|dta\scripts\onPlayerResurrect.sqs}} does not exist.
{{Feature|arma3|{{hl|{{Link|#onPlayerResurrect.sqs}}}} was renamed to {{hl|playerResurrectScript.sqs}} in {{arma3}}.}}
<sqf>params ["_player"];</sqf>
* player: [[Object]]
| {{Icon|unchecked}} <!-- OFP -->
| {{Icon|unchecked}} <!-- OFPR -->
| {{Icon|unchecked}} <!-- A1 -->
| {{Icon|unchecked}} <!-- A2 -->
| {{Icon|unchecked}} <!-- A2OA -->
| {{Icon|checked}} <!-- A3 -->
| {{Icon|unchecked}} <!-- TKOH -->
| <!-- suspension -->




== See also ==


* [[Script (File)]]
|-
* [[SQS syntax]]
|
* [[SQF syntax]]
=== teamSwitchScript.sqs ===
* [[Initialization Order]]
Executed ''after'' a [[Team Switch]] is done. '''Not''' triggered by [[selectPlayer]].
<sqf>params ["_oldUnit", "_newUnit"];</sqf>
* oldUnit: [[Object]]
* newUnit: [[Object]]
| {{Icon|unchecked}} <!-- OFP -->
| <!-- OFPR -->
| <!-- A1 -->
| <!-- A2 -->
| <!-- A2OA -->
| {{Icon|checked}} <!-- A3 -->
| <!-- TKOH -->
| <!-- suspension -->
|}




[[Category: Event Handlers]]
[[Category: Event Handlers]]
[[Category: Scripting Topics]]
[[Category: Scripting Topics]]
[[Category: Mission Editor]]
[[Category: Mission Editing]]
[[Category: Operation Flashpoint: Editing]]
[[Category: ArmA: Editing]]
[[Category:Arma 2: Editing]]
[[Category: Arma 3: Editing]]
[[Category: Take On Helicopters: Editing]]

Latest revision as of 17:23, 10 March 2024

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.50
Arma 3 logo black.png1.00 functions_f.pbo/scripts
tkoh logo small.png1.00 data_h.pbo/data/scripts

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 Details
Logo A0.png1.00 ofpr version.gif1.75 Logo A1 black.png1.00 Logo A2.png1.00 A2 OA Logo.png1.50 Arma 3 logo black.png1.00 tkoh logo small.png1.00 Can suspend

exit.sqf

Executed when mission is finished (before debriefing screen). In Arma 3, see also "Ended" and "MPEnded" Mission Event Handlers.

params ["_endType"];

 Checked Checked Checked Checked Checked

exit.sqs

Executed when mission is finished (before debriefing screen). In Arma 3, see also "Ended" and "MPEnded" Mission Event Handlers.

params ["_endType"];

 Checked Checked Checked Checked Checked Checked

init.sqf

Executed when mission is started (before briefing screen).

Checked Checked Checked Checked Checked Checked

init.sqs

Executed when mission is started (before briefing screen).

Checked Checked Checked Checked Checked Checked Checked

init3DEN.sqf

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

Checked Unchecked

initIntro.sqf

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

Arma 3
Functional in Arma 3 only for intro.
 Checked Checked Checked Checked Checked Checked

initIntro.sqs

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

Arma 3
Functional in Arma 3 only for intro.
 Checked Checked Checked Checked Checked Checked

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.

Checked Checked

initPlayerLocal.sqf

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

params ["_player", "_didJIP"];

 Checked Checked

initPlayerServer.sqf

Executed only on server when a player joins mission (includes both mission start and JIP). See Initialisation 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 - use this method instead.

params ["_playerUnit", "_didJIP"];

 Checked Checked

initServer.sqf

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

Checked Checked

missionFlow.fsm

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

Checked

onFlare.sqs

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

params ["_colorRGB", "_shooter", "_projectile", "_instigator"];

 Checked Checked Checked Checked Checked Checked

onPlayerKilled.sqf

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

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

 Checked Checked

onPlayerKilled.sqs

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

params ["_player", "_killer"];

 Checked Checked Checked Checked Checked Unchecked Checked

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"];

 Checked Checked

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"];

 Checked

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
onPlayerRespawnAsSeagull.sqs was renamed to playerRespawnSeagullScript.sqs in Arma 3.

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

 Checked Checked Checked Checked Checked Unchecked Checked

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
onPlayerRespawnOtherUnit.sqs was renamed to playerRespawnOtherUnit.sqs in Arma 3.

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

 Checked Checked Checked Checked Checked Unchecked Checked

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
onPlayerResurrect.sqs was renamed to playerResurrectScript.sqs in Arma 3.

params ["_player"];

 Checked Unchecked

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"];

 Checked Checked Checked Checked

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"];

 Unknown Unknown Unknown Unknown Unknown Checked Unknown

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"];

 Unknown Unknown Unknown Unknown Unknown Checked Unknown

playerRespawnSeagullScript.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
onPlayerRespawnAsSeagull.sqs was renamed to playerRespawnSeagullScript.sqs in Arma 3.

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

 Unchecked Unchecked Unchecked Unchecked Unchecked Checked Unchecked

playerRespawnOtherUnit.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
onPlayerRespawnOtherUnit.sqs was renamed to playerRespawnOtherUnit.sqs in Arma 3.

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

 Unchecked Unchecked Unchecked Unchecked Unchecked Checked Unchecked

playerResurrectScript.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
onPlayerResurrect.sqs was renamed to playerResurrectScript.sqs in Arma 3.

params ["_player"];

 Unchecked Unchecked Unchecked Unchecked Unchecked Checked Unchecked


teamSwitchScript.sqs

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

params ["_oldUnit", "_newUnit"];

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