bevy_replicon 0.40.1

A server-authoritative replication crate for Bevy
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
use bevy::{
    ecs::system::{FilteredResourcesMutParamBuilder, FilteredResourcesParamBuilder, ParamBuilder},
    prelude::*,
};

use super::ServerUpdateTick;
use crate::{
    prelude::*,
    shared::{
        message::{
            ctx::{ClientReceiveCtx, ClientSendCtx},
            registry::RemoteMessageRegistry,
        },
        server_entity_map::ServerEntityMap,
    },
};

/// Sending messages and events from a client to the server.
///
/// Requires [`ClientPlugin`].
/// Can be disabled for apps that act only as servers.
pub struct ClientMessagePlugin;

impl Plugin for ClientMessagePlugin {
    fn build(&self, _app: &mut App) {}

    fn finish(&self, app: &mut App) {
        // Construct systems dynamically after all plugins initialization
        // because we need to access resources by registered IDs.
        let registry = app
            .world_mut()
            .remove_resource::<RemoteMessageRegistry>()
            .expect("message registry should be initialized on app build");

        let send_fn = (
            FilteredResourcesParamBuilder::new(|builder| {
                for message in registry.iter_all_client() {
                    builder.add_read_by_id(message.messages_id());
                }
            }),
            FilteredResourcesMutParamBuilder::new(|builder| {
                for message in registry.iter_all_client() {
                    builder.add_write_by_id(message.reader_id());
                }
            }),
            ParamBuilder,
            ParamBuilder,
            ParamBuilder,
            ParamBuilder,
        )
            .build_state(app.world_mut())
            .build_system(send);

        let send_shared_fn = (
            FilteredResourcesMutParamBuilder::new(|builder| {
                for message in registry.iter_all_shared() {
                    builder.add_write_by_id(message.messages_id());
                }
            }),
            FilteredResourcesMutParamBuilder::new(|builder| {
                for message in registry.iter_all_shared() {
                    builder.add_write_by_id(message.shared_messages_id());
                }
            }),
            ParamBuilder,
            ParamBuilder,
            ParamBuilder,
            ParamBuilder,
        )
            .build_state(app.world_mut())
            .build_system(send_shared);

        let trigger_shared_fn = (
            FilteredResourcesMutParamBuilder::new(|builder| {
                for event in registry.iter_shared_events() {
                    builder.add_write_by_id(event.message().shared_messages_id());
                }
            }),
            ParamBuilder,
            ParamBuilder,
        )
            .build_state(app.world_mut())
            .build_system(trigger_shared);

        let receive_builder = (
            FilteredResourcesMutParamBuilder::new(|builder| {
                for message in registry.iter_all_server() {
                    builder.add_write_by_id(message.messages_id());
                }
            }),
            FilteredResourcesMutParamBuilder::new(|builder| {
                for message in registry.iter_all_server() {
                    builder.add_write_by_id(message.queue_id());
                }
            }),
            ParamBuilder,
            ParamBuilder,
            ParamBuilder,
            ParamBuilder,
            ParamBuilder,
        );

        let receive_fn = receive_builder
            .clone()
            .build_state(app.world_mut())
            .build_system(receive);

        let enter_receive_fn = receive_builder
            .build_state(app.world_mut())
            .build_system(receive);

        let trigger_builder = (
            FilteredResourcesMutParamBuilder::new(|builder| {
                for event in registry.iter_server_events() {
                    builder.add_write_by_id(event.message().messages_id());
                }
            }),
            ParamBuilder,
            ParamBuilder,
        );

        let trigger_fn = trigger_builder
            .clone()
            .build_state(app.world_mut())
            .build_system(trigger);

        let enter_trigger_fn = trigger_builder
            .build_state(app.world_mut())
            .build_system(trigger);

        let send_locally_fn = (
            FilteredResourcesMutParamBuilder::new(|builder| {
                for message in registry.iter_all_client() {
                    builder.add_write_by_id(message.from_messages_id());
                }
            }),
            FilteredResourcesMutParamBuilder::new(|builder| {
                for message in registry.iter_all_client() {
                    builder.add_write_by_id(message.messages_id());
                }
            }),
            ParamBuilder,
        )
            .build_state(app.world_mut())
            .build_system(send_locally);

        let send_shared_locally_fn = (
            FilteredResourcesMutParamBuilder::new(|builder| {
                for message in registry.iter_all_shared() {
                    builder.add_write_by_id(message.shared_messages_id());
                }
            }),
            FilteredResourcesMutParamBuilder::new(|builder| {
                for message in registry.iter_all_shared() {
                    builder.add_write_by_id(message.messages_id());
                }
            }),
            ParamBuilder,
        )
            .build_state(app.world_mut())
            .build_system(send_shared_locally);

        let reset_fn = (
            FilteredResourcesMutParamBuilder::new(|builder| {
                for message in registry.iter_all_client() {
                    builder.add_write_by_id(message.messages_id());
                }
            }),
            FilteredResourcesMutParamBuilder::new(|builder| {
                for message in registry.iter_all_server() {
                    builder.add_write_by_id(message.queue_id());
                }
            }),
            FilteredResourcesMutParamBuilder::new(|builder| {
                for message in registry.iter_all_shared() {
                    builder.add_write_by_id(message.messages_id());
                }
            }),
            ParamBuilder,
        )
            .build_state(app.world_mut())
            .build_system(reset);

        app.insert_resource(registry)
            .add_systems(
                PreUpdate,
                (
                    receive_fn.run_if(in_state(ClientState::Connected)),
                    trigger_fn,
                )
                    .chain()
                    .after(super::receive_replication)
                    .in_set(ClientSystems::Receive),
            )
            .add_systems(
                OnEnter(ClientState::Connected),
                (enter_receive_fn, enter_trigger_fn)
                    .chain()
                    .after(super::receive_replication)
                    .in_set(ClientSystems::Receive),
            )
            .add_systems(
                OnExit(ClientState::Connected),
                reset_fn.in_set(ClientSystems::Reset),
            )
            .add_systems(
                PostUpdate,
                (
                    (send_fn, send_shared_fn).run_if(in_state(ClientState::Connected)),
                    (send_locally_fn, send_shared_locally_fn)
                        .run_if(in_state(ClientState::Disconnected)),
                    trigger_shared_fn,
                )
                    .chain()
                    .in_set(ClientSystems::Send),
            );
    }
}

fn send(
    messages: FilteredResources,
    mut readers: FilteredResourcesMut,
    mut client_messages: ResMut<ClientMessages>,
    type_registry: Res<AppTypeRegistry>,
    entity_map: Res<ServerEntityMap>,
    registry: Res<RemoteMessageRegistry>,
) {
    let mut ctx = ClientSendCtx {
        entity_map: &entity_map,
        type_registry: &type_registry,
        invalid_entities: Vec::new(),
    };

    for message in registry.iter_all_client() {
        let messages = messages
            .get_by_id(message.messages_id())
            .expect("messages resource should be accessible");
        let reader = readers
            .get_mut_by_id(message.reader_id())
            .expect("message reader resource should be accessible");

        // SAFETY: passed pointers were obtained using this message data.
        unsafe {
            message.send(
                &mut ctx,
                &messages,
                reader.into_inner(),
                &mut client_messages,
            );
        }
    }
}

fn send_shared(
    mut messages: FilteredResourcesMut,
    mut shared_messages: FilteredResourcesMut,
    mut client_messages: ResMut<ClientMessages>,
    type_registry: Res<AppTypeRegistry>,
    entity_map: Res<ServerEntityMap>,
    registry: Res<RemoteMessageRegistry>,
) {
    let mut ctx = ClientSendCtx {
        entity_map: &entity_map,
        type_registry: &type_registry,
        invalid_entities: Vec::new(),
    };

    for message in registry.iter_all_shared() {
        let messages = messages
            .get_mut_by_id(message.messages_id())
            .expect("messages resource should be accessible");
        let shared_messages = shared_messages
            .get_mut_by_id(message.shared_messages_id())
            .expect("shared messages resource should be accessible");

        // SAFETY: passed pointers were obtained using this message data.
        unsafe {
            message.send(
                &mut ctx,
                messages.into_inner(),
                shared_messages.into_inner(),
                &mut client_messages,
            );
        }
    }
}

fn receive(
    mut messages: FilteredResourcesMut,
    mut queues: FilteredResourcesMut,
    mut client_messages: ResMut<ClientMessages>,
    type_registry: Res<AppTypeRegistry>,
    entity_map: Res<ServerEntityMap>,
    message_registry: Res<RemoteMessageRegistry>,
    update_tick: Res<ServerUpdateTick>,
) {
    let mut ctx = ClientReceiveCtx {
        type_registry: &type_registry,
        entity_map: &entity_map,
        invalid_entities: Vec::new(),
    };

    for message in message_registry.iter_all_server() {
        let messages = messages
            .get_mut_by_id(message.messages_id())
            .expect("messages resource should be accessible");
        let queue = queues
            .get_mut_by_id(message.queue_id())
            .expect("queue resource should be accessible");

        // SAFETY: passed pointers were obtained using this message data.
        unsafe {
            message.receive(
                &mut ctx,
                messages.into_inner(),
                queue.into_inner(),
                &mut client_messages,
                **update_tick,
            )
        };
    }
}

fn trigger(
    mut messages: FilteredResourcesMut,
    mut commands: Commands,
    registry: Res<RemoteMessageRegistry>,
) {
    for event in registry.iter_server_events() {
        let messages = messages
            .get_mut_by_id(event.message().messages_id())
            .expect("messages resource should be accessible");
        event.trigger(&mut commands, messages.into_inner());
    }
}

fn trigger_shared(
    mut shared_messages: FilteredResourcesMut,
    mut commands: Commands,
    registry: Res<RemoteMessageRegistry>,
) {
    for event in registry.iter_shared_events() {
        let shared_messages = shared_messages
            .get_mut_by_id(event.message().shared_messages_id())
            .expect("shared messages resource should be accessible");
        // SAFETY: passed pointer was obtained using this event data.
        unsafe { event.trigger(&mut commands, shared_messages.into_inner()) };
    }
}

fn send_locally(
    mut from_messages: FilteredResourcesMut,
    mut messages: FilteredResourcesMut,
    registry: Res<RemoteMessageRegistry>,
) {
    for message in registry.iter_all_client() {
        let from_messages = from_messages
            .get_mut_by_id(message.from_messages_id())
            .expect("from clients messages resource should be accessible");
        let messages = messages
            .get_mut_by_id(message.messages_id())
            .expect("messages resource should be accessible");

        // SAFETY: passed pointers were obtained using this message data.
        unsafe { message.send_locally(from_messages.into_inner(), messages.into_inner()) };
    }
}

fn send_shared_locally(
    mut shared_messages: FilteredResourcesMut,
    mut messages: FilteredResourcesMut,
    registry: Res<RemoteMessageRegistry>,
) {
    for message in registry.iter_all_shared() {
        let shared_messages = shared_messages
            .get_mut_by_id(message.shared_messages_id())
            .expect("shared messages resource should be accessible");
        let messages = messages
            .get_mut_by_id(message.messages_id())
            .expect("messages resource should be accessible");

        // SAFETY: passed pointers were obtained using this message data.
        unsafe { message.send_locally(shared_messages.into_inner(), messages.into_inner()) };
    }
}

fn reset(
    mut messages: FilteredResourcesMut,
    mut queues: FilteredResourcesMut,
    mut shared_messages: FilteredResourcesMut,
    registry: Res<RemoteMessageRegistry>,
) {
    for message in registry.iter_all_client() {
        let messages = messages
            .get_mut_by_id(message.messages_id())
            .expect("messages resource should be accessible");

        // SAFETY: passed pointer was obtained using this message data.
        unsafe { message.reset(messages.into_inner()) };
    }

    for messages in registry.iter_all_server() {
        let queue = queues
            .get_mut_by_id(messages.queue_id())
            .expect("queue resource should be accessible");

        // SAFETY: passed pointer was obtained using this message data.
        unsafe { messages.reset(queue.into_inner()) };
    }

    for message in registry.iter_all_shared() {
        let shared_messages = shared_messages
            .get_mut_by_id(message.messages_id())
            .expect("shared messages resource should be accessible");

        // SAFETY: passed pointer was obtained using this message data.
        unsafe { message.reset(shared_messages.into_inner()) };
    }
}