#bevy-ecs #game #bevy #ecs

bevy_register_in_world

Register types into the world during runtime

1 unstable release

0.14.0 Aug 16, 2024

#1701 in Game dev

MIT/Apache

20KB
204 lines

Crate provides a way for tracking initialized to the world types, automatically initializing components into the world on add and conveniently adding system during runtime.

Motivation

Sometimes it's impossible, or will be way too hard, to initialize everything on the stage of building the app. For example:

#[derive(Component)]
struct GenericComponent<A, B>(A, B)
    where A: Send + Sync + 'static, B: Send + Sync + 'static;

fn system_operating_on_generic_component<A, B>(query: Query<&GenericComponent<A, B>>)
    where A: Send + Sync + 'static, B: Send + Sync + 'static 
{
    // do_something ...
}

Usual way to use generic types in bevy ecs is to provide a method to register all data related to the generic parameter to the world. For example, add_event registers all necessary data to the app so that it is possible to work with the registered event. This way of handling generics should still be preferred, because it avoids unnecessary runtime checks.

But in the situation above, for it to be possible, user should register every possible combination of two generics beforehand for the program to work.

So, with this library you can do this:

use bevy_register_in_world::prelude::*;

#[derive(ComponentAutoRegister)]
struct GenericComponent<A, B>(A, B)
    where A: Send + Sync + 'static, B: Send + Sync + 'static;

impl<A, B> RegisterInWorld for GenericComponent<A, B> 
    where A: Send + Sync + 'static, B: Send + Sync + 'static
{
    fn register(mut world: DeferredWorld) {
        world.add_systems(Update, system_operating_on_generic_component::<A, B>);
    }
}

fn system_operating_on_generic_component<A, B>(query: Query<&GenericComponent<A, B>>) 
    where A: Send + Sync + 'static, B: Send + Sync + 'static
{
    // do_something ...
}

And when component with unique combination of generics is added, register is called during it's on_add hook.

Dependencies

~8–11MB
~188K SLoC