Difference between revisions of "onEachFrame"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]2(\|.*)\]\]" to "{{GameCategory|arma2|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
 
{{Command|Comments=
 
{{Command|Comments=
____________________________________________________________________________________________
 
  
 
| arma2oa |Game name=
 
| arma2oa |Game name=
Line 7: Line 6:
  
 
|gr1= Event Handlers |GROUP1=
 
|gr1= Event Handlers |GROUP1=
____________________________________________________________________________________________
 
  
 
| Runs given statement every frame.
 
| Runs given statement every frame.
Line 14: Line 12:
 
* 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:_Event_Handlers/addMissionEventHandler#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]]).}} |DESCRIPTION=
 
* Before that, the scripted version of the event handler should be used instead (using [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]]).}} |DESCRIPTION=
____________________________________________________________________________________________
 
  
 
| [[onEachFrame]] statement |SYNTAX=
 
| [[onEachFrame]] statement |SYNTAX=
Line 23: Line 20:
  
 
| [[diag_frameNo]], [[diag_fps]] |SEEALSO=
 
| [[diag_frameNo]], [[diag_fps]] |SEEALSO=
____________________________________________________________________________________________
 
  
 
|x1= <code>[[onEachFrame]] { [[hintSilent]] [[str]] [[position]] [[player]]}; {{cc|Hints position every frame}}</code> |EXAMPLE1=
 
|x1= <code>[[onEachFrame]] { [[hintSilent]] [[str]] [[position]] [[player]]}; {{cc|Hints position every frame}}</code> |EXAMPLE1=

Revision as of 02:55, 17 January 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

Notes

Bottom Section