Struct ggrs::SyncTestSession

pub struct SyncTestSession<T> where
    T: Config,  { /* private fields */ }

During a SyncTestSession, GGRS will simulate a rollback every frame and resimulate the last n states, where n is the given check distance. The resimulated checksums will be compared with the original checksums and report if there was a mismatch.

Implementations

impl<T: Config> SyncTestSession<T>

pub fn add_local_input(
    &mut self,
    player_handle: PlayerHandle,
    input: T::Input
) -> Result<(), GGRSError>

Registers local input for a player for the current frame. This should be successfully called for every local player before calling advance_frame(). If this is called multiple times for the same player before advancing the frame, older given inputs will be overwritten. In a sync test, all players are considered to be local, so you need to add input for all of them.

Errors

• Returns InvalidRequest when the given handle is not valid (i.e. not between 0 and num_players).

pub fn advance_frame(&mut self) -> Result<Vec<GGRSRequest<T>>, GGRSError>

In a sync test, this will advance the state by a single frame and afterwards rollback check_distance amount of frames, resimulate and compare checksums with the original states. Returns an order-sensitive Vec<GGRSRequest>. You should fulfill all requests in the exact order they are provided. Failure to do so will cause panics later.

Errors

• Returns MismatchedChecksumError if checksums don’t match after resimulation.

pub fn num_players(&self) -> usize

Returns the number of players this session was constructed with.

pub fn max_prediction(&self) -> usize

Returns the maximum prediction window of a session.