Click or drag to resize

AsyncCallWaitForPhysics Method

Delays execution until the specified condition is reached. Waiting is limited by the specified number of fixed frame updates.

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 WaitForPhysics(
	MonoBehaviour mono,
	int maxFrames,
	Func<bool> waitUntilFn,
	Action success = null,
	Action failure = null,
	Action<int> update = null
)
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.
maxFrames
Type: SystemInt32
The number of fixed frame updates to wait before giving up.
waitUntilFn
Type: SystemFuncBoolean
The state checking function. It should return true once the target state is reached. The very first execution happens immediately on the method call, before exiting from the method. If this execution returns true, then the successful callback is also called immediately.
success (Optional)
Type: SystemAction
The callback to execute when the state has been successfully reached.
failure (Optional)
Type: SystemAction
The callabck to execute when the state has not been reached before the frame update limit is exhausted.
update (Optional)
Type: SystemActionInt32
The callback to execute every fixed frame update while waiting. This callabck will be called at least once, and the first call happens immediately. The argument tells how many frames the method was waiting so far. For the very first call it's 0.

Return Value

Type: Coroutine
The coroutine instance.
Remarks
Can be used when the code expects some specific physical state of the game. The method allows to define for how long to wait, what to do while waiting, and what to execute when target state is reached or missed.
Examples
Copy
class AsyncCall_WaitForPhysics1 : MonoBehaviour {
  void Awake() {
    var count = 5;
    Debug.Log("Before start waiting");
    AsyncCall.WaitForPhysics(
        this, 10,
        () => --count == 0,
        success: () => Debug.Log("Success!"),
        failure: () => Debug.Log("Failure!"),
        update: x => Debug.LogFormat("...waiting: {0}", x));
    Debug.Log("After start waiting");

    // The output in the logs will be:
    // Before start waiting
    // ...waiting: 0
    // After start waiting
    // ...waiting: 1
    // ...waiting: 2
    // ...waiting: 3
    // ...waiting: 4
    // Success!
  }
}
Examples
Copy
class AsyncCall_WaitForPhysics2 : MonoBehaviour {
  void Awake() {
    var count = 10;
    Debug.Log("Before start waiting");
    AsyncCall.WaitForPhysics(
        this, 5,
        () => --count == 0,
        success: () => Debug.Log("Success!"),
        failure: () => Debug.Log("Failure!"),
        update: x => Debug.LogFormat("...waiting: {0}", x));
    Debug.Log("After start waiting");

    // The output in the logs will be:
    // Before start waiting
    // ...waiting: 0
    // After start waiting
    // ...waiting: 1
    // ...waiting: 2
    // ...waiting: 3
    // ...waiting: 4
    // Failure!
  }
}
See Also