onEachFrame: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (+Draw3D KK note link x3)
m (Some wiki formatting)
(52 intermediate revisions by 7 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. {{Feature arma3|In order to keep compatability between official and community content the functions [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]] should be used instead.}} |= Description
|game3= arma3
____________________________________________________________________________________________
|version3= 0.50


| '''onEachFrame''' statement |= Syntax
|gr1= Event Handlers


|p1= statement: [[Code]] |= Parameter 1
|descr= Runs given statement every frame in an [[Scheduler#Unscheduled Environment|unscheduled environment]].
{{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]]).
}}
 
|s1= [[onEachFrame]] statement
 
|p1= statement: [[String]] or [[Code]]
 
|r1= [[Nothing]]


| [[Nothing]] |= Return value
|x1= <sqf>onEachFrame { hintSilent str getPosWorld player }; // hints position every frame</sqf>


____________________________________________________________________________________________
|x2= Private variables defined outside of the [[onEachFrame]] scope are not inherited:
<sqf>
_myVar = "bob";
MyVar = "bill";
onEachFrame { hintSilent str [_myVar, MyVar]; };
// Result: [any, "bill"]
</sqf>


|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:
<code>_myvar = "bob";
myvar = "bill";
[[onEachFrame]] {
[[hintSilent]] [[str]] [_myvar, myvar]
};
//Result: [any,"bill"]</code>
|= Example 2
|x3= Only one [[onEachFrame]] loop can exist at any time:
|x3= Only one [[onEachFrame]] loop can exist at any time:
<code>[[onEachFrame]] {
<sqf>
[[player]] [[sideChat]] "first";
onEachFrame { player sideChat "first"; };
};
onEachFrame { player sideChat "second"; }; // replaces the first one
[[onEachFrame]] {
onEachFrame {}; // reset to the initial state
[[player]] [[sideChat]] "second";
</sqf>
};
//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
|x4= Script suspension is not permitted within [[onEachFrame]] scope:
|x4= Script suspension is not permitted within [[onEachFrame]] scope:
<code>[[onEachFrame]] {
<sqf>
[[sleep]] 1
// will throw an error
};
onEachFrame { sleep 1; };
//ERROR!!!</code> |= Example 4
</sqf>
}}


<h3 style="display:none">Notes</h3>
|x5= <sqf>
<dl class="command_description">
onEachFrame { if (diag_frameNo mod 60 isEqualTo 0) then { /* code */ } }; // executes every 60 frames (every second @ 60 FPS, every two seconds @ 30 FPS, etc)
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on 21 Dec, 2012
onEachFrame { // this version is the closest to a precise 1 second tick
<dt class="note">[[User:neokika|neokika]]<dd class="note">
if (isNil "TAG_LastHint") then
<code>[[onEachFrame]] {}; //Reset event</code>
{
<!-- Note Section END -->
TAG_LastHint = diag_tickTime;
</dl>
}
<!-- CONTINUE Notes -->
else
<dl class="command_description">
{
<dd class="notedate">Posted on August 28, 2014 - 15:21 (UTC)</dd>
if (diag_tickTime - TAG_LastHint >= 1) then // set the duration in seconds here
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
{
<dd class="note">
hint format ["a second has passed (%1s since game start)", diag_tickTime];
If you need a stackable [[onEachFrame]] event, use mission event handler "[[Arma_3:_Event_Handlers#Draw3D|Draw3D]]":
TAG_LastHint = diag_tickTime;
<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>
</sqf>
<!-- DISCONTINUE Notes -->
<h3 style="display:none">Bottom Section</h3>


[[Category:ArmA 2 OA: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
|seealso= [[diag_frameNo]] [[diag_fps]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 11:58, 6 January 2023

A2 OA Logo.png1.63tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Runs given statement every frame in an unscheduled environment.
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 getPosWorld 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"; }; // replaces the first one onEachFrame {}; // reset to the initial state
Example 4:
Script suspension is not permitted within onEachFrame scope:
// will throw an error onEachFrame { sleep 1; };
Example 5:
onEachFrame { if (diag_frameNo mod 60 isEqualTo 0) then { /* code */ } }; // executes every 60 frames (every second @ 60 FPS, every two seconds @ 30 FPS, etc) onEachFrame { // this version is the closest to a precise 1 second tick if (isNil "TAG_LastHint") then { TAG_LastHint = diag_tickTime; } else { if (diag_tickTime - TAG_LastHint >= 1) then // set the duration in seconds here { hint format ["a second has passed (%1s since game start)", diag_tickTime]; TAG_LastHint = diag_tickTime; }; }; };

Additional Information

See also:
diag_frameNo diag_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
Retrieved from "https://community.bistudio.com/wiki?title=onEachFrame&oldid=337016"