borger/

tick.rs

use borger_plugin_sdk::TickID;
use std::fmt::{Debug, Error, Formatter};
use std::time::Duration;
use web_time::Instant;

#[cfg(feature = "server")]
use {crate::thread_comms::SimToClientChannel, borger_plugin_sdk::primitive::usize32};

pub struct TickInfo {
	//this value is not network synchronized in any way and so
	//isn't deterministic. it only measures how long the local
	//simulation has been running
	first: Instant,

	//simulation delta time/tick rate, in seconds/tick.
	//see SimulationInitOptions::sim_dt
	sim_dt: f32,

	//all of these id's are incremental

	//oldest tick that can still be rolled back and (as in, rewind
	//state to right before this tick happened). controls the amount
	//of state history that must be stored for rollback. will only
	//ever increase
	pub(crate) id_consensus: TickID,

	//same as id_consensus but includes pending unreconciled buffers
	//held in pending_received_buffers
	#[cfg(feature = "client")]
	pub(crate) id_consensus_received: TickID,

	//highest tick id received from the server so far. will only ever
	//increase. used to block reconciliation until receiving an equal
	//or higher tick id from the server. fixes severe visual glitching
	//caused by receiving wildly fluctuating tick id's during
	//consensus timeouts
	#[cfg(feature = "client")]
	pub(crate) id_cur_received: TickID,

	//another way of looking at this number is "how many ticks have
	//completed start to finish" or "tick.id_unfinished". may increase
	//or decrease due to local rollbacks, causing old ticks to be
	//resimulated
	pub(crate) id_cur: TickID,

	//by the end of the current scheduled tick, id_cur should be here
	pub(crate) id_target: TickID,

	//id_consensus <= id_consensus_received <= id_cur_received <= id_cur <= id_target
	//the wider the gap between id's (particularly consensus+target),
	//the worse the performance due to more rollbacks and
	//retransmitting old ticks. this also means that the laggiest
	//client will hurt performance for everyone, including the server.
	//we don't like that guy

	//server authoritative data that can't be reconciled yet due to
	//none of the pending_received_buffers having a tick id higher than
	//id_received
	#[cfg(feature = "client")]
	pub(crate) pending_received_buffers: Vec<Vec<u8>>,
}

impl TickInfo {
	pub(crate) fn new(sim_dt: f32, id_start: TickID, fast_forward_ticks: TickID) -> Self {
		assert!(
			sim_dt.is_finite() && sim_dt > 0.0,
			"sim_dt must be a positive number of seconds"
		);

		TickInfo {
			first: Instant::now()
				- Duration::from_secs_f64((id_start + fast_forward_ticks) as f64 * sim_dt as f64),

			sim_dt,

			id_consensus: id_start,

			#[cfg(feature = "client")]
			id_consensus_received: id_start,

			#[cfg(feature = "client")]
			id_cur_received: id_start,

			id_cur: id_start,
			id_target: id_start + fast_forward_ticks,

			#[cfg(feature = "client")]
			pending_received_buffers: Vec::new(),
		}
	}

	pub fn id(&self) -> TickID {
		self.id_cur
	}

	//if true, this tick is being simulated for the final time.
	//non-deterministic code is allowed, and large transition events
	//(objective complete, game end, etc.) are encouraged to happen now
	#[cfg(feature = "server")]
	pub(crate) fn has_consensus(&self) -> bool {
		//seems counterintuitive that consensus can be higher
		//than cur, but this is because id_consensus is
		//incremented at the start of a tick while id_cur of
		//a tick while id_cur is incremented at the end
		self.id_consensus > self.id_cur
	}

	//used by multiplayer tradeoff macro and marked unsafe for similar
	//reasoning: multiplayer safety, not memory safety
	#[cfg(feature = "server")]
	#[doc(hidden)]
	pub unsafe fn _has_consensus_tradeoff(&self) -> bool {
		self.has_consensus()
	}

	//analogous to InputAge::Fresh - true if this is the first time
	//the current tick ID is being simulated, false on resimulation
	#[cfg(feature = "client")]
	pub(crate) fn is_fresh(&self) -> bool {
		self.id_cur == self.id_target - 1
	}

	#[cfg(any(feature = "server", feature = "singlethreaded"))]
	pub(crate) fn get_ticks(&self, dur: Duration) -> TickID {
		f32::round(dur.as_secs_f32() / self.sim_dt) as TickID
	}

	pub(crate) fn get_duration(&self, offset: TickID) -> Duration {
		Duration::from_secs_f64(self.sim_dt as f64 * offset as f64)
	}

	pub(crate) fn get_instant_at(&self, id: TickID) -> Instant {
		self.first + self.get_duration(id)
	}

	#[cfg(any(feature = "server", feature = "singlethreaded"))]
	pub(crate) fn get_tick_at(&self, instant: Instant) -> TickID {
		let duration = instant - self.first;
		self.get_ticks(duration)
	}

	pub(crate) fn get_now(&self) -> Instant {
		self.get_instant_at(self.id_cur)
	}

	//recalibration is needed when server and client have
	//differing tick.id_target. this is unrelated to ping.
	//it causes client to exist at the wrong time, either
	//too far into the past or future
	#[cfg(feature = "client")]
	pub(crate) fn recalibrate(&mut self, offset_from_server: i16) {
		if offset_from_server >= 0 {
			//early relative to server
			let offset_from_server = offset_from_server as TickID;
			self.first += self.get_duration(offset_from_server);
			//do not modify id_target. rather, the adjustment of first
			//causes the simulation to pause for that many ticks
		} else {
			//late relative to server
			let offset_from_server = (-offset_from_server) as TickID;
			self.first -= self.get_duration(offset_from_server);
			self.id_target += offset_from_server;
		}
	}
}

impl Debug for TickInfo {
	fn fmt(&self, f: &mut Formatter) -> Result<(), Error> {
		#[derive(Debug)]
		#[allow(dead_code)]
		struct TickInfo {
			id_consensus: TickID,
			id_cur: TickID,
		}

		Debug::fmt(
			&TickInfo {
				id_consensus: self.id_consensus,
				id_cur: self.id_cur,
			},
			f,
		)
	}
}

//triggering an unrollbackable game logic event (aka
//using multiplayer_tradeoff!(WaitForConsensus) is
//normally delayed because it's caused by something
//happening on a specific tick, so that tick needs
//to finalize/reach consensus before triggering the
//unrollbackable event. unrollbackable network events
//on the other hand do not care about happening on a
//specific tick, so in order to trigger them asap,
//server rolls back as far as it can to the most recent
//consensus point in history
#[cfg(feature = "server")]
pub(crate) enum UnrollbackableNetEvent {
	ServerStart,
	ClientConnect(SimToClientChannel),
	ClientDisconnect(usize32),
}