Difference between revisions of "onEachFrame"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
+
{{Command
  
| arma2oa |Game name=
+
| arma2oa
  
|1.63|Game version=
+
|1.63
  
|gr1= Event Handlers |GROUP1=
+
|gr1= Event Handlers
  
 
| Runs given statement every frame.
 
| Runs given statement every frame.
Line 11: Line 11:
 
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:_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]]).}}
  
| [[onEachFrame]] statement |SYNTAX=
+
| [[onEachFrame]] statement
  
|p1= statement: [[String]] or [[Code]] |PARAMETER1=
+
|p1= statement: [[String]] or [[Code]]
  
| [[Nothing]] |RETURNVALUE=
+
| [[Nothing]]
  
| [[diag_frameNo]], [[diag_fps]] |SEEALSO=
+
| [[diag_frameNo]], [[diag_fps]]
  
|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>
  
 
|x2= Private variables defined outside of the [[onEachFrame]] scope are not inherited:
 
|x2= Private variables defined outside of the [[onEachFrame]] scope are not inherited:
Line 28: Line 28:
 
[[onEachFrame]] { [[hintSilent]] [[str]] [_myvar, myvar]; };
 
[[onEachFrame]] { [[hintSilent]] [[str]] [_myvar, myvar]; };
 
{{cc|Result: [any,"bill"]}}</code>
 
{{cc|Result: [any,"bill"]}}</code>
|EXAMPLE2=
+
 
  
 
|x3= Only one [[onEachFrame]] loop can exist at any time:
 
|x3= Only one [[onEachFrame]] loop can exist at any time:
Line 35: Line 35:
 
{{cc|Result: "second", "second", "second"...}}</code>
 
{{cc|Result: "second", "second", "second"...}}</code>
  
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. |EXAMPLE3=
+
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.
 
|x4= Script suspension is not permitted within [[onEachFrame]] scope:
 
|x4= Script suspension is not permitted within [[onEachFrame]] scope:
 
<code>{{cc|Will throw an error}}
 
<code>{{cc|Will throw an error}}
[[onEachFrame]] { [[sleep]] 1; };</code> |EXAMPLE4=
+
[[onEachFrame]] { [[sleep]] 1; };</code>
  
|x5= <code>[[onEachFrame]] {}; {{cc|Reset event}}</code> |EXAMPLE5=
+
|x5= <code>[[onEachFrame]] {}; {{cc|Reset event}}</code>
 
}}
 
}}
 
<h3 style="display:none">Bottom Section</h3>
 
<h3 style="display:none">Bottom Section</h3>

Revision as of 02:11, 18 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

Bottom Section