use bevy_utils::tracing::warn; use core::fmt::Debug; use crate::component::Tick; use crate::world::unsafe_world_cell::UnsafeWorldCell; use crate::{archetype::ArchetypeComponentId, component::ComponentId, query::Access, world::World}; use std::any::TypeId; use std::borrow::Cow; /// An ECS system that can be added to a [`Schedule`](crate::schedule::Schedule) /// /// Systems are functions with all arguments implementing /// [`SystemParam`](crate::system::SystemParam). /// /// Systems are added to an application using `App::add_system(my_system)` /// or similar methods, and will generally run once per pass of the main loop. /// /// Systems are executed in parallel, in opportunistic order; data access is managed automatically. /// It's possible to specify explicit execution order between specific systems, /// see [`IntoSystemConfigs`](crate::schedule::IntoSystemConfigs). pub trait System: Send + Sync + 'static { /// The system's input. See [`In`](crate::system::In) for /// [`FunctionSystem`](crate::system::FunctionSystem)s. type In; /// The system's output. type Out; /// Returns the system's name. fn name(&self) -> Cow<'static, str>; /// Returns the [`TypeId`] of the underlying system type. fn type_id(&self) -> TypeId; /// Returns the system's component [`Access`]. fn component_access(&self) -> &Access; /// Returns the system's archetype component [`Access`]. fn archetype_component_access(&self) -> &Access; /// Returns true if the system is [`Send`]. fn is_send(&self) -> bool; /// Returns true if the system must be run exclusively. fn is_exclusive(&self) -> bool; /// Runs the system with the given input in the world. Unlike [`System::run`], this function /// can be called in parallel with other systems and may break Rust's aliasing rules /// if used incorrectly, making it unsafe to call. /// /// # Safety /// /// - The caller must ensure that `world` has permission to access any world data /// registered in [`Self::archetype_component_access`]. There must be no conflicting /// simultaneous accesses while the system is running. /// - The method [`Self::update_archetype_component_access`] must be called at some /// point before this one, with the same exact [`World`]. If `update_archetype_component_access` /// panics (or otherwise does not return for any reason), this method must not be called. unsafe fn run_unsafe(&mut self, input: Self::In, world: UnsafeWorldCell) -> Self::Out; /// Runs the system with the given input in the world. /// /// For [read-only](ReadOnlySystem) systems, see [`run_readonly`], which can be called using `&World`. /// /// [`run_readonly`]: ReadOnlySystem::run_readonly fn run(&mut self, input: Self::In, world: &mut World) -> Self::Out { let world = world.as_unsafe_world_cell(); self.update_archetype_component_access(world); // SAFETY: // - We have exclusive access to the entire world. // - `update_archetype_component_access` has been called. unsafe { self.run_unsafe(input, world) } } /// Applies any [`Deferred`](crate::system::Deferred) system parameters (or other system buffers) of this system to the world. /// /// This is where [`Commands`](crate::system::Commands) get applied. fn apply_deferred(&mut self, world: &mut World); /// Initialize the system. fn initialize(&mut self, _world: &mut World); /// Update the system's archetype component [`Access`]. /// /// ## Note for implementors /// `world` may only be used to access metadata. This can be done in safe code /// via functions such as [`UnsafeWorldCell::archetypes`]. fn update_archetype_component_access(&mut self, world: UnsafeWorldCell); /// Checks any [`Tick`]s stored on this system and wraps their value if they get too old. /// /// This method must be called periodically to ensure that change detection behaves correctly. /// When using bevy's default configuration, this will be called for you as needed. fn check_change_tick(&mut self, change_tick: Tick); /// Returns the system's default [system sets](crate::schedule::SystemSet). fn default_system_sets(&self) -> Vec> { Vec::new() } /// Gets the tick indicating the last time this system ran. fn get_last_run(&self) -> Tick; /// Overwrites the tick indicating the last time this system ran. /// /// # Warning /// This is a complex and error-prone operation, that can have unexpected consequences on any system relying on this code. /// However, it can be an essential escape hatch when, for example, /// you are trying to synchronize representations using change detection and need to avoid infinite recursion. fn set_last_run(&mut self, last_run: Tick); } /// [`System`] types that do not modify the [`World`] when run. /// This is implemented for any systems whose parameters all implement [`ReadOnlySystemParam`]. /// /// Note that systems which perform [deferred](System::apply_deferred) mutations (such as with [`Commands`]) /// may implement this trait. /// /// [`ReadOnlySystemParam`]: crate::system::ReadOnlySystemParam /// [`Commands`]: crate::system::Commands /// /// # Safety /// /// This must only be implemented for system types which do not mutate the `World` /// when [`System::run_unsafe`] is called. pub unsafe trait ReadOnlySystem: System { /// Runs this system with the given input in the world. /// /// Unlike [`System::run`], this can be called with a shared reference to the world, /// since this system is known not to modify the world. fn run_readonly(&mut self, input: Self::In, world: &World) -> Self::Out { let world = world.as_unsafe_world_cell_readonly(); self.update_archetype_component_access(world); // SAFETY: // - We have read-only access to the entire world. // - `update_archetype_component_access` has been called. unsafe { self.run_unsafe(input, world) } } } /// A convenience type alias for a boxed [`System`] trait object. pub type BoxedSystem = Box>; pub(crate) fn check_system_change_tick(last_run: &mut Tick, this_run: Tick, system_name: &str) { if last_run.check_tick(this_run) { let age = this_run.relative_to(*last_run).get(); warn!( "System '{system_name}' has not run for {age} ticks. \ Changes older than {} ticks will not be detected.", Tick::MAX.get() - 1, ); } } impl Debug for dyn System { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { write!(f, "System {}: {{{}}}", self.name(), { if self.is_send() { if self.is_exclusive() { "is_send is_exclusive" } else { "is_send" } } else if self.is_exclusive() { "is_exclusive" } else { "" } },) } }