pluginbase.Objects.Tasks.YieldingTask Class Reference

Uses static yield-types to schedule something if IEnumerable<ITaskYieldAction> for inline code More...

Inheritance diagram for pluginbase.Objects.Tasks.YieldingTask:

Public Member Functions
	YieldingTask (Func< IEnumerable< ITaskYieldAction >> method, TimeSpan delay)
	YieldingTask (Func< IEnumerable< ITaskYieldAction >> method)

Static Public Member Functions
static ITaskYieldAction	Task (ITask task)
	Yield a new task to run here More...
static ITaskYieldAction	Task (Func< IEnumerable< ITaskYieldAction >> task)
	Yield a new task to run here More...
static ITaskYieldAction	Wait (Func< bool > predicate, TimeSpan checkTime)
	Wait until the predicate is true, checking every amount of time More...
static ITaskYieldAction	Wait (TimeSpan time)
	Wait the specified time More...
static ITaskYieldAction	Wait (Func< bool > predicate)
	Wait for the predicate to be true More...
static ITaskYieldAction	Wait (double seconds)
	Wait the specified number of seconds More...

Properties
static ITaskYieldAction	Next [get]
	Yields to the next scheduled task. Will start again in the next tick More...
static ITaskYieldAction	Reset [get]
	Restarts the task over from the beginning More...
Properties inherited from pluginbase.Objects.Tasks.ITask
TimeSpan	Frequency [get]

Detailed Description

Uses static yield-types to schedule something if IEnumerable<ITaskYieldAction> for inline code

Constructor & Destructor Documentation

YieldingTask() [1/2]

pluginbase.Objects.Tasks.YieldingTask.YieldingTask	(	Func< IEnumerable< ITaskYieldAction >>	method,
		TimeSpan	delay
	)

        {
            _method = method;
            _iter = method().GetEnumerator();
            _frequency = delay;
        }

YieldingTask() [2/2]

pluginbase.Objects.Tasks.YieldingTask.YieldingTask

(

Func< IEnumerable< ITaskYieldAction >>

method

)

            :this(method, TimeSpan.Zero)
        { }

Member Function Documentation

Task() [1/2]

static ITaskYieldAction pluginbase.Objects.Tasks.YieldingTask.Task ( ITask  task )

static

Yield a new task to run here

Parameters

task

Task.

        {
            return new YieldTask(task);
        }

Task() [2/2]

static ITaskYieldAction pluginbase.Objects.Tasks.YieldingTask.Task ( Func< IEnumerable< ITaskYieldAction >>  task )

static

Yield a new task to run here

Parameters

task

Task.

        {
            return new YieldTask(new YieldingTask(task));
        }

Wait() [1/4]

static ITaskYieldAction pluginbase.Objects.Tasks.YieldingTask.Wait ( Func< bool >  predicate, TimeSpan  checkTime  )

static

Wait until the predicate is true, checking every amount of time

Parameters

predicate	Predicate.
checkTime	Check time.

        {
            return new YieldWait(predicate, checkTime);
        }

Wait() [2/4]

static ITaskYieldAction pluginbase.Objects.Tasks.YieldingTask.Wait ( TimeSpan  time )

static

Wait the specified time

Parameters

time

Time.

        {
            return new YieldWait(time);
        }

Wait() [3/4]

static ITaskYieldAction pluginbase.Objects.Tasks.YieldingTask.Wait ( Func< bool >  predicate )

static

Wait for the predicate to be true

Parameters

predicate

Predicate.

        {
            return new YieldWait(predicate, TimeSpan.FromSeconds(0.5));
        }

Wait() [4/4]

static ITaskYieldAction pluginbase.Objects.Tasks.YieldingTask.Wait ( double  seconds )

static

Wait the specified number of seconds

Parameters

seconds

Seconds.

        {
            return new YieldWait(TimeSpan.FromSeconds(seconds));
        }

Property Documentation

Next

ITaskYieldAction pluginbase.Objects.Tasks.YieldingTask.Next

staticget

Yields to the next scheduled task. Will start again in the next tick

Reset

ITaskYieldAction pluginbase.Objects.Tasks.YieldingTask.Reset

staticget

Restarts the task over from the beginning

The reset.

---

The documentation for this class was generated from the following file:

• pluginbase/Objects/Tasks/YieldingTask.cs