Struct bevy_ecs::system::FunctionSystem

pub struct FunctionSystem<Marker, F>where
    F: SystemParamFunction<Marker>,{ /* private fields */ }

The System counter part of an ordinary function.

You get this by calling IntoSystem::into_system on a function that only accepts SystemParams. The output of the system becomes the functions return type, while the input becomes the functions In tagged parameter or () if no such parameter exists.

FunctionSystem must be .initialized before they can be run.

Trait Implementations

impl<Marker, F> System for FunctionSystem<Marker, F>where Marker: 'static, F: SystemParamFunction<Marker>,

type In = <F as SystemParamFunction<Marker>>::In

The system’s input. See In for FunctionSystems.

type Out = <F as SystemParamFunction<Marker>>::Out

The system’s output.

fn name(&self) -> Cow<'static, str>

Returns the system’s name.

fn type_id(&self) -> TypeId

Returns the TypeId of the underlying system type.

fn component_access(&self) -> &Access<ComponentId>

Returns the system’s component Access.

fn archetype_component_access(&self) -> &Access<ArchetypeComponentId>

Returns the system’s archetype component Access.

fn is_send(&self) -> bool

Returns true if the system is Send.

fn is_exclusive(&self) -> bool

Returns true if the system must be run exclusively.

unsafe fn run_unsafe(&mut self, input: Self::In, world: &World) -> Self::Out

Runs the system with the given input in the world. Unlike System::run, this function takes a shared reference to World and may therefore break Rust’s aliasing rules, making it unsafe to call.

fn get_last_change_tick(&self) -> u32

Gets the system’s last change tick

fn set_last_change_tick(&mut self, last_change_tick: u32)

Sets the system’s last change tick

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

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

Initialize the system.

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

Update the system’s archetype component Access.

fn check_change_tick(&mut self, change_tick: u32)

fn default_system_sets(&self) -> Vec<Box<dyn SystemSet>>

Returns the system’s default system sets.

fn run(&mut self, input: Self::In, world: &mut World) -> Self::Out

Runs the system with the given input in the world.

impl<Marker, F> ReadOnlySystem for FunctionSystem<Marker, F>where Marker: 'static, F: SystemParamFunction<Marker>, F::Param: ReadOnlySystemParam,

SAFETY: F’s param is ReadOnlySystemParam, so this system will only read from the world.