onEachFrame

1.63

Hover & click on the images for descriptions

Description

Description:

Statement is run every frame.

In order to keep compatibility between official and community content the functions BIS_fnc_addStackedEventHandler and BIS_fnc_removeStackedEventHandler should be used instead.

Syntax

Syntax:

onEachFrame statement

Parameters:

statement: Code

Return Value:

Nothing

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:

See also needed

Notes

i

Only post proven facts here. Report bugs on the feedback tracker. Use the Talk page or the Forums for discussions.

Add New Note | How To

Notes

Posted on 21 Dec, 2012

neokika

onEachFrame {}; //Reset event

Posted on August 28, 2014 - 15:21 (UTC)

Killzone Kid

If you need a stackable onEachFrame event, use mission event handler "Draw3D": addMissionEventHandler ["Draw3D", {...code to run each frame...}]; It is not a full substitute to onEachFrame as "Draw3D" will stop executing on Alt+Tab and doesn't work on hasInterface => false clients, such as dedicated server.