GameFiber Class

RAGE Plugin Hook Documentation

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

Represents a multi-tasking fiber. Natives can only be invoked from a fiber. Not meant to be inherited.

Inheritance Hierarchy

SystemObject
RageGameFiber

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

Syntax

C++

Copy

[SerializableAttribute]
public class GameFiber

<SerializableAttribute>
Public Class GameFiber

[SerializableAttribute]
public ref class GameFiber

The GameFiber type exposes the following members.

Constructors

	Name	Description
	GameFiber(ThreadStart)	Initializes a new instance of the GameFiber class.
	GameFiber(ThreadStart, String)	Initializes a new instance of the GameFiber class.

Top

Properties

	Name	Description
	CanSleepNow	Gets a value indicating whether the calling code is executing in the active GameFiber instance.
	IsAlive	Gets a value indicating whether this instance is still running.
	IsEntryFiber	Gets or sets a value indicating whether this fiber is the original fiber created when this plugin was loaded.
	IsHibernating	Gets a value indicating whether this instance is hibernating.
	IsSleeping	Gets a value indicating whether this instance is sleeping.
	Name	Gets the name of this instance.

Top

Methods

	Name	Description
	Abort	Aborts this instance.
	ExecuteFor	Calls the specified method once every tick on the calling GameFiber, for the specified duration.
	ExecuteNewFor(ThreadStart, Int32)	Calls the specified method once every tick on a new GameFiber, for the specified duration.
	ExecuteNewFor(ThreadStart, String, Int32)	Calls the specified method once every tick on a new GameFiber, for the specified duration.
	ExecuteNewWhile(ThreadStart, FuncBoolean)	Calls the specified method once every tick on a new GameFiber, while the specified condition is true.
	ExecuteNewWhile(ThreadStart, String, FuncBoolean)	Calls the specified method once every tick on a new GameFiber, while the specified condition is true.
	ExecuteWhile	Calls the specified method once every tick on the calling GameFiber, while the specified condition is true.
	Hibernate	Makes the active GameFiber sleep indefinitely. Other GameFibers can awaken this instance by calling Wake() on the instance.
	HibernateThis	Hibernates this instance. Note that only the active GameFiber can be set to hibernate.
	Sleep	Sleeps the active instance the specified duration.
	SleepThis	Sleeps this instance the specified duration. Note that only the active GameFiber can be set to sleep.
	SleepUntil	Yields the executing fiber until the specified condition is met.
	SleepWhile	Yields the executing fiber while the specified condition is met.
	Start	Starts this instance.
	StartNew(ThreadStart)	Starts a new GameFiber instance.
	StartNew(ThreadStart, String)	Starts a new GameFiber instance.
	Wait	Waits the active instance the specified duration. Unlike sleep, wait is scaled based on game time dilation.
	WaitThis	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.
	WaitUntil(FuncBoolean)	Yields the executing fiber until the specified condition is met. The condition is not checked while the game is paused.
	WaitUntil(FuncBoolean, Int32)	Yields the executing fiber until the specified condition is met. The condition is not checked while the game is paused.
	WaitWhile(FuncBoolean)	Yields the executing fiber while the specified condition is met. The condition is not checked while the game is paused.
	WaitWhile(FuncBoolean, Int32)	Yields the executing fiber while the specified condition is met. The condition is not checked while the game is paused.
	Wake	Awakens this instance from hibernation.
	Yield	Yields this instance allowing other instances to be processed. Equivalent to Sleep(0);

Top

Reference

Rage Namespace