Struct HostLogic

source

pub struct HostLogic<StepT: Clone + Eq + Debug + Deserialize + Serialize + Display> { /* private fields */ }

Expand description

Core logic handler for the Nimble host.

Manages connections, game sessions, and processes client commands.

Implementations§

source §

impl<StepT: Clone + Eq + Debug + Deserialize + Serialize + Display> HostLogic<StepT>

source

pub fn new(tick_id: TickId, deterministic_simulation_version: Version) -> Self

Creates a new instance of HostLogic.

§Parameters

tick_id: The initial tick identifier for the game session.
deterministic_simulation_version: The version of the deterministic simulation.

§Returns

A new HostLogic instance.

source

pub fn create_connection(&mut self) -> Option<HostConnectionId>

Creates a new connection and returns its identifier.

Allocates a unique HostConnectionId for a new client connection.

§Returns

An Option containing the new HostConnectionId if allocation is successful, or None if the limit is reached.

source

pub fn get(&self, connection_id: HostConnectionId) -> Option<&Connection<StepT>>

Retrieves a reference to a connection by its identifier.

§Parameters

connection_id: The HostConnectionId of the connection to retrieve.

§Returns

An Option containing a reference to the Connection if found, or None otherwise.

source

pub fn destroy_connection( &mut self, connection_id: HostConnectionId, ) -> Result<(), HostLogicError>

Destroys a connection, freeing its identifier.

§Parameters

connection_id: The HostConnectionId of the connection to destroy.

§Returns

A Result indicating success or a HostLogicError if the connection ID is invalid.

§Errors

HostLogicError // TODO:

source

pub const fn session(&self) -> &GameSession<StepT>

Retrieves a reference to the current game session.

§Returns

A reference to the GameSession.

source

pub fn post_update(&mut self)

Performs post-update operations after the main update cycle.

Specifically, it triggers the production of authoritative steps within the session’s combinator.

source

pub fn update( &mut self, connection_id: HostConnectionId, now: Millis, request: &ClientToHostCommands<StepT>, state_provider: &impl GameStateProvider, ) -> Result<Vec<HostToClientCommands<Step<StepT>>>, HostLogicError>

Processes an update from a client connection.

Handles incoming client commands and updates the game state accordingly.

§Parameters

connection_id: The HostConnectionId of the client sending the commands.
now: The current absolute time in milliseconds precision.
request: The ClientToHostCommands sent by the client.
state_provider: An implementation of GameStateProvider to supply game state data.