Trait oxygengine::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, world: &mut World) { ... }
    fn dispose(self, world: &mut World) { ... }
}

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, world: &mut World)

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

fn dispose(self, world: &mut World)

Performs clean up that requires resources from the World. This commonly removes components from world 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>, PanicHandler>)

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

Loading content...

Implementors

impl<'a, '_, '_> System<'a> for DefaultBatchControllerSystem<'_, '_>

type SystemData = BatchUncheckedWorld<'a>

fn run(
    &mut self,
    data: <DefaultBatchControllerSystem<'_, '_> as System<'a>>::SystemData
)

fn running_time(&self) -> RunningTime

fn accessor(
    &'c self
) -> AccessorCow<'a, 'c, DefaultBatchControllerSystem<'_, '_>>

fn setup(&mut self, world: &mut World)

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

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

fn run(&mut self, data: <AssetsSystem as System<'s>>::SystemData)

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

type SystemData = (Read<'s, AssetsDatabase, PanicHandler>, Write<'s, Localization, DefaultProvider>)

fn run(&mut self, <LocalizationSystem as System<'s>>::SystemData)

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

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

fn run(&mut self, <PrefabSystem as System<'s>>::SystemData)

Loading content...