Struct rlbot::Physicist

pub struct Physicist<'a> { /* fields omitted */ }

An iterator-like object that yields physics ticks from the game as they occur.

Methods

impl<'a> Physicist<'a>

pub fn next(&mut self) -> Result<RigidBodyTick, Box<dyn Error>>

Deprecated:

the struct-based methods are deprecated; use the flatbuffer equivalents instead

Block until the next physics tick occurs, and then return it.

Errors

This function returns an error if ten seconds pass without a new tick being received. The assumption is that the game froze or crashed, and waiting longer will not help.

pub fn try_next(&mut self) -> Result<Option<RigidBodyTick>, Box<dyn Error>>

Deprecated:

the struct-based methods are deprecated; use the flatbuffer equivalents instead

Polls for a new physics tick.

If there is a tick that is newer than the previous tick, it is returned. Otherwise, None is returned.

pub fn next_flat<'fb>(&mut self) -> Result<RigidBodyTick<'fb>, Box<dyn Error>>

Block until the next physics tick occurs, and then return it.

Errors

This function returns an error if ten seconds pass without a new tick being received. The assumption is that the game froze or crashed, and waiting longer will not help.

pub fn next_flat_with_timeout<'fb>(
    &mut self,
    timeout: Duration
) -> Result<RigidBodyTick<'fb>, Box<dyn Error>>

Block until the next physics tick occurs, and then return it.

This works the same as next_flat, but lets the caller choose the timeout.

pub fn try_next_flat<'fb>(&mut self) -> Option<RigidBodyTick<'fb>>

Polls for a new physics tick.

If there is a tick that is newer than the previous tick, it is returned. Otherwise, None is returned.