lightyear_core 0.26.4

Core types shared by lightyear crates
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

//! # Lightyear Core
//!
//! This crate provides fundamental types and utilities shared across the Lightyear networking library.
//! It includes core concepts such as:
//! - Ticking and time management (`tick`, `time`, `timeline`).
//! - Network identifiers and abstractions (`network`, `id`).
//! - History buffers for state management (`history_buffer`).
//! - Core plugin structures (`plugin`).

#![cfg_attr(not(feature = "test_utils"), no_std)]

extern crate alloc;
extern crate core;
#[cfg(test)]
extern crate std;

/// Defines the `Tick` type and related systems for managing discrete time steps.
pub mod tick;

/// Provides core network-related types and traits.
pub mod network;

/// Provides `HistoryBuffer` for storing and managing historical state.
pub mod history_buffer;
/// Provides types for network identifiers, such as `PeerId` and `NetId`.
pub mod id;
/// Defines core plugin structures and related utilities.
pub mod plugin;
/// Utilities for time management, including interpolation and synchronization.
pub mod time;
/// Defines [`Timeline`](timeline::Timeline) for managing different views of time (local, network).
pub mod timeline;

pub mod interpolation;

pub mod prediction;

#[cfg(feature = "test_utils")]
pub mod test;

/// Commonly used items from the `lightyear_core` crate.
pub mod prelude {
    pub use crate::interpolation::Interpolated;

    pub use crate::prediction::Predicted;

    pub use crate::id::{LocalId, PeerId, RemoteId};
    pub use crate::tick::Tick;
    pub use crate::timeline::{
        LocalTimeline, NetworkTimeline, NetworkTimelinePlugin, Rollback, SyncEvent, Timeline,
        is_in_rollback,
    };
}