onPreloadStarted: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (SeeAlso added.)
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(51 intermediate revisions by 7 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


| Defines an action performed just before the preload screen started. |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| '''onPreloadStarted''' command |= Syntax
|game4= arma3
|version4= 0.50


|p1= command:  -  |= PARAMETER1
|gr1= Event Handlers


|p2= |= PARAMETER2
|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>
{{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
|s1= [[onPreloadStarted]] command


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


|r1= [[Nothing]]


|x1= <code>(example)</code>|= EXAMPLE1
|x1= <sqf>onPreloadStarted {diag_log "preload started"};</sqf>


____________________________________________________________________________________________
|seealso= [[onPreloadFinished]]
 
| [[onPreloadFinished]] |= SEEALSO
 
|  |= MPBEHAVIOUR
____________________________________________________________________________________________
}}
}}
<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:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 00:25, 2 February 2024

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