QcPrediction Class

Member Function Documentation

const std::optional<QcBoatState> &QcPrediction::boat() const

Returns the predicted boat the player drives after the latest tick; none when they drive none.

bool QcPrediction::crouches() const

Returns whether the player crouches: he sneaks on foot, not flying (sneak descends then, decision E-284) and not riding.

double QcPrediction::eyeHeight() const

Returns the height of the player's eyes above the feet after the latest tick: lower while he crouches (QcPhysics::eyeHeight, decision E-961).

void QcPrediction::followCart(const QcClientEntities &entities)

While riding, after predict(): the player moves onto the seat of the cart as the entity mirror entities shows it this tick.

bool QcPrediction::hasServerState() const

Returns whether a state of the server placed the player.

const QcPlayerInput &QcPrediction::intent() const

Returns the movement intent as last set.

See also setIntent().

double QcPrediction::largestCorrection() const

Returns the most metres the server moved the predicted player since resetCorrections().

quint32 QcPrediction::lastAcknowledged() const

Returns the sequence number of the latest input the server acknowledged.

double QcPrediction::lastCorrection() const

Returns the metres the server moved the predicted player in the latest reconcile (E-257).

quint32 QcPrediction::lastSequence() const

Returns the sequence number of the latest input predicted; 0 before the first.

void QcPrediction::mirror(const QcPrediction &core, bool current)

Takes over the prediction of the session's tick core (decision E-560), keeping the own intent (the session writes it) and, while riding, the own motion (the session follows the cart). With current false the core has not seen all of the session's commands yet: the own largest correction stays (it may just have been reset).

const QcEntityMotion &QcPrediction::motion() const

Returns the predicted state after the latest tick.

qsizetype QcPrediction::pendingInputCount() const

Returns the number of inputs the server has not acknowledged yet.

QcPlayerInput QcPrediction::predict(const QcBlockAccess &world, bool flying, QcMovement movement, const QcVec3 &push = {})

Predicts one tick in world from the intent: on foot or flying (with flying as the wish sent and movement from the game mode) through the shared physics, pushed by the creatures with push (QcPushBodies, decision E-882; kept with the input, so a replay pushes alike: after a correction the replayed steps keep the pushes of the places predicted before, not of the corrected ones, and the next correction takes up the difference); riding a cart the motion stays (followCart moves it); driving a boat the input steps the boat and the player sits in it. Returns the input to send; it carries the next sequence number and is kept until acknowledged.

const std::optional<QcBoatState> &QcPrediction::previousBoat() const

Returns the predicted boat one tick earlier.

const QcEntityMotion &QcPrediction::previousMotion() const

Returns the predicted state one tick earlier, for interpolation.

QcPrediction::Reconciled QcPrediction::reconcile(const QcMsg::PlayerState &state, const QcBlockAccess *world, QcMovement movement)

Applies the server's state of the player and replays the pending inputs on top of it (with world once it exists, moving by movement). Returns what the state did.

void QcPrediction::resetCorrections()

Forgets the largest correction so far.

void QcPrediction::rest()

A tick without a step (the server paused or the player dead, decision E-960): the state one tick earlier becomes the current one, so the interpolation between them stands still instead of swinging back over the last step with every tick.

const QcClientRiding &QcPrediction::riding() const

Returns the minecart the player rides or the boat they drive.

void QcPrediction::setIntent(const QcPlayerInput &intent)

Sets the movement intent applied on every tick until changed. Non-finite values are replaced, ranges (also the flight speed) clamped and yaw wrapped into [0, 360).

See also intent().

void QcPrediction::setSpeedFactor(float factor)

Sets factor, the factor of the player's status effects on their speed (slowness, decision E-838), as the server told them; the next inputs carry it, so replaying them moves as predicted.

void QcPrediction::setUsingItem(bool usingItem)

Sets usingItem, whether the next inputs hold an item in use (draw a bow, decision E-986). The inputs keep it, so replaying them moves as predicted.

bool QcPrediction::usingItemRefused(const QcMsg::PlayerState &state) const

Returns whether state shows that the server does not know of the running draw: it acknowledged an input of this draw and does not draw.