essentials.action.Pathing.PathingJob Class Reference

A pathing job for the task scheduler to increment an engine More...

Inheritance diagram for essentials.action.Pathing.PathingJob:

Public Member Functions
	PathingJob (IPathingEngine engine)
void	Abort ()
Path	GetResult ()

Properties
PathEngineState	State [get]
Properties inherited from pluginbase.Objects.Tasks.ITask
TimeSpan	Frequency [get]

Events
Action< Path >	OnComplete
Action< Path >	OnIncrement

Detailed Description

A pathing job for the task scheduler to increment an engine

Constructor & Destructor Documentation

PathingJob()

essentials.action.Pathing.PathingJob.PathingJob

(

IPathingEngine

engine

)

        {
            _engine = engine;
            _timer = new Stopwatch();
        }

Member Function Documentation

Abort()

void essentials.action.Pathing.PathingJob.Abort

(

)

        {
            _abort = true;
        }

GetResult()

Path essentials.action.Pathing.PathingJob.GetResult

(

)

        {
            return _engine.GetResult();
        }

Property Documentation

State

PathEngineState essentials.action.Pathing.PathingJob.State

get

Event Documentation

OnComplete

Action<Path> essentials.action.Pathing.PathingJob.OnComplete

OnIncrement

Action<Path> essentials.action.Pathing.PathingJob.OnIncrement

---

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

• essentials.action/Pathing/PathingJob.cs