Struct constellation::SystemContext

pub struct SystemContext<'a, S: Send + Sync + 'static> { /* fields omitted */ }

Contains system execution state information.

Methods

impl<'a, S: Send + Sync + 'static> SystemContext<'a, S>

fn state(&self) -> &S

Gets the current system execution state.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r0w1<'b, W0>(&self,
                     W0: &'b mut W0)
                     -> EntityIteratorBuilder<'a, (), (&'b mut W0,)> where W0: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r0w2<'b, W0, W1>(&self,
                         W0: &'b mut W0,
                         W1: &'b mut W1)
                         -> EntityIteratorBuilder<'a, (), (&'b mut W0, &'b mut W1)> where W0: EntityResource, W1: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r0w3<'b, W0, W1, W2>(&self,
                             W0: &'b mut W0,
                             W1: &'b mut W1,
                             W2: &'b mut W2)
                             -> EntityIteratorBuilder<'a, (), (&'b mut W0, &'b mut W1, &'b mut W2)> where W0: EntityResource, W1: EntityResource, W2: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r1w0<'b, R0>(&self,
                     R0: &'b R0)
                     -> EntityIteratorBuilder<'a, (&'b R0,), ()> where R0: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r1w1<'b, R0, W0>(&self,
                         R0: &'b R0,
                         W0: &'b mut W0)
                         -> EntityIteratorBuilder<'a, (&'b R0,), (&'b mut W0,)> where R0: EntityResource, W0: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r1w2<'b, R0, W0, W1>(&self,
                             R0: &'b R0,
                             W0: &'b mut W0,
                             W1: &'b mut W1)
                             -> EntityIteratorBuilder<'a, (&'b R0,), (&'b mut W0, &'b mut W1)> where R0: EntityResource, W0: EntityResource, W1: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r1w3<'b, R0, W0, W1, W2>(&self,
                                 R0: &'b R0,
                                 W0: &'b mut W0,
                                 W1: &'b mut W1,
                                 W2: &'b mut W2)
                                 -> EntityIteratorBuilder<'a, (&'b R0,), (&'b mut W0, &'b mut W1, &'b mut W2)> where R0: EntityResource,
        W0: EntityResource,
        W1: EntityResource,
        W2: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r2w0<'b, R0, R1>(&self,
                         R0: &'b R0,
                         R1: &'b R1)
                         -> EntityIteratorBuilder<'a, (&'b R0, &'b R1), ()> where R0: EntityResource, R1: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r2w1<'b, R0, R1, W0>(&self,
                             R0: &'b R0,
                             R1: &'b R1,
                             W0: &'b mut W0)
                             -> EntityIteratorBuilder<'a, (&'b R0, &'b R1), (&'b mut W0,)> where R0: EntityResource, R1: EntityResource, W0: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r2w2<'b, R0, R1, W0, W1>(&self,
                                 R0: &'b R0,
                                 R1: &'b R1,
                                 W0: &'b mut W0,
                                 W1: &'b mut W1)
                                 -> EntityIteratorBuilder<'a, (&'b R0, &'b R1), (&'b mut W0, &'b mut W1)> where R0: EntityResource,
        R1: EntityResource,
        W0: EntityResource,
        W1: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r2w3<'b, R0, R1, W0, W1, W3>(&self,
                                     R0: &'b R0,
                                     R1: &'b R1,
                                     W0: &'b mut W0,
                                     W1: &'b mut W1,
                                     W3: &'b mut W3)
                                     -> EntityIteratorBuilder<'a, (&'b R0, &'b R1), (&'b mut W0, &'b mut W1, &'b mut W3)> where R0: EntityResource,
        R1: EntityResource,
        W0: EntityResource,
        W1: EntityResource,
        W3: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r3w0<'b, R0, R1, R2>(&self,
                             R0: &'b R0,
                             R1: &'b R1,
                             R2: &'b R2)
                             -> EntityIteratorBuilder<'a, (&'b R0, &'b R1, &'b R2), ()> where R0: EntityResource, R1: EntityResource, R2: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r3w1<'b, R0, R1, R2, W0>(&self,
                                 R0: &'b R0,
                                 R1: &'b R1,
                                 R2: &'b R2,
                                 W0: &'b mut W0)
                                 -> EntityIteratorBuilder<'a, (&'b R0, &'b R1, &'b R2), (&'b mut W0,)> where R0: EntityResource,
        R1: EntityResource,
        R2: EntityResource,
        W0: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r3w2<'b, R0, R1, R2, W0, W1>(&self,
                                     R0: &'b R0,
                                     R1: &'b R1,
                                     R2: &'b R2,
                                     W0: &'b mut W0,
                                     W1: &'b mut W1)
                                     -> EntityIteratorBuilder<'a, (&'b R0, &'b R1, &'b R2), (&'b mut W0, &'b mut W1)> where R0: EntityResource,
        R1: EntityResource,
        R2: EntityResource,
        W0: EntityResource,
        W1: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r3w3<'b, R0, R1, R2, W0, W1, W3>(&self,
                                         R0: &'b R0,
                                         R1: &'b R1,
                                         R2: &'b R2,
                                         W0: &'b mut W0,
                                         W1: &'b mut W1,
                                         W3: &'b mut W3)
                                         -> EntityIteratorBuilder<'a, (&'b R0, &'b R1, &'b R2), (&'b mut W0, &'b mut W1, &'b mut W3)> where R0: EntityResource,
        R1: EntityResource,
        R2: EntityResource,
        W0: EntityResource,
        W1: EntityResource,
        W3: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r4w0<'b, R0, R1, R2, R3>(&self,
                                 R0: &'b R0,
                                 R1: &'b R1,
                                 R2: &'b R2,
                                 R3: &'b R3)
                                 -> EntityIteratorBuilder<'a, (&'b R0, &'b R1, &'b R2, &'b R3), ()> where R0: EntityResource,
        R1: EntityResource,
        R2: EntityResource,
        R3: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r4w1<'b, R0, R1, R2, R3, W0>(&self,
                                     R0: &'b R0,
                                     R1: &'b R1,
                                     R2: &'b R2,
                                     R3: &'b R3,
                                     W0: &'b mut W0)
                                     -> EntityIteratorBuilder<'a, (&'b R0, &'b R1, &'b R2, &'b R3), (&'b mut W0,)> where R0: EntityResource,
        R1: EntityResource,
        R2: EntityResource,
        R3: EntityResource,
        W0: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r4w2<'b, R0, R1, R2, R3, W0, W1>(&self,
                                         R0: &'b R0,
                                         R1: &'b R1,
                                         R2: &'b R2,
                                         R3: &'b R3,
                                         W0: &'b mut W0,
                                         W1: &'b mut W1)
                                         -> EntityIteratorBuilder<'a, (&'b R0, &'b R1, &'b R2, &'b R3), (&'b mut W0, &'b mut W1)> where R0: EntityResource,
        R1: EntityResource,
        R2: EntityResource,
        R3: EntityResource,
        W0: EntityResource,
        W1: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

impl<'a, S: Sync + Send> SystemContext<'a, S>

fn iter_r4w3<'b, R0, R1, R2, R3, W0, W1, W3>(&self,
                                             R0: &'b R0,
                                             R1: &'b R1,
                                             R2: &'b R2,
                                             R3: &'b R3,
                                             W0: &'b mut W0,
                                             W1: &'b mut W1,
                                             W3: &'b mut W3)
                                             -> EntityIteratorBuilder<'a, (&'b R0, &'b R1, &'b R2, &'b R3), (&'b mut W0, &'b mut W1, &'b mut W3)> where R0: EntityResource,
        R1: EntityResource,
        R2: EntityResource,
        R3: EntityResource,
        W0: EntityResource,
        W1: EntityResource,
        W3: EntityResource

Constructs an entity iterator builder for performing iterations over the given resources.

Methods from Deref<Target=EntitiesTransaction<'a>>

fn create(&mut self) -> Entity

Creates a new Entity.

This Entity can immediately be used to register data with resources, and the calling system may destroy the entity, but other systems running concurrently will not observe the entity's creation.

fn destroy(&mut self, entity: Entity)

Destroys an Entity.

Entity destructions are deferred until after the system has completed execution. All related data stored in entity resources will also be removed at this time.

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

Determines if the given Entity is still alive.

fn by_index(&self, index: Index) -> Entity

Gets the currently living Entity with the given Index.

fn to_change_set(self) -> EntityChangeSet

Converts this transaction into a change set, consuming the transaction in the process.

Trait Implementations

impl<'a, S: Send + Sync + 'static> Deref for SystemContext<'a, S>

type Target = EntitiesTransaction<'a>

The resulting type after dereferencing

fn deref(&self) -> &EntitiesTransaction<'a>

The method called to dereference a value

impl<'a, S: Send + Sync + 'static> DerefMut for SystemContext<'a, S>

fn deref_mut(&mut self) -> &mut EntitiesTransaction<'a>

The method called to mutably dereference a value