Enum bones_framework::networking::SyncingInfo

pub enum SyncingInfo {
    Online {
        current_frame: i32,
        last_confirmed_frame: i32,
        socket: Socket,
        players_network_stats: SVec<PlayerNetworkStats>,
        local_player_idx: usize,
        local_frame_delay: usize,
        disconnected_players: SVec<usize>,
        random_seed: u64,
    },
    Offline {
        current_frame: i32,
        random_seed: u64,
    },
}

Resource updated each frame exposing syncing/networking information in the current session.

Variants

Online

Holds data for an online session

Fields

current_frame: i32

Current frame of simulation step

last_confirmed_frame: i32

Last confirmed frame by all clients. Anything that occurred on this frame is agreed upon by all clients.

socket: Socket

Socket

players_network_stats: SVec<PlayerNetworkStats>

Networking stats for each connected player, stored at the [player_idx] index for each respective player.

local_player_idx: usize

The local player’s index

local_frame_delay: usize

The local input delay set for this session

disconnected_players: SVec<usize>

List of disconnected players (their idx)

random_seed: u64

The random seed for this session

Offline

Holds data for an offline session

Fields

current_frame: i32

Current frame of simulation step

random_seed: u64

The random seed for this session

Implementations

impl SyncingInfo

pub fn is_online(&self) -> bool

Checks if the session is online.

pub fn is_offline(&self) -> bool

Checks if the session is offline.

pub fn current_frame(&self) -> i32

Getter for the current frame (number).

pub fn last_confirmed_frame(&self) -> i32

Getter for the last confirmed frame (number).

pub fn socket(&self) -> Option<&Socket>

Getter for socket.

pub fn socket_mut(&mut self) -> Option<&mut Socket>

Mutable getter for socket.

pub fn player_network_stats( &self, player_idx: usize, ) -> Option<PlayerNetworkStats>

Getter for a single player’s network stats using their player_idx

pub fn players_network_stats(&self) -> SVec<PlayerNetworkStats>

Getter for all players’ network stats, including local player (set to default). This maintains index == player_idx.

pub fn remote_players_network_stats(&self) -> SVec<PlayerNetworkStats>

Getter for remote player network stats (filtering out local player). This does not maintain index == player_idx.

pub fn total_kbps_sent(&self) -> usize

Calculates the total kilobits per second sent across all remote players.

pub fn averaged_kbps_sent(&self) -> f32

Calculates the average kilobits per second sent across all remote players.

pub fn highest_local_frames_behind(&self) -> i32

Returns the highest number of local frames behind across all remote players.

pub fn highest_remote_frames_behind(&self) -> i32

Returns the highest number of remote frames behind across all remote players.

pub fn averaged_ping(&self) -> u128

Calculates the average ping across all remote players.

pub fn lowest_ping(&self) -> u128

Returns the lowest ping across all remote players.

pub fn highest_ping(&self) -> u128

Returns the highest ping across all remote players.

pub fn local_player_idx_checked(&self) -> Option<usize>

Getter for the local player index, if offline defaults to None.

pub fn local_player_idx(&self) -> usize

Getter for the local player index, if offline defaults to 0.

pub fn local_frame_delay(&self) -> usize

Getter for the local frame delay.

pub fn players_count(&self) -> usize

Getter for the number of players, if offline defaults to 0.

pub fn players_count_checked(&self) -> Option<usize>

Getter for the number of players, if offline defaults to None.

pub fn active_players(&self) -> SVec<usize>

Getter for the list of active players (idx) which are connected. Offline returns empty list.

pub fn active_players_checked(&self) -> Option<SVec<usize>>

Getter for the list of active players (idx) which are connected. Offline returns None.

pub fn disconnected_players(&self) -> SVec<usize>

Getter for the list of players which have been disconnected (their idx). Offline returns empty list.

pub fn disconnected_players_checked(&self) -> Option<SVec<usize>>

Getter for the list of players which have been disconnected (their idx). Offline returns None.

pub fn random_seed(&self) -> u64

Getter for the random seed.

Trait Implementations

impl Clone for SyncingInfo

fn clone(&self) -> SyncingInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl HasSchema for SyncingInfo

fn schema() -> &'static Schema

Get this type’s [Schema].

fn register_schema()

Register this schema with the global schema registry.

fn cast<T>(this: &Self) -> &T

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn try_cast<T>(this: &Self) -> Result<&T, SchemaMismatchError>

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn cast_mut<T>(this: &mut Self) -> &mut T

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn try_cast_mut<T>(this: &mut Self) -> Result<&mut T, SchemaMismatchError>

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn as_schema_ref(&self) -> SchemaRef<'_>

where Self: Sized,

Converts a reference of T to a SchemaRef

fn as_schema_mut(&mut self) -> SchemaRefMut<'_>

where Self: Sized,

Converts a reference of T to a SchemaRefMut