Skip to content

Commit

Permalink
Document replicon conditions specifics (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
Shatur authored Sep 16, 2024
1 parent f50adea commit 586722e
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,17 @@ let connection_config = ConnectionConfig {
For a full example of how to initialize a server or client see the example in the
repository.
## Replicon conditions
The crate updates the running state of [`RepliconServer`] and connection state of [`RepliconClient`]
based on the states of [`RenetServer`](renet::RenetServer) and [`RenetClient`](renet::RenetServer)
in [`PreUpdate`].
This means that [replicon conditions](bevy_replicon::core::common_conditions) won't work in schedules
like [`Startup`]. As a workaround, you can directly check if renet's resources are present. This may be resolved
in the future once we have [observers for resources](https://github.com/bevyengine/bevy/issues/12231)
to immediately react to changes.
*/
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

Expand Down

0 comments on commit 586722e

Please sign in to comment.