Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing schedules in add_systems doc (#11814) #11815

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add missing schedules in add_systems doc (#11814) #11815

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions crates/bevy_ecs/src/schedule/condition.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ pub type BoxedCondition<In = ()> = Box<dyn ReadOnlySystem<In = In, Out = bool>>;
/// # let mut app = Schedule::default();
/// # #[derive(Resource)] struct DidRun(bool);
/// # fn my_system(mut did_run: ResMut<DidRun>) { did_run.0 = true; }
/// app.add_systems(my_system.run_if(always_true.pipe(identity())));
/// app.add_systems(Update, my_system.run_if(always_true.pipe(identity())));
/// # let mut world = World::new();
/// # world.insert_resource(DidRun(false));
/// # app.run(&mut world);
Expand All @@ -89,6 +89,7 @@ pub trait Condition<Marker, In = ()>: sealed::Condition<Marker, In> {
/// # let mut world = World::new();
/// # fn my_system() {}
/// app.add_systems(
/// Update,
/// // The `resource_equals` run condition will panic since we don't initialize `R`,
/// // just like if we used `Res<R>` in a system.
/// my_system.run_if(resource_equals(R(0))),
Expand All @@ -106,6 +107,7 @@ pub trait Condition<Marker, In = ()>: sealed::Condition<Marker, In> {
/// # let mut world = World::new();
/// # fn my_system() {}
/// app.add_systems(
/// Update,
/// // `resource_equals` will only get run if the resource `R` exists.
/// my_system.run_if(resource_exists::<R>.and_then(resource_equals(R(0)))),
/// );
Expand Down Expand Up @@ -144,6 +146,7 @@ pub trait Condition<Marker, In = ()>: sealed::Condition<Marker, In> {
/// # #[derive(Resource)] struct C(bool);
/// # fn my_system(mut c: ResMut<C>) { c.0 = true; }
/// app.add_systems(
/// Update,
/// // Only run the system if either `A` or `B` exist.
/// my_system.run_if(resource_exists::<A>.or_else(resource_exists::<B>)),
/// );
Expand Down Expand Up @@ -219,6 +222,7 @@ pub mod common_conditions {
/// # let mut world = World::new();
/// # world.init_resource::<Counter>();
/// app.add_systems(
/// Update,
/// // `run_once` will only return true the first time it's evaluated
/// my_system.run_if(run_once()),
/// );
Expand Down Expand Up @@ -259,6 +263,7 @@ pub mod common_conditions {
/// # let mut app = Schedule::default();
/// # let mut world = World::new();
/// app.add_systems(
/// Update,
/// // `resource_exists` will only return true if the given resource exists in the world
/// my_system.run_if(resource_exists::<Counter>),
/// );
Expand Down Expand Up @@ -299,6 +304,7 @@ pub mod common_conditions {
/// # let mut world = World::new();
/// # world.init_resource::<Counter>();
/// app.add_systems(
/// Update,
/// // `resource_equals` will only return true if the given resource equals the given value
/// my_system.run_if(resource_equals(Counter(0))),
/// );
Expand Down Expand Up @@ -336,6 +342,7 @@ pub mod common_conditions {
/// # let mut app = Schedule::default();
/// # let mut world = World::new();
/// app.add_systems(
/// Update,
/// // `resource_exists_and_equals` will only return true
/// // if the given resource exists and equals the given value
/// my_system.run_if(resource_exists_and_equals(Counter(0))),
Expand Down Expand Up @@ -379,6 +386,7 @@ pub mod common_conditions {
/// # let mut app = Schedule::default();
/// # let mut world = World::new();
/// app.add_systems(
/// Update,
/// // `resource_added` will only return true if the
/// // given resource was just added
/// my_system.run_if(resource_added::<Counter>),
Expand Down Expand Up @@ -430,6 +438,7 @@ pub mod common_conditions {
/// # let mut world = World::new();
/// # world.init_resource::<Counter>();
/// app.add_systems(
/// Update,
/// // `resource_changed` will only return true if the
/// // given resource was just changed (or added)
/// my_system.run_if(
Expand Down Expand Up @@ -483,6 +492,7 @@ pub mod common_conditions {
/// # let mut app = Schedule::default();
/// # let mut world = World::new();
/// app.add_systems(
/// Update,
/// // `resource_exists_and_changed` will only return true if the
/// // given resource exists and was just changed (or added)
/// my_system.run_if(
Expand Down Expand Up @@ -545,6 +555,7 @@ pub mod common_conditions {
/// # let mut world = World::new();
/// # world.init_resource::<Counter>();
/// app.add_systems(
/// Update,
/// // `resource_changed_or_removed` will only return true if the
/// // given resource was just changed or removed (or added)
/// my_system.run_if(
Expand Down Expand Up @@ -615,6 +626,7 @@ pub mod common_conditions {
/// # let mut world = World::new();
/// # world.init_resource::<Counter>();
/// app.add_systems(
/// Update,
/// // `resource_removed` will only return true if the
/// // given resource was just removed
/// my_system.run_if(resource_removed::<MyResource>()),
Expand Down Expand Up @@ -677,6 +689,7 @@ pub mod common_conditions {
/// }
///
/// app.add_systems(
/// Update,
/// // `state_exists` will only return true if the
/// // given state exists
/// my_system.run_if(state_exists::<GameState>),
Expand Down Expand Up @@ -724,6 +737,7 @@ pub mod common_conditions {
/// world.init_resource::<State<GameState>>();
///
/// app.add_systems((
/// Update,
/// // `in_state` will only return true if the
/// // given state equals the given value
/// play_system.run_if(in_state(GameState::Playing)),
Expand Down Expand Up @@ -854,6 +868,7 @@ pub mod common_conditions {
/// world.init_resource::<State<GameState>>();
///
/// app.add_systems(
/// Update,
/// // `state_changed` will only return true if the
/// // given states value has just been updated or
/// // the state has just been added
Expand Down Expand Up @@ -898,9 +913,10 @@ pub mod common_conditions {
/// # let mut world = World::new();
/// # world.init_resource::<Counter>();
/// # world.init_resource::<Events<MyEvent>>();
/// # app.add_systems(bevy_ecs::event::event_update_system::<MyEvent>.before(my_system));
/// # app.add_systems(Update, bevy_ecs::event::event_update_system::<MyEvent>.before(my_system));
///
/// app.add_systems(
/// Update,
/// my_system.run_if(on_event::<MyEvent>()),
/// );
///
Expand Down Expand Up @@ -942,6 +958,7 @@ pub mod common_conditions {
/// # let mut world = World::new();
/// # world.init_resource::<Counter>();
/// app.add_systems(
/// Update,
/// my_system.run_if(any_with_component::<MyComponent>),
/// );
///
Expand Down Expand Up @@ -989,6 +1006,7 @@ pub mod common_conditions {
/// # let mut world = World::new();
/// # world.init_resource::<Counter>();
/// app.add_systems(
/// Update,
/// // `not` will inverse any condition you pass in.
/// // Since the condition we choose always returns true
/// // this system will never run
Expand Down
12 changes: 7 additions & 5 deletions crates/bevy_ecs/src/system/combinator.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,13 @@ use super::{ReadOnlySystem, System};
/// # world.init_resource::<RanFlag>();
/// #
/// # let mut app = Schedule::default();
/// app.add_systems(my_system.run_if(Xor::new(
/// IntoSystem::into_system(resource_equals(A(1))),
/// IntoSystem::into_system(resource_equals(B(1))),
/// // The name of the combined system.
/// std::borrow::Cow::Borrowed("a ^ b"),
/// app.add_systems(
/// Update,
/// my_system.run_if(Xor::new(
/// IntoSystem::into_system(resource_equals(A(1))),
/// IntoSystem::into_system(resource_equals(B(1))),
/// // The name of the combined system.
/// std::borrow::Cow::Borrowed("a ^ b"),
/// )));
/// # fn my_system(mut flag: ResMut<RanFlag>) { flag.0 = true; }
/// #
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_ecs/src/system/system_param.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -702,7 +702,7 @@ unsafe impl SystemParam for &'_ World {
/// move |mut val| val.0 = value.0
/// }
///
/// // .add_systems(reset_to_system(my_config))
/// // .add_systems(Update, reset_to_system(my_config))
/// # assert_is_system(reset_to_system(Config(10)));
/// ```
#[derive(Debug)]
Expand Down
Loading