Click or drag to resize

AsyncCallCallOnEndOfFrame Method

Delays execution of the delegate till the end of the frame.

Namespace:  KSPDev.ProcessingUtils
Assembly:  KSPDev_Utils.1.2 (in KSPDev_Utils.1.2.dll) Version: 1.2 for KSP v1.6+
Syntax
C#
Copy
public static Coroutine CallOnEndOfFrame(
	MonoBehaviour mono,
	Action action,
	int skipFrames = 0
)
Request Example View Source

Parameters

mono
Type: UnityEngineMonoBehaviour
The Unity object to run the coroutine on. If this object dies, then the async call will not be invoked.
action
Type: SystemAction
The delegate to execute.
skipFrames (Optional)
Type: SystemInt32
The number of frames to skip.

Return Value

Type: Coroutine
The coroutine instance.
Remarks
The delegate will trigger at the end of the selected frame update. If skipFrames is set to 0, then the delegate will be called at the end of the current frame. Calling this method in the "end of frame" callback will not schedule the callback on the next frame, the execution will just be placed at the end of the current frame execution queue. This behavior can be used to execute a logic that depends on some other delayed logic. In order to schedule the execution on the frame different from the current, specify the skipFrames parameter.
Examples
Copy
class AsyncCall_EndOfFrame : MonoBehaviour {
  void Update() {
    // Execute at the end of the current frame.
    AsyncCall.CallOnEndOfFrame(this, () => Debug.Log("Same frame async call!"));
    AsyncCall.CallOnEndOfFrame(
        this,
        () => AsyncCall.CallOnEndOfFrame(this, () => Debug.Log("Same frame, end of queue call!")));
    // Execute at the end of the next frame.
    AsyncCall.CallOnEndOfFrame(this, () => Debug.Log("Next frame async call!"), skipFrames: 1);
  }
}
See Also