Click or drag to resize

AsyncCallAsyncWaitForPhysics Method

Async version of WaitForPhysics(MonoBehaviour, Int32, FuncBoolean, Action, Action, ActionInt32).

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 IEnumerator AsyncWaitForPhysics(
	int maxFrames,
	Func<bool> waitUntilFn,
	Action success = null,
	Action failure = null,
	Action<int> update = null
)
Request Example View Source

Parameters

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: IEnumerator
The enumerator that can be used as a coroutine target.
Examples
This method is useful when synchronous wait is needed within a coroutine. Instead of implementing own loops just return the waiting enumerator. The code below will log 10 waiting lines between "Started" and "Ended" records.
Copy
class MyComponent : MonoBehaviour {
  void Awake() {
    StartCoroutine(MyDelayedFn());
  }
  IEnumerator MyDelayedFn() {
    Debug.Log("Started!");
    yield return AsyncCall.AsyncWaitForPhysics(
       10,
       () => false,
       update: frame => Debug.LogFormat("...waiting frame {0}...", frame));
    Debug.Log("Ended!");
  }
}
See Also