Struct ClientLogic

pub struct ClientLogic<StateT: BufferDeserializer, StepT: Clone + Deserialize + Serialize + Debug + Display> { /* private fields */ }

ClientLogic manages the client’s state and communication logic with the host in a multiplayer game session.

Type Parameters

• StateT: A type implementing representing the game state.
• StepT: A type implementing representing the game steps.

Implementations

impl<StateT: BufferDeserializer, StepT: Clone + Deserialize + Serialize + Debug + Display> ClientLogic<StateT, StepT>

pub fn new(deterministic_simulation_version: Version) -> Self

Creates a new ClientLogic instance, initializing all fields.

pub const fn debug_authoritative_steps(&self) -> &Queue<StepMap<Step<StepT>>>

Returns a reference to the incoming authoritative steps.

pub const fn phase(&self) -> &ClientLogicPhase

pub fn latency(&self) -> Option<MinMaxAvg<u16>>

pub fn pop_all_authoritative_steps( &mut self, ) -> (TickId, Vec<StepMap<Step<StepT>>>)

pub fn set_joining_player(&mut self, local_players: Vec<LocalIndex>)

Sets the joining player request for this client.

Arguments

• join_game_request: The join game request to send to the host.

pub const fn debug_connect_request_id(&self) -> Option<ClientRequestId>

pub fn send(&mut self, now: Millis) -> Vec<ClientToHostCommands<StepT>>

Returns client commands that should be sent to the host.

Returns

A vector of ClientToHostCommands representing all the commands to be sent to the host.

pub fn can_push_predicted_step(&self) -> bool

pub fn is_in_game(&self) -> bool

pub fn push_predicted_step( &mut self, tick_id: TickId, step: StepMap<StepT>, ) -> Result<(), ClientLogicError>

Adds a predicted step to the outgoing steps queue.

Arguments

• tick_id: The tick ID of the step.
• step: The predicted step to add.

Errors

Returns a [StepsError] if the step is empty or cannot be added.

pub fn predicted_step_count_in_queue(&self) -> usize

pub const fn game(&self) -> Option<&StateT>

Returns the received game state from the host.

Returns

An Option containing a reference to the received game state, if available.

pub fn game_mut(&mut self) -> Option<&mut StateT>

pub fn receive( &mut self, now: Millis, command: &HostToClientCommands<Step<StepT>>, ) -> Result<(), ClientLogicError>

Receives a command from the host and processes it accordingly.

Arguments

• command: The command from the host.

Errors

Returns a [ClientErrorKind] if the command cannot be processed.

pub fn server_buffer_delta_ticks(&self) -> Option<i16>

Returns the average server buffer delta tick, if available.

Returns

An optional average server buffer delta tick.

pub fn local_players(&self) -> Vec<LocalPlayer>

Trait Implementations

impl<StateT: Debug + BufferDeserializer, StepT: Debug + Clone + Deserialize + Serialize + Debug + Display> Debug for ClientLogic<StateT, StepT>

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

Formats the value using the given formatter.