Trait oxygengine_core::ecs::prelude::System

pub trait System<'a> {
    type SystemData: DynamicSystemData<'a>;
    fn run(&mut self, data: Self::SystemData);

    fn running_time(&self) -> RunningTime { ... }
    fn accessor(&'b self) -> AccessorCow<'a, 'b, Self> { ... }
    fn setup(&mut self, res: &mut Resources) { ... }
    fn dispose(self, res: &mut Resources) { ... }
}

A System, executed with a set of required Resources.

Associated Types

type SystemData: DynamicSystemData<'a>

The resource bundle required to execute this system.

You will mostly use a tuple of system data (which also implements SystemData). You can also create such a resource bundle by simply deriving SystemData for a struct.

Every SystemData is also a DynamicSystemData.

Loading content...

Required methods

fn run(&mut self, data: Self::SystemData)

Executes the system with the required system data.

Loading content...

Provided methods

fn running_time(&self) -> RunningTime

Returns a hint how long the system needs for running. This is used to optimize the way they're executed (might allow more parallelization).

Defaults to RunningTime::Average.

fn accessor(&'b self) -> AccessorCow<'a, 'b, Self>

Return the accessor from the SystemData.

fn setup(&mut self, res: &mut Resources)

Sets up the Resources using Self::SystemData::setup.

fn dispose(self, res: &mut Resources)

Performs clean up that requires resources from the Resources.

This commonly removes components from Resources which depend on external resources.

Loading content...

Implementations on Foreign Types

impl<'a, P> System<'a> for HierarchySystem<P> where
    P: Component + Parent + Send + Sync + 'static,
    <P as Component>::Storage: Tracked, 

type SystemData = (ParentData<'a, P>, Write<'a, Hierarchy<P>, HierarchySetupHandler<P>>)

fn run(&mut self, <HierarchySystem<P> as System<'a>>::SystemData)

Loading content...

Implementors

impl<'s> System<'s> for AssetsSystem

type SystemData = Option<Write<'s, AssetsDatabase>>

fn run(&mut self, data: Self::SystemData)

impl<'s> System<'s> for LocalizationSystem

type SystemData = (ReadExpect<'s, AssetsDatabase>, Write<'s, Localization>)

fn run(&mut self, (assets, localization): Self::SystemData)

impl<'s> System<'s> for PrefabSystem

type SystemData = (Read<'s, EntitiesRes>, Read<'s, LazyUpdate>, ReadExpect<'s, AppLifeCycle>, ReadExpect<'s, AssetsDatabase>, Write<'s, PrefabManager>)

fn run(
    &mut self,
    (entities, lazy_update, lifecycle, assets, prefabs): Self::SystemData
)

Loading content...