BIS fnc onLoad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *(arg|eff|mp|serverExec|gr[0-9]) *= *(.*) * *\|([^=]{12})" to "|$1=$2 |descr=$3")
m (Text replacement - "[[Arma 3: Event Handlers/addMissionEventHandler" to "[[Arma 3: Mission Event Handlers")
Line 7: Line 7:


|descr= Register code to be executed after a mission load (from a save, for example).
|descr= Register code to be executed after a mission load (from a save, for example).
{{Feature|important|Replaced by [[Arma 3: Event Handlers/addMissionEventHandler#Loaded|"loaded" mission event handler]].<br>
{{Feature|important|Replaced by [[Arma 3: Mission Event Handlers#Loaded|"loaded" mission event handler]].<br>
This function now exists only because of backward compatibility}}
This function now exists only because of backward compatibility}}


Line 23: Line 23:
|x2= <code>0 [[call]] [[BIS_fnc_onLoad]]; {{cc|removes code with index 0}}</code>
|x2= <code>0 [[call]] [[BIS_fnc_onLoad]]; {{cc|removes code with index 0}}</code>


|seealso= [[Arma 3: Event Handlers/addMissionEventHandler|Mission Event Handlers]], [[addMissionEventHandler]]
|seealso= [[Arma 3: Mission Event Handlers|Mission Event Handlers]], [[addMissionEventHandler]]
}}
}}


[[Category:{{Name|arma3}}: Functions|{{uc:onLoad}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:onLoad}}]]

Revision as of 11:36, 16 June 2021

Hover & click on the images for description

Description

Description:
Register code to be executed after a mission load (from a save, for example).
Replaced by "loaded" mission event handler.
This function now exists only because of backward compatibility
Execution:
call
Groups:
Event Handlers

Syntax

Syntax:
parameter call BIS_fnc_onLoad
Parameters:
parameter: Code or Number:
  • Code - code to be executed on mission load
  • Number - index of code to remove
 
Return Value:
Number - index of onLoad code

Examples

Example 1:
_codeIndex = { hint "Welcome back!"; } call BIS_fnc_onLoad;
Example 2:
0 call BIS_fnc_onLoad; // removes code with index 0

Additional Information

See also:
Mission Event HandlersaddMissionEventHandler

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note