diff --git a/Cargo.toml b/Cargo.toml index b8ebfd23269d4..05773e978e52f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -10,7 +10,7 @@ keywords = ["game", "engine", "gamedev", "graphics", "bevy"] license = "MIT OR Apache-2.0" repository = "https://github.com/bevyengine/bevy" documentation = "https://docs.rs/bevy" -rust-version = "1.77.0" +rust-version = "1.78.0" [workspace] exclude = [ diff --git a/crates/bevy_app/src/plugin.rs b/crates/bevy_app/src/plugin.rs index d3307485fecbb..3c5ca1adf0dc7 100644 --- a/crates/bevy_app/src/plugin.rs +++ b/crates/bevy_app/src/plugin.rs @@ -54,7 +54,7 @@ use std::any::Any; /// } /// } /// # fn damp_flickering() {} -/// ```` +/// ``` pub trait Plugin: Downcast + Any + Send + Sync { /// Configures the [`App`] to which this plugin is added. fn build(&self, app: &mut App); diff --git a/crates/bevy_asset/src/lib.rs b/crates/bevy_asset/src/lib.rs index ea8caf003a1dd..f6fd2ae42be3b 100644 --- a/crates/bevy_asset/src/lib.rs +++ b/crates/bevy_asset/src/lib.rs @@ -223,6 +223,11 @@ impl Plugin for AssetPlugin { } } +#[diagnostic::on_unimplemented( + message = "`{Self}` is not an `Asset`", + label = "invalid `Asset`", + note = "consider annotating `{Self}` with `#[derive(Asset)]`" +)] pub trait Asset: VisitAssetDependencies + TypePath + Send + Sync + 'static {} pub trait VisitAssetDependencies { diff --git a/crates/bevy_ecs/src/bundle.rs b/crates/bevy_ecs/src/bundle.rs index 7ba65e9ba42cd..718a9356440f8 100644 --- a/crates/bevy_ecs/src/bundle.rs +++ b/crates/bevy_ecs/src/bundle.rs @@ -141,6 +141,11 @@ use std::ptr::NonNull; // bundle, in the _exact_ order that [`DynamicBundle::get_components`] is called. // - [`Bundle::from_components`] must call `func` exactly once for each [`ComponentId`] returned by // [`Bundle::component_ids`]. +#[diagnostic::on_unimplemented( + message = "`{Self}` is not a `Bundle`", + label = "invalid `Bundle`", + note = "consider annotating `{Self}` with `#[derive(Component)]` or `#[derive(Bundle)]`" +)] pub unsafe trait Bundle: DynamicBundle + Send + Sync + 'static { /// Gets this [`Bundle`]'s component ids, in the order of this bundle's [`Component`]s #[doc(hidden)] diff --git a/crates/bevy_ecs/src/component.rs b/crates/bevy_ecs/src/component.rs index 6b91c432f52bd..7f30eebdc9180 100644 --- a/crates/bevy_ecs/src/component.rs +++ b/crates/bevy_ecs/src/component.rs @@ -150,6 +150,11 @@ use std::{ /// /// [`SyncCell`]: bevy_utils::synccell::SyncCell /// [`Exclusive`]: https://doc.rust-lang.org/nightly/std/sync/struct.Exclusive.html +#[diagnostic::on_unimplemented( + message = "`{Self}` is not a `Component`", + label = "invalid `Component`", + note = "consider annotating `{Self}` with `#[derive(Component)]`" +)] pub trait Component: Send + Sync + 'static { /// A constant indicating the storage type used for this component. const STORAGE_TYPE: StorageType; diff --git a/crates/bevy_ecs/src/entity/map_entities.rs b/crates/bevy_ecs/src/entity/map_entities.rs index 083b7a5075b2e..b8e638f940018 100644 --- a/crates/bevy_ecs/src/entity/map_entities.rs +++ b/crates/bevy_ecs/src/entity/map_entities.rs @@ -37,7 +37,6 @@ use super::EntityHashMap; /// } /// } /// ``` -/// pub trait MapEntities { /// Updates all [`Entity`] references stored inside using `entity_mapper`. /// diff --git a/crates/bevy_ecs/src/event.rs b/crates/bevy_ecs/src/event.rs index 5f5b7092f047e..871dd3af21e62 100644 --- a/crates/bevy_ecs/src/event.rs +++ b/crates/bevy_ecs/src/event.rs @@ -28,6 +28,11 @@ use std::{ /// You can conveniently access events using the [`EventReader`] and [`EventWriter`] system parameter. /// /// Events must be thread-safe. +#[diagnostic::on_unimplemented( + message = "`{Self}` is not an `Event`", + label = "invalid `Event`", + note = "consider annotating `{Self}` with `#[derive(Event]`" +)] pub trait Event: Send + Sync + 'static {} /// An `EventId` uniquely identifies an event stored in a specific [`World`]. diff --git a/crates/bevy_ecs/src/query/fetch.rs b/crates/bevy_ecs/src/query/fetch.rs index 29a89363135d9..2ebf95cdea787 100644 --- a/crates/bevy_ecs/src/query/fetch.rs +++ b/crates/bevy_ecs/src/query/fetch.rs @@ -268,6 +268,10 @@ use std::{cell::UnsafeCell, marker::PhantomData}; /// /// [`Query`]: crate::system::Query /// [`ReadOnly`]: Self::ReadOnly +#[diagnostic::on_unimplemented( + message = "`{Self}` is not valid to request as data in a `Query`", + label = "invalid `Query` data" +)] pub unsafe trait QueryData: WorldQuery { /// The read-only variant of this [`QueryData`], which satisfies the [`ReadOnlyQueryData`] trait. type ReadOnly: ReadOnlyQueryData::State>; diff --git a/crates/bevy_ecs/src/query/filter.rs b/crates/bevy_ecs/src/query/filter.rs index 646d1d0a088a5..583ce4947e70c 100644 --- a/crates/bevy_ecs/src/query/filter.rs +++ b/crates/bevy_ecs/src/query/filter.rs @@ -70,7 +70,11 @@ use std::{cell::UnsafeCell, marker::PhantomData}; /// [`matches_component_set`]: Self::matches_component_set /// [`Query`]: crate::system::Query /// [`State`]: Self::State - +#[diagnostic::on_unimplemented( + message = "`{Self}` is not a valid `Query` filter", + label = "invalid `Query` filter", + note = "a `QueryFilter` typically uses a combination of `With` and `Without` statements" +)] pub trait QueryFilter: WorldQuery { /// Returns true if (and only if) this Filter relies strictly on archetypes to limit which /// components are accessed by the Query. @@ -938,6 +942,11 @@ impl QueryFilter for Changed { /// /// [`Added`] and [`Changed`] works with entities, and therefore are not archetypal. As such /// they do not implement [`ArchetypeFilter`]. +#[diagnostic::on_unimplemented( + message = "`{Self}` is not a valid `Query` filter based on archetype information", + label = "invalid `Query` filter", + note = "an `ArchetypeFilter` typically uses a combination of `With` and `Without` statements" +)] pub trait ArchetypeFilter: QueryFilter {} impl ArchetypeFilter for With {} diff --git a/crates/bevy_ecs/src/schedule/config.rs b/crates/bevy_ecs/src/schedule/config.rs index 3204b59e65d22..2fc37eb2894c0 100644 --- a/crates/bevy_ecs/src/schedule/config.rs +++ b/crates/bevy_ecs/src/schedule/config.rs @@ -288,6 +288,10 @@ impl NodeConfigs { /// ) /// ); /// ``` +#[diagnostic::on_unimplemented( + message = "`{Self}` does not describe a valid system configuration", + label = "invalid system configuration" +)] pub trait IntoSystemConfigs where Self: Sized, @@ -562,6 +566,10 @@ impl SystemSetConfig { pub type SystemSetConfigs = NodeConfigs; /// Types that can convert into a [`SystemSetConfigs`]. +#[diagnostic::on_unimplemented( + message = "`{Self}` does not describe a valid system set configuration", + label = "invalid system set configuration" +)] pub trait IntoSystemSetConfigs where Self: Sized, diff --git a/crates/bevy_ecs/src/schedule/set.rs b/crates/bevy_ecs/src/schedule/set.rs index 7096d5c2e21a8..a39efdb41b584 100644 --- a/crates/bevy_ecs/src/schedule/set.rs +++ b/crates/bevy_ecs/src/schedule/set.rs @@ -149,6 +149,10 @@ impl SystemSet for AnonymousSet { } /// Types that can be converted into a [`SystemSet`]. +#[diagnostic::on_unimplemented( + message = "`{Self}` is not a system set", + label = "invalid system set" +)] pub trait IntoSystemSet: Sized { /// The type of [`SystemSet`] this instance converts into. type Set: SystemSet; diff --git a/crates/bevy_ecs/src/system/adapter_system.rs b/crates/bevy_ecs/src/system/adapter_system.rs index c44e19c24d709..794db43936506 100644 --- a/crates/bevy_ecs/src/system/adapter_system.rs +++ b/crates/bevy_ecs/src/system/adapter_system.rs @@ -39,6 +39,10 @@ use crate::{schedule::InternedSystemSet, world::unsafe_world_cell::UnsafeWorldCe /// # system.initialize(&mut world); /// # assert!(system.run((), &mut world)); /// ``` +#[diagnostic::on_unimplemented( + message = "`{Self}` can not adapt a system of type `{S}`", + label = "invalid system adapter" +)] pub trait Adapt: Send + Sync + 'static { /// The [input](System::In) type for an [`AdapterSystem`]. type In; diff --git a/crates/bevy_ecs/src/system/combinator.rs b/crates/bevy_ecs/src/system/combinator.rs index 8184cf76226fb..dca72127dc9a5 100644 --- a/crates/bevy_ecs/src/system/combinator.rs +++ b/crates/bevy_ecs/src/system/combinator.rs @@ -83,6 +83,11 @@ use super::{ReadOnlySystem, System}; /// # assert!(world.resource::().0); /// # world.resource_mut::().0 = false; /// ``` +#[diagnostic::on_unimplemented( + message = "`{Self}` can not combine systems `{A}` and `{B}`", + label = "invalid system combination", + note = "the inputs and outputs of `{A}` and `{B}` are not compatible with this combiner" +)] pub trait Combine { /// The [input](System::In) type for a [`CombinatorSystem`]. type In; diff --git a/crates/bevy_ecs/src/system/exclusive_function_system.rs b/crates/bevy_ecs/src/system/exclusive_function_system.rs index d4351923adaf4..85f3af12097e3 100644 --- a/crates/bevy_ecs/src/system/exclusive_function_system.rs +++ b/crates/bevy_ecs/src/system/exclusive_function_system.rs @@ -161,6 +161,10 @@ where /// /// This trait can be useful for making your own systems which accept other systems, /// sometimes called higher order systems. +#[diagnostic::on_unimplemented( + message = "`{Self}` is not an exclusive system", + label = "invalid system" +)] pub trait ExclusiveSystemParamFunction: Send + Sync + 'static { /// The input type to this system. See [`System::In`]. type In; @@ -168,7 +172,7 @@ pub trait ExclusiveSystemParamFunction: Send + Sync + 'static { /// The return type of this system. See [`System::Out`]. type Out; - /// The [`ExclusiveSystemParam`]/s defined by this system's `fn` parameters. + /// The [`ExclusiveSystemParam`]'s defined by this system's `fn` parameters. type Param: ExclusiveSystemParam; /// Executes this system once. See [`System::run`]. diff --git a/crates/bevy_ecs/src/system/exclusive_system_param.rs b/crates/bevy_ecs/src/system/exclusive_system_param.rs index 3c356c98175cf..93ad2e603a247 100644 --- a/crates/bevy_ecs/src/system/exclusive_system_param.rs +++ b/crates/bevy_ecs/src/system/exclusive_system_param.rs @@ -10,6 +10,10 @@ use std::marker::PhantomData; /// 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; diff --git a/crates/bevy_ecs/src/system/function_system.rs b/crates/bevy_ecs/src/system/function_system.rs index ac96075017bdb..c97e684e64337 100644 --- a/crates/bevy_ecs/src/system/function_system.rs +++ b/crates/bevy_ecs/src/system/function_system.rs @@ -626,6 +626,10 @@ where /// ``` /// [`PipeSystem`]: crate::system::PipeSystem /// [`ParamSet`]: crate::system::ParamSet +#[diagnostic::on_unimplemented( + message = "`{Self}` is not a valid system", + label = "invalid system" +)] pub trait SystemParamFunction: Send + Sync + 'static { /// The input type to this system. See [`System::In`]. type In; diff --git a/crates/bevy_ecs/src/system/mod.rs b/crates/bevy_ecs/src/system/mod.rs index 19785a7243c75..c1fb76ed26c98 100644 --- a/crates/bevy_ecs/src/system/mod.rs +++ b/crates/bevy_ecs/src/system/mod.rs @@ -147,6 +147,10 @@ use crate::world::World; // This trait has to be generic because we have potentially overlapping impls, in particular // because Rust thinks a type could impl multiple different `FnMut` combinations // even though none can currently +#[diagnostic::on_unimplemented( + message = "`{Self}` is not a valid system with input `{In}` and output `{Out}`", + label = "invalid system" +)] pub trait IntoSystem: Sized { /// The type of [`System`] that this instance converts into. type System: System; diff --git a/crates/bevy_ecs/src/system/system.rs b/crates/bevy_ecs/src/system/system.rs index ec1b08707c70e..f8321a5d93389 100644 --- a/crates/bevy_ecs/src/system/system.rs +++ b/crates/bevy_ecs/src/system/system.rs @@ -22,6 +22,7 @@ use super::IntoSystem; /// 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). +#[diagnostic::on_unimplemented(message = "`{Self}` is not a system", label = "invalid system")] pub trait System: Send + Sync + 'static { /// The system's input. See [`In`](crate::system::In) for /// [`FunctionSystem`](crate::system::FunctionSystem)s. diff --git a/crates/bevy_ecs/src/system/system_param.rs b/crates/bevy_ecs/src/system/system_param.rs index d85f50ae2529e..0390e9981e5e1 100644 --- a/crates/bevy_ecs/src/system/system_param.rs +++ b/crates/bevy_ecs/src/system/system_param.rs @@ -432,6 +432,11 @@ impl_param_set!(); /// ``` /// /// [`Exclusive`]: https://doc.rust-lang.org/nightly/std/sync/struct.Exclusive.html +#[diagnostic::on_unimplemented( + message = "`{Self}` is not a `Resource`", + label = "invalid `Resource`", + note = "consider annotating `{Self}` with `#[derive(Resource)]`" +)] pub trait Resource: Send + Sync + 'static {} // SAFETY: Res only reads a single World resource diff --git a/crates/bevy_reflect/compile_fail/tests/reflect_derive/generics_fail.rs b/crates/bevy_reflect/compile_fail/tests/reflect_derive/generics_fail.rs index ad7426299aa12..ba463bf4dd322 100644 --- a/crates/bevy_reflect/compile_fail/tests/reflect_derive/generics_fail.rs +++ b/crates/bevy_reflect/compile_fail/tests/reflect_derive/generics_fail.rs @@ -12,9 +12,9 @@ struct NoReflect(f32); fn main() { let mut foo: Box = Box::new(Foo:: { a: NoReflect(42.0) }); - //~^ ERROR: not satisfied + //~^ ERROR: `NoReflect` does not provide type registration information // foo doesn't implement Reflect because NoReflect doesn't implement Reflect foo.get_field::("a").unwrap(); - //~^ ERROR: not satisfied + //~^ ERROR: `NoReflect` can not be reflected } diff --git a/crates/bevy_reflect/compile_fail/tests/reflect_derive/generics_fail.stderr b/crates/bevy_reflect/compile_fail/tests/reflect_derive/generics_fail.stderr index c61aacaf72722..8c4890827de6c 100644 --- a/crates/bevy_reflect/compile_fail/tests/reflect_derive/generics_fail.stderr +++ b/crates/bevy_reflect/compile_fail/tests/reflect_derive/generics_fail.stderr @@ -1,4 +1,4 @@ -error[E0277]: the trait bound `NoReflect: Reflect` is not satisfied +error[E0277]: `NoReflect` can not be reflected --> tests/reflect_derive/generics_fail.rs:18:21 | 18 | foo.get_field::("a").unwrap(); @@ -6,6 +6,7 @@ error[E0277]: the trait bound `NoReflect: Reflect` is not satisfied | | | required by a bound introduced by this call | + = note: Try using `#[derive(Reflect)]` = help: the following other types implement trait `Reflect`: bool char @@ -17,17 +18,19 @@ error[E0277]: the trait bound `NoReflect: Reflect` is not satisfied i128 and 74 others note: required by a bound in `bevy_reflect::GetField::get_field` - --> $BEVY_ROOT/crates/bevy_reflect/src/struct_trait.rs:242:21 + --> $BEVY_ROOT/crates/bevy_reflect/src/struct_trait.rs:244:21 | -242 | fn get_field(&self, name: &str) -> Option<&T>; +244 | fn get_field(&self, name: &str) -> Option<&T>; | ^^^^^^^ required by this bound in `GetField::get_field` -error[E0277]: the trait bound `NoReflect: GetTypeRegistration` is not satisfied +error[E0277]: `NoReflect` does not provide type registration information --> tests/reflect_derive/generics_fail.rs:14:36 | 14 | let mut foo: Box = Box::new(Foo:: { a: NoReflect(42.0) }); - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ the trait `GetTypeRegistration` is not implemented for `NoReflect`, which is required by `Foo: bevy_reflect::Struct` + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Invalid Type | + = help: the trait `GetTypeRegistration` is not implemented for `NoReflect`, which is required by `Foo: bevy_reflect::Struct` + = note: Try using `#[derive(Reflect)]` = help: the following other types implement trait `GetTypeRegistration`: bool char diff --git a/crates/bevy_reflect/src/from_reflect.rs b/crates/bevy_reflect/src/from_reflect.rs index 85de6c6bffd12..aacb7d9d2516f 100644 --- a/crates/bevy_reflect/src/from_reflect.rs +++ b/crates/bevy_reflect/src/from_reflect.rs @@ -21,6 +21,10 @@ use crate::{FromType, Reflect}; /// [derive macro]: bevy_reflect_derive::FromReflect /// [`DynamicStruct`]: crate::DynamicStruct /// [crate-level documentation]: crate +#[diagnostic::on_unimplemented( + message = "`{Self}` can not be created through reflection", + note = "consider annotating `{Self}` with `#[derive(FromReflect)]`" +)] pub trait FromReflect: Reflect + Sized { /// Constructs a concrete instance of `Self` from a reflected value. fn from_reflect(reflect: &dyn Reflect) -> Option; diff --git a/crates/bevy_reflect/src/path/mod.rs b/crates/bevy_reflect/src/path/mod.rs index fdf1c5d9d5e07..6a38faad59595 100644 --- a/crates/bevy_reflect/src/path/mod.rs +++ b/crates/bevy_reflect/src/path/mod.rs @@ -230,6 +230,10 @@ impl<'a> ReflectPath<'a> for &'a str { /// [`List`]: crate::List /// [`Array`]: crate::Array /// [`Enum`]: crate::Enum +#[diagnostic::on_unimplemented( + message = "`{Self}` does not provide a reflection path", + note = "consider annotating `{Self}` with `#[derive(Reflect)]`" +)] pub trait GetPath: Reflect { /// Returns a reference to the value specified by `path`. /// diff --git a/crates/bevy_reflect/src/reflect.rs b/crates/bevy_reflect/src/reflect.rs index 43108e61a4278..8238048d0a5b0 100644 --- a/crates/bevy_reflect/src/reflect.rs +++ b/crates/bevy_reflect/src/reflect.rs @@ -179,6 +179,10 @@ impl std::fmt::Display for ReflectKind { /// [`bevy_reflect`]: crate /// [derive macro]: bevy_reflect_derive::Reflect /// [crate-level documentation]: crate +#[diagnostic::on_unimplemented( + message = "`{Self}` can not be reflected", + note = "consider annotating `{Self}` with `#[derive(Reflect)]`" +)] pub trait Reflect: DynamicTypePath + Any + Send + Sync { /// Returns the [`TypeInfo`] of the type _represented_ by this value. /// diff --git a/crates/bevy_reflect/src/type_info.rs b/crates/bevy_reflect/src/type_info.rs index c64131a7b825f..1f68dbb7d0fa0 100644 --- a/crates/bevy_reflect/src/type_info.rs +++ b/crates/bevy_reflect/src/type_info.rs @@ -70,6 +70,10 @@ use std::fmt::Debug; /// ``` /// /// [utility]: crate::utility +#[diagnostic::on_unimplemented( + message = "`{Self}` can not provide type information through reflection", + note = "consider annotating `{Self}` with `#[derive(Reflect)]`" +)] pub trait Typed: Reflect + TypePath { /// Returns the compile-time [info] for the underlying type. /// diff --git a/crates/bevy_reflect/src/type_path.rs b/crates/bevy_reflect/src/type_path.rs index d6e6a4ad44ef4..dd2e18cc12486 100644 --- a/crates/bevy_reflect/src/type_path.rs +++ b/crates/bevy_reflect/src/type_path.rs @@ -79,6 +79,10 @@ use std::fmt; /// [`crate_name`]: TypePath::crate_name /// [`module_path`]: TypePath::module_path /// [`type_ident`]: TypePath::type_ident +#[diagnostic::on_unimplemented( + message = "`{Self}` does not have a type path", + note = "consider annotating `{Self}` with `#[derive(Reflect)]` or `#[derive(TypePath)]`" +)] pub trait TypePath: 'static { /// Returns the fully qualified path of the underlying type. /// @@ -129,6 +133,10 @@ pub trait TypePath: 'static { /// Since this is a supertrait of [`Reflect`] its methods can be called on a `dyn Reflect`. /// /// [`Reflect`]: crate::Reflect +#[diagnostic::on_unimplemented( + message = "`{Self}` can not be used as a dynamic type path", + note = "consider annotating `{Self}` with `#[derive(Reflect)]` or `#[derive(TypePath)]`" +)] pub trait DynamicTypePath { /// See [`TypePath::type_path`]. fn reflect_type_path(&self) -> &str; diff --git a/crates/bevy_reflect/src/type_registry.rs b/crates/bevy_reflect/src/type_registry.rs index 6940a14542bde..5db83589d320e 100644 --- a/crates/bevy_reflect/src/type_registry.rs +++ b/crates/bevy_reflect/src/type_registry.rs @@ -56,6 +56,10 @@ impl Debug for TypeRegistryArc { /// See the [crate-level documentation] for more information on type registration. /// /// [crate-level documentation]: crate +#[diagnostic::on_unimplemented( + message = "`{Self}` does not provide type registration information", + note = "consider annotating `{Self}` with `#[derive(Reflect)]`" +)] pub trait GetTypeRegistration: 'static { /// Returns the default [`TypeRegistration`] for this type. fn get_type_registration() -> TypeRegistration; diff --git a/crates/bevy_state/src/state/freely_mutable_state.rs b/crates/bevy_state/src/state/freely_mutable_state.rs index 1fc809f9e5d1f..88b5d901b5148 100644 --- a/crates/bevy_state/src/state/freely_mutable_state.rs +++ b/crates/bevy_state/src/state/freely_mutable_state.rs @@ -9,6 +9,7 @@ use super::transitions::*; /// /// While ordinary states are freely mutable (and implement this trait as part of their derive macro), /// computed states are not: instead, they can *only* change when the states that drive them do. +#[diagnostic::on_unimplemented(note = "consider annotating `{Self}` with `#[derive(States)]`")] pub trait FreelyMutableState: States { /// This function registers all the necessary systems to apply state changes and run transition schedules fn register_state(schedule: &mut Schedule) { diff --git a/crates/bevy_state/src/state/states.rs b/crates/bevy_state/src/state/states.rs index 6f2be17cd5759..bcd627580c91d 100644 --- a/crates/bevy_state/src/state/states.rs +++ b/crates/bevy_state/src/state/states.rs @@ -54,6 +54,11 @@ use std::hash::Hash; /// app.add_systems(Update, handle_escape_pressed.run_if(in_state(GameState::MainMenu))); /// app.add_systems(OnEnter(GameState::SettingsMenu), open_settings_menu); /// ``` +#[diagnostic::on_unimplemented( + message = "`{Self}` can not be used as a state", + label = "invalid state", + note = "consider annotating `{Self}` with `#[derive(States)]`" +)] pub trait States: 'static + Send + Sync + Clone + PartialEq + Eq + Hash + Debug { /// How many other states this state depends on. /// Used to help order transitions and de-duplicate [`ComputedStates`](crate::state::ComputedStates), as well as prevent cyclical diff --git a/crates/bevy_state/src/state/sub_states.rs b/crates/bevy_state/src/state/sub_states.rs index 8046a059b9652..9aa05567a7ffa 100644 --- a/crates/bevy_state/src/state/sub_states.rs +++ b/crates/bevy_state/src/state/sub_states.rs @@ -143,6 +143,11 @@ pub use bevy_state_macros::SubStates; /// /// impl FreelyMutableState for GamePhase {} /// ``` +#[diagnostic::on_unimplemented( + message = "`{Self}` can not be used as a sub-state", + label = "invalid sub-state", + note = "consider annotating `{Self}` with `#[derive(SubStates)]`" +)] pub trait SubStates: States + FreelyMutableState { /// The set of states from which the [`Self`] is derived. ///