C4 Engine
C4 Engine API Documentation


Defined in:  C4Threads.h
Waits for a signal to be triggered.

int32 WaitSignal(int32 time = kSignalForever);

time The time, in milliseconds, to wait for a signal. This should be a nonnegative integer or the special constant kSignalForever indicating that the function should not time out.
The WaitSignal function waits for a signal to be triggered or for a timeout interval to expire. If no trigger occurs before the timeout interval expires, then the return value is kSignalTimeout. Otherwise, the return value is the index value that was passed to the Signal::TriggerSignal function to trigger the signal.
See Also