ecs-tiny

A minimal ECS supporting entity and component insertion/removal, association, and single-type iteration

4 releases (2 breaking)

0.3.0 Jun 29, 2024
0.2.0 Jun 6, 2024
0.1.1 May 16, 2024
0.1.0 May 16, 2024

#696 in Data structures

24 downloads per month

MIT license

24KB
272 lines

ecs-tiny

crates.io doc.rs

A minimal ECS supporting entity and component insertion/removal, association, and single-type iteration.

Usages

// Create new ecs instance and inserts new entity:

let mut ecs = ecs_tiny::ECS::new();

let entity_key0 = ecs.insert_entity();
let entity_key1 = ecs.insert_entity();

// Register new component type:

ecs.register::<i32>().unwrap();
ecs.register::<()>().unwrap();

// Inserts new component associated with specified entity:

let comp_key0 = ecs.insert_comp(entity_key0, 42).unwrap();
let comp_key1 = ecs.insert_comp(entity_key0, 63).unwrap();
let comp_key2 = ecs.insert_comp(entity_key1, 42).unwrap();
let comp_key3 = ecs.insert_comp(entity_key1, ()).unwrap();

// Iterates over all components associated with specified entity:

for comp in ecs.iter_comp_mut_by_entity::<i32>(entity_key0).unwrap() {
    *comp += 1;
}

// Iterates over all components of specified type (single type only):

for comp in ecs.iter_comp_mut::<i32>().unwrap() {
    *comp += 1;
}

// Removes specified component:

ecs.remove_comp::<i32>(comp_key0).unwrap();

// Removes specified entity:

ecs.remove_entity(entity_key1).unwrap();

Dependencies

~0.7–1MB
~14K SLoC