Skip to content

Commit

Permalink
docs: explain that sprite_bundle should not be used with tilemap edit…
Browse files Browse the repository at this point in the history
…or visuals (#142)

* docs: Fix spelling

* docs: Add recommendation for when to use sprite_sheet_bundle over sprite_bundle
  • Loading branch information
johanhelsing committed Nov 29, 2022
1 parent cafba57 commit 1a7a8a1
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/app/ldtk_entity.rs
Expand Up @@ -57,14 +57,15 @@ use crate::app::register_ldtk_objects::RegisterLdtkObjects;
///
/// By default, each component or nested bundle in the bundle will be created using their [Default]
/// implementations.
/// However, this behavior can be overriden with some field attribute macros...
/// However, this behavior can be overridden with some field attribute macros...
///
/// ### `#[sprite_bundle...]`
/// Indicates that a [SpriteBundle] field should be created with an actual material/image.
/// There are two forms for this attribute:
/// - `#[sprite_bundle("path/to/asset.png")]` will create the field using the image at the provided
/// path in the assets folder.
/// - `#[sprite_bundle]` will create the field using its Editor Visual image in LDtk, if it has one.
/// Note that if your editor visual is part of a tilemap, you should use `#[sprite_sheet_bundle]` instead.
/// ```
/// # use bevy::prelude::*;
/// # use bevy_ecs_ldtk::prelude::*;
Expand Down

0 comments on commit 1a7a8a1

Please sign in to comment.