onEachFrame: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " \| *(([^=\| ]+)('''|\[\[)([^=\| ]+)) * +\|p1=" to " |s1= $1 |p1=") |
Lou Montana (talk | contribs) m (Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= ") |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{RV|type=command | {{RV|type=command | ||
| arma2oa | |game1= arma2oa | ||
|1.63 | |version1= 1.63 | ||
|game2= tkoh | |game2= tkoh | ||
| Line 12: | Line 12: | ||
|gr1= Event Handlers | |gr1= Event Handlers | ||
| Runs given statement every frame. | |descr= Runs given statement every frame. | ||
{{Feature|arma3 | | {{Feature|arma3 | | ||
In order to keep compatibility between official and community content: | In order to keep compatibility between official and community content: | ||
* Since {{arma3}} v1.57 a stackable version of this EH is available: [[ | * 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]]).}} | * Before that, the scripted version of the event handler should be used instead (using [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]]).}} | ||
|s1= | |s1= [[onEachFrame]] statement | ||
|p1= statement: [[String]] or [[Code]] | |p1= statement: [[String]] or [[Code]] | ||
|r1= [[Nothing]] | |r1= [[Nothing]] | ||
|x1= <code>[[onEachFrame]] { [[hintSilent]] [[str]] [[position]] [[player]]}; {{cc|Hints position every frame}}</code> | |x1= <code>[[onEachFrame]] { [[hintSilent]] [[str]] [[position]] [[player]]}; {{cc|Hints position every frame}}</code> | ||
| Line 45: | Line 43: | ||
|x5= <code>[[onEachFrame]] {}; {{cc|Reset event}}</code> | |x5= <code>[[onEachFrame]] {}; {{cc|Reset event}}</code> | ||
|seealso= [[diag_frameNo]], [[diag_fps]] | |||
}} | }} | ||
Revision as of 23:17, 19 June 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