onEachFrame

From Bohemia Interactive Community
Jump to: navigation, search
Introduced with Arma 2: Operation Arrowhead version 1.63
  

Click on the images for descriptions

Introduced in

Game:
Arma 2: Operation Arrowhead
Version:
1.63

Description

Description:
Runs given statement every frame.
i Since Arma 3 v1.57 a stackable version of this EH is available: EachFrame
Arma 3 logo black.png In order to keep compatibility between official and community content the functions BIS_fnc_addStackedEventHandler and BIS_fnc_removeStackedEventHandler should be used instead.

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 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"..."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: onEachFrame {sleep 1}; //ERROR!!!

Additional Information

Multiplayer:
-
See also:
diag_frameNodiag_fps

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Posted on 21 Dec, 2012
neokika
onEachFrame {}; //Reset event

Bottom Section