Initialisation Order: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[SQF[ _]syntax" to "[[SQF Syntax") |
Lou Montana (talk | contribs) m (Text replacement - "[[Arma 3 " to "[[Arma 3: ") |
||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 20: | Line 20: | ||
|} | |} | ||
Take note that the order of initialisation is different in single player and multiplayer environments. If an entry is unmarked then it applies to both. | Take note that the order of initialisation is different in single player and multiplayer environments. If an entry is unmarked then it applies to both. | ||
{{Feature | | {{Feature|informative| | ||
If the server is non-dedicated then it should be considered both a server and client.}} | In multiplayer the following is relevant to every machine including the server and [[Arma 3: Headless Client|headless clients]]. | ||
If the server is non-dedicated then it should be considered both a server and client. | |||
}} | |||
{{Clear}} | {{Clear}} | ||
== | == {{arma3}} == | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 39: | Line 41: | ||
| All | | All | ||
| {{Icon|checked}} | | {{Icon|checked}} | ||
| [[Arma 3 Functions Library]] | | [[Arma 3: Functions Library]] | ||
| | | | ||
| | | | ||
| Line 46: | Line 48: | ||
| All | | All | ||
| {{Icon|checked}} | | {{Icon|checked}} | ||
| [[Arma 3 Functions Library]] | | [[Arma 3: Functions Library]] | ||
| [[Scheduler#Unscheduled Environment|Unscheduled]] | | [[Scheduler#Unscheduled Environment|Unscheduled]] | ||
| | | | ||
| Line 58: | Line 60: | ||
|- | |- | ||
| Expressions of Eden Editor entity attributes are called | | Expressions of Eden Editor entity attributes are called | ||
| | | Server | ||
| {{Icon|unchecked}} | | {{Icon|unchecked}} | ||
| [[Eden Editor: Configuring Attributes]] | | [[Eden Editor: Configuring Attributes]] | ||
| [[Scheduler#Unscheduled Environment|Unscheduled]] | | [[Scheduler#Unscheduled Environment|Unscheduled]] | ||
| | | <sqf inline>isPlayer _entity</sqf> does not return [[true]] immediately. Once the entity has become a [[player]], it is transfered to the client. | ||
|- | |- | ||
| Object initialisation fields are called | | Object initialisation fields are called | ||
| Line 73: | Line 75: | ||
| [[Event Scripts#init.sqs|init.sqs]] is executed | | [[Event Scripts#init.sqs|init.sqs]] is executed | ||
| Singleplayer | | Singleplayer | ||
| | | {{n/a}} | ||
| [[Event Scripts]] | | [[Event Scripts]] | ||
| | | | ||
| Line 80: | Line 82: | ||
| [[Event Scripts#init.sqf|init.sqf]] is executed | | [[Event Scripts#init.sqf|init.sqf]] is executed | ||
| Singleplayer | | Singleplayer | ||
| | | {{n/a}} | ||
| [[Event Scripts]] | | [[Event Scripts]] | ||
| [[Scheduler#Scheduled Environment|Scheduled]]<ref name="enginewaits">Note that while the environment is [[Scheduler#Scheduled Environment|Scheduled]] ([[canSuspend]] returns true), the engine seems to wait until the script is done executing, essentially behaving similarly to an [[Scheduler#Unscheduled Environment|Unscheduled environment]] - infinite loops will freeze the game, uiSleep may pause the game for up to ~ | | [[Scheduler#Scheduled Environment|Scheduled]]<ref name="enginewaits">Note '''in single player''' that while the environment is [[Scheduler#Scheduled Environment|Scheduled]] ([[canSuspend]] returns true), the engine seems to wait until the script is done executing, essentially behaving similarly to an [[Scheduler#Unscheduled Environment|Unscheduled environment]] - infinite loops will freeze the game, [[uiSleep]] may pause the game for up to ~20s (postInit), [[waitUntil]] can cause catastrophic issues, etc.</ref> | ||
| | | | ||
|- | |- | ||
| Line 91: | Line 93: | ||
| [[Scheduler#Unscheduled Environment|Unscheduled]] | | [[Scheduler#Unscheduled Environment|Unscheduled]] | ||
| [[player]] is not available immediately. | | [[player]] is not available immediately. | ||
|- | |- style="background-color: #95DEF0" | ||
| Persistent functions are called | | Persistent functions are called | ||
| Client | | Client | ||
| {{Icon|checked}} | | {{Icon|checked}} | ||
| [[BIS_fnc_MP]] | | [[Arma 3: Remote Execution]], [[BIS_fnc_MP]] | ||
| | | | ||
| | | | ||
| Line 108: | Line 110: | ||
| [[Event Scripts#initServer.sqf|initServer.sqf]] is executed | | [[Event Scripts#initServer.sqf|initServer.sqf]] is executed | ||
| Server | | Server | ||
| | | {{n/a}} | ||
| [[Event Scripts]] | | [[Event Scripts]] | ||
| [[Scheduler#Scheduled Environment|Scheduled]] | | [[Scheduler#Scheduled Environment|Scheduled]] | ||
| Line 130: | Line 132: | ||
| All | | All | ||
| {{Icon|checked}} | | {{Icon|checked}} | ||
| [[Arma 3 Functions Library]] | | [[Arma 3: Functions Library]] | ||
| [[Scheduler#Scheduled Environment|Scheduled]]<ref name="enginewaits"/> | | [[Scheduler#Scheduled Environment|Scheduled]]<ref name="enginewaits"/> | ||
| | | | ||
Latest revision as of 10:38, 6 May 2024
Whenever a mission is launched (or joined in Multiplayer) certain tasks are performed to ensure the mission's various components are initialised correctly and that everyone is synced in multiplayer games (particularly JIP players). Initialisation order refers to the order in which those tasks are executed and it is important to take into account when setting up the start of a mission.
Event Scripts are a key part of a mission's initialisation order and will be utilised often when working with SQF.
| Item | Meaning |
|---|---|
| Single Player Only | |
| Multiplayer Only | |
| Order is not guaranteed |
Take note that the order of initialisation is different in single player and multiplayer environments. If an entry is unmarked then it applies to both.
Arma 3
| Task | Applies To | JIP | Related To | Exec Environment | Notes |
|---|---|---|---|---|---|
| Functions with recompile attribute are recompiled | All | 
|
Arma 3: Functions Library | ||
| Functions with preInit attribute are called | All |
|
Arma 3: Functions Library | Unscheduled | |
| Object Init Event Handlers are called | All | 
|
Unscheduled | ||
| Expressions of Eden Editor entity attributes are called | Server |
|
Eden Editor: Configuring Attributes | Unscheduled | isPlayer _entity does not return true immediately. Once the entity has become a player, it is transfered to the client. |
| Object initialisation fields are called | All |
|
Unscheduled | ||
| init.sqs is executed | Singleplayer | N/A | Event Scripts | ||
| init.sqf is executed | Singleplayer | N/A | Event Scripts | Scheduled[1] | |
| Expressions of Eden Editor scenario attributes are called | All |
|
Eden Editor: Configuring Attributes | Unscheduled | player is not available immediately. |
| Persistent functions are called | Client |
|
Arma 3: Remote Execution, BIS_fnc_MP | ||
| Modules are initialised | All |
|
|||
| initServer.sqf is executed | Server | N/A | Event Scripts | Scheduled | |
| initPlayerLocal.sqf is executed | Client |
|
Event Scripts | Scheduled | |
| initPlayerServer.sqf is executed on the server | Client |
|
Event Scripts | Scheduled | |
| Functions with postInit attribute are called | All |
|
Arma 3: Functions Library | Scheduled[1] | |
| "BIS_fnc_init" variable is set to true | All |
|
Arma 2: Functions Library | ||
| init.sqs is executed | Multiplayer |
|
Event Scripts | Scheduled | |
| init.sqf is executed | Multiplayer |
|
Event Scripts | Scheduled |
- ↑ 1.0 1.1 Note in single player that while the environment is Scheduled (canSuspend returns true), the engine seems to wait until the script is done executing, essentially behaving similarly to an Unscheduled environment - infinite loops will freeze the game, uiSleep may pause the game for up to ~20s (postInit), waitUntil can cause catastrophic issues, etc.