mirror of
https://github.com/bevyengine/bevy
synced 2024-09-20 14:32:06 +00:00
1ba7429371
# Objective Provide a starting point for #3951, or a partial solution. Providing a few comment blocks to discuss, and hopefully find better one in the process. ## Solution Since I am pretty new to pretty much anything in this context, I figured I'd just start with a draft for some file level doc blocks. For some of them I found more relevant details (or at least things I considered interessting), for some others there is less. ## Changelog - Moved some existing comments from main() functions in the 2d examples to the file header level - Wrote some more comment blocks for most other 2d examples TODO: - [x] 2d/sprite_sheet, wasnt able to come up with something good yet - [x] all other example groups... Also: Please let me know if the commit style is okay, or to verbose. I could certainly squash these things, or add more details if needed. I also hope its okay to raise this PR this early, with just a few files changed. Took me long enough and I dont wanted to let it go to waste because I lost motivation to do the whole thing. Additionally I am somewhat uncertain over the style and contents of the commets. So let me know what you thing please.
67 lines
1.6 KiB
Rust
67 lines
1.6 KiB
Rust
//! Implements loader for a custom asset type.
|
|
|
|
use bevy::{
|
|
asset::{AssetLoader, LoadContext, LoadedAsset},
|
|
prelude::*,
|
|
reflect::TypeUuid,
|
|
utils::BoxedFuture,
|
|
};
|
|
use serde::Deserialize;
|
|
|
|
#[derive(Debug, Deserialize, TypeUuid)]
|
|
#[uuid = "39cadc56-aa9c-4543-8640-a018b74b5052"]
|
|
pub struct CustomAsset {
|
|
pub value: i32,
|
|
}
|
|
|
|
#[derive(Default)]
|
|
pub struct CustomAssetLoader;
|
|
|
|
impl AssetLoader for CustomAssetLoader {
|
|
fn load<'a>(
|
|
&'a self,
|
|
bytes: &'a [u8],
|
|
load_context: &'a mut LoadContext,
|
|
) -> BoxedFuture<'a, Result<(), anyhow::Error>> {
|
|
Box::pin(async move {
|
|
let custom_asset = ron::de::from_bytes::<CustomAsset>(bytes)?;
|
|
load_context.set_default_asset(LoadedAsset::new(custom_asset));
|
|
Ok(())
|
|
})
|
|
}
|
|
|
|
fn extensions(&self) -> &[&str] {
|
|
&["custom"]
|
|
}
|
|
}
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
.init_resource::<State>()
|
|
.add_asset::<CustomAsset>()
|
|
.init_asset_loader::<CustomAssetLoader>()
|
|
.add_startup_system(setup)
|
|
.add_system(print_on_load)
|
|
.run();
|
|
}
|
|
|
|
#[derive(Default)]
|
|
struct State {
|
|
handle: Handle<CustomAsset>,
|
|
printed: bool,
|
|
}
|
|
|
|
fn setup(mut state: ResMut<State>, asset_server: Res<AssetServer>) {
|
|
state.handle = asset_server.load("data/asset.custom");
|
|
}
|
|
|
|
fn print_on_load(mut state: ResMut<State>, custom_assets: ResMut<Assets<CustomAsset>>) {
|
|
let custom_asset = custom_assets.get(&state.handle);
|
|
if state.printed || custom_asset.is_none() {
|
|
return;
|
|
}
|
|
|
|
info!("Custom asset loaded: {:?}", custom_asset.unwrap());
|
|
state.printed = true;
|
|
}
|