Struct InputBuffer 

pub struct InputBuffer<S, M> {
    pub start_tick: Option<Tick>,
    pub buffer: VecDeque<Compressed<S>>,
    pub last_remote_tick: Option<Tick>,
    pub marker: PhantomData<M>,
}

Available on crate features input_bei or input_native or leafwing only.

Buffer that stores a value (usually Inputs) for the last few ticks.

S is the type of the InputSnapshot. M is present in case the InputSnapshot does not have a generic.

Fields

start_tick: Option<Tick>

buffer: VecDeque<Compressed<S>>

last_remote_tick: Option<Tick>

For remote inputs, keep track of the last tick we have received from the remote. (this is necessary because even without receiving a remote tick we keep updating the buffer with predicted inputs)

marker: PhantomData<M>

Implementations

impl<T, M> InputBuffer<T, M>

where T: Clone + PartialEq,

pub fn len(&self) -> usize

Available on crate feature input_native only.

Number of elements in the buffer

pub fn clip_after(&mut self, tick: Tick)

Available on crate feature input_native only.

Remove all elements in the buffer that are strictly after tick (leaves tick in the buffer)

pub fn extend_to_range(&mut self, start_tick: Tick, end_tick: Tick)

Available on crate feature input_native only.

Make sure that the buffer fits the range [start_tick, end_tick]

This is used when we receive a new InputMessage, to update the buffer from the message. It is important to extend the range, otherwise get_raw might return immediately if the tick is outside the current range.

pub fn set(&mut self, tick: Tick, value: T)

Available on crate feature input_native only.

Set the ActionState for the given tick in the InputBuffer

This should be called every tick.

pub fn set_empty(&mut self, tick: Tick)

Available on crate feature input_native only.

Set the ActionState for the given tick in the InputBuffer

This should be called every tick.

pub fn set_raw(&mut self, tick: Tick, value: Compressed<T>)

Available on crate feature input_native only.

pub fn pop_keeping_last(&mut self, tick: Tick) -> Option<T>

Available on crate feature input_native only.

Like pop, but preserves the most recent entry so it remains available as a get_predict fallback.

pub fn pop(&mut self, tick: Tick) -> Option<T>

Available on crate feature input_native only.

Remove all the inputs that are older or equal than the given tick, then return the input for the given tick

pub fn get_raw(&self, tick: Tick) -> &Compressed<T>

Available on crate feature input_native only.

Get the raw InputData for the given tick, without resolving SameAsPrecedent

pub fn get(&self, tick: Tick) -> Option<&T>

Available on crate feature input_native only.

Get the ActionState for the given tick. This does not apply prediction:

• if the tick is outside the range of the buffer, it returns None

pub fn get_predict(&self, tick: Tick) -> Option<&T>

Available on crate feature input_native only.

Get the ActionState for the given tick. This applies prediction:

• if the tick is outside the range of the buffer, we return the last known ActionState (if any)

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

Available on crate feature input_native only.

Get latest ActionState present in the buffer

pub fn get_last_with_tick(&self) -> Option<(Tick, &T)>

Available on crate feature input_native only.

Get latest ActionState present in the buffer, along with the associated Tick

pub fn end_tick(&self) -> Option<Tick>

Available on crate feature input_native only.

Get the last tick in the buffer

Trait Implementations

impl<S, M> Component for InputBuffer<S, M>

where InputBuffer<S, M>: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<InputBuffer<S, M>>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl<S, M> Debug for InputBuffer<S, M>

where S: Debug,

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

Formats the value using the given formatter.

impl<T, M> Default for InputBuffer<T, M>

fn default() -> InputBuffer<T, M>

Returns the “default value” for a type.

impl<T, M> Display for InputBuffer<T, M>

where T: Debug,

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

Formats the value using the given formatter.

impl<S, M> FromReflect for InputBuffer<S, M>

where InputBuffer<S, M>: Any + Send + Sync, S: TypePath, M: TypePath, VecDeque<Compressed<S>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<InputBuffer<S, M>>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl<S, M> GetTypeRegistration for InputBuffer<S, M>

where InputBuffer<S, M>: Any + Send + Sync, S: TypePath, M: TypePath, VecDeque<Compressed<S>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl<S, M> PartialReflect for InputBuffer<S, M>

where InputBuffer<S, M>: Any + Send + Sync, S: TypePath, M: TypePath, VecDeque<Compressed<S>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<InputBuffer<S, M>>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<InputBuffer<S, M>>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<InputBuffer<S, M>>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl<S, M> Reflect for InputBuffer<S, M>

where InputBuffer<S, M>: Any + Send + Sync, S: TypePath, M: TypePath, VecDeque<Compressed<S>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<InputBuffer<S, M>>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<InputBuffer<S, M>>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl<S, M> Struct for InputBuffer<S, M>

where InputBuffer<S, M>: Any + Send + Sync, S: TypePath, M: TypePath, VecDeque<Compressed<S>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut( &mut self, name: &str, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl<S, M> TypePath for InputBuffer<S, M>

where InputBuffer<S, M>: Any + Send + Sync, S: TypePath, M: TypePath,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl<S, M> Typed for InputBuffer<S, M>

where InputBuffer<S, M>: Any + Send + Sync, S: TypePath, M: TypePath, VecDeque<Compressed<S>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.