Struct BlockStatePredictionHandler

pub struct BlockStatePredictionHandler { /* private fields */ }

A component that contains information about our local block state predictions.

Implementations

impl BlockStatePredictionHandler

pub fn start_predicting(&mut self) -> u32

Get the next sequence number that we’re going to use and increment the value.

pub fn retain_known_server_state( &mut self, pos: BlockPos, old_state: BlockState, player_pos: Vec3, )

Should be called right before the client updates a block with its prediction.

This is used to make sure that we can rollback to this state if the server acknowledges the sequence number (with ClientboundBlockChangedAck) without having sent a block update.

pub fn update_known_server_state( &mut self, pos: BlockPos, state: BlockState, ) -> bool

Save this update as the correct server state so when the server sends a ClientboundBlockChangedAck we don’t roll back this new update.

This should be used when we receive a block update from the server.

pub fn end_prediction_up_to(&mut self, seq: u32, world: &Instance)

Trait Implementations

impl Clone for BlockStatePredictionHandler

fn clone(&self) -> BlockStatePredictionHandler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for BlockStatePredictionHandler

where BlockStatePredictionHandler: 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, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

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 register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its [ComponentHooks].

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 Debug for BlockStatePredictionHandler

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

Formats the value using the given formatter.

impl Default for BlockStatePredictionHandler

fn default() -> BlockStatePredictionHandler

Returns the “default value” for a type.