onPreloadStarted: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Feature arma3|" to "{{Feature|arma3|")
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(32 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|gr1= Event Handlers |GROUP1=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Defines an action performed just before the preload screen started. Preload event occurs after briefing screen on mission start.<br><br>
|game4= arma3
{{Important | This event handler also fires on client after user closes the main map. }}<br>
|version4= 0.50
{{Informative|Since '''Arma 3''' ''v1.57'' a stackable version of this EH is available: [[Arma_3:_Event_Handlers/addMissionEventHandler#PreloadStarted|PreloadStarted]]}}<br>
{{Feature|arma3|In order to keep compatibility between official and community content the functions [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]] should be used instead.}}
|DESCRIPTION=
____________________________________________________________________________________________


| '''onPreloadStarted''' command |SYNTAX=
|gr1= Event Handlers


|p1= command: [[String]] or [[Code]] |PARAMETER1=
|descr= Defines an action performed just before the preload screen started. Preload event occurs after briefing screen on mission start.{{Feature | important | This event handler also fires on client after user closes the main map. }}<br>
 
{{Feature|informative|Since '''Arma 3''' ''v1.57'' a stackable version of this EH is available: [[Arma 3: Mission Event Handlers#PreloadStarted|PreloadStarted]]}}<br>
|p2= |PARAMETER2=
{{Feature|arma3|In order to keep compatibility between official and community content the functions [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]] should be used instead.}}
 
|p3= |PARAMETER3=


| [[Nothing]] |RETURNVALUE=
|s1= [[onPreloadStarted]] command


|p1= command: [[String]] or [[Code]]


|x1= <code>[[onPreloadStarted]] {[[diag_log]] "preload started"};</code>|EXAMPLE1=
|r1= [[Nothing]]
____________________________________________________________________________________________


| [[onPreloadFinished]] |SEEALSO=  
|x1= <sqf>onPreloadStarted {diag_log "preload started"};</sqf>


| |MPBEHAVIOUR=  
|seealso= [[onPreloadFinished]]
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 00:25, 2 February 2024

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Defines an action performed just before the preload screen started. Preload event occurs after briefing screen on mission start.
⚠
This event handler also fires on client after user closes the main map.

ⓘ
Since Arma 3 v1.57 a stackable version of this EH is available: PreloadStarted

Arma 3
In order to keep compatibility between official and community content the functions BIS_fnc_addStackedEventHandler and BIS_fnc_removeStackedEventHandler should be used instead.
Groups:
Event Handlers

Syntax

Syntax:
onPreloadStarted command
Parameters:
command: String or Code
Return Value:
Nothing

Examples

Example 1:
onPreloadStarted {diag_log "preload started"};

Additional Information

See also:
onPreloadFinished

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
Retrieved from "https://community.bistudio.com/wiki?title=onPreloadStarted&oldid=352159"