Struct EntityInstance

pub struct EntityInstance {

    pub grid: IVec2,
    pub identifier: String,
    pub pivot: Vec2,
    pub smart_color: Color,
    pub tags: Vec<String>,
    pub tile: Option<TilesetRectangle>,
    pub world_x: Option<i32>,
    pub world_y: Option<i32>,
    pub def_uid: i32,
    pub field_instances: Vec<FieldInstance>,
    pub height: i32,
    pub iid: String,
    pub px: IVec2,
    pub width: i32,
}

Component added to any LDtk Entity by default.

When loading levels, you can flesh out LDtk entities in your own system by querying for Added<EntityInstance>. Or, you can hook into the entity’s spawning process using LdtkEntity.

Fields

grid: IVec2

Grid-based coordinates ([x,y] format)

identifier: String

Entity definition identifier

pivot: Vec2

Pivot coordinates ([x,y] format, values are from 0 to 1) of the Entity

smart_color: Color

The entity “smart” color, guessed from either Entity definition, or one its field instances.

tags: Vec<String>

Array of tags defined in this Entity definition

tile: Option<TilesetRectangle>

Optional TilesetRect used to display this entity (it could either be the default Entity tile, or some tile provided by a field value, like an Enum).

world_x: Option<i32>

X world coordinate in pixels. Only available in GridVania or Free world layouts.

world_y: Option<i32>

Y world coordinate in pixels Only available in GridVania or Free world layouts.

def_uid: i32

Reference of the Entity definition UID

field_instances: Vec<FieldInstance>

An array of all custom fields and their values.

height: i32

Entity height in pixels. For non-resizable entities, it will be the same as Entity definition.

iid: String

Unique instance identifier

px: IVec2

Pixel coordinates ([x,y] format) in current level coordinate space. Don’t forget optional layer offsets, if they exist!

width: i32

Entity width in pixels. For non-resizable entities, it will be the same as Entity definition.

Trait Implementations

impl Clone for EntityInstance

fn clone(&self) -> EntityInstance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for EntityInstance

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_required_components( requiree: ComponentId, components: &mut Components, storages: &mut Storages, required_components: &mut RequiredComponents, inheritance_depth: u16, )

Registers required components.

fn register_component_hooks(hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Debug for EntityInstance

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

Formats the value using the given formatter.

impl Default for EntityInstance

fn default() -> EntityInstance

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EntityInstance

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&EntityInstance> for EntityInstance

fn from(value: &EntityInstance) -> Self

Converts to this type from the input type.

impl FromReflect for EntityInstance

where EntityInstance: Any + Send + Sync, IVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Color: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<TilesetRectangle>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<i32>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, i32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<FieldInstance>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for EntityInstance

where EntityInstance: Any + Send + Sync, IVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Color: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<TilesetRectangle>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<i32>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, i32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<FieldInstance>: FromReflect + TypePath + MaybeTyped + 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 LdtkFields for EntityInstance

fn field_instances(&self) -> &[FieldInstance]

Immutable accessor for this item’s field instances, by reference.

fn get_field_instance( &self, identifier: &str, ) -> Result<&FieldInstance, LdtkFieldsError>

Get this item’s field instance (with metadata) for the given identifier.

fn get_field(&self, identifier: &str) -> Result<&FieldValue, LdtkFieldsError>

Get this item’s field value for the given identifier.

fn get_maybe_int_field( &self, identifier: &str, ) -> Result<&Option<i32>, LdtkFieldsError>

Get this item’s nullable Int field value for the given identifier.

fn get_int_field(&self, identifier: &str) -> Result<&i32, LdtkFieldsError>

Get this item’s non-null Int field value for the given identifier.

fn get_maybe_float_field( &self, identifier: &str, ) -> Result<&Option<f32>, LdtkFieldsError>

Get this item’s nullable Float field value for the given identifier.

fn get_float_field(&self, identifier: &str) -> Result<&f32, LdtkFieldsError>

Get this item’s non-null Float field value for the given identifier.

fn get_bool_field(&self, identifier: &str) -> Result<&bool, LdtkFieldsError>

Get this item’s Bool field value for the given identifier.

fn get_maybe_string_field( &self, identifier: &str, ) -> Result<&Option<String>, LdtkFieldsError>

Get this item’s nullable String field value for the given identifier.

fn get_string_field(&self, identifier: &str) -> Result<&String, LdtkFieldsError>

Get this item’s non-null String field value for the given identifier.

fn get_color_field(&self, identifier: &str) -> Result<&Color, LdtkFieldsError>

Get this item’s Color field value for the given identifier.

fn get_maybe_file_path_field( &self, identifier: &str, ) -> Result<&Option<String>, LdtkFieldsError>

Get this item’s nullable FilePath field value for the given identifier.

fn get_file_path_field( &self, identifier: &str, ) -> Result<&String, LdtkFieldsError>

Get this item’s non-null FilePath field value for the given identifier.

fn get_maybe_enum_field( &self, identifier: &str, ) -> Result<&Option<String>, LdtkFieldsError>

Get this item’s nullable Enum field value for the given identifier.

fn get_enum_field(&self, identifier: &str) -> Result<&String, LdtkFieldsError>

Get this item’s non-null Enum field value for the given identifier.

fn get_maybe_tile_field( &self, identifier: &str, ) -> Result<&Option<TilesetRectangle>, LdtkFieldsError>

Get this item’s nullable Tile field value for the given identifier.

fn get_tile_field( &self, identifier: &str, ) -> Result<&TilesetRectangle, LdtkFieldsError>

Get this item’s non-null Tile field value for the given identifier.

fn get_maybe_entity_ref_field( &self, identifier: &str, ) -> Result<&Option<ReferenceToAnEntityInstance>, LdtkFieldsError>

Get this item’s nullable EntityRef field value for the given identifier.

fn get_entity_ref_field( &self, identifier: &str, ) -> Result<&ReferenceToAnEntityInstance, LdtkFieldsError>

Get this item’s non-null EntityRef field value for the given identifier.

fn get_maybe_point_field( &self, identifier: &str, ) -> Result<&Option<IVec2>, LdtkFieldsError>

Get this item’s nullable Point field value for the given identifier.

fn get_point_field(&self, identifier: &str) -> Result<&IVec2, LdtkFieldsError>

Get this item’s non-null Point field value for the given identifier.

fn get_maybe_ints_field( &self, identifier: &str, ) -> Result<&[Option<i32>], LdtkFieldsError>

Get this item’s nullable Ints field value for the given identifier.

fn iter_ints_field( &self, identifier: &str, ) -> Result<AllSomeIter<'_, i32>, LdtkFieldsError>

Iterate over this item’s non-null Ints field value for the given identifier.

fn get_maybe_floats_field( &self, identifier: &str, ) -> Result<&[Option<f32>], LdtkFieldsError>

Get this item’s nullable Floats field value for the given identifier.

fn iter_floats_field( &self, identifier: &str, ) -> Result<AllSomeIter<'_, f32>, LdtkFieldsError>

Iterate over this item’s non-null Floats field value for the given identifier.

fn get_bools_field(&self, identifier: &str) -> Result<&[bool], LdtkFieldsError>

Get this item’s Bools field value for the given identifier.

fn get_maybe_strings_field( &self, identifier: &str, ) -> Result<&[Option<String>], LdtkFieldsError>

Get this item’s nullable Strings field value for the given identifier.

fn iter_strings_field( &self, identifier: &str, ) -> Result<AllSomeIter<'_, String>, LdtkFieldsError>

Iterate over this item’s non-null Strings field value for the given identifier.

fn get_colors_field( &self, identifier: &str, ) -> Result<&[Color], LdtkFieldsError>

Get this item’s Colors field value for the given identifier.

fn get_maybe_file_paths_field( &self, identifier: &str, ) -> Result<&[Option<String>], LdtkFieldsError>

Get this item’s nullable FilePaths field value for the given identifier.

fn iter_file_paths_field( &self, identifier: &str, ) -> Result<AllSomeIter<'_, String>, LdtkFieldsError>

Iterate over this item’s non-null FilePaths field value for the given identifier.

fn get_maybe_enums_field( &self, identifier: &str, ) -> Result<&[Option<String>], LdtkFieldsError>

Get this item’s nullable Enums field value for the given identifier.

fn iter_enums_field( &self, identifier: &str, ) -> Result<AllSomeIter<'_, String>, LdtkFieldsError>

Iterate over this item’s non-null Enums field value for the given identifier.

fn get_maybe_tiles_field( &self, identifier: &str, ) -> Result<&[Option<TilesetRectangle>], LdtkFieldsError>

Get this item’s nullable Tiles field value for the given identifier.

fn iter_tiles_field( &self, identifier: &str, ) -> Result<AllSomeIter<'_, TilesetRectangle>, LdtkFieldsError>

Iterate over this item’s non-null Tiles field value for the given identifier.

fn get_maybe_entity_refs_field( &self, identifier: &str, ) -> Result<&[Option<ReferenceToAnEntityInstance>], LdtkFieldsError>

Get this item’s nullable EntityRefs field value for the given identifier.

fn iter_entity_refs_field( &self, identifier: &str, ) -> Result<AllSomeIter<'_, ReferenceToAnEntityInstance>, LdtkFieldsError>

Iterate over this item’s non-null EntityRefs field value for the given identifier.

fn get_maybe_points_field( &self, identifier: &str, ) -> Result<&[Option<IVec2>], LdtkFieldsError>

Get this item’s nullable Points field value for the given identifier.

fn iter_points_field( &self, identifier: &str, ) -> Result<AllSomeIter<'_, IVec2>, LdtkFieldsError>

Iterate over this item’s non-null Points field value for the given identifier.

impl PartialEq for EntityInstance

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialReflect for EntityInstance

where EntityInstance: Any + Send + Sync, IVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Color: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<TilesetRectangle>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<i32>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, i32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<FieldInstance>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

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

Clones the value as a Reflect trait object.

fn try_apply(&mut self, value: &dyn PartialReflect) -> 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 try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

fn apply(&mut self, value: &(dyn PartialReflect + '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 Reflect for EntityInstance

where EntityInstance: Any + Send + Sync, IVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Color: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<TilesetRectangle>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<i32>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, i32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<FieldInstance>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

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

Casts this type to a mutable, fully-reflected value.

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

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

impl Serialize for EntityInstance

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for EntityInstance

where EntityInstance: Any + Send + Sync, IVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Color: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<TilesetRectangle>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<i32>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, i32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<FieldInstance>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

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

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

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

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

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

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

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

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.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for EntityInstance

where EntityInstance: 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 EntityInstance

where EntityInstance: Any + Send + Sync, IVec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, String: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec2: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Color: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<String>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<TilesetRectangle>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Option<i32>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, i32: FromReflect + TypePath + MaybeTyped + RegisterForReflection, Vec<FieldInstance>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl StructuralPartialEq for EntityInstance