Trait rin::ecs::System

pub trait System: Send {
    pub fn run(&mut self, entities: Entities<'_>, resources: Resources<'_>);

    pub fn checks(
        &mut StorageRegistry
    ) -> Option<SystemConditionElse<SyncSystem>> { ... }
    pub fn name() -> Option<&'static str> { ... }
    pub fn before() -> Vec<SystemId, Global> { ... }
    pub fn after() -> Vec<SystemId, Global> { ... }
    pub fn updates() -> Vec<TypeId, Global> { ... }
    pub fn needs() -> Vec<TypeId, Global> { ... }
    pub fn reads() -> Vec<TypeId, Global> { ... }
    pub fn writes() -> Vec<TypeId, Global> { ... }
    pub fn file_line_info(&self) -> &'static str { ... }
}

[−] Expand description

Trait for systems that can run from any thread in parallel with other systems.

Types implementing this trait must be Send and are usually called Send System in the documentation.

Any function that receives an Entities and a Resources parameter in that order can be added as a System to the world.

Required methods

pub fn run(&mut self, entities: Entities<'_>, resources: Resources<'_>)

Provided methods

pub fn checks(&mut StorageRegistry) -> Option<SystemConditionElse<SyncSystem>>

pub fn name() -> Option<&'static str>

pub fn before() -> Vec<SystemId, Global>

pub fn after() -> Vec<SystemId, Global>

pub fn updates() -> Vec<TypeId, Global>

pub fn needs() -> Vec<TypeId, Global>

pub fn reads() -> Vec<TypeId, Global>

pub fn writes() -> Vec<TypeId, Global>

pub fn file_line_info(&self) -> &'static str

Implementations on Foreign Types

impl<D, S> System for (S, D) where
    D: 'static + Send,
    S: SystemWithData<D> + Send, 

[+] Show hidden undocumented items

pub fn run(&mut self, entities: Entities<'_>, resources: Resources<'_>)

pub fn checks(
    entities: &mut StorageRegistry
) -> Option<SystemConditionElse<SyncSystem>> where
    (S, D): Sized, 

pub fn name() -> Option<&'static str> where
    (S, D): Sized, 

pub fn before() -> Vec<SystemId, Global> where
    (S, D): Sized, 

pub fn after() -> Vec<SystemId, Global> where
    (S, D): Sized, 

pub fn updates() -> Vec<TypeId, Global> where
    (S, D): Sized, 

pub fn needs() -> Vec<TypeId, Global> where
    (S, D): Sized, 

pub fn reads() -> Vec<TypeId, Global> where
    (S, D): Sized, 

pub fn writes() -> Vec<TypeId, Global> where
    (S, D): Sized, 

pub fn file_line_info(&self) -> &'static str

Implementors

impl System for SkeletonGeometryUpdater

[+] Show hidden undocumented items

pub fn run(&mut self, entities: Entities<'_>, _resources: Resources<'_>)

pub fn name() -> Option<&'static str>

pub fn needs() -> Vec<TypeId, Global>

pub fn updates() -> Vec<TypeId, Global>

impl System for bone_updater

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn before() -> Vec<SystemId, Global>

pub fn after() -> Vec<SystemId, Global>

pub fn needs() -> Vec<TypeId, Global>

pub fn updates() -> Vec<TypeId, Global>

pub fn writes() -> Vec<TypeId, Global>

pub fn run(&mut self, entities: Entities<'_>, _resources: Resources<'_>)

impl System for feet_updater

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn after() -> Vec<SystemId, Global>

pub fn needs() -> Vec<TypeId, Global>

pub fn updates() -> Vec<TypeId, Global>

pub fn reads() -> Vec<TypeId, Global>

pub fn writes() -> Vec<TypeId, Global>

pub fn run(&mut self, ___entities: Entities<'_>, ___resources: Resources<'_>)

impl System for skeleton_cache_updater

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn needs() -> Vec<TypeId, Global>

pub fn updates() -> Vec<TypeId, Global>

pub fn reads() -> Vec<TypeId, Global>

pub fn writes() -> Vec<TypeId, Global>

pub fn run(&mut self, ___entities: Entities<'_>, ___resources: Resources<'_>)

impl System for skeleton_changed_reseter

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn after() -> Vec<SystemId, Global>

pub fn writes() -> Vec<TypeId, Global>

pub fn run(&mut self, entities: Entities<'_>, Resources<'_>)

impl System for update_all

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn needs() -> Vec<TypeId, Global>

pub fn updates() -> Vec<TypeId, Global>

pub fn run(&mut self, entities: Entities<'_>, Resources<'_>)

impl System for update_dynamic

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn needs() -> Vec<TypeId, Global>

pub fn updates() -> Vec<TypeId, Global>

pub fn run(&mut self, entities: Entities<'_>, Resources<'_>)

impl System for update_static

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn needs() -> Vec<TypeId, Global>

pub fn updates() -> Vec<TypeId, Global>

pub fn run(&mut self, entities: Entities<'_>, Resources<'_>)

impl System for path_follower

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn needs() -> Vec<TypeId, Global>

pub fn updates() -> Vec<TypeId, Global>

pub fn reads() -> Vec<TypeId, Global>

pub fn writes() -> Vec<TypeId, Global>

pub fn run(&mut self, entities: Entities<'_>, resources: Resources<'_>)

impl System for check_lights_changed_system

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn needs() -> Vec<TypeId, Global>

pub fn updates() -> Vec<TypeId, Global>

pub fn reads() -> Vec<TypeId, Global>

pub fn writes() -> Vec<TypeId, Global>

pub fn run(&mut self, entities: Entities<'_>, resources: Resources<'_>)

impl System for all_shadows_geometry_sort

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn checks(
    world: &mut StorageRegistry
) -> Option<SystemConditionElse<SyncSystem>>

pub fn after() -> Vec<SystemId, Global>

pub fn needs() -> Vec<TypeId, Global>

pub fn updates() -> Vec<TypeId, Global>

pub fn reads() -> Vec<TypeId, Global>

pub fn run(&mut self, entities: Entities<'_>, resources: Resources<'_>)

impl System for dynamic_shadows_geometry_sort

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn checks(
    world: &mut StorageRegistry
) -> Option<SystemConditionElse<SyncSystem>>

pub fn after() -> Vec<SystemId, Global>

pub fn needs() -> Vec<TypeId, Global>

pub fn updates() -> Vec<TypeId, Global>

pub fn reads() -> Vec<TypeId, Global>

pub fn run(&mut self, entities: Entities<'_>, resources: Resources<'_>)

impl System for geometry_sort

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn checks(
    world: &mut StorageRegistry
) -> Option<SystemConditionElse<SyncSystem>>

pub fn after() -> Vec<SystemId, Global>

pub fn needs() -> Vec<TypeId, Global>

pub fn updates() -> Vec<TypeId, Global>

pub fn reads() -> Vec<TypeId, Global>

pub fn writes() -> Vec<TypeId, Global>

pub fn run(&mut self, entities: Entities<'_>, resources: Resources<'_>)

impl System for geometryref_changed_updater

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn needs() -> Vec<TypeId, Global>

pub fn writes() -> Vec<TypeId, Global>

pub fn run(&mut self, entities: Entities<'_>, Resources<'_>)

impl System for static_shadows_geometry_sort

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn checks(
    world: &mut StorageRegistry
) -> Option<SystemConditionElse<SyncSystem>>

pub fn after() -> Vec<SystemId, Global>

pub fn needs() -> Vec<TypeId, Global>

pub fn updates() -> Vec<TypeId, Global>

pub fn writes() -> Vec<TypeId, Global>

pub fn run(&mut self, entities: Entities<'_>, resources: Resources<'_>)

impl System for update_materialrefs_changed

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn needs() -> Vec<TypeId, Global>

pub fn writes() -> Vec<TypeId, Global>

pub fn run(&mut self, entities: Entities<'_>, Resources<'_>)

impl System for update_visible_changed

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn needs() -> Vec<TypeId, Global>

pub fn updates() -> Vec<TypeId, Global>

pub fn writes() -> Vec<TypeId, Global>

pub fn run(&mut self, entities: Entities<'_>, Resources<'_>)

impl System for CameraUpdater

[+] Show hidden undocumented items

pub fn run(&mut self, _e: Entities<'_>, resources: Resources<'_>)

pub fn name() -> Option<&'static str>

pub fn needs() -> Vec<TypeId, Global>

pub fn updates() -> Vec<TypeId, Global>

impl<F> System for F where
    F: FnMut(Entities<'_>, Resources<'_>) + Send, 

[+] Show hidden undocumented items

pub fn run(&mut self, e: Entities<'_>, r: Resources<'_>)

impl<V> System for geometry_changed_updater<V> where
    V: Clone + Send + 'static, 

[+] Show hidden undocumented items

pub fn name() -> Option<&'static str>

pub fn needs() -> Vec<TypeId, Global>

pub fn writes() -> Vec<TypeId, Global>

pub fn run(&mut self, entities: Entities<'_>, Resources<'_>)

impl System for skeleton_changed_reseter

impl System for bone_updater

impl System for feet_updater

impl System for skeleton_cache_updater

impl System for SkeletonGeometryUpdater

impl System for update_dynamic

impl System for update_static

impl System for update_all

impl System for geometryref_changed_updater

impl<V> System for geometry_changed_updater<V> where     V: Clone + Send + 'static,

impl System for update_visible_changed

impl System for update_materialrefs_changed

impl System for geometry_sort

impl System for dynamic_shadows_geometry_sort

impl System for static_shadows_geometry_sort

impl System for all_shadows_geometry_sort

impl System for CameraUpdater

impl System for check_lights_changed_system

impl System for path_follower