├── .gitignore ├── Cargo.toml ├── LICENSE ├── README.md ├── examples ├── fixed_tick.rs └── multiple.rs └── src └── lib.rs /.gitignore: -------------------------------------------------------------------------------- 1 | # Generated by Cargo 2 | # will have compiled files and executables 3 | /target/ 4 | 5 | # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries 6 | # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html 7 | Cargo.lock 8 | 9 | # These are backup files generated by rustfmt 10 | **/*.rs.bk 11 | 12 | # IntelliJ IDE project files 13 | /.idea -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "bevy_contrib_schedules" 3 | version = "0.2.1" 4 | authors = ["Sean Kaufman "] 5 | edition = "2018" 6 | license = "cc0" 7 | repository = "https://github.com/thebluefish/bevy_contrib_schedules" 8 | 9 | [dependencies] 10 | log = "0.4" 11 | bevy = "0.3" 12 | 13 | [dev-dependencies] 14 | simple_logger = "1" -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Creative Commons Legal Code 2 | 3 | CC0 1.0 Universal 4 | 5 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 6 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 7 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 8 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 9 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 10 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 11 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 12 | HEREUNDER. 13 | 14 | Statement of Purpose 15 | 16 | The laws of most jurisdictions throughout the world automatically confer 17 | exclusive Copyright and Related Rights (defined below) upon the creator 18 | and subsequent owner(s) (each and all, an "owner") of an original work of 19 | authorship and/or a database (each, a "Work"). 20 | 21 | Certain owners wish to permanently relinquish those rights to a Work for 22 | the purpose of contributing to a commons of creative, cultural and 23 | scientific works ("Commons") that the public can reliably and without fear 24 | of later claims of infringement build upon, modify, incorporate in other 25 | works, reuse and redistribute as freely as possible in any form whatsoever 26 | and for any purposes, including without limitation commercial purposes. 27 | These owners may contribute to the Commons to promote the ideal of a free 28 | culture and the further production of creative, cultural and scientific 29 | works, or to gain reputation or greater distribution for their Work in 30 | part through the use and efforts of others. 31 | 32 | For these and/or other purposes and motivations, and without any 33 | expectation of additional consideration or compensation, the person 34 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 35 | is an owner of Copyright and Related Rights in the Work, voluntarily 36 | elects to apply CC0 to the Work and publicly distribute the Work under its 37 | terms, with knowledge of his or her Copyright and Related Rights in the 38 | Work and the meaning and intended legal effect of CC0 on those rights. 39 | 40 | 1. Copyright and Related Rights. A Work made available under CC0 may be 41 | protected by copyright and related or neighboring rights ("Copyright and 42 | Related Rights"). Copyright and Related Rights include, but are not 43 | limited to, the following: 44 | 45 | i. the right to reproduce, adapt, distribute, perform, display, 46 | communicate, and translate a Work; 47 | ii. moral rights retained by the original author(s) and/or performer(s); 48 | iii. publicity and privacy rights pertaining to a person's image or 49 | likeness depicted in a Work; 50 | iv. rights protecting against unfair competition in regards to a Work, 51 | subject to the limitations in paragraph 4(a), below; 52 | v. rights protecting the extraction, dissemination, use and reuse of data 53 | in a Work; 54 | vi. database rights (such as those arising under Directive 96/9/EC of the 55 | European Parliament and of the Council of 11 March 1996 on the legal 56 | protection of databases, and under any national implementation 57 | thereof, including any amended or successor version of such 58 | directive); and 59 | vii. other similar, equivalent or corresponding rights throughout the 60 | world based on applicable law or treaty, and any national 61 | implementations thereof. 62 | 63 | 2. Waiver. To the greatest extent permitted by, but not in contravention 64 | of, applicable law, Affirmer hereby overtly, fully, permanently, 65 | irrevocably and unconditionally waives, abandons, and surrenders all of 66 | Affirmer's Copyright and Related Rights and associated claims and causes 67 | of action, whether now known or unknown (including existing as well as 68 | future claims and causes of action), in the Work (i) in all territories 69 | worldwide, (ii) for the maximum duration provided by applicable law or 70 | treaty (including future time extensions), (iii) in any current or future 71 | medium and for any number of copies, and (iv) for any purpose whatsoever, 72 | including without limitation commercial, advertising or promotional 73 | purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each 74 | member of the public at large and to the detriment of Affirmer's heirs and 75 | successors, fully intending that such Waiver shall not be subject to 76 | revocation, rescission, cancellation, termination, or any other legal or 77 | equitable action to disrupt the quiet enjoyment of the Work by the public 78 | as contemplated by Affirmer's express Statement of Purpose. 79 | 80 | 3. Public License Fallback. Should any part of the Waiver for any reason 81 | be judged legally invalid or ineffective under applicable law, then the 82 | Waiver shall be preserved to the maximum extent permitted taking into 83 | account Affirmer's express Statement of Purpose. In addition, to the 84 | extent the Waiver is so judged Affirmer hereby grants to each affected 85 | person a royalty-free, non transferable, non sublicensable, non exclusive, 86 | irrevocable and unconditional license to exercise Affirmer's Copyright and 87 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 88 | maximum duration provided by applicable law or treaty (including future 89 | time extensions), (iii) in any current or future medium and for any number 90 | of copies, and (iv) for any purpose whatsoever, including without 91 | limitation commercial, advertising or promotional purposes (the 92 | "License"). The License shall be deemed effective as of the date CC0 was 93 | applied by Affirmer to the Work. Should any part of the License for any 94 | reason be judged legally invalid or ineffective under applicable law, such 95 | partial invalidity or ineffectiveness shall not invalidate the remainder 96 | of the License, and in such case Affirmer hereby affirms that he or she 97 | will not (i) exercise any of his or her remaining Copyright and Related 98 | Rights in the Work or (ii) assert any associated claims and causes of 99 | action with respect to the Work, in either case contrary to Affirmer's 100 | express Statement of Purpose. 101 | 102 | 4. Limitations and Disclaimers. 103 | 104 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 105 | surrendered, licensed or otherwise affected by this document. 106 | b. Affirmer offers the Work as-is and makes no representations or 107 | warranties of any kind concerning the Work, express, implied, 108 | statutory or otherwise, including without limitation warranties of 109 | title, merchantability, fitness for a particular purpose, non 110 | infringement, or the absence of latent or other defects, accuracy, or 111 | the present or absence of errors, whether or not discoverable, all to 112 | the greatest extent permissible under applicable law. 113 | c. Affirmer disclaims responsibility for clearing rights of other persons 114 | that may apply to the Work or any use thereof, including without 115 | limitation any person's Copyright and Related Rights in the Work. 116 | Further, Affirmer disclaims responsibility for obtaining any necessary 117 | consents, permissions or other rights required for any use of the 118 | Work. 119 | d. Affirmer understands and acknowledges that Creative Commons is not a 120 | party to this document and has no duty or obligation with respect to 121 | this CC0 or use of the Work. 122 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Bevy Schedule Runner 2 | 3 | --- 4 | 5 | Please note this project is minimally maintained. 6 | 7 | I originally wrote this as a temporary stop-gap until Bevy gets proper support for adding/removing systems during runtime. Ideally, it should serve as a base for writing your own schedules; and thus I wish to keep it to a very minimal implementation. I feel that this accomplishes what I set forth to do. 8 | 9 | I will try to support new Bevy releases on crates.io, but I am not aiming to bring in additional features. When Bevy gets proper support for adding/removing systems, I will probably archive this repository. I whole-heartedly welcome anyone who wants to fork it and make something awesome. 10 | 11 | --- 12 | 13 | A component for running systems at a different rate from the main schedule. 14 | 15 | - Run systems at a fixed timestep 16 | - Component schedules 17 | - Add and remove schedules as necessary 18 | - Run multiple schedules 19 | 20 | See [examples](https://github.com/thebluefish/bevy_contrib_schedules/tree/master/examples) -------------------------------------------------------------------------------- /examples/fixed_tick.rs: -------------------------------------------------------------------------------- 1 | use bevy::{prelude::*, app::ScheduleRunnerPlugin, core::CorePlugin, type_registry::TypeRegistryPlugin}; 2 | use bevy_contrib_schedules::*; 3 | 4 | fn main() { 5 | if let Err(e) = simple_logger::SimpleLogger::new().with_level(log::LevelFilter::Error).init() { 6 | println!("Failed to setup logger!\n{}", e); 7 | } 8 | 9 | App::build() 10 | // Ticks every 2 seconds 11 | .add_resource(ScheduleRunner::from_rate(2.0) 12 | .add_system(fixed_sys.system()) 13 | ) 14 | .add_resource(Time::default()) 15 | .add_plugin(TypeRegistryPlugin::default()) 16 | .add_plugin(CorePlugin::default()) 17 | .add_plugin(ScheduleRunnerPlugin::default()) 18 | .add_system(schedule_runner_system.thread_local_system()) 19 | .run(); 20 | } 21 | 22 | fn fixed_sys() { 23 | println!("game tick!"); 24 | } -------------------------------------------------------------------------------- /examples/multiple.rs: -------------------------------------------------------------------------------- 1 | use bevy::{prelude::*, app::ScheduleRunnerPlugin, core::CorePlugin, type_registry::TypeRegistryPlugin}; 2 | use bevy_contrib_schedules::*; 3 | 4 | fn main() { 5 | if let Err(e) = simple_logger::SimpleLogger::new().with_level(log::LevelFilter::Error).init() { 6 | println!("Failed to setup logger!\n{}", e); 7 | } 8 | 9 | App::build() 10 | .add_resource(Time::default()) 11 | .add_plugin(TypeRegistryPlugin::default()) 12 | .add_plugin(CorePlugin::default()) 13 | .add_plugin(ScheduleRunnerPlugin::default()) 14 | .add_startup_system(build.system()) 15 | .add_system(schedule_runner_system.thread_local_system()) 16 | .run(); 17 | } 18 | 19 | struct Foo; 20 | struct Bar; 21 | 22 | fn build(mut commands: Commands) { 23 | // TODO: Demonstrate how to later remove schedules conditionally 24 | // Spoiler: Just `.despawn` the node when you're done! 25 | commands 26 | // Always ticks 27 | .spawn(( 28 | Foo, ScheduleRunner::default() 29 | .add_system(foo_sys.system()) 30 | )) 31 | // Ticks 10 times per second 32 | .spawn(( 33 | Bar, ScheduleRunner::from_rate_inv(10.0) 34 | .add_system(bar_sys.system()) 35 | )) 36 | ; 37 | } 38 | 39 | fn foo_sys() { 40 | println!("foo"); 41 | } 42 | 43 | fn bar_sys() { 44 | println!("bar"); 45 | } -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | use bevy::{ 2 | app::stage, 3 | core::Time, 4 | ecs::{Schedule, ParallelExecutor, World, Resources, System, Entity}, 5 | utils::HashMap, 6 | }; 7 | 8 | /// Determines how the schedule should run 9 | #[derive(Debug)] 10 | pub enum ScheduleType { // The Schedule runs with... 11 | // ... Every frame 12 | Always, 13 | // ... A fixed tick cycle 14 | Fixed(f64, f64), // (rate, accumulator) 15 | // TODO: Figure out how to make this more useful? 16 | // ... A user-provided fn 17 | // With(Box), 18 | } 19 | 20 | /// The PackedSchedule is responsible for actual execution 21 | /// You probably won't need to touch this directly 22 | pub struct PackedSchedule(pub ScheduleType, pub Schedule, ParallelExecutor); 23 | 24 | impl Default for PackedSchedule { 25 | fn default() -> Self { 26 | PackedSchedule( 27 | ScheduleType::Always, 28 | Default::default(), 29 | ParallelExecutor::without_tracker_clears(), 30 | ) 31 | } 32 | } 33 | 34 | impl PackedSchedule { 35 | fn run(&mut self, mut world: &mut World, mut resources: &mut Resources) { 36 | self.1.initialize(world, resources); 37 | 38 | match &mut self.0 { 39 | ScheduleType::Always => { 40 | self.2.run(&mut self.1, &mut world, &mut resources); 41 | }, 42 | ScheduleType::Fixed(rate, accumulator) => { 43 | // Accumulate time 44 | match resources.get::