Struct NetworkSimulationTime 

pub struct NetworkSimulationTime { /* private fields */ }

Resource to track the state of the network simulation separately from the ECS frame timings

Implementations

impl NetworkSimulationTime

pub fn sim_frames_to_run(&self) -> RangeInclusive<u32>

Returns the simulation frame numbers needed to be run this game frame.

pub fn should_send_message_now(&self) -> bool

Determines whether or not to send a message in the current frame based on the message_send_rate

pub fn should_send_message(&self, frame: u32) -> bool

Determines whether or not to send a message based on the message_send_rate

pub fn increment_frame_number(&mut self)

Bumps the frame number

pub fn reset_frame_lag(&mut self)

Resets the frame lag

pub fn update_elapsed(&mut self, duration: Duration)

Increases the elapsed_duration by the given duration

pub fn frame_number(&self) -> u32

Returns the current simulation frame number

pub fn set_frame_number(&mut self, new_frame: u32)

Sets the frame number to the given frame number. This is useful when synchronizing frames with a server for example.

pub fn elapsed_duration(&self) -> Duration

Returns the total duration since the last simulation frame

pub fn per_frame_duration(&self) -> Duration

Returns the duration between each simulation frame. This number is calculated when a frame rate is set

pub fn message_send_rate(&self) -> u8

Returns the rate at which messages should be sent over the network. i.e. ‘every N frames’ where N is message_send_rate.

pub fn frame_lag(&self) -> u32

Returns the number of frames which the simulation is behind. This will usually be 0 or 1 if the ECS system is keeping up.

pub fn set_sim_frame_rate(&mut self, new_rate: u32)

Sets the rate at which the network simulation progresses. Specified in hertz (frames/second).

pub fn set_message_send_rate(&mut self, new_rate: u8)

Set the rate which messages are sent. Specified as ‘every N frames’ where N is new_rate.

Trait Implementations

impl Clone for NetworkSimulationTime

fn clone(&self) -> NetworkSimulationTime

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NetworkSimulationTime

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

Formats the value using the given formatter.

impl Default for NetworkSimulationTime

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for NetworkSimulationTime

fn eq(&self, other: &NetworkSimulationTime) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for NetworkSimulationTime

impl StructuralPartialEq for NetworkSimulationTime