Struct bevy_ecs_ldtk::assets::LdtkProject

pub struct LdtkProject { /* private fields */ }

Main asset for loading LDtk project data.

Accessing level data

This type provides many methods for accessing level data. The correct method for you will vary depending on whether or not you need “complete” level data, and if so, whether or not your project uses internal levels or external levels.

Raw vs loaded levels

There are a couple main flavors that level data can have - raw and loaded.

Raw levels don’t have any type guarantee that the level data is complete or incomplete. Level data may be incomplete and contain no layer instances if external levels are enabled. However, even in this case, a raw level is sufficient if you don’t need any layer data. Raw levels are represented by the Level type from LDtk. See RawLevelAccessor and LevelMetadataAccessor for some methods that access raw levels.

On the other hand, loaded levels are type-guaranteed to have complete level data. Loaded levels are represented by the LoadedLevel type. Methods for accessing loaded levels vary depending on if the levels are internal or external.

Accessing internal and external loaded levels

By default, LDtk stores level data inside the main project file. You have the option to store level data externally, where each level gets its own file. In this case, some of the level data remains available in the project file, but not layer data. See the previous section for more details.

Level data stored so differently on disk results in a similar difference when loaded in memory. In the external case, an entirely different asset type LdtkExternalLevel comes into play. So, methods for accessing loaded levels vary between the two cases.

If you know that your project uses internal levels, you can coerce it as a “standalone project”. To do this, use LdtkProject::as_standalone. With that, you can use these loaded_level accessors.

If you know that your project uses external levels, you can coerce it as a “parent project”. To do this, use LdtkProject::as_parent. You will also need the LdtkExternalLevel asset collection. With these, you can use these external_level accessors.

Implementations

impl LdtkProject

Auto-generated by derive_getters::Getters.

pub fn data(&self) -> &LdtkProjectData

LDtk json data and level metadata.

pub fn tileset_map(&self) -> &HashMap<i32, Handle<Image>>

Map from tileset uids to image handles for the loaded tileset.

pub fn int_grid_image_handle(&self) -> &Option<Handle<Image>>

Image used for rendering int grid colors.

impl LdtkProject

pub fn json_data(&self) -> &LdtkJson

Raw ldtk json data.

pub fn as_standalone(&self) -> &LdtkJsonWithMetadata<InternalLevels>

Unwrap as a LdtkJsonWithMetadata<InternalLevels>. For use on internal-levels ldtk projects only.

Panics

Panics if self.data() is not LdtkProjectData::Standalone. This shouldn’t occur if the project uses internal levels.

pub fn as_parent(&self) -> &LdtkJsonWithMetadata<ExternalLevels>

Unwrap as a LdtkJsonWithMetadata<ExternalLevels>. For use on external-levels ldtk projects only.

Panics

Panics if self.data() is not LdtkProjectData::Parent. This shouldn’t occur if the project uses external levels.

Trait Implementations

impl Clone for LdtkProject

fn clone(&self) -> LdtkProject

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LdtkProject

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<(LdtkProjectData, HashMap<i32, Handle<Image>>, Option<Handle<Image>>)> for LdtkProject

fn from( original: (LdtkProjectData, HashMap<i32, Handle<Image>>, Option<Handle<Image>>), ) -> LdtkProject

Converts to this type from the input type.

impl FromReflect for LdtkProject

where Self: Any + Send + Sync, LdtkProjectData: FromReflect + TypePath + RegisterForReflection, HashMap<i32, Handle<Image>>: FromReflect + TypePath + RegisterForReflection, Option<Handle<Image>>: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn Reflect>, ) -> Result<Self, Box<dyn Reflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for LdtkProject

where Self: Any + Send + Sync, LdtkProjectData: FromReflect + TypePath + RegisterForReflection, HashMap<i32, Handle<Image>>: FromReflect + TypePath + RegisterForReflection, Option<Handle<Image>>: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl LevelMetadataAccessor for LdtkProject

fn get_level_metadata_by_iid(&self, iid: &String) -> Option<&LevelMetadata>

Returns a reference to the level metadata corresponding to the given level iid.

fn get_raw_level_by_iid(&self, iid: &String) -> Option<&Level>

Immutable access to a level at the given level iid.

fn find_raw_level_by_level_selection( &self, level_selection: &LevelSelection, ) -> Option<&Level>

Find the level matching the given LevelSelection.

impl PartialEq for LdtkProject

fn eq(&self, other: &LdtkProject) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RawLevelAccessor for LdtkProject

fn worlds(&self) -> &[World]

Slice to this project’s collection of Worlds.

fn root_levels(&self) -> &[Level]

Slice to this project’s collection of root levels.

fn iter_root_levels(&self) -> IterRootLevels<'_>

Iterate through this project’s root levels.

fn iter_world_levels(&self) -> IterWorldLevels<'_>

Iterate through this project’s world levels.

fn iter_raw_levels(&self) -> IterLevels<'_>

Iterate through this project’s levels.

fn iter_root_levels_with_indices(&self) -> IterRootLevelsWithIndices<'_>

Iterate through this project’s root levels enumerated with their LevelIndices.

fn iter_world_levels_with_indices(&self) -> IterWorldLevelsWithIndices<'_>

Iterate through this project’s world levels enumerated with their LevelIndices.

fn iter_raw_levels_with_indices(&self) -> IterLevelsWithIndices<'_>

Iterate through this project’s levels enumerated with their LevelIndices.

fn get_raw_level_at_indices(&self, indices: &LevelIndices) -> Option<&Level>

Immutable access to a level at the given LevelIndices.

impl Reflect for LdtkProject

where Self: Any + Send + Sync, LdtkProjectData: FromReflect + TypePath + RegisterForReflection, HashMap<i32, Handle<Image>>: FromReflect + TypePath + RegisterForReflection, Option<Handle<Image>>: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for LdtkProject

where Self: Any + Send + Sync, LdtkProjectData: FromReflect + TypePath + RegisterForReflection, HashMap<i32, Handle<Image>>: FromReflect + TypePath + RegisterForReflection, Option<Handle<Image>>: FromReflect + TypePath + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for LdtkProject

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for LdtkProject

where Self: Any + Send + Sync, LdtkProjectData: FromReflect + TypePath + RegisterForReflection, HashMap<i32, Handle<Image>>: FromReflect + TypePath + RegisterForReflection, Option<Handle<Image>>: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl VisitAssetDependencies for LdtkProject

fn visit_dependencies(&self, visit: &mut impl FnMut(UntypedAssetId))

impl Asset for LdtkProject

impl StructuralPartialEq for LdtkProject