use crate::{ prelude::{FromWorld, QueryState}, query::{QueryData, QueryFilter}, system::{Local, SystemMeta, SystemParam, SystemState}, world::World, }; use bevy_utils::synccell::SyncCell; use core::marker::PhantomData; use variadics_please::all_tuples; /// A parameter that can be used in an exclusive system (a system with an `&mut World` parameter). /// Any parameters implementing this trait must come after the `&mut World` parameter. #[diagnostic::on_unimplemented( message = "`{Self}` can not be used as a parameter for an exclusive system", label = "invalid system parameter" )] pub trait ExclusiveSystemParam: Sized { /// Used to store data which persists across invocations of a system. type State: Send + Sync + 'static; /// The item type returned when constructing this system param. /// See [`SystemParam::Item`]. type Item<'s>: ExclusiveSystemParam; /// Creates a new instance of this param's [`State`](Self::State). fn init(world: &mut World, system_meta: &mut SystemMeta) -> Self::State; /// Creates a parameter to be passed into an [`ExclusiveSystemParamFunction`]. /// /// [`ExclusiveSystemParamFunction`]: super::ExclusiveSystemParamFunction fn get_param<'s>(state: &'s mut Self::State, system_meta: &SystemMeta) -> Self::Item<'s>; } /// Shorthand way of accessing the associated type [`ExclusiveSystemParam::Item`] /// for a given [`ExclusiveSystemParam`]. pub type ExclusiveSystemParamItem<'s, P> =

::Item<'s>; impl<'a, D: QueryData + 'static, F: QueryFilter + 'static> ExclusiveSystemParam for &'a mut QueryState { type State = QueryState; type Item<'s> = &'s mut QueryState; fn init(world: &mut World, _system_meta: &mut SystemMeta) -> Self::State { QueryState::new(world) } fn get_param<'s>(state: &'s mut Self::State, _system_meta: &SystemMeta) -> Self::Item<'s> { state } } impl<'a, P: SystemParam + 'static> ExclusiveSystemParam for &'a mut SystemState

{ type State = SystemState

; type Item<'s> = &'s mut SystemState

; fn init(world: &mut World, _system_meta: &mut SystemMeta) -> Self::State { SystemState::new(world) } fn get_param<'s>(state: &'s mut Self::State, _system_meta: &SystemMeta) -> Self::Item<'s> { state } } impl<'_s, T: FromWorld + Send + 'static> ExclusiveSystemParam for Local<'_s, T> { type State = SyncCell; type Item<'s> = Local<'s, T>; fn init(world: &mut World, _system_meta: &mut SystemMeta) -> Self::State { SyncCell::new(T::from_world(world)) } fn get_param<'s>(state: &'s mut Self::State, _system_meta: &SystemMeta) -> Self::Item<'s> { Local(state.get()) } } impl ExclusiveSystemParam for PhantomData { type State = (); type Item<'s> = PhantomData; fn init(_world: &mut World, _system_meta: &mut SystemMeta) -> Self::State {} fn get_param<'s>(_state: &'s mut Self::State, _system_meta: &SystemMeta) -> Self::Item<'s> { PhantomData } } macro_rules! impl_exclusive_system_param_tuple { ($(#[$meta:meta])* $($param: ident),*) => { #[allow(unused_variables)] #[allow(non_snake_case)] $(#[$meta])* impl<$($param: ExclusiveSystemParam),*> ExclusiveSystemParam for ($($param,)*) { type State = ($($param::State,)*); type Item<'s> = ($($param::Item<'s>,)*); #[inline] fn init(_world: &mut World, _system_meta: &mut SystemMeta) -> Self::State { (($($param::init(_world, _system_meta),)*)) } #[inline] #[allow(clippy::unused_unit)] fn get_param<'s>( state: &'s mut Self::State, system_meta: &SystemMeta, ) -> Self::Item<'s> { let ($($param,)*) = state; ($($param::get_param($param, system_meta),)*) } } }; } all_tuples!( #[doc(fake_variadic)] impl_exclusive_system_param_tuple, 0, 16, P ); #[cfg(test)] mod tests { use crate as bevy_ecs; use crate::{schedule::Schedule, system::Local, world::World}; use bevy_ecs_macros::Resource; use core::marker::PhantomData; #[test] fn test_exclusive_system_params() { #[derive(Resource, Default)] struct Res { test_value: u32, } fn my_system(world: &mut World, mut local: Local, _phantom: PhantomData>) { assert_eq!(world.resource::().test_value, *local); *local += 1; world.resource_mut::().test_value += 1; } let mut schedule = Schedule::default(); schedule.add_systems(my_system); let mut world = World::default(); world.init_resource::(); schedule.run(&mut world); schedule.run(&mut world); assert_eq!(2, world.get_resource::().unwrap().test_value); } }