onEachFrame: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "<code>([^ ]*)\{\{cc\|([^ ]*)\}\}([^ ]*)<\/code>" to "<code>$1// $2$3</code>") |
Lou Montana (talk | contribs) m (Text replacement - "\{\{cc\|([^} ]*)\}\}" to "// $1") |
||
| Line 30: | Line 30: | ||
myvar = "bill"; | myvar = "bill"; | ||
[[onEachFrame]] { [[hintSilent]] [[str]] [_myvar, myvar]; }; | [[onEachFrame]] { [[hintSilent]] [[str]] [_myvar, myvar]; }; | ||
// Result: [any,"bill"]</code> | |||
|x3= Only one [[onEachFrame]] loop can exist at any time: | |x3= Only one [[onEachFrame]] loop can exist at any time: | ||
<code>[[onEachFrame]] { [[player]] [[sideChat]] "first"; }; | <code>[[onEachFrame]] { [[player]] [[sideChat]] "first"; }; | ||
[[onEachFrame]] { [[player]] [[sideChat]] "second"; }; | [[onEachFrame]] { [[player]] [[sideChat]] "second"; }; | ||
// 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. | 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> | <code>// Will throw an error | ||
[[onEachFrame]] { [[sleep]] 1; };</code> | [[onEachFrame]] { [[sleep]] 1; };</code> | ||
Revision as of 11:26, 12 May 2022
Description
- Description:
- Runs given statement every frame.
In order to keep compatibility between official and community content:- Since Arma 3 v1.57 a stackable version of this EH is available: 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).
- 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_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