bevy_ecs_ldtk 0.14.0

//! System functions used by the plugin for processing ldtk files.

#[cfg(feature = "render")]
use crate::resources::SetClearColor;
use crate::{
    app::{LdtkEntityMap, LdtkIntCellMap},
    assets::{LdtkProject, LdtkProjectData, LevelMetadataAccessor},
    components::*,
    ldtk::{Level, TilesetDefinition},
    level::spawn_level,
    resources::{LdtkSettings, LevelEvent, LevelSelection, LevelSpawnBehavior},
    utils::*,
};

#[cfg(feature = "external_levels")]
use crate::assets::LdtkExternalLevel;

use bevy::{ecs::system::SystemState, prelude::*};
use std::collections::{HashMap, HashSet};

/// Detects [LdtkProject] events and spawns levels as children of the [LdtkWorldBundle].
#[allow(clippy::too_many_arguments)]
pub fn process_ldtk_assets(
    mut commands: Commands,
    mut ldtk_project_events: MessageReader<AssetEvent<LdtkProject>>,
    ldtk_world_query: Query<(Entity, &LdtkProjectHandle)>,
    #[cfg(feature = "render")] ldtk_settings: Res<LdtkSettings>,
    #[cfg(feature = "render")] mut clear_color: ResMut<ClearColor>,
    #[cfg(feature = "render")] ldtk_project_assets: Res<Assets<LdtkProject>>,
) {
    let mut ldtk_handles_to_respawn = HashSet::new();
    let mut ldtk_handles_for_clear_color = HashSet::new();

    for event in ldtk_project_events.read() {
        match event {
            AssetEvent::LoadedWithDependencies { id } => {
                debug!("LDtk asset creation detected.");
                ldtk_handles_for_clear_color.insert(id);
            }
            AssetEvent::Modified { id } => {
                info!("LDtk asset modification detected.");
                ldtk_handles_to_respawn.insert(id);
                ldtk_handles_for_clear_color.insert(id);
            }
            AssetEvent::Removed { id } => {
                info!("LDtk asset removal detected.");
                // if mesh was modified and removed in the same update, ignore the modification
                // events are ordered so future modification events are ok
                ldtk_handles_to_respawn.retain(|changed_id| *changed_id != id);
            }
            _ => (),
        }
    }

    #[cfg(feature = "render")]
    if ldtk_settings.set_clear_color == SetClearColor::FromEditorBackground {
        for handle in ldtk_handles_for_clear_color.iter() {
            if let Some(project) = &ldtk_project_assets.get(**handle) {
                clear_color.0 = project.json_data().bg_color;
            }
        }
    }

    for (entity, handle) in ldtk_world_query.iter() {
        if ldtk_handles_to_respawn.contains(&handle.id()) {
            commands.entity(entity).insert(Respawn);
        }
    }
}

/// Updates all LevelSet components according to the LevelSelection
pub fn apply_level_selection(
    level_selection: Option<Res<LevelSelection>>,
    ldtk_settings: Res<LdtkSettings>,
    ldtk_project_assets: Res<Assets<LdtkProject>>,
    mut level_set_query: Query<(&LdtkProjectHandle, &mut LevelSet)>,
    #[cfg(feature = "render")] mut clear_color: ResMut<ClearColor>,
) {
    let Some(level_selection) = level_selection else {
        return;
    };
    for (ldtk_handle, mut level_set) in level_set_query.iter_mut() {
        let Some(project) = &ldtk_project_assets.get(ldtk_handle) else {
            continue;
        };
        let Some(level) = project.find_raw_level_by_level_selection(&level_selection) else {
            continue;
        };
        let new_level_set = {
            let mut iids = HashSet::new();
            iids.insert(LevelIid::new(level.iid.clone()));

            if let LevelSpawnBehavior::UseWorldTranslation {
                load_level_neighbors,
            } = ldtk_settings.level_spawn_behavior
            {
                if load_level_neighbors {
                    iids.extend(
                        level
                            .neighbours
                            .iter()
                            .map(|n| LevelIid::new(n.level_iid.clone())),
                    );
                }
            }

            LevelSet { iids }
        };

        if *level_set != new_level_set {
            *level_set = new_level_set;

            #[cfg(feature = "render")]
            if ldtk_settings.set_clear_color == SetClearColor::FromLevelBackground {
                clear_color.0 = level.bg_color;
            }
        }
    }
}

/// Triggers the spawning/despawning of levels according to `LevelSet` values.
#[allow(clippy::too_many_arguments, clippy::type_complexity)]
pub fn apply_level_set(
    mut commands: Commands,
    ldtk_world_query: Query<(
        Entity,
        &LevelSet,
        Option<&Children>,
        &LdtkProjectHandle,
        Option<&Respawn>,
    )>,
    ldtk_level_query: Query<(&LevelIid, Entity)>,
    ldtk_project_assets: Res<Assets<LdtkProject>>,
    ldtk_settings: Res<LdtkSettings>,
    asset_server: Res<AssetServer>,
    mut level_events: MessageWriter<LevelEvent>,
) {
    for (world_entity, level_set, children, ldtk_asset_handle, respawn) in ldtk_world_query.iter() {
        // Only apply level set if the asset has finished loading
        let Some(project) = ldtk_project_assets.get(ldtk_asset_handle) else {
            continue;
        };
        if let Some(load_state) =
            asset_server.get_recursive_dependency_load_state(ldtk_asset_handle)
        {
            if !load_state.is_loaded() {
                continue;
            }
        }
        // Determine what levels are currently spawned
        let previous_level_maps = children
            .into_iter()
            .flat_map(|iterator| iterator.iter())
            .filter_map(|child_entity| ldtk_level_query.get(child_entity).ok())
            .map(|(level_iid, entity)| (level_iid.clone(), entity))
            .collect::<HashMap<_, _>>();

        let previous_iids: HashSet<&LevelIid> = previous_level_maps.keys().collect();

        let level_set_as_ref = level_set.iids.iter().collect::<HashSet<_>>();

        // Spawn levels that should be spawned but aren't
        let spawned_levels = level_set_as_ref
            .difference(&previous_iids)
            .filter_map(|&iid| project.get_raw_level_by_iid(iid.get()))
            .map(|level| {
                level_events.write(LevelEvent::SpawnTriggered(LevelIid::new(level.iid.clone())));
                pre_spawn_level(&mut commands, level, &ldtk_settings)
            })
            .collect::<Vec<_>>();

        commands.entity(world_entity).add_children(&spawned_levels);

        // Despawn levels that shouldn't be spawned but are
        for &iid in previous_iids.difference(&level_set_as_ref) {
            let map_entity = previous_level_maps.get(iid).expect(
                "The set of previous_iids and the keys in previous_level_maps should be the same.",
            );
            commands.entity(*map_entity).despawn();
            level_events.write(LevelEvent::Despawned(iid.clone()));
        }

        // If the world was empty before but has now been populated, and this world was
        // supposed to respawn, then this run of the system must have completed the "spawning"
        // portion of said respawn.
        // In that case, the respawn component needs to be removed so that the cleanup system
        // doesn't start the process over again.
        if previous_iids.is_empty() && !spawned_levels.is_empty() && respawn.is_some() {
            commands.entity(world_entity).remove::<Respawn>();
        }
    }
}

fn pre_spawn_level(commands: &mut Commands, level: &Level, ldtk_settings: &LdtkSettings) -> Entity {
    let mut translation = Vec3::ZERO;

    if let LevelSpawnBehavior::UseWorldTranslation { .. } = ldtk_settings.level_spawn_behavior {
        let level_coords = ldtk_pixel_coords_to_translation(
            IVec2::new(level.world_x, level.world_y + level.px_hei),
            0,
        );
        translation.x = level_coords.x;
        translation.y = level_coords.y;
    }

    commands
        .spawn((
            LevelIid::new(level.iid.clone()),
            Transform::from_translation(translation),
            Visibility::default(),
            Name::new(level.identifier.clone()),
            Respawn,
        ))
        .id()
}

/// Performs all the spawning of levels, layers, chunks, bundles, entities, tiles, etc. when a
/// LevelIid is added or respawned.
#[allow(clippy::too_many_arguments, clippy::type_complexity)]
pub fn process_ldtk_levels(
    mut commands: Commands,
    asset_server: Res<AssetServer>,
    images: ResMut<Assets<Image>>,
    mut texture_atlases: ResMut<Assets<TextureAtlasLayout>>,
    ldtk_project_assets: Res<Assets<LdtkProject>>,
    #[cfg(feature = "external_levels")] level_assets: Res<Assets<LdtkExternalLevel>>,
    ldtk_entity_map: NonSend<LdtkEntityMap>,
    ldtk_int_cell_map: NonSend<LdtkIntCellMap>,
    ldtk_query: Query<&LdtkProjectHandle>,
    level_query: Query<(Entity, &LevelIid, &ChildOf), With<Respawn>>,
    worldly_query: Query<&Worldly>,
    mut level_events: MessageWriter<LevelEvent>,
    ldtk_settings: Res<LdtkSettings>,
) {
    let mut worldly_set = None;
    for (ldtk_entity, level_iid, child_of) in level_query.iter() {
        // Ensure the project is loaded.
        let Ok(ldtk_handle) = ldtk_query.get(child_of.parent()) else {
            continue;
        };
        let Some(ldtk_project) = ldtk_project_assets.get(ldtk_handle) else {
            continue;
        };

        // Commence the spawning
        let tileset_definition_map: HashMap<i32, &TilesetDefinition> = ldtk_project
            .json_data()
            .defs
            .tilesets
            .iter()
            .map(|t| (t.uid, t))
            .collect();

        let entity_definition_map =
            create_entity_definition_map(&ldtk_project.json_data().defs.entities);

        let layer_definition_map =
            create_layer_definition_map(&ldtk_project.json_data().defs.layers);

        let int_grid_image_handle = &ldtk_project.int_grid_image_handle();

        let maybe_level_data =
            match ldtk_project.data() {
                #[cfg(feature = "internal_levels")]
                LdtkProjectData::Standalone(project) => project
                    .level_map()
                    .get(level_iid.get())
                    .and_then(|level_metadata| {
                        let loaded_level =
                            project.get_loaded_level_at_indices(level_metadata.indices())?;

                        Some((level_metadata, loaded_level))
                    }),
                #[cfg(feature = "external_levels")]
                LdtkProjectData::Parent(project) => project
                    .level_map()
                    .get(level_iid.get())
                    .and_then(|level_metadata| {
                        let loaded_level = project.get_external_level_at_indices(
                            &level_assets,
                            level_metadata.metadata().indices(),
                        )?;

                        Some((level_metadata.metadata(), loaded_level))
                    }),
            };

        if let Some((level_metadata, loaded_level)) = maybe_level_data {
            let worldly_set =
                worldly_set.get_or_insert_with(|| worldly_query.iter().cloned().collect());
            spawn_level(
                loaded_level,
                level_metadata.bg_image(),
                &mut commands,
                &asset_server,
                &images,
                &mut texture_atlases,
                &ldtk_entity_map,
                &ldtk_int_cell_map,
                &entity_definition_map,
                &layer_definition_map,
                ldtk_project.tileset_map(),
                &tileset_definition_map,
                int_grid_image_handle,
                worldly_set,
                ldtk_entity,
                &ldtk_settings,
            );
            level_events.write(LevelEvent::Spawned(LevelIid::new(
                loaded_level.iid().clone(),
            )));
        }

        commands.entity(ldtk_entity).remove::<Respawn>();
    }
}

/// Performs the "despawning" portion of the respawn process for `Respawn` entities.
///
/// This is currently an exclusive system for scheduling purposes.
/// If we need to revert it to its non-exclusive form, copy it from commit
/// 90155a75acb6dea4c97bb92a724b741e693b100d
pub fn clean_respawn_entities(world: &mut World) {
    #[allow(clippy::type_complexity)]
    let mut system_state: SystemState<(
        Query<&Children, (With<LdtkProjectHandle>, With<Respawn>)>,
        Query<(Entity, &LevelIid), With<Respawn>>,
        Query<&LevelIid, Without<Respawn>>,
        Query<Entity, With<Worldly>>,
        MessageWriter<LevelEvent>,
    )> = SystemState::new(world);

    let mut entities_to_despawn_recursively = Vec::new();
    let mut entities_to_despawn_descendants = Vec::new();

    {
        let (
            ldtk_worlds_to_clean,
            ldtk_levels_to_clean,
            other_ldtk_levels,
            worldly_entities,
            mut level_events,
        ) = system_state.get_mut(world);

        for world_children in ldtk_worlds_to_clean.iter() {
            for child in world_children
                .iter()
                .filter(|l| other_ldtk_levels.contains(*l) || worldly_entities.contains(*l))
            {
                entities_to_despawn_recursively.push(child);

                if let Ok(level_iid) = other_ldtk_levels.get(child) {
                    level_events.write(LevelEvent::Despawned(level_iid.clone()));
                }
            }
        }

        for (level_entity, level_iid) in ldtk_levels_to_clean.iter() {
            entities_to_despawn_descendants.push(level_entity);

            level_events.write(LevelEvent::Despawned(level_iid.clone()));
        }
    }

    for entity in entities_to_despawn_recursively {
        world.entity_mut(entity).despawn();
    }

    for entity in entities_to_despawn_descendants {
        world.entity_mut(entity).despawn_related::<Children>();
    }
}

/// Implements the functionality for `Worldly` components.
pub fn worldly_adoption(
    mut commands: Commands,
    ancestors: Query<&ChildOf>,
    worldly_query: Query<Entity, Added<Worldly>>,
) {
    for worldly_entity in worldly_query.iter() {
        // world entity for this worldly entity is its third ancestor...
        // - first ancestor is the layer entity
        // - second ancestor is the level entity
        // - third ancestor is the world entity
        if let Some(world_entity) = ancestors.iter_ancestors(worldly_entity).nth(2) {
            commands
                .entity(worldly_entity)
                .set_parent_in_place(world_entity);
        } else {
            commands.entity(worldly_entity).remove_parent_in_place();
        }
    }
}

/// Returns the `iid`s of levels that have spawned in this update.
///
/// Mean to be used in a chain with [fire_level_transformed_events].
pub fn detect_level_spawned_events(mut reader: MessageReader<LevelEvent>) -> Vec<LevelIid> {
    let mut spawned_ids = Vec::new();
    for event in reader.read() {
        if let LevelEvent::Spawned(id) = event {
            spawned_ids.push(id.clone());
        }
    }
    spawned_ids
}

/// Fires [LevelEvent::Transformed] events for all the entities that spawned in the previous
/// update.
///
/// Meant to be used in a chain with [detect_level_spawned_events].
pub fn fire_level_transformed_events(
    In(spawned_ids): In<Vec<LevelIid>>,
    mut writer: MessageWriter<LevelEvent>,
) {
    for id in spawned_ids {
        writer.write(LevelEvent::Transformed(id));
    }
}