Struct crystalorb::server::Server

pub struct Server<WorldType: World> { /* fields omitted */ }

This is the top-level structure of CrystalOrb for your game server, analogous to the Client for game clients. You create, store, and update this server instance to run your game on the server side.

Implementations

impl<WorldType: World> Server<WorldType>

pub fn new(config: Config, seconds_since_startup: f64) -> Self

Constructs a new Server. This function requires a seconds_since_startup parameter to initialize the server’s simulation timestamp.

pub fn last_completed_timestamp(&self) -> Timestamp

The timestamp of the most recent frame that has completed its simulation. This is typically one less than Server::simulating_timestamp.

pub fn simulating_timestamp(&self) -> Timestamp

The timestamp of the frame that is in the process of being simulated. This is typically one more than Server::simulating_timestamp.

pub fn estimated_client_simulating_timestamp(&self) -> Timestamp

The timestamp that clients are supposed to be simulating at the moment (which should always be ahead of the server to compensate for the latency between the server and the clients).

This is also the timestamp that gets attached to the command when you call Server::issue_command.

pub fn estimated_client_last_completed_timestamp(&self) -> Timestamp

The timestamp that clients have supposed to have completed simulating (which should always be ahead of the server to compensate for the latency between the server and the clients).

pub fn issue_command<NetworkResourceType: NetworkResource>(
    &mut self,
    command: WorldType::CommandType,
    net: &mut NetworkResourceType
)

Issue a command from the server to the world. The command will be scheduled to the estimated client’s current timestamp.

pub fn buffered_commands(
    &self
) -> impl Iterator<Item = (Timestamp, &Vec<WorldType::CommandType>)>

Iterate through the commands that are being kept around. This is intended to be for diagnostic purposes.

pub fn display_state(&self) -> Timestamped<WorldType::DisplayStateType>

Get the current display state of the server’s world.

pub fn update<NetworkResourceType: NetworkResource>(
    &mut self,
    delta_seconds: f64,
    seconds_since_startup: f64,
    net: &mut NetworkResourceType
)

Perform the next update. You would typically call this in your game engine’s update loop of some kind.

Trait Implementations

impl<WorldType: Debug + World> Debug for Server<WorldType>

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

Formats the value using the given formatter.