Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seldom-se/seldom_singleton
A helper `SystemParam` for when you have a resource containing a handle
https://github.com/seldom-se/seldom_singleton
bevy
Last synced: 3 months ago
JSON representation
A helper `SystemParam` for when you have a resource containing a handle
- Host: GitHub
- URL: https://github.com/seldom-se/seldom_singleton
- Owner: Seldom-SE
- License: other
- Created: 2024-04-16T03:06:25.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-10T00:01:48.000Z (6 months ago)
- Last Synced: 2024-10-09T20:04:30.942Z (3 months ago)
- Topics: bevy
- Language: Rust
- Homepage:
- Size: 6.84 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# `seldom_singleton`
[](https://crates.io/crates/seldom_singleton)
[](https://github.com/Seldom-SE/seldom_singleton#license)
[](https://crates.io/crates/seldom_singleton)
`seldom_singleton` adds a helper `SystemParam` for when you have a resource containing a handle. If
you're using Bevy's asset system to, for example, load a list of items in the game and their
properties, you'd end up with a handle in a resource, and you'd need to get `Res>`
to get the asset you need. This crate adds a helper that lets you avoid the additional system param.
This is a very small crate. You can just copy the source code into your project to avoid adding a
dependency.
Before:
```rust
#[derive(Asset, TypePath)]
struct MyAsset;
#[derive(Resource, Deref)]
struct MySingleton(Handle);
fn my_system(my_assets: Res>, my_singleton: Res) {
// Return if the asset doesn't exist
let Some(my_asset) = my_assets.get(&**my_singleton) else {
return;
};
// or panic
let my_asset = my_assets.get(&**my_singleton).unwrap();
}
```
After:
```rust
#[derive(Asset, TypePath)]
struct MyAsset;
// Your resource. Add it to the world yourself.
#[derive(Resource, Deref)]
struct MySingleton(Handle);
// `AssetSingleton` is this crate's `SystemParam`. This type definition can help reduce boilerplate
// a bit, but it's optional. There's also `AssetSingletonMut`.
type MySingletonParam<'w> = AssetSingleton<'w, MySingleton>;
fn my_system(my_singleton: MySingletonParam) {
// Return if the asset doesn't exist
let Some(my_asset) = my_singleton.get() else {
return;
};
// or panic
let my_asset = my_singleton.unwrap();
// `AssetSingletonMut` has `get_mut` and `unwrap_mut`
}
```
## Usage
Add to your `Cargo.toml`
```toml
# Replace * with your desired version
[dependencies]
seldom_singleton = "*"
```
## Compatibility
| Bevy | `seldom_singleton` |
| ---- | ------------------ |
| 0.14 | 0.2 |
| 0.13 | 0.1 |
## License
`seldom_singleton` is dual-licensed under MIT and Apache 2.0 at your option.
## Contributing
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.