Difference between revisions of "onEachFrame"
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (link to stackable) |
m (template:command argument fix) |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
− | | | + | | Runs given statement every frame. <br><br> |
− | {{Informative|Since '''Arma 3''' ''v1.57'' a stackable version of this EH is available: [[Arma_3:_Event_Handlers/addMissionEventHandler#EachFrame|EachFrame]]}} | + | {{Informative|Since '''Arma 3''' ''v1.57'' a stackable version of this EH is available: [[Arma_3:_Event_Handlers/addMissionEventHandler#EachFrame|EachFrame]]}}<br> |
− | {{Feature arma3|In order to keep compatibility between official and community content the functions [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]] should be used instead.}} |= | + | {{Feature arma3|In order to keep compatibility between official and community content the functions [[BIS_fnc_addStackedEventHandler]] and [[BIS_fnc_removeStackedEventHandler]] should be used instead.}}|DESCRIPTION= |
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
− | | '''onEachFrame''' statement |= | + | | '''onEachFrame''' statement |SYNTAX= |
− | |p1= statement: [[Code]] |= | + | |p1= statement: [[String]] or [[Code]] |PARAMETER1= |
− | | [[Nothing]] |= | + | | [[Nothing]] |RETURNVALUE= |
+ | | [[diag_frameNo]], [[diag_fps]] |SEEALSO= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
− | |x1= <code>[[onEachFrame]] { [[hintSilent]] [[str]] [[position]] [[player]] | + | |x1= <code>[[onEachFrame]] { [[hintSilent]] [[str]] [[position]] [[player]]}; //Hints position every frame</code> |EXAMPLE1= |
|x2= Private variables defined outside of [[onEachFrame]] scope are not inherited: | |x2= Private variables defined outside of [[onEachFrame]] scope are not inherited: | ||
<code>_myvar = "bob"; | <code>_myvar = "bob"; | ||
myvar = "bill"; | myvar = "bill"; | ||
− | [[onEachFrame]] { | + | [[onEachFrame]] {[[hintSilent]] [[str]] [_myvar, myvar]}; |
− | |||
− | }; | ||
//Result: [any,"bill"]</code> | //Result: [any,"bill"]</code> | ||
− | |= | + | |EXAMPLE2= |
|x3= Only one [[onEachFrame]] loop can exist at any time: | |x3= Only one [[onEachFrame]] loop can exist at any time: | ||
− | <code>[[onEachFrame]] { | + | <code>[[onEachFrame]] {[[player]] [[sideChat]] "first"}; |
− | + | [[onEachFrame]] {[[player]] [[sideChat]] "second"}; | |
− | }; | ||
− | [[onEachFrame]] { | ||
− | |||
− | }; | ||
//Result: "second","second","second"..."second"</code> | //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. |= | + | 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]] { | + | <code>[[onEachFrame]] {[[sleep]] 1}; |
− | + | //ERROR!!!</code> |EXAMPLE4= | |
− | }; | ||
− | //ERROR!!!</code> |= | ||
}} | }} | ||
Line 55: | Line 48: | ||
<!-- Note Section END --> | <!-- Note Section END --> | ||
</dl> | </dl> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
Revision as of 14:44, 7 April 2019
Hover & click on the images for descriptions
Description
- Description:
-
Runs given statement every frame.
Syntax
Examples
- Example 1:
-
onEachFrame { hintSilent str position player}; //Hints position every frame
- Example 2:
- Private variables defined outside of 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"..."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:
onEachFrame {sleep 1}; //ERROR!!!
Additional Information
- See also:
- diag_frameNodiag_fps
- Groups:
- Uncategorised
Notes
Notes
- Posted on 21 Dec, 2012
- neokika
-
onEachFrame {}; //Reset event
Bottom Section
Categories:
- Pages using duplicate arguments in template calls
- Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Arma 2: Operation Arrowhead: New Scripting Commands
- Command Group: Uncategorised
- Introduced with Arma 2: Operation Arrowhead version 1.63
- ArmA 2 OA: New Scripting Commands List
- Scripting Commands ArmA2
- Scripting Commands Arma 3