onEachFrame: Difference between revisions
Jump to navigation
Jump to search
m (Text replace - "{{uc:{{PAGENAME}}}}" to "{{uc:{{PAGENAME}}}} {{uc:{{PAGENAME}}}}") |
Lou Montana (talk | contribs) m (Text replacement - "[[Category:ArmA 2 OA: New Scripting Commands List" to "[[Category:Arma 2: Operation Arrowhead: New Scripting Commands List") |
||
(17 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
{{Command|= | {{Command|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| arma2oa | | | arma2oa |Game name= | ||
|1.63| | |1.63|Game version= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | Runs given statement every frame. <br><br> | ||
{{Informative|Since '''Arma 3''' ''v1.57'' a stackable version of this EH is available: [[Arma_3:_Event_Handlers/addMissionEventHandler#EachFrame|EachFrame]]}}<br> | |||
{{Feature arma3|In order to keep compatibility between official and community content the functions [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]] should be used instead.}}|DESCRIPTION= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| '''onEachFrame''' statement |= | | '''onEachFrame''' statement |SYNTAX= | ||
|p1= statement: [[Code]] |= | |p1= statement: [[String]] or [[Code]] |PARAMETER1= | ||
| [[Nothing]] |= | | [[Nothing]] |RETURNVALUE= | ||
| [[diag_frameNo]], [[diag_fps]] |SEEALSO= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>onEachFrame { hintSilent str position player | |x1= <code>[[onEachFrame]] { [[hintSilent]] [[str]] [[position]] [[player]]}; //Hints position every frame</code> |EXAMPLE1= | ||
|x2= Private variables defined outside of [[onEachFrame]] scope are not inherited: | |||
<code>_myvar = "bob"; | |||
myvar = "bill"; | |||
[[onEachFrame]] {[[hintSilent]] [[str]] [_myvar, myvar]}; | |||
//Result: [any,"bill"]</code> | |||
|EXAMPLE2= | |||
|x3= Only one [[onEachFrame]] loop can exist at any time: | |||
<code>[[onEachFrame]] {[[player]] [[sideChat]] "first"}; | |||
[[onEachFrame]] {[[player]] [[sideChat]] "second"}; | |||
//Result: "second","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= | |||
|x4= Script suspension is not permitted within [[onEachFrame]] scope: | |||
<code>[[onEachFrame]] {[[sleep]] 1}; | |||
//ERROR!!!</code> |EXAMPLE4= | |||
}} | }} | ||
Line 28: | Line 45: | ||
<dd class="notedate">Posted on 21 Dec, 2012 | <dd class="notedate">Posted on 21 Dec, 2012 | ||
<dt class="note">[[User:neokika|neokika]]<dd class="note"> | <dt class="note">[[User:neokika|neokika]]<dd class="note"> | ||
<code>onEachFrame {}; //Reset event</code> | <code>[[onEachFrame]] {}; //Reset event</code> | ||
<!-- Note Section END --> | <!-- Note Section END --> | ||
</dl> | </dl> | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category: | [[Category:Arma 2: Operation Arrowhead: New Scripting Commands List|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] |
Revision as of 13:31, 19 September 2019
Description
- Description:
- Runs given statement every frame.
- Groups:
- Uncategorised
Syntax
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
- 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
- Posted on 21 Dec, 2012
- neokika
-
onEachFrame {}; //Reset event
Bottom Section
Categories:
- Scripting Commands
- Introduced with Arma 2: Operation Arrowhead version 1.63
- Arma 2: Operation Arrowhead: New Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Command Group: Uncategorised
- Arma 2: Operation Arrowhead: New Scripting Commands List
- Scripting Commands ArmA2
- Scripting Commands Arma 3