taskshark/io.github.gearup12499.taskshark.prefabs/Group

Group

open class Group(conf: Group.ConfigureFn) : Task<Group>

Constructors

Group

constructor(conf: Group.ConfigureFn)

Types

ConfigureFn

fun interface ConfigureFn

Functions

canStart

open override fun canStart(): Boolean

Implement/override this method to check custom conditions upon which the Task can begin ticking.

dependedLocks

override fun dependedLocks(): Set<Lock>

Returns the set of Locks required for this task to begin. These are checked before canStart.

dependedTasks

override fun dependedTasks(): Set<ITask<*>>

Returns the set of ITasks that need to be completed for this task to begin.

describeVerbose

open fun describeVerbose(): <Error class: unknown class>

equals

open operator override fun equals(other: Any?): Boolean

extendGetDependents

open fun extendGetDependents(result: MutableSet<ITask<*>>)

finish

open fun finish()

Stops this task, moving it the Finished state and potentially calling onFinish.

getDependents

override fun getDependents(): <Error class: unknown class>

Provides hints for quicker startup times on chains of tasks.

getId

override fun getId(): Int

Return the task's ID number in the scheduler it's registered to.

getPriority

override fun getPriority(): Int

Priority hints which tasks should be processed first. High priority tasks are processed earlier than low priority tasks, in general.

getScheduler

fun getScheduler(): Scheduler

getState

override fun getState(): ITask.State

Returns the current State of the Task.

getTags

open override fun getTags(): Set<String>

Returns a set of descriptive tags that apply to this task.

hashCode

open override fun hashCode(): Int

onFinish

open override fun onFinish(completedNormally: Boolean)

Implement/override this method to handle cleaning up a Task after successful completion or cancellation.

onStart

open override fun onStart()

Implement/override this method to run code when the Task starts for the first time.

onTick

open override fun onTick(): Boolean

Implement/override this method to run code repeatedly during the Task's lifetime.

require

open override fun require(before: ITask<*>): Group

Add the provided before task as a dependency for this task.

open override fun require(lock: Lock): Group

Add the provided lock lock as a dependency for this task.

stop

open fun stop()

Stops this task, moving it the Cancelled state and potentially calling onFinish.

open override fun stop(cancel: Boolean)

Stops this task, moving it to an appropriate final state and potentially calling onFinish.

then

open override fun <T : ITask<T>> then(other: T): T

Sets up the provided other task to run after this task completes, adding it to the dependency tree.

toString

open override fun toString(): String

transition

open override fun transition(newState: ITask.State)

Updates the current State of the Task.