Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ickshonpe/flat_commands
Spawn entity hierarchies without nesting or collecting the ids.
https://github.com/ickshonpe/flat_commands
bevy ecs ergonomics
Last synced: about 1 month ago
JSON representation
Spawn entity hierarchies without nesting or collecting the ids.
- Host: GitHub
- URL: https://github.com/ickshonpe/flat_commands
- Owner: ickshonpe
- License: mit
- Created: 2022-02-05T12:36:42.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-23T08:26:47.000Z (over 2 years ago)
- Last Synced: 2024-11-17T18:57:27.233Z (about 2 months ago)
- Topics: bevy, ecs, ergonomics
- Language: Rust
- Homepage:
- Size: 118 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flat Commands
Spawn entity hierarchies without nesting or collecting the ids.
## Examples
### Before
```rust
fn setup(mut commands: Commands) {
commands
.spawn_bundle(PbrBundle {
transform: Transform::from_xyz(1.0, 1.0, 1.0),
..Default::default()
})
.with_children(|parent| {
parent
.spawn_bundle(PbrBundle {
transform: Transform::from_xyz(1.0, 1.0, 1.0),
..Default::default()
})
.spawn_bundle(PbrBundle {
transform: Transform::from_xyz(2.0, 2.0, 2.0),
..Default::default()
})
});
}
```
### or
```rust
fn setup(mut commands: Commands) {
let child_1 = commands
.spawn_bundle(PbrBundle {
transform: Transform::from_xyz(1.0, 1.0, 1.0),
..Default::default()
})
.id();
let child_2 = commands
.spawn_bundle(PbrBundle {
transform: Transform::from_xyz(2.0, 2.0, 2.0),
..Default::default()
})
.id();
commands
.spawn_bundle(PbrBundle {
transform: Transform::from_xyz(1.0, 1.0, 1.0),
..Default::default()
})
.push_children(&[child_1, child_2]);
}
```
### after
```rust
use flat_commands::*;
fn setup(mut commands: Commands) {
commands
.spawn_root(PbrBundle {
transform: Transform::from_xyz(1.0, 1.0, 1.0),
..Default::default()
})
.with_child(PbrBundle {
transform: Transform::from_xyz(1.0, 1.0, 1.0),
..Default::default()
})
.with_sibling(PbrBundle {
transform: Transform::from_xyz(2.0, 2.0, 2.0),
..Default::default()
});
}
```
#
### Before
```rust
fn spawn_text_box(
mut commands: Commands,
asset_server: Res,
) {
commands.spawn_bundle(NodeBundle {
style: Style {
position_type: PositionType::Absolute,
position: UiRect { left: Val::Px(100.0), bottom: Val::Px(100.0), ..Default::default() },
padding: UiRect::all(Val::Px(2.0)),
..Default::default()
},
..Default::default()
})
.with_children(|builder| {
builder.spawn_bundle(NodeBundle {
color: UiColor (Color::DARK_GRAY),
style: Style {
padding: UiRect::all(Val::Px(4.0)),
..Default::default()
},
..Default::default()
}
)
.with_children(|builder| {
builder.spawn_bundle(TextBundle {
text: Text::from_section(
"Hello, world!",
TextStyle {
font: asset_server.load("FiraMono-Regular.ttf"),
font_size: 16.0,
color: Color::ANTIQUE_WHITE,
},
),
..Default::default()
});
});
});
}
```
### after
```rust
use flat_commands::*;
fn spawn_text_box(
mut commands: Commands,
asset_server: Res,
) {
commands.spawn_root(NodeBundle {
style: Style {
position_type: PositionType::Absolute,
position: UiRect { left: Val::Px(100.0), bottom: Val::Px(100.0), ..Default::default() },
padding: UiRect::all(Val::Px(2.0)),
..Default::default()
},
..Default::default()
})
.with_child(NodeBundle {
color: UiColor (Color::DARK_GRAY),
style: Style {
padding: UiRect::all(Val::Px(4.0)),
..Default::default()
},
..Default::default()
})
.with_child(TextBundle {
text: Text::from_section(
"Hello, world!",
TextStyle {
font: asset_server.load("FiraMono-Regular.ttf"),
font_size: 16.0,
color: Color::ANTIQUE_WHITE,
}
),
..Default::default()
});
}
```
#
### Before
```rust
fn spawn_branching_hierachy(
commands: &mut Commands
) -> Entity {
let id = commands.spawn().id();
commands.entity(id)
.with_children(|builder| {
builder
.spawn()
.with_children(|builder| {
builder
.spawn()
.with_children(|builder| {
builder
.spawn();
builder
.spawn();
});
});
builder
.spawn()
.with_children(|builder| {
builder
.spawn()
.with_children(|builder| {
builder
.spawn();
builder
.spawn();
});
});
builder
.spawn()
.with_children(|builder| {
builder
.spawn()
.with_children(|builder| {
builder
.spawn();
builder
.spawn();
});
});
});
id
}
```
### after
```rust
use flat_commands::*;
fn spawn_branching_hierachy(
commands: &mut Commands
) -> Entity {
commands
.spawn_empty_root()
.with_descendants(|local_root| {
local_root
.with_empty_child()
.with_empty_child()
.with_empty_sibling()
})
.with_descendants(|local_root| {
local_root
.with_empty_child()
.with_empty_child()
.with_empty_sibling()
})
.with_descendants(|local_root| {
local_root
.with_empty_child()
.with_empty_child()
.with_empty_sibling()
})
.root_id()
}
```
### or
```rust
use flat_commands::*;
fn spawn_hierachy(
mut commands: Commands
) -> Entity {
let root = commands
.spawn_empty_root();
root
.with_empty_child()
.with_empty_child()
.with_empty_sibling();
root
.with_empty_child()
.with_empty_child()
.with_empty_sibling();
root
.with_empty_child()
.with_empty_child()
.with_empty_sibling()
.root_id()
}
```
#
### EntityCommands also implements the extension traits
```rust
use flat_commands::*;
fn spawn_hierachy(
mut commands: Commands
) {
let entity_commands = commands.spawn();
entity_commands
.insert(MyComponent)
.with_empty_child()
.with_empty_sibling();
}
```
#
### Batched child spawning
```rust
use flat_commands::*;
fn spawn_brood(
mut commands: Commands,
asset_server: Res,
) {
let font = asset_server.load("fonts/FiraSans-Bold.ttf");
commands.spawn_root(NodeBundle { ..Default::default() })
.with_child_batch((0..30).map(move |i| {
TextBundle {
text: Text::with_section(
format!("Item {}", i),
TextStyle {
font: font.clone(),
font_size: 20.,
color: Color::RED,
},
Default::default(),
),
..Default::default()
}
);
}
```
#
## Examples
There is a minimal example of spawning a text box in the /examples folder. To run use:
```
cargo run --example text_box
```
## Other Info
* Unoptimized, will be slower than with_children and push_children.
* Doesn't do any despawning or component removal (use regular commands).
* Doesn't use any unsafe code or macros.
* version 3.0 supports Bevy 0.8, 2.2 supports Bevy 0.7, > 2.2 supports Bevy 0.6
* Todo: Automatic marker component insertion.