Difference between revisions of "onEachFrame"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= ")
 
(41 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| arma2oa |= Game name
+
|game1= arma2oa
 +
|version1= 1.63
  
|1.63|= Game version
+
|game2= tkoh
____________________________________________________________________________________________
+
|version2= 1.00
  
| Statement is run every frame.|= Description
+
|game3= arma3
____________________________________________________________________________________________
+
|version3= 0.50
  
| '''onEachFrame''' statement |= Syntax
+
|gr1= Event Handlers
  
|p1= statement: [[Code]] |= Parameter 1
+
|descr= Runs given statement every frame.
 +
{{Feature|arma3 |
 +
In order to keep compatibility between official and community content:
 +
* 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]]).}}
  
| [[Nothing]] |= Return value
+
|s1= [[onEachFrame]] statement
  
____________________________________________________________________________________________
+
|p1= statement: [[String]] or [[Code]]
  
|x1= <code>onEachFrame { hintSilent str position player; }; //Updates position every frame</code> |= Example 1
+
|r1= [[Nothing]]
  
}}
+
|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:
 +
<code>_myvar = "bob";
 +
myvar = "bill";
 +
[[onEachFrame]] { [[hintSilent]] [[str]] [_myvar, myvar]; };
 +
{{cc|Result: [any,"bill"]}}</code>
  
<h3 style="display:none">Notes</h3>
+
|x3= Only one [[onEachFrame]] loop can exist at any time:
<dl class="command_description">
+
<code>[[onEachFrame]] { [[player]] [[sideChat]] "first"; };
<!-- Note Section BEGIN -->
+
[[onEachFrame]] { [[player]] [[sideChat]] "second"; };
 +
{{cc|Result: "second", "second", "second"...}}</code>
  
<dd class="notedate">Posted on 21 Dec, 2012
+
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.
<dt class="note">[[User:neokika|neokika]]<dd class="note">
+
|x4= Script suspension is not permitted within [[onEachFrame]] scope:
<code>onEachFrame {}; //Reset event</code>
+
<code>{{cc|Will throw an error}}
<!-- Note Section END -->
+
[[onEachFrame]] { [[sleep]] 1; };</code>
</dl>
 
  
<h3 style="display:none">Bottom Section</h3>
+
|x5= <code>[[onEachFrame]] {}; {{cc|Reset event}}</code>
  
[[Category:ArmA 2 OA: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
+
|seealso= [[diag_frameNo]], [[diag_fps]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+
}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 23:17, 19 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