CG Framework 0.1
Chloroplast Games Framework
CGF.Systems.Job Class Reference

Clase de Job. More...

Public Member Functions

 Job (IEnumerator coroutine)
 
 Job (IEnumerator coroutine, bool shouldStart)
 
Job CreateAndAddChildJob (IEnumerator coroutine)
 
void AddChildJob (Job childJob)
 
void RemoveChildJob (Job childJob)
 
void Start ()
 
void Restart ()
 
IEnumerator StartAsCoroutine ()
 
void Pause ()
 
void Play ()
 
void Kill ()
 

Static Public Member Functions

static Job Make (IEnumerator coroutine)
 
static Job Make (IEnumerator coroutine, bool shouldStart)
 

Properties

bool running [get]
 
bool paused [get]
 

Events

Action< bool > jobComplete
 

Private Member Functions

IEnumerator DoWork ()
 
IEnumerator RunChildJobs ()
 

Private Attributes

bool _running
 
bool _paused
 
IEnumerator _coroutine
 
bool _jobWasKilled
 
Stack< Job_childJobStack
 

Detailed Description

Clase de Job.

Constructor & Destructor Documentation

◆ Job() [1/2]

CGF.Systems.Job.Job ( IEnumerator  coroutine)

Parameters
coroutine

◆ Job() [2/2]

CGF.Systems.Job.Job ( IEnumerator  coroutine,
bool  shouldStart 
)

Parameters
coroutine
shouldStart

Member Function Documentation

◆ AddChildJob()

void CGF.Systems.Job.AddChildJob ( Job  childJob)

Parameters
childJob

◆ CreateAndAddChildJob()

Job CGF.Systems.Job.CreateAndAddChildJob ( IEnumerator  coroutine)

Parameters
coroutine
Returns

◆ DoWork()

IEnumerator CGF.Systems.Job.DoWork ( )
private

Returns

◆ Kill()

void CGF.Systems.Job.Kill ( )

◆ Make() [1/2]

static Job CGF.Systems.Job.Make ( IEnumerator  coroutine)
static

Parameters
coroutine
Returns

◆ Make() [2/2]

static Job CGF.Systems.Job.Make ( IEnumerator  coroutine,
bool  shouldStart 
)
static

Parameters
coroutine
shouldStart
Returns

◆ Pause()

void CGF.Systems.Job.Pause ( )

◆ Play()

void CGF.Systems.Job.Play ( )

◆ RemoveChildJob()

void CGF.Systems.Job.RemoveChildJob ( Job  childJob)

Parameters
childJob

◆ Restart()

void CGF.Systems.Job.Restart ( )

◆ RunChildJobs()

IEnumerator CGF.Systems.Job.RunChildJobs ( )
private

Returns

◆ Start()

void CGF.Systems.Job.Start ( )

◆ StartAsCoroutine()

IEnumerator CGF.Systems.Job.StartAsCoroutine ( )

Returns

Member Data Documentation

◆ _childJobStack

Stack<Job> CGF.Systems.Job._childJobStack
private

◆ _coroutine

IEnumerator CGF.Systems.Job._coroutine
private

◆ _jobWasKilled

bool CGF.Systems.Job._jobWasKilled
private

◆ _paused

bool CGF.Systems.Job._paused
private

◆ _running

bool CGF.Systems.Job._running
private

Property Documentation

◆ paused

bool CGF.Systems.Job.paused
get

Returns

◆ running

bool CGF.Systems.Job.running
get

Returns

Event Documentation

◆ jobComplete

Action<bool> CGF.Systems.Job.jobComplete


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