Struct macroquad::experimental::coroutines::Coroutine

pub struct Coroutine<T = ()> { /* private fields */ }

Implementations

impl<T: 'static + Any> Coroutine<T>

pub fn is_done(&self) -> bool

Returns true if the coroutine finished or was stopped.

pub fn retrieve(&self) -> Option<T>

pub fn set_manual_poll(&mut self)

By default coroutines are being polled each frame, inside the “next_frame()”

start_coroutine(async move {
   println!("a");
   next_frame().await;
   println!("b");
}); // <- coroutine is created, but not yet polled
println!("c"); // <- first print, "c"
next_frame().await; // coroutine will be polled for the first time
                    // will print "a"
println!("d");      // "d"
next_frame().await; // coroutine will be polled second time, pass next_frame().await and will print "b"

will print “cadb” (there is a test for it, “tests/coroutine.rs:coroutine_execution_order” )

But, sometimes, automatic polling is not nice good example - game pause. Imagine a player that have some “update” function and some coroutines runned. During the pause “update” just early quit, but what with the coroutines?

“set_manual_poll” allows to control how coroutine is beng polled after set_manual_poll() coroutine will never be polled automatically so player will need to poll all its coroutines inside “update” function

pub fn poll(&mut self, delta_time: f64)

Poll coroutine once and advance coroutine’s timeline by delta_time Things like wait_for_seconds will wait for time in this local timeline` Will panic if coroutine.manual_poll == false

Trait Implementations

impl<T: Clone> Clone for Coroutine<T>

fn clone(&self) -> Coroutine<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Coroutine<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Copy> Copy for Coroutine<T>