Skip to content

Commit 586722e

Browse files
authored
Document replicon conditions specifics (#9)
1 parent f50adea commit 586722e

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/lib.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,17 @@ let connection_config = ConnectionConfig {
6262
6363
For a full example of how to initialize a server or client see the example in the
6464
repository.
65+
66+
## Replicon conditions
67+
68+
The crate updates the running state of [`RepliconServer`] and connection state of [`RepliconClient`]
69+
based on the states of [`RenetServer`](renet::RenetServer) and [`RenetClient`](renet::RenetServer)
70+
in [`PreUpdate`].
71+
72+
This means that [replicon conditions](bevy_replicon::core::common_conditions) won't work in schedules
73+
like [`Startup`]. As a workaround, you can directly check if renet's resources are present. This may be resolved
74+
in the future once we have [observers for resources](https://github.com/bevyengine/bevy/issues/12231)
75+
to immediately react to changes.
6576
*/
6677
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
6778

0 commit comments

Comments
 (0)