onEachFrame: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "") |
||
| Line 42: | Line 42: | ||
|x5= <code>[[onEachFrame]] {}; {{cc|Reset event}}</code> |EXAMPLE5= | |x5= <code>[[onEachFrame]] {}; {{cc|Reset event}}</code> |EXAMPLE5= | ||
}} | }} | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
{{GameCategory|arma2|Scripting Commands}} | {{GameCategory|arma2|Scripting Commands}} | ||
{{GameCategory|arma3|Scripting Commands}} | {{GameCategory|arma3|Scripting Commands}} | ||
Revision as of 14:46, 17 January 2021
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_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