Add unregister_system command (#16340)

# Objective

Fixes #16266 

## Solution

Added an `UnregisterSystem` command struct and
`Commands::unregister_system`. Also renamed `World::remove_system` and
`World::remove_system_cached` to `World::unregister_*`

## Testing

It's a fairly simple change, but I tested locally to ensure it actually
works.

---------

Co-authored-by: Benjamin Brienen <benjamin.brienen@outlook.com>
This commit is contained in:
Rob Grindeland 2024-11-12 16:49:29 -06:00 committed by GitHub
parent 4225848b0a
commit a8c610a52d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 43 additions and 5 deletions

View file

@ -4,6 +4,7 @@ use core::{marker::PhantomData, panic::Location};
use super::{ use super::{
Deferred, IntoObserverSystem, IntoSystem, RegisterSystem, Resource, RunSystemCachedWith, Deferred, IntoObserverSystem, IntoSystem, RegisterSystem, Resource, RunSystemCachedWith,
UnregisterSystem,
}; };
use crate::{ use crate::{
self as bevy_ecs, self as bevy_ecs,
@ -890,6 +891,17 @@ impl<'w, 's> Commands<'w, 's> {
SystemId::from_entity(entity) SystemId::from_entity(entity)
} }
/// Removes a system previously registered with [`Commands::register_system`] or [`World::register_system`].
///
/// See [`World::unregister_system`] for more information.
pub fn unregister_system<I, O>(&mut self, system_id: SystemId<I, O>)
where
I: SystemInput + Send + 'static,
O: Send + 'static,
{
self.queue(UnregisterSystem::new(system_id));
}
/// Similar to [`Self::run_system`], but caching the [`SystemId`] in a /// Similar to [`Self::run_system`], but caching the [`SystemId`] in a
/// [`CachedSystemId`](crate::system::CachedSystemId) resource. /// [`CachedSystemId`](crate::system::CachedSystemId) resource.
/// ///

View file

@ -30,7 +30,7 @@ pub struct SystemIdMarker;
/// A system that has been removed from the registry. /// A system that has been removed from the registry.
/// It contains the system and whether or not it has been initialized. /// It contains the system and whether or not it has been initialized.
/// ///
/// This struct is returned by [`World::remove_system`]. /// This struct is returned by [`World::unregister_system`].
pub struct RemovedSystem<I = (), O = ()> { pub struct RemovedSystem<I = (), O = ()> {
initialized: bool, initialized: bool,
system: BoxedSystem<I, O>, system: BoxedSystem<I, O>,
@ -172,7 +172,7 @@ impl World {
/// ///
/// If no system corresponds to the given [`SystemId`], this method returns an error. /// If no system corresponds to the given [`SystemId`], this method returns an error.
/// Systems are also not allowed to remove themselves, this returns an error too. /// Systems are also not allowed to remove themselves, this returns an error too.
pub fn remove_system<I, O>( pub fn unregister_system<I, O>(
&mut self, &mut self,
id: SystemId<I, O>, id: SystemId<I, O>,
) -> Result<RemovedSystem<I, O>, RegisteredSystemError<I, O>> ) -> Result<RemovedSystem<I, O>, RegisteredSystemError<I, O>>
@ -412,7 +412,7 @@ impl World {
/// Removes a cached system and its [`CachedSystemId`] resource. /// Removes a cached system and its [`CachedSystemId`] resource.
/// ///
/// See [`World::register_system_cached`] for more information. /// See [`World::register_system_cached`] for more information.
pub fn remove_system_cached<I, O, M, S>( pub fn unregister_system_cached<I, O, M, S>(
&mut self, &mut self,
_system: S, _system: S,
) -> Result<RemovedSystem<I, O>, RegisteredSystemError<I, O>> ) -> Result<RemovedSystem<I, O>, RegisteredSystemError<I, O>>
@ -424,7 +424,7 @@ impl World {
let id = self let id = self
.remove_resource::<CachedSystemId<S::System>>() .remove_resource::<CachedSystemId<S::System>>()
.ok_or(RegisteredSystemError::SystemNotCached)?; .ok_or(RegisteredSystemError::SystemNotCached)?;
self.remove_system(id.0) self.unregister_system(id.0)
} }
/// Runs a cached system, registering it if necessary. /// Runs a cached system, registering it if necessary.
@ -544,6 +544,32 @@ where
} }
} }
/// The [`Command`] type for unregistering one-shot systems from [`Commands`](crate::system::Commands).
pub struct UnregisterSystem<I: SystemInput + 'static, O: 'static> {
system_id: SystemId<I, O>,
}
impl<I, O> UnregisterSystem<I, O>
where
I: SystemInput + 'static,
O: 'static,
{
/// Creates a new [`Command`] struct, which can be added to [`Commands`](crate::system::Commands).
pub fn new(system_id: SystemId<I, O>) -> Self {
Self { system_id }
}
}
impl<I, O> Command for UnregisterSystem<I, O>
where
I: SystemInput + 'static,
O: 'static,
{
fn apply(self, world: &mut World) {
let _ = world.unregister_system(self.system_id);
}
}
/// The [`Command`] type for running a cached one-shot system from /// The [`Command`] type for running a cached one-shot system from
/// [`Commands`](crate::system::Commands). /// [`Commands`](crate::system::Commands).
/// ///
@ -834,7 +860,7 @@ mod tests {
let new = world.register_system_cached(four); let new = world.register_system_cached(four);
assert_eq!(old, new); assert_eq!(old, new);
let result = world.remove_system_cached(four); let result = world.unregister_system_cached(four);
assert!(result.is_ok()); assert!(result.is_ok());
let new = world.register_system_cached(four); let new = world.register_system_cached(four);
assert_ne!(old, new); assert_ne!(old, new);