 f907d67d7e
			
		
	
	
		f907d67d7e
		
	
	
	
	
		
			
			# Objective The `bevy_app` crate has a lot of inconsistencies in the documentation (formatting, spelling, phrasing, consistency). ## Solution Make it more consistent.
		
			
				
	
	
		
			160 lines
		
	
	
		
			5.7 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			160 lines
		
	
	
		
			5.7 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| use crate::{
 | |
|     app::{App, AppExit},
 | |
|     plugin::Plugin,
 | |
| };
 | |
| use bevy_ecs::event::{Events, ManualEventReader};
 | |
| use bevy_utils::{Duration, Instant};
 | |
| 
 | |
| #[cfg(target_arch = "wasm32")]
 | |
| use std::{cell::RefCell, rc::Rc};
 | |
| #[cfg(target_arch = "wasm32")]
 | |
| use wasm_bindgen::{prelude::*, JsCast};
 | |
| 
 | |
| /// Determines the method used to run an [`App`]'s [`Schedule`](bevy_ecs::schedule::Schedule).
 | |
| ///
 | |
| /// It is used in the [`ScheduleRunnerSettings`].
 | |
| #[derive(Copy, Clone, Debug)]
 | |
| pub enum RunMode {
 | |
|     /// Indicates that the [`App`]'s schedule should run repeatedly.
 | |
|     Loop {
 | |
|         /// The minimum [`Duration`] to wait after a [`Schedule`](bevy_ecs::schedule::Schedule)
 | |
|         /// has completed before repeating. A value of [`None`] will not wait.
 | |
|         wait: Option<Duration>,
 | |
|     },
 | |
|     /// Indicates that the [`App`]'s schedule should run only once.
 | |
|     Once,
 | |
| }
 | |
| 
 | |
| impl Default for RunMode {
 | |
|     fn default() -> Self {
 | |
|         RunMode::Loop { wait: None }
 | |
|     }
 | |
| }
 | |
| 
 | |
| /// The configuration information for the [`ScheduleRunnerPlugin`].
 | |
| ///
 | |
| /// It gets added as a [`Resource`](bevy_ecs::system::Resource) inside of the [`ScheduleRunnerPlugin`].
 | |
| #[derive(Copy, Clone, Default)]
 | |
| pub struct ScheduleRunnerSettings {
 | |
|     /// Determines whether the [`Schedule`](bevy_ecs::schedule::Schedule) is run once or repeatedly.
 | |
|     pub run_mode: RunMode,
 | |
| }
 | |
| 
 | |
| impl ScheduleRunnerSettings {
 | |
|     /// See [`RunMode::Once`].
 | |
|     pub fn run_once() -> Self {
 | |
|         ScheduleRunnerSettings {
 | |
|             run_mode: RunMode::Once,
 | |
|         }
 | |
|     }
 | |
| 
 | |
|     /// See [`RunMode::Loop`].
 | |
|     pub fn run_loop(wait_duration: Duration) -> Self {
 | |
|         ScheduleRunnerSettings {
 | |
|             run_mode: RunMode::Loop {
 | |
|                 wait: Some(wait_duration),
 | |
|             },
 | |
|         }
 | |
|     }
 | |
| }
 | |
| 
 | |
| /// Configures an [`App`] to run its [`Schedule`](bevy_ecs::schedule::Schedule) according to a given
 | |
| /// [`RunMode`].
 | |
| #[derive(Default)]
 | |
| pub struct ScheduleRunnerPlugin;
 | |
| 
 | |
| impl Plugin for ScheduleRunnerPlugin {
 | |
|     fn build(&self, app: &mut App) {
 | |
|         let settings = app
 | |
|             .world
 | |
|             .get_resource_or_insert_with(ScheduleRunnerSettings::default)
 | |
|             .to_owned();
 | |
|         app.set_runner(move |mut app: App| {
 | |
|             let mut app_exit_event_reader = ManualEventReader::<AppExit>::default();
 | |
|             match settings.run_mode {
 | |
|                 RunMode::Once => {
 | |
|                     app.update();
 | |
|                 }
 | |
|                 RunMode::Loop { wait } => {
 | |
|                     let mut tick = move |app: &mut App,
 | |
|                                          wait: Option<Duration>|
 | |
|                           -> Result<Option<Duration>, AppExit> {
 | |
|                         let start_time = Instant::now();
 | |
| 
 | |
|                         if let Some(app_exit_events) =
 | |
|                             app.world.get_resource_mut::<Events<AppExit>>()
 | |
|                         {
 | |
|                             if let Some(exit) = app_exit_event_reader.iter(&app_exit_events).last()
 | |
|                             {
 | |
|                                 return Err(exit.clone());
 | |
|                             }
 | |
|                         }
 | |
| 
 | |
|                         app.update();
 | |
| 
 | |
|                         if let Some(app_exit_events) =
 | |
|                             app.world.get_resource_mut::<Events<AppExit>>()
 | |
|                         {
 | |
|                             if let Some(exit) = app_exit_event_reader.iter(&app_exit_events).last()
 | |
|                             {
 | |
|                                 return Err(exit.clone());
 | |
|                             }
 | |
|                         }
 | |
| 
 | |
|                         let end_time = Instant::now();
 | |
| 
 | |
|                         if let Some(wait) = wait {
 | |
|                             let exe_time = end_time - start_time;
 | |
|                             if exe_time < wait {
 | |
|                                 return Ok(Some(wait - exe_time));
 | |
|                             }
 | |
|                         }
 | |
| 
 | |
|                         Ok(None)
 | |
|                     };
 | |
| 
 | |
|                     #[cfg(not(target_arch = "wasm32"))]
 | |
|                     {
 | |
|                         while let Ok(delay) = tick(&mut app, wait) {
 | |
|                             if let Some(delay) = delay {
 | |
|                                 std::thread::sleep(delay);
 | |
|                             }
 | |
|                         }
 | |
|                     }
 | |
| 
 | |
|                     #[cfg(target_arch = "wasm32")]
 | |
|                     {
 | |
|                         fn set_timeout(f: &Closure<dyn FnMut()>, dur: Duration) {
 | |
|                             web_sys::window()
 | |
|                                 .unwrap()
 | |
|                                 .set_timeout_with_callback_and_timeout_and_arguments_0(
 | |
|                                     f.as_ref().unchecked_ref(),
 | |
|                                     dur.as_millis() as i32,
 | |
|                                 )
 | |
|                                 .expect("Should register `setTimeout`.");
 | |
|                         }
 | |
|                         let asap = Duration::from_millis(1);
 | |
| 
 | |
|                         let mut rc = Rc::new(app);
 | |
|                         let f = Rc::new(RefCell::new(None));
 | |
|                         let g = f.clone();
 | |
| 
 | |
|                         let c = move || {
 | |
|                             let mut app = Rc::get_mut(&mut rc).unwrap();
 | |
|                             let delay = tick(&mut app, wait);
 | |
|                             match delay {
 | |
|                                 Ok(delay) => {
 | |
|                                     set_timeout(f.borrow().as_ref().unwrap(), delay.unwrap_or(asap))
 | |
|                                 }
 | |
|                                 Err(_) => {}
 | |
|                             }
 | |
|                         };
 | |
|                         *g.borrow_mut() = Some(Closure::wrap(Box::new(c) as Box<dyn FnMut()>));
 | |
|                         set_timeout(g.borrow().as_ref().unwrap(), asap);
 | |
|                     };
 | |
|                 }
 | |
|             }
 | |
|         });
 | |
|     }
 | |
| }
 |