Event Scripts: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added onPlayerKilled.sqf and onPlayerRespawn.sqf)
m (Swapped image icons for {{GVI}} calls + changed to "bikitable" for padding + <code> to <tt> for tidiness)
Line 5: Line 5:
== Available Scripts ==
== Available Scripts ==


{| class="wikitable"
{| class="bikitable"
! File
! File
! Description
! Description
! Arguments
! Arguments
! [[File:ofp_1.00.gif]]
! {{GVI|ofp|1.00}}
! [[File:ofpr_1.75.gif]]
! {{GVI|ofpr|1.75}}
! [[File:arma_1.00.gif]]
! {{GVI|arma|1.00}}
! [[File:arma2_1.00.gif]]
! {{GVI|arma2|1.00}}
! [[File:arma2oa_1.51.gif]]
! {{GVI|arma2oa|1.51}}
! [[File:arma3_1.00.gif]]
! {{GVI|arma3|1.00}}
! [[File:TKOH_1.00.gif]]
! {{GVI|TKOH|1.00}}


|-
|-
Line 56: Line 56:
| ''exit.sqs''
| ''exit.sqs''
| Executed when mission is finished (before debriefing screen). In Arma 3, "ended" [[addMissionEventHandler|mission event handler]] has the same functionality.
| Executed when mission is finished (before debriefing screen). In Arma 3, "ended" [[addMissionEventHandler|mission event handler]] has the same functionality.
| <code>[endType:[[String]]]</code>
| <tt style="white-space:nowrap;">[endType:[[String]]]</tt>
|  <!-- OFP -->
|  <!-- OFP -->
| ✔ <!-- OFPR -->
| ✔ <!-- OFPR -->
Line 68: Line 68:
| ''onFlare.sqs''
| ''onFlare.sqs''
| Executed when a flare is lit after being fired from grenade launcher.
| Executed when a flare is lit after being fired from grenade launcher.
| <code>[colorRGB:[[Array]],shooter:[[Object]]]</code>
| <tt style="white-space:nowrap;">[colorRGB:[[Array]],shooter:[[Object]]]</tt>
|  <!-- OFP -->
|  <!-- OFP -->
| ✔ <!-- OFPR -->
| ✔ <!-- OFPR -->
Line 82: Line 82:


To make it work in MP, use ''onPauseScript = "myScript.sqf"'' in [[description.ext]]
To make it work in MP, use ''onPauseScript = "myScript.sqf"'' in [[description.ext]]
| <code>[pauseMenuDisplay:[[Display]]]</code>
| <tt style="white-space:nowrap;">[pauseMenuDisplay:[[Display]]]</tt>
|  <!-- OFP -->
|  <!-- OFP -->
|  <!-- OFPR -->
|  <!-- OFPR -->
Line 94: Line 94:
| ''onPlayerKilled.sqs''
| ''onPlayerKilled.sqs''
| Executed when player is killed in singleplayer or in multiplayer mission with "NONE" [[description.ext#respawn|respawn type]].
| Executed when player is killed in singleplayer or in multiplayer mission with "NONE" [[description.ext#respawn|respawn type]].
| <code>[player:[[Object]], killer:[[Object]]]</code>
| <tt style="white-space:nowrap;">[player:[[Object]], killer:[[Object]]]</tt>
| ✔ <!-- OFP -->
| ✔ <!-- OFP -->
| ✔ <!-- OFPR -->
| ✔ <!-- OFPR -->
Line 106: Line 106:
| ''onPlayerKilled.sqs''
| ''onPlayerKilled.sqs''
| Executed when player is killed in singleplayer or in multiplayer mission with "NONE" [[description.ext#respawn|respawn type]].
| Executed when player is killed in singleplayer or in multiplayer mission with "NONE" [[description.ext#respawn|respawn type]].
| <code>[player:[[Object]], killer:[[Object]]]</code>
| <tt style="white-space:nowrap;">[player:[[Object]], killer:[[Object]]]</tt>
| ✔ <!-- OFP -->
| ✔ <!-- OFP -->
| ✔ <!-- OFPR -->
| ✔ <!-- OFPR -->
Line 118: Line 118:
| ''onPlayerRespawnOtherUnit.sqs''
| ''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.
| 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.
| <code>[player:[[Object]], killer:[[Object]], newPlayer:[[Object]]]</code>
| <tt style="white-space:nowrap;">[player:[[Object]], killer:[[Object]], newPlayer:[[Object]]]</tt>
| ✔ <!-- OFP -->
| ✔ <!-- OFP -->
| ✔ <!-- OFPR -->
| ✔ <!-- OFPR -->
Line 154: Line 154:
| ''initPlayerServer.sqf''
| ''initPlayerServer.sqf''
| Executed only on server when a 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.
| Executed only on server when a 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.
| <code>[player:[[Object]],didJIP:[[Boolean]]]</code>
| <tt style="white-space:nowrap;">[player:[[Object]],didJIP:[[Boolean]]]</tt>
| <!-- OFP -->
| <!-- OFP -->
| <!-- OFPR -->
| <!-- OFPR -->
Line 166: Line 166:
| ''initPlayerLocal.sqf''
| ''initPlayerLocal.sqf''
| 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.
| 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.
| <code>[player:[[Object]],didJIP:[[Boolean]]]</code>
| <tt style="white-space:nowrap;">[player:[[Object]],didJIP:[[Boolean]]]</tt>
| <!-- OFP -->
| <!-- OFP -->
| <!-- OFPR -->
| <!-- OFPR -->
Line 178: Line 178:
| ''onPlayerKilled.sqf''
| ''onPlayerKilled.sqf''
| Executed when player is [[Arma_3_Respawn#Files|killed]] in singleplayer or in multiplayer mission.
| Executed when player is [[Arma_3_Respawn#Files|killed]] in singleplayer or in multiplayer mission.
| <code>[<oldUnit>,<killer>,<respawn>,<respawnDelay>]</code>
| <tt style="white-space:nowrap;">[<oldUnit>,<killer>,<respawn>,<respawnDelay>]</tt>
|  <!-- OFP -->
|  <!-- OFP -->
|  <!-- OFPR -->
|  <!-- OFPR -->
Line 190: Line 190:
| ''onPlayerRespawn.sqf''
| ''onPlayerRespawn.sqf''
| Executed when player [[Arma_3_Respawn#Files|respawns]] in a multiplayer mission.
| Executed when player [[Arma_3_Respawn#Files|respawns]] in a multiplayer mission.
| <code>[<newUnit>,<oldUnit>,<respawn>,<respawnDelay>]</code>
| <tt style="white-space:nowrap;">[<newUnit>,<oldUnit>,<respawn>,<respawnDelay>]</tt>
|  <!-- OFP -->
|  <!-- OFP -->
|  <!-- OFPR -->
|  <!-- OFPR -->

Revision as of 07:55, 14 July 2014

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 Logo A0.png1.00 ofpr version.gif1.75 -wrong parameter ("Arma") defined!-1.00 Logo A2.png1.00 A2 OA Logo.png1.51 Arma 3 logo black.png1.00 tkoh logo small.png1.00
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] ✔ ✔ ✔ ✔ ✔ ✔ ✔
onPlayerKilled.sqs Executed when player is killed in singleplayer or in multiplayer mission with "NONE" respawn type. [player:Object, killer: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] ✔ ✔ ✔ ✔ ✔ ✔
initJIPcompatible.sqf Executed by Multiplayer framework on all machines when a player joins mission (includes both mission start and JIP). ✔ ✔
initServer.sqf Executed only on server when mission is started. See initialization order for details about when the script is exactly executed. ✔
initPlayerServer.sqf 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. [player:Object,didJIP:Boolean] ✔
initPlayerLocal.sqf Executed locally when player joins mission (includes both mission start and JIP). See initialization order for details about when the script is exactly executed. [player:Object,didJIP:Boolean] ✔
onPlayerKilled.sqf Executed when player is killed in singleplayer or in multiplayer mission. [<oldUnit>,<killer>,<respawn>,<respawnDelay>] ✔
onPlayerRespawn.sqf Executed when player respawns in a multiplayer mission. [<newUnit>,<oldUnit>,<respawn>,<respawnDelay>] ✔

Note: Additional init scripts can be executed using functions with preInit or postInit attribute.


See also

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