BIS fnc onLoad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| tkoh |Game name=
| tkoh |Game name=
Line 7: Line 6:


|gr1 = Event Handlers |GROUP1=
|gr1 = Event Handlers |GROUP1=
____________________________________________________________________________________________


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


| parameter call [[BIS_fnc_onLoad]] |Syntax=
| parameter call [[BIS_fnc_onLoad]] |Syntax=
Line 22: Line 19:


| [[Number]] - index of onLoad code |Return value=
| [[Number]] - index of onLoad code |Return value=
____________________________________________________________________________________________


|x1= <code>_codeIndex = { [[hint]] "Welcome back!"; } [[call]] [[BIS_fnc_onLoad]];</code> |Example 1=
|x1= <code>_codeIndex = { [[hint]] "Welcome back!"; } [[call]] [[BIS_fnc_onLoad]];</code> |Example 1=


|x2= <code>0 [[call]] [[BIS_fnc_onLoad]]; {{codecomment|// removes code with index 0}}</code> |Example 2=
|x2= <code>0 [[call]] [[BIS_fnc_onLoad]]; {{codecomment|// removes code with index 0}}</code> |Example 2=
____________________________________________________________________________________________


| [[Arma 3: Event Handlers/addMissionEventHandler|Mission Event Handlers]], [[addMissionEventHandler]] |See also=
| [[Arma 3: Event Handlers/addMissionEventHandler|Mission Event Handlers]], [[addMissionEventHandler]] |See also=

Revision as of 23:49, 16 January 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

Notes

Bottom Section