Skip to main content

PredictionBuffer

Struct PredictionBuffer 

Source
pub struct PredictionBuffer<I, S> { /* private fields */ }
Expand description

Bounded client input/state history for server reconciliation.

Implementations§

Source§

impl<I, S> PredictionBuffer<I, S>

Source

pub fn new(config: PredictionConfig) -> NetcodeResult<Self>

Creates an empty prediction history.

Source

pub fn record( &mut self, tick: u64, input: I, predicted_state: S, ) -> NetcodeResult<()>

Records one successfully simulated local input and resulting state.

Source

pub fn confirmed_tick(&self) -> u64

Returns the highest authoritative Tick already reconciled.

Source

pub fn pending_len(&self) -> usize

Returns the number of inputs awaiting authoritative confirmation.

Source

pub fn is_empty(&self) -> bool

Returns whether no unconfirmed input remains.

Source

pub fn frames(&self) -> impl Iterator<Item = &PredictionFrame<I, S>>

Iterates retained prediction frames in Tick order.

Source§

impl<I, S> PredictionBuffer<I, S>
where S: Clone,

Source

pub fn reconcile<Simulate>( &mut self, authoritative_tick: u64, authoritative_state: S, simulate: Simulate, ) -> NetcodeResult<ReconciliationReport<S>>
where Simulate: FnMut(&mut S, u64, &I),

Restores an authoritative state and deterministically replays later local inputs.

simulate owns game rules and must advance state exactly once for the supplied Tick and input. A replay-limit or ordering error leaves the buffer unchanged.

Source

pub fn reset(&mut self, confirmed_tick: u64)

Clears all prediction history and installs a new confirmed Tick.

Trait Implementations§

Source§

impl<I: Clone, S: Clone> Clone for PredictionBuffer<I, S>

Source§

fn clone(&self) -> PredictionBuffer<I, S>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<I: Debug, S: Debug> Debug for PredictionBuffer<I, S>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<I, S> Freeze for PredictionBuffer<I, S>

§

impl<I, S> RefUnwindSafe for PredictionBuffer<I, S>

§

impl<I, S> Send for PredictionBuffer<I, S>
where I: Send, S: Send,

§

impl<I, S> Sync for PredictionBuffer<I, S>
where I: Sync, S: Sync,

§

impl<I, S> Unpin for PredictionBuffer<I, S>
where I: Unpin, S: Unpin,

§

impl<I, S> UnsafeUnpin for PredictionBuffer<I, S>

§

impl<I, S> UnwindSafe for PredictionBuffer<I, S>
where I: UnwindSafe, S: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.