Difference between revisions of "onEachFrame"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Text replacement - "[[Arma_3:_Event_Handlers/addMissionEventHandler" to "[[Arma 3: Mission Event Handlers")
Line 15: Line 15:
 
{{Feature|arma3 |
 
{{Feature|arma3 |
 
In order to keep compatibility between official and community content:
 
In order to keep compatibility between official and community content:
* Since {{arma3}} v1.57 a stackable version of this EH is available: [[Arma_3:_Event_Handlers/addMissionEventHandler#EachFrame|EachFrame Mission Event Handler]]
+
* Since {{arma3}} v1.57 a stackable version of this EH is available: [[Arma 3: Mission Event Handlers#EachFrame|EachFrame Mission Event Handler]]
 
* Before that, the scripted version of the event handler should be used instead (using [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]]).}}
 
* Before that, the scripted version of the event handler should be used instead (using [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]]).}}
  

Revision as of 11:32, 16 June 2021

Hover & click on the images for description

Description

Description:
Runs given statement every frame.
Arma 3
In order to keep compatibility between official and community content:
Groups:
Event Handlers

Syntax

Syntax:
onEachFrame statement
Parameters:
statement: String or Code
Return Value:
Nothing

Examples

Example 1:
onEachFrame { hintSilent str position player}; // Hints position every frame
Example 2:
Private variables defined outside of the onEachFrame scope are not inherited: _myvar = "bob"; myvar = "bill"; onEachFrame { hintSilent str [_myvar, myvar]; }; // Result: [any,"bill"]
Example 3:
Only one onEachFrame loop can exist at any time: onEachFrame { player sideChat "first"; }; onEachFrame { player sideChat "second"; }; // Result: "second", "second", "second"... Note how "first" never gets shown even though it precedes "second". This is because script thread is executing within the same frame and first onEachFrame is overwritten before it has a chance to execute its statement.
Example 4:
Script suspension is not permitted within onEachFrame scope: // Will throw an error onEachFrame { sleep 1; };
Example 5:
onEachFrame {}; // Reset event

Additional Information

See also:
diag_frameNodiag_fps

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