onEachFrame: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "Category:Scripting Commands ArmA2" to "Category:Scripting Commands Arma 2") |
Lou Montana (talk | contribs) (Merge infoboxes) |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Runs given statement every frame. | | Runs given statement every frame. | ||
{{ | {{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:_Event_Handlers/addMissionEventHandler#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]]).}} |DESCRIPTION= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | [[onEachFrame]] statement |SYNTAX= | ||
|p1= statement: [[String]] or [[Code]] |PARAMETER1= | |p1= statement: [[String]] or [[Code]] |PARAMETER1= | ||
| Line 21: | Line 23: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>[[onEachFrame]] { [[hintSilent]] [[str]] [[position]] [[player]]}; | |x1= <code>[[onEachFrame]] { [[hintSilent]] [[str]] [[position]] [[player]]}; {{cc|Hints position every frame}}</code> |EXAMPLE1= | ||
|x2= Private variables defined outside of [[onEachFrame]] scope are not inherited: | |||
|x2= Private variables defined outside of the [[onEachFrame]] scope are not inherited: | |||
<code>_myvar = "bob"; | <code>_myvar = "bob"; | ||
myvar = "bill"; | myvar = "bill"; | ||
[[onEachFrame]] {[[hintSilent]] [[str]] [_myvar, myvar]}; | [[onEachFrame]] { [[hintSilent]] [[str]] [_myvar, myvar]; }; | ||
{{cc|Result: [any,"bill"]}}</code> | |||
|EXAMPLE2= | |EXAMPLE2= | ||
|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"; }; | ||
{{cc|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. |EXAMPLE3= | 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. |EXAMPLE3= | ||
|x4= Script suspension is not permitted within [[onEachFrame]] scope: | |x4= Script suspension is not permitted within [[onEachFrame]] scope: | ||
<code>[[onEachFrame]] {[[sleep]] 1}; | <code>{{cc|Will throw an error}} | ||
[[onEachFrame]] { [[sleep]] 1; };</code> |EXAMPLE4= | |||
|x5= <code>[[onEachFrame]] {}; {{cc|Reset event}}</code> |EXAMPLE5= | |||
}} | }} | ||
| Line 43: | Line 49: | ||
<!-- Note Section BEGIN --> | <!-- Note Section BEGIN --> | ||
<!-- Note Section END --> | <!-- Note Section END --> | ||
</dl> | </dl> | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
Revision as of 13:55, 2 July 2020
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:
- 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 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