TaskWaitForStatus Method (TaskStatus, Int32)

RAGE Plugin Hook Documentation

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

Sleeps the active GameFiber until the task reaches the specified status.

Namespace:  Rage
Assembly:  RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.56.1131.11510)
Syntax

public virtual bool WaitForStatus(
	TaskStatus status,
	int timeout
)

Parameters

status
Type: RageTaskStatus
The status to wait for.
timeout
Type: SystemInt32
The time, in milliseconds, to allow the task to reach the specified status. If -1, the method will never time out.

Return Value

Type: Boolean
If the task reached the status before timing out, returns true; otherwise, returns false.
See Also

Reference