Struct traffloat::SetupEcs[−][src]

pub struct SetupEcs {
    pub server: bool,
    pub builder: Builder,
    pub world: World,
    pub resources: Resources,
    pub(crate) classes: EnumMap<SystemClass, ClassSchedule>,
}

Expand description

The standard setup parameters

Fields

server: bool

Whether to enable server-only systems

builder: Builder

The legion::Scheduler builder

world: World

The legion world storing entities and components

resources: Resources

The resource set storing legion resources

classes: EnumMap<SystemClass, ClassSchedule>

The schedule of each class of systems

Implementations

[src]

impl SetupEcs

[src]

pub fn uses(self, setup_ecs: fn(SetupEcs) -> SetupEcs) -> SetupEcs

Register a bundle

[src]

pub fn system(
    self,
    sys: impl ParallelRunnable + 'static,
    class: SystemClass
) -> SetupEcs

Add a system

[src]

pub fn system_local(
    self,
    sys: impl Runnable + 'static,
    class: SystemClass
) -> SetupEcs

Add a thread-local system

[src]

pub fn entity<T>(self, components: T) -> SetupEcs where
Option<T>: IntoComponentSource,

Add an entity

[src]

pub fn entities<T>(self, components: impl IntoComponentSource) -> SetupEcs

Add entities

[src]

pub fn resource(self, res: impl Resource) -> SetupEcs

Add a resource

[src]

pub fn resource_default<T>(self) -> SetupEcs where
T: Resource + Default,

Add a default resource

[src]

pub fn publisher<T>(self) -> SetupEcs where
T: Event,

Declare a published event

[src]

pub fn publish_event<T>(self, t: T) -> SetupEcs where
T: Event,

Publish an event

[src]

pub fn subscriber<T>(&mut self) -> ReaderId<T> where
T: Event,

Declare a subscribed event

[src]

pub fn build(self) -> Legion

Build the setup into a legion

Trait Implementations

[src]

impl Default for SetupEcs

[src]

pub fn default() -> SetupEcs

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl !RefUnwindSafe for SetupEcs

impl !Send for SetupEcs

impl !Sync for SetupEcs

impl Unpin for SetupEcs

impl !UnwindSafe for SetupEcs

Blanket Implementations

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> Downcast for T where
T: Any,

[src]

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

[src]

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

[src]

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

[src]

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T> Same<T> for T

type Output = T

Should always be Self

[src]

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

[src]

pub fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

[src]

pub fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

[src]

pub fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

[src]

pub fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

[src]

Struct traffloat::SetupEcs[−][src]

Fields

Implementations

impl SetupEcs

pub fn uses(self, setup_ecs: fn(SetupEcs) -> SetupEcs) -> SetupEcs

pub fn system( self, sys: impl ParallelRunnable + 'static, class: SystemClass) -> SetupEcs

pub fn system_local( self, sys: impl Runnable + 'static, class: SystemClass) -> SetupEcs

pub fn entity<T>(self, components: T) -> SetupEcs where Option<T>: IntoComponentSource,

pub fn entities<T>(self, components: impl IntoComponentSource) -> SetupEcs

pub fn resource(self, res: impl Resource) -> SetupEcs

pub fn resource_default<T>(self) -> SetupEcs where T: Resource + Default,

pub fn publisher<T>(self) -> SetupEcs where T: Event,

pub fn publish_event<T>(self, t: T) -> SetupEcs where T: Event,

pub fn subscriber<T>(&mut self) -> ReaderId<T> where T: Event,

pub fn build(self) -> Legion

Trait Implementations

impl Default for SetupEcs

pub fn default() -> SetupEcs

Auto Trait Implementations

impl !RefUnwindSafe for SetupEcs

impl !Send for SetupEcs

impl !Sync for SetupEcs

impl Unpin for SetupEcs

impl !UnwindSafe for SetupEcs

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for T where T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

pub fn as_any(&self) -> &(dyn Any + 'static)

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

pub fn to_subset(&self) -> Option<SS>

pub fn is_in_subset(&self) -> bool

pub fn to_subset_unchecked(&self) -> SS

pub fn from_subset(element: &SS) -> SP

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> Resource for T where T: 'static,

impl<T> UnsafeAny for T where T: Any,

pub fn system(
self,
sys: impl ParallelRunnable + 'static,
class: SystemClass
) -> SetupEcs

pub fn system_local(
self,
sys: impl Runnable + 'static,
class: SystemClass
) -> SetupEcs

pub fn entity<T>(self, components: T) -> SetupEcs where
Option<T>: IntoComponentSource,

pub fn resource_default<T>(self) -> SetupEcs where
T: Resource + Default,

pub fn publisher<T>(self) -> SetupEcs where
T: Event,

pub fn publish_event<T>(self, t: T) -> SetupEcs where
T: Event,

pub fn subscriber<T>(&mut self) -> ReaderId<T> where
T: Event,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Downcast for T where
T: Any,

impl<T, U> Into<U> for T where
U: From<T>,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<T> Resource for T where
T: 'static,

impl<T> UnsafeAny for T where
T: Any,