onEachFrame: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(link to stackable)
(format, removed note that is now irrelevant)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Statement is run every frame.  
| Runs given statement every frame.  
{{Informative|Since '''Arma 3''' ''v1.57'' a stackable version of this EH is available: [[Arma_3:_Event_Handlers/addMissionEventHandler#EachFrame|EachFrame]]}}
{{Informative|Since '''Arma 3''' ''v1.57'' a stackable version of this EH is available: [[Arma_3:_Event_Handlers/addMissionEventHandler#EachFrame|EachFrame]]}}
{{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
{{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
Line 14: Line 14:
| '''onEachFrame''' statement |= Syntax
| '''onEachFrame''' statement |= Syntax


|p1= statement: [[Code]] |= Parameter 1
|p1= statement: [[String]] or [[Code]] |= Parameter 1


| [[Nothing]] |= Return value
| [[Nothing]] |= Return value
Line 20: Line 20:
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>[[onEachFrame]] { [[hintSilent]] [[str]] [[position]] [[player]]; }; //Hints position every frame</code> |= Example 1
|x1= <code>[[onEachFrame]] { [[hintSilent]] [[str]] [[position]] [[player]]}; //Hints position every frame</code> |= Example 1
|x2= Private variables defined outside of [[onEachFrame]] scope are not inherited:
|x2= Private variables defined outside of [[onEachFrame]] scope are not inherited:
<code>_myvar = "bob";
<code>_myvar = "bob";
myvar = "bill";
myvar = "bill";
[[onEachFrame]] {
[[onEachFrame]] {[[hintSilent]] [[str]] [_myvar, myvar]};
[[hintSilent]] [[str]] [_myvar, myvar]  
};
//Result: [any,"bill"]</code>
//Result: [any,"bill"]</code>
|= Example 2
|= Example 2
|x3= Only one [[onEachFrame]] loop can exist at any time:
|x3= Only one [[onEachFrame]] loop can exist at any time:
<code>[[onEachFrame]] {
<code>[[onEachFrame]] {[[player]] [[sideChat]] "first"};
[[player]] [[sideChat]] "first";
[[onEachFrame]] {[[player]] [[sideChat]] "second"};
};
[[onEachFrame]] {
[[player]] [[sideChat]] "second";
};
//Result: "second","second","second"..."second"</code>
//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. |= Example 3
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 3
|x4= Script suspension is not permitted within [[onEachFrame]] scope:
|x4= Script suspension is not permitted within [[onEachFrame]] scope:
<code>[[onEachFrame]] {
<code>[[onEachFrame]] {[[sleep]] 1};
[[sleep]] 1
};
//ERROR!!!</code> |= Example 4
//ERROR!!!</code> |= Example 4
}}
}}
Line 55: Line 47:
<!-- Note Section END -->
<!-- Note Section END -->
</dl>
</dl>
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on August 28, 2014 - 15:21 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
If you need a stackable [[onEachFrame]] event, use mission event handler "[[Arma_3:_Event_Handlers#Draw3D|Draw3D]]":
<code>[[addMissionEventHandler]] ["[[Arma_3:_Event_Handlers#Draw3D|Draw3D]]", {...code to run each frame...}];</code>
It is not a full substitute to [[onEachFrame]] as "[[Arma_3:_Event_Handlers#Draw3D|Draw3D]]" will stop executing on Alt+Tab and doesn't work on [[hasInterface]] <nowiki>=</nowiki>&gt; [[false]] clients, such as dedicated server.
</dd>
</dl>
<!-- DISCONTINUE Notes -->
<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>


Revision as of 03:23, 1 April 2016

A2 OA Logo.png1.63
Hover & click on the images for description

Description

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

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

See also:
See also needed

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

Retrieved from "https://community.bistudio.com/wiki?title=onEachFrame&oldid=95312"