GameFiber Methods

RAGE Plugin Hook Documentation

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

The GameFiber type exposes the following members.

Methods

  NameDescription
Public methodAbort
Aborts this instance.
Public methodStatic memberExecuteFor
Calls the specified method once every tick on the calling GameFiber, for the specified duration.
Public methodStatic memberExecuteNewFor(ThreadStart, Int32)
Calls the specified method once every tick on a new GameFiber, for the specified duration.
Public methodStatic memberExecuteNewFor(ThreadStart, String, Int32)
Calls the specified method once every tick on a new GameFiber, for the specified duration.
Public methodStatic memberExecuteNewWhile(ThreadStart, FuncBoolean)
Calls the specified method once every tick on a new GameFiber, while the specified condition is true.
Public methodStatic memberExecuteNewWhile(ThreadStart, String, FuncBoolean)
Calls the specified method once every tick on a new GameFiber, while the specified condition is true.
Public methodStatic memberExecuteWhile
Calls the specified method once every tick on the calling GameFiber, while the specified condition is true.
Public methodStatic memberHibernate

Makes the active GameFiber sleep indefinitely.

Other GameFibers can awaken this instance by calling Wake() on the instance.

Protected methodHibernateThis
Hibernates this instance. Note that only the active GameFiber can be set to hibernate.
Public methodStatic memberSleep
Sleeps the active instance the specified duration.
Protected methodSleepThis
Sleeps this instance the specified duration. Note that only the active GameFiber can be set to sleep.
Public methodStatic memberCode exampleSleepUntil
Yields the executing fiber until the specified condition is met.
Public methodStatic memberCode exampleSleepWhile
Yields the executing fiber while the specified condition is met.
Public methodStart
Starts this instance.
Public methodStatic memberStartNew(ThreadStart)
Starts a new GameFiber instance.
Public methodStatic memberStartNew(ThreadStart, String)
Starts a new GameFiber instance.
Public methodStatic memberWait

Waits the active instance the specified duration.

Unlike sleep, wait is scaled based on game time dilation.

Protected methodWaitThis

Waits this instance the specified duration. Note that only the active GameFiber can be set to wait.

Unlike sleep, wait is scaled based on game time dilation.

Public methodStatic memberCode exampleWaitUntil(FuncBoolean)
Yields the executing fiber until the specified condition is met. The condition is not checked while the game is paused.
Public methodStatic memberCode exampleWaitUntil(FuncBoolean, Int32)
Yields the executing fiber until the specified condition is met. The condition is not checked while the game is paused.
Public methodStatic memberCode exampleWaitWhile(FuncBoolean)
Yields the executing fiber while the specified condition is met. The condition is not checked while the game is paused.
Public methodStatic memberCode exampleWaitWhile(FuncBoolean, Int32)
Yields the executing fiber while the specified condition is met. The condition is not checked while the game is paused.
Public methodWake
Awakens this instance from hibernation.
Public methodStatic memberYield
Yields this instance allowing other instances to be processed. Equivalent to Sleep(0);
Top
See Also

Reference