Struct specs_task::TaskManager

pub struct TaskManager<'a> { /* fields omitted */ }

The main object for users of this module. Used for creating and connecting tasks.

Implementations

impl<'_> TaskManager<'_>

pub fn task_is_complete(&self, entity: Entity) -> bool

Returns true iff the task was seen as complete on the last run of the TaskManagerSystem.

WARNING: assumes that this entity was at one point a task, and it can't tell otherwise.

pub fn entity_is_complete(&self, entity: Entity) -> bool

Tells you whether a fork or a task entity is complete.

WARNING: assumes that this entity was at one point a task or a fork, and it can't tell otherwise.

pub fn count_tasks_in_progress(&self) -> usize

Returns the number of tasks that haven't yet completed.

pub fn delete_descendents(&self, entity: Entity)

Deletes only the descendent entities of entity, but leaves entity alive.

pub fn delete_entity_and_descendents(&self, entity: Entity)

Deletes entity and all of its descendents.

Trait Implementations

impl<'a> SystemData<'a> for TaskManager<'a> where
    Entities<'a>: SystemData<'a>,
    WriteStorage<'a, TaskProgress>: SystemData<'a>,
    ReadStorage<'a, SingleEdge>: SystemData<'a>,
    ReadStorage<'a, MultiEdge>: SystemData<'a>, 

fn setup(world: &mut World)

Sets up the system data for fetching it from the World.

fn fetch(world: &'a World) -> Self

Fetches the system data from World. Note that this is only specified for one concrete lifetime 'a, you need to implement the SystemData trait for every possible lifetime.

fn reads() -> Vec<ResourceId>

Returns all read dependencies as fetched from Self::fetch.

fn writes() -> Vec<ResourceId>

Returns all write dependencies as fetched from Self::fetch.