GameFiberSleepWhile Method

RAGE Plugin Hook Documentation

[This is preliminary documentation and is subject to change.]

Yields the executing fiber while the specified condition is met.

Namespace:  Rage
Assembly:  RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.56.1131.11510)
Syntax
Copy
public static void SleepWhile(
	Func<bool> condition,
	int timeOut
)

Parameters

condition
Type: SystemFuncBoolean
The condition.
timeOut
Type: SystemInt32
The maximum time to sleep. If set to 0, the call will not time out.
Examples

The following statement:

C#
Copy
GameFiber.SleepWhile(() => vehicle && vehicle.Speed < FiftyKilometersPerHour, 30000);

Is equivalent to the following piece of code:

C#
Copy
ulong startTime = Game.TickCount;
while (vehicle && vehicle.Speed < FiftyKilometersPerHour)
{
    if (Game.TickCount > startTime + 5000)
    {
        break;
    }

    GameFiber.Yield();
}
Examples

The following statement:

C#
Copy
GameFiber.SleepWhile(() => vehicle && vehicle.Speed < FiftyKilometersPerHour, 0);

Is equivalent to the following piece of code:

C#
Copy
while (vehicle && vehicle.Speed < FiftyKilometersPerHour)
{
    GameFiber.Yield();
}
See Also

Reference

GameFiber Class
Rage Namespace