animation.cpp

Go to the documentation of this file.

/*
   Copyright (C) 2006 - 2018 by Jeremy Rosen <jeremy.rosen@enst-bretagne.fr>
   Part of the Battle for Wesnoth Project https://www.wesnoth.org/

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY.

   See the COPYING file for more details.
*/

#include "units/animation.hpp"

#include "display.hpp"
#include "filter_context.hpp"
#include "map/map.hpp"
#include "play_controller.hpp"
#include "resources.hpp"
#include "color.hpp"
#include "units/unit.hpp"
#include "units/animation_component.hpp"
#include "units/filter.hpp"
#include "variable.hpp"
#include "random.hpp"

#include <algorithm>

static std::string get_heal_sound(const config& cfg)
{
    return cfg["healed_sound"].empty() ? "heal.wav" : cfg["healed_sound"].str();
}

struct animation_branch
{
    animation_branch()
        : attributes()
        , children()
    {}

    config merge() const
    {
        config result = attributes;
        for(const config::const_all_children_iterator& i : children) {
            result.add_child(i->key, i->cfg);
        }

        return result;
    }

    config attributes;
    std::vector<config::const_all_children_iterator> children;
};

typedef std::list<animation_branch> animation_branches;

struct animation_cursor
{
    animation_cursor(const config& cfg)
        : itors(cfg.all_children_range()), branches(1), parent(nullptr)
    {
        branches.back().attributes.merge_attributes(cfg);
    }

    animation_cursor(const config&cfg, animation_cursor *p)
        : itors(cfg.all_children_range()), branches(p->branches), parent(p)
    {
        // If similar 'if' condition in parent branches, we need to
        // cull the branches where there are partial matches.
        // Hence the need to check if the condition has come up before.
        // Also, the attributes are merged here between branches.
        bool previously_hits_set      = false;
        bool previously_direction_set = false;
        bool previously_terrain_set   = false;
        bool previously_value_set     = false;
        bool previously_value_2nd_set = false;

        const std::string s_cfg_hits      = cfg["hits"];
        const std::string s_cfg_direction = cfg["direction"];
        const std::string s_cfg_terrain   = cfg["terrain_types"];
        const std::string s_cfg_value     = cfg["value"];
        const std::string s_cfg_value_2nd = cfg["value_2nd"];

        for(const auto& branch : branches) {
            const std::string s_branch_hits      = branch.attributes["hits"];
            const std::string s_branch_direction = branch.attributes["direction"];
            const std::string s_branch_terrain   = branch.attributes["terrain_types"];
            const std::string s_branch_value     = branch.attributes["value"];
            const std::string s_branch_value_2nd = branch.attributes["value_second"];

            if(!s_branch_hits.empty() && s_branch_hits == s_cfg_hits) {
                previously_hits_set = true;
            }

            if(!s_branch_direction.empty() && s_branch_direction == s_cfg_direction) {
                previously_direction_set = true;
            }

            if(!s_branch_terrain.empty() && s_branch_terrain == s_cfg_terrain) {
                previously_terrain_set = true;
            }

            if(!s_branch_value.empty() && s_branch_value == s_cfg_value) {
                previously_value_set = true;
            }

            if(!s_branch_value_2nd.empty() && s_branch_value_2nd == s_cfg_value_2nd) {
                previously_value_2nd_set = true;
            }
        }

        // Merge all frames that have new matches and prune any impossible
        // matches, e.g. hits='yes' and hits='no'
        for(auto iter = branches.begin(); iter != branches.end(); /* nothing */) {
            const std::string s_branch_hits      = (*iter).attributes["hits"];
            const std::string s_branch_direction = (*iter).attributes["direction"];
            const std::string s_branch_terrain   = (*iter).attributes["terrain_types"];
            const std::string s_branch_value     = (*iter).attributes["value"];
            const std::string s_branch_value_2nd = (*iter).attributes["value_second"];

            const bool hits_match      = (previously_hits_set && s_branch_hits != s_cfg_hits);
            const bool direction_match = (previously_direction_set && s_branch_direction != s_cfg_direction);
            const bool terrain_match   = (previously_terrain_set && s_branch_terrain != s_cfg_terrain);
            const bool value_match     = (previously_value_set && s_branch_value != s_cfg_value);
            const bool value_2nd_match = (previously_value_2nd_set && s_branch_value_2nd != s_cfg_value_2nd);

            if((!previously_hits_set      || hits_match) &&
               (!previously_direction_set || direction_match) &&
               (!previously_terrain_set   || terrain_match) &&
               (!previously_value_set     || value_match)  &&
               (!previously_value_2nd_set || value_2nd_match) &&
                (hits_match || direction_match || terrain_match || value_match || value_2nd_match))
            {
                branches.erase(iter++);
            } else {
                (*iter).attributes.merge_attributes(cfg);
                ++iter;
            }
        }

        // Then we prune all parent branches with similar matches as they
        // now will not have the full frame list
        for(auto iter = parent->branches.begin(); iter != parent->branches.end(); /* nothing */) {
            const std::string s_branch_hits      = (*iter).attributes["hits"];
            const std::string s_branch_direction = (*iter).attributes["direction"];
            const std::string s_branch_terrain   = (*iter).attributes["terrain_types"];
            const std::string s_branch_value     = (*iter).attributes["value"];
            const std::string s_branch_value_2nd = (*iter).attributes["value_second"];

            const bool hits_match      = (previously_hits_set && s_branch_hits == s_cfg_hits);
            const bool direction_match = (previously_direction_set && s_branch_direction == s_cfg_direction);
            const bool terrain_match   = (previously_terrain_set && s_branch_terrain == s_cfg_terrain);
            const bool value_match     = (previously_value_set && s_branch_value == s_cfg_value);
            const bool value_2nd_match = (previously_value_2nd_set && s_branch_value_2nd == s_cfg_value_2nd);

            if((!previously_hits_set        || hits_match) &&
                 (!previously_direction_set || direction_match) &&
                 (!previously_terrain_set   || terrain_match) &&
                 (!previously_value_set     || value_match) &&
                 (!previously_value_2nd_set || value_2nd_match) &&
                 (hits_match || direction_match || terrain_match || value_match || value_2nd_match))
            {
                parent->branches.erase(iter++);
            } else {
                ++iter;
            }
        }
    }

    config::const_all_children_itors itors;

    animation_branches branches;
    animation_cursor* parent;
};

static void prepare_single_animation(const config& anim_cfg, animation_branches& expanded_anims)
{
    /* The anim_cursor holds the current parsing through the config and the branches hold the data
     * that will be interpreted as the actual animation. The branches store the config attributes
     * for each block and the children of those branches make up all the 'frame', 'missile_frame',
     * etc. individually (so 2 instances of 'frame' would be stored as 2 children).
     */
    std::list<animation_cursor> anim_cursors;
    anim_cursors.emplace_back(anim_cfg);

    while(!anim_cursors.empty()) {
        animation_cursor& ac = anim_cursors.back();

        // Reached end of sub-tag config block
        if(ac.itors.empty()) {
            if(!ac.parent) break;

            // Merge all the current branches into the parent.
            ac.parent->branches.splice(ac.parent->branches.end(), ac.branches);
            anim_cursors.pop_back();
            continue;
        }

        if(ac.itors.front().key != "if") {
            // Append current config object to all the branches in scope.
            for(animation_branch &ab : ac.branches) {
                ab.children.push_back(ac.itors.begin());
            }

            ac.itors.pop_front();
            continue;
        }

        int count = 0;
        do {
            // Copies the current branches to each cursor created for the conditional clauses.
            // Merge attributes of the clause into them.
            anim_cursors.emplace_back(ac.itors.front().cfg, &ac);
            ac.itors.pop_front();
            ++count;
        } while (!ac.itors.empty() && ac.itors.front().key == "else");

        if(count > 1) {
            // When else statements present, clear all branches before 'if'
            ac.branches.clear();
        }
    }

#if 0
    // Debug aid
    for(animation_branch& ab : anim_cursors.back().branches) {
        std::cout << "--branch--\n" << ab.attributes;
        for(config::all_children_iterator &ci : ab.children) {
            std::cout << "--branchcfg--\n" << ci->cfg;
        }
        std::cout << "\n";
    }
#endif

    // Create the config object describing each branch.
    assert(anim_cursors.size() == 1);
    animation_cursor& ac = anim_cursors.back();
    expanded_anims.splice(expanded_anims.end(), ac.branches, ac.branches.begin(), ac.branches.end());
}

static animation_branches prepare_animation(const config& cfg, const std::string& animation_tag)
{
    animation_branches expanded_animations;
    for(const config &anim : cfg.child_range(animation_tag)) {
        prepare_single_animation(anim, expanded_animations);
    }

    return expanded_animations;
}

unit_animation::unit_animation(int start_time,
        const unit_frame& frame, const std::string& event, const int variation, const frame_builder& builder)
    : terrain_types_()
    , unit_filter_()
    , secondary_unit_filter_()
    , directions_()
    , frequency_(0)
    , base_score_(variation)
    , event_(utils::split(event))
    , value_()
    , primary_attack_filter_()
    , secondary_attack_filter_()
    , hits_()
    , value2_()
    , sub_anims_()
    , unit_anim_(start_time,builder)
    , src_()
    , dst_()
    , play_offscreen_(true)
{
    add_frame(frame.duration(),frame,!frame.does_not_change());
}

unit_animation::unit_animation(const config& cfg,const std::string& frame_string )
    : terrain_types_(t_translation::read_list(cfg["terrain_type"].str()))
    , unit_filter_()
    , secondary_unit_filter_()
    , directions_()
    , frequency_(cfg["frequency"])
    , base_score_(cfg["base_score"])
    , event_()
    , value_()
    , primary_attack_filter_()
    , secondary_attack_filter_()
    , hits_()
    , value2_()
    , sub_anims_()
    , unit_anim_(cfg,frame_string)
    , src_()
    , dst_()
    , play_offscreen_(true)
{
    //if(!cfg["debug"].empty()) printf("DEBUG WML: FINAL\n%s\n\n",cfg.debug().c_str());

    for(const config::any_child& fr : cfg.all_children_range()) {
        if(fr.key == frame_string) {
            continue;
        }

        if(fr.key.find("_frame", fr.key.size() - 6) == std::string::npos) {
            continue;
        }

        if(sub_anims_.find(fr.key) != sub_anims_.end()) {
            continue;
        }

        sub_anims_[fr.key] = particle(cfg, fr.key.substr(0, fr.key.size() - 5));
    }

    event_ = utils::split(cfg["apply_to"]);

    const std::vector<std::string>& my_directions = utils::split(cfg["direction"]);
    for(const auto& direction :  my_directions) {
        const map_location::DIRECTION d = map_location::parse_direction(direction);
        directions_.push_back(d);
    }

    /*const filter_context* fc = game_display::get_singleton();
    if(!fc) {
        // This is a pointer to the gamestate. Would prefer to tie unit animations only to the display, but for now this
        // is an acceptable fallback. It seems to be relevant because when a second game is created, it seems that the
        // game_display is null at the time that units are being constructed, and hence at the time that this code is running.
        // A different solution might be to delay the team_builder stage 2 call until after the gui is initialized. Note that
        // the current set up could conceivably cause problems with the editor, iirc it doesn't initialize a filter context.
        fc = resources::filter_con;
        assert(fc);
    }*/

    for(const config& filter : cfg.child_range("filter")) {
        unit_filter_.push_back(filter);
    }

    for(const config& filter : cfg.child_range("filter_second")) {
        secondary_unit_filter_.push_back(filter);
    }

    for(const auto& v : utils::split(cfg["value"])) {
        value_.push_back(atoi(v.c_str()));
    }

    for(const auto& h : utils::split(cfg["hits"])) {
        if(h == "yes" || h == "hit") {
            hits_.push_back(hit_type::HIT);
        }

        if(h == "no" || h == "miss") {
            hits_.push_back(hit_type::MISS);
        }

        if(h == "yes" || h == "kill" ) {
            hits_.push_back(hit_type::KILL);
        }
    }

    for(const auto& v2 : utils::split(cfg["value_second"])) {
        value2_.push_back(atoi(v2.c_str()));
    }

    for(const config& filter : cfg.child_range("filter_attack")) {
        primary_attack_filter_.push_back(filter);
    }

    for(const config& filter : cfg.child_range("filter_second_attack")) {
        secondary_attack_filter_.push_back(filter);
    }

    play_offscreen_ = cfg["offscreen"].to_bool(true);
}

int unit_animation::matches(const display& disp, const map_location& loc, const map_location& second_loc,
        const unit* my_unit, const std::string& event, const int value, hit_type hit, const_attack_ptr attack,
        const_attack_ptr second_attack, int value2) const
{
    int result = base_score_;

    if(!event.empty() && !event_.empty()) {
        if(std::find(event_.begin(), event_.end(), event) == event_.end()) {
            return MATCH_FAIL;
        }

        result++;
    }

    if(!terrain_types_.empty()) {
        if(!t_translation::terrain_matches(disp.get_map().get_terrain(loc), terrain_types_)) {
            return MATCH_FAIL;
        }

        result++;
    }

    if(!value_.empty()) {
        if(std::find(value_.begin(), value_.end(), value) == value_.end()) {
            return MATCH_FAIL;
        }

        result++;
    }

    if(my_unit) {
        if(!directions_.empty()) {
            if(std::find(directions_.begin(), directions_.end(), my_unit->facing()) == directions_.end()) {
                return MATCH_FAIL;
            }

            result++;
        }

        for(const auto& filter : unit_filter_) {
            unit_filter f{ vconfig(filter) };
            if(!f(*my_unit, loc)) return MATCH_FAIL;
            ++result;
        }

        if(!secondary_unit_filter_.empty()) {
            unit_map::const_iterator unit = disp.get_units().find(second_loc);
            if(!unit.valid()) {
                return MATCH_FAIL;
            }

            for(const config& c : secondary_unit_filter_) {
                unit_filter f{ vconfig(c) };
                if(!f(*unit, second_loc)) return MATCH_FAIL;
                result++;
            }
        }
    } else if(!unit_filter_.empty()) {
        return MATCH_FAIL;
    }

    if(frequency_ && !(randomness::rng::default_instance().get_random_int(0, frequency_-1))) {
        return MATCH_FAIL;
    }

    if(!hits_.empty()) {
        if(std::find(hits_.begin(),hits_.end(),hit) == hits_.end()) {
            return MATCH_FAIL;
        }

        result ++;
    }

    if(!value2_.empty()) {
        if(std::find(value2_.begin(),value2_.end(),value2) == value2_.end()) {
            return MATCH_FAIL;
        }

        result ++;
    }

    if(!attack) {
        if(!primary_attack_filter_.empty()) {
            return MATCH_FAIL;
        }
    }

    for(const auto& iter : primary_attack_filter_) {
        if(!attack->matches_filter(iter)) return MATCH_FAIL;
        result++;
    }

    if(!second_attack) {
        if(!secondary_attack_filter_.empty()) {
            return MATCH_FAIL;
        }
    }

    for(const auto& iter : secondary_attack_filter_) {
        if(!second_attack->matches_filter(iter)) return MATCH_FAIL;
        result++;
    }

    return result;
}

void unit_animation::fill_initial_animations(std::vector<unit_animation>& animations, const config& cfg)
{
    add_anims(animations, cfg);

    std::vector<unit_animation> animation_base;
    for(const auto& anim : animations) {
        if(std::find(anim.event_.begin(), anim.event_.end(), "default") != anim.event_.end()) {
            animation_base.push_back(anim);
            animation_base.back().base_score_ += unit_animation::DEFAULT_ANIM;
            animation_base.back().event_.clear();
        }
    }

    const std::string default_image = cfg["image"];

    if(animation_base.empty()) {
        animation_base.push_back(unit_animation(0, frame_builder().image(default_image).duration(1), "", unit_animation::DEFAULT_ANIM));
    }

    animations.push_back(unit_animation(0, frame_builder().image(default_image).duration(1), "_disabled_", 0));
    animations.push_back(unit_animation(0,
        frame_builder().image(default_image).duration(300).blend("0.0~0.3:100,0.3~0.0:200", {255,255,255}),
        "_disabled_selected_", 0));

    for(const auto& base : animation_base) {
        animations.push_back(base);
        animations.back().event_ = { "standing" };
        animations.back().play_offscreen_ = false;

        animations.push_back(base);
        animations.back().event_ = { "_ghosted_" };
        animations.back().unit_anim_.override(0, animations.back().unit_anim_.get_animation_duration(),particle::UNSET,"0.9", "", {0,0,0}, "", "", "~GS()");

        animations.push_back(base);
        animations.back().event_ = { "_disabled_ghosted_" };
        animations.back().unit_anim_.override(0, 1, particle::UNSET, "0.4", "", {0,0,0}, "", "", "~GS()");

        animations.push_back(base);
        animations.back().event_ = { "selected" };
        animations.back().unit_anim_.override(0, 300, particle::UNSET, "", "0.0~0.3:100,0.3~0.0:200", {255,255,255});

        animations.push_back(base);
        animations.back().event_ = { "recruited" };
        animations.back().unit_anim_.override(0, 600, particle::NO_CYCLE, "0~1:600");

        animations.push_back(base);
        animations.back().event_ = { "levelin" };
        animations.back().unit_anim_.override(0, 600, particle::NO_CYCLE, "", "1~0:600", {255,255,255});

        animations.push_back(base);
        animations.back().event_ = { "levelout" };
        animations.back().unit_anim_.override(0, 600, particle::NO_CYCLE, "", "0~1:600,1", {255,255,255});

        animations.push_back(base);
        animations.back().event_ = { "pre_movement" };
        animations.back().unit_anim_.override(0, 1, particle::NO_CYCLE);

        animations.push_back(base);
        animations.back().event_ = { "post_movement" };
        animations.back().unit_anim_.override(0, 1, particle::NO_CYCLE);

        animations.push_back(base);
        animations.back().event_ = { "movement" };
        animations.back().unit_anim_.override(0, 200,
            particle::NO_CYCLE, "", "", {0,0,0}, "0~1:200", std::to_string(drawing_queue::LAYER_UNIT_MOVE_DEFAULT - drawing_queue::LAYER_UNIT_FIRST));

        animations.push_back(base);
        animations.back().event_ = { "defend" };
        animations.back().unit_anim_.override(0, animations.back().unit_anim_.get_animation_duration(),
            particle::NO_CYCLE, "", "0.0,0.5:75,0.0:75,0.5:75,0.0", {255,0,0});
        animations.back().hits_.push_back(hit_type::HIT);
        animations.back().hits_.push_back(hit_type::KILL);

        animations.push_back(base);
        animations.back().event_ = { "defend" };

        animations.push_back(base);
        animations.back().event_ = { "attack" };
        animations.back().unit_anim_.override(-150, 300, particle::NO_CYCLE, "", "", {0,0,0}, "0~0.6:150,0.6~0:150", std::to_string(drawing_queue::LAYER_UNIT_MOVE_DEFAULT-drawing_queue::LAYER_UNIT_FIRST));
        animations.back().primary_attack_filter_.emplace_back("range", "melee");

        animations.push_back(base);
        animations.back().event_ = { "attack" };
        animations.back().unit_anim_.override(-150, 150, particle::NO_CYCLE);
        animations.back().primary_attack_filter_.emplace_back("range", "ranged");

        animations.push_back(base);
        animations.back().event_ = { "death" };
        animations.back().unit_anim_.override(0, 600, particle::NO_CYCLE, "1~0:600");
        animations.back().sub_anims_["_death_sound"] = particle();
        animations.back().sub_anims_["_death_sound"].add_frame(1, frame_builder().sound(cfg["die_sound"]), true);

        animations.push_back(base);
        animations.back().event_ = { "victory" };
        animations.back().unit_anim_.override(0, animations.back().unit_anim_.get_animation_duration(), particle::CYCLE);

        animations.push_back(base);
        animations.back().unit_anim_.override(0, 150, particle::NO_CYCLE, "1~0:150");
        animations.back().event_ = { "pre_teleport" };

        animations.push_back(base);
        animations.back().unit_anim_.override(0, 150, particle::NO_CYCLE, "0~1:150,1");
        animations.back().event_ = { "post_teleport" };

        animations.push_back(base);
        animations.back().event_ = { "healing" };

        animations.push_back(base);
        animations.back().event_ = { "healed" };
        animations.back().unit_anim_.override(0, 300, particle::NO_CYCLE, "", "0:30,0.5:30,0:30,0.5:30,0:30,0.5:30,0:30,0.5:30,0:30", {255,255,255});

        const std::string healed_sound = get_heal_sound(cfg);

        animations.back().sub_anims_["_healed_sound"].add_frame(1, frame_builder().sound(healed_sound), true);

        animations.push_back(base);
        animations.back().event_ = { "poisoned" };
        animations.back().unit_anim_.override(0, 300, particle::NO_CYCLE, "", "0:30,0.5:30,0:30,0.5:30,0:30,0.5:30,0:30,0.5:30,0:30", {0,255,0});
        animations.back().sub_anims_["_poison_sound"] = particle();
        animations.back().sub_anims_["_poison_sound"].add_frame(1, frame_builder().sound(game_config::sounds::status::poisoned), true);
    }
}

static void add_simple_anim(std::vector<unit_animation>& animations,
    const config& cfg, char const* tag_name, char const* apply_to,
    drawing_queue::layer layer = drawing_queue::LAYER_UNIT_DEFAULT,
    bool offscreen = true)
{
    for(const animation_branch& ab : prepare_animation(cfg, tag_name)) {
        config anim = ab.merge();
        anim["apply_to"] = apply_to;

        if(!offscreen) {
            config::attribute_value& v = anim["offscreen"];
            if(v.empty()) v = false;
        }

        config::attribute_value& v = anim["layer"];
        if(v.empty()) v = layer - drawing_queue::LAYER_UNIT_FIRST;

        animations.emplace_back(anim);
    }
}

void unit_animation::add_anims( std::vector<unit_animation> & animations, const config & cfg)
{
    for(const animation_branch& ab : prepare_animation(cfg, "animation")) {
        animations.emplace_back(ab.merge());
    }

    const int default_layer = drawing_queue::LAYER_UNIT_DEFAULT - drawing_queue::LAYER_UNIT_FIRST;
    const int move_layer    = drawing_queue::LAYER_UNIT_MOVE_DEFAULT - drawing_queue::LAYER_UNIT_FIRST;
    const int missile_layer = drawing_queue::LAYER_UNIT_MISSILE_DEFAULT - drawing_queue::LAYER_UNIT_FIRST;

    add_simple_anim(animations, cfg, "resistance_anim", "resistance");
    add_simple_anim(animations, cfg, "leading_anim", "leading");
    add_simple_anim(animations, cfg, "recruit_anim", "recruited");
    add_simple_anim(animations, cfg, "recruiting_anim", "recruiting");
    add_simple_anim(animations, cfg, "idle_anim", "idling", drawing_queue::LAYER_UNIT_DEFAULT, false);
    add_simple_anim(animations, cfg, "levelin_anim", "levelin");
    add_simple_anim(animations, cfg, "levelout_anim", "levelout");

    for(const animation_branch& ab : prepare_animation(cfg, "standing_anim")) {
        config anim = ab.merge();
        anim["apply_to"] = "standing";
        anim["cycles"] = true;

        // Add cycles to all frames within a standing animation block
        for(config::const_all_children_iterator ci : ab.children) {
            std::string sub_frame_name = ci->key;
            std::size_t pos = sub_frame_name.find("_frame");
            if(pos != std::string::npos) {
                anim[sub_frame_name.substr(0, pos) + "_cycles"] = true;
            }
        }

        if(anim["layer"].empty()) {
            anim["layer"] = default_layer;
        }

        if(anim["offscreen"].empty()) {
            anim["offscreen"] = false;
        }

        animations.emplace_back(anim);
    }

    // Standing animations are also used as default animations
    for(const animation_branch& ab : prepare_animation(cfg, "standing_anim")) {
        config anim = ab.merge();
        anim["apply_to"] = "default";
        anim["cycles"] = true;

        for(config::const_all_children_iterator ci : ab.children) {
            std::string sub_frame_name = ci->key;
            std::size_t pos = sub_frame_name.find("_frame");
            if(pos != std::string::npos) {
                anim[sub_frame_name.substr(0, pos) + "_cycles"] = true;
            }
        }

        if(anim["layer"].empty()) {
            anim["layer"] = default_layer;
        }

        if(anim["offscreen"].empty()) {
            anim["offscreen"] = false;
        }

        animations.emplace_back(anim);
    }

    for(const animation_branch& ab : prepare_animation(cfg, "healing_anim")) {
        config anim = ab.merge();
        anim["apply_to"] = "healing";
        anim["value"] = anim["damage"];

        if(anim["layer"].empty()) {
            anim["layer"] = default_layer;
        }

        animations.emplace_back(anim);
    }

    for(const animation_branch& ab : prepare_animation(cfg, "healed_anim")) {
        config anim = ab.merge();
        anim["apply_to"] = "healed";
        anim["value"] = anim["healing"];

        if(anim["layer"].empty()) {
            anim["layer"] = default_layer;
        }

        animations.emplace_back(anim);
        animations.back().sub_anims_["_healed_sound"] = particle();

        const std::string healed_sound = get_heal_sound(cfg);
        animations.back().sub_anims_["_healed_sound"].add_frame(1,frame_builder().sound(healed_sound),true);
    }

    for(const animation_branch &ab : prepare_animation(cfg, "poison_anim")) {
        config anim = ab.merge();
        anim["apply_to"] = "poisoned";
        anim["value"] = anim["damage"];

        if(anim["layer"].empty()) {
            anim["layer"] = default_layer;
        }

        animations.emplace_back(anim);
        animations.back().sub_anims_["_poison_sound"] = particle();
        animations.back().sub_anims_["_poison_sound"].add_frame(1,frame_builder().sound(game_config::sounds::status::poisoned),true);
    }

    add_simple_anim(animations, cfg, "pre_movement_anim", "pre_movement", drawing_queue::LAYER_UNIT_MOVE_DEFAULT);

    for(const animation_branch& ab : prepare_animation(cfg, "movement_anim")) {
        config anim = ab.merge();
        anim["apply_to"] = "movement";

        if(anim["offset"].empty()) {
            anim["offset"] = "0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,0~1:200,";
        }

        if(anim["layer"].empty()) {
            anim["layer"] = move_layer;
        }

        animations.emplace_back(anim);
    }

    add_simple_anim(animations, cfg, "post_movement_anim", "post_movement", drawing_queue::LAYER_UNIT_MOVE_DEFAULT);

    for(const animation_branch& ab : prepare_animation(cfg, "defend")) {
        config anim = ab.merge();
        anim["apply_to"] = "defend";

        if(anim["layer"].empty()) {
            anim["layer"] = default_layer;
        }

        if(!anim["damage"].empty() && anim["value"].empty()) {
            anim["value"] = anim["damage"];
        }

        if(anim["hits"].empty()) {
            anim["hits"] = false;
            animations.emplace_back(anim);
            animations.back().base_score_--; //so default doesn't interfere with 'if' block

            anim["hits"] = true;
            animations.emplace_back(anim);
            animations.back().base_score_--;

            image::locator image_loc = animations.back().get_last_frame().end_parameters().image;
            animations.back().add_frame(225, frame_builder()
                .image(image_loc.get_filename()+image_loc.get_modifications())
                .duration(225)
                .blend("0.0,0.5:75,0.0:75,0.5:75,0.0", {255,0,0}));
        } else {
            for(const std::string& hit_type : utils::split(anim["hits"])) {
                config tmp = anim;
                tmp["hits"] = hit_type;

                animations.emplace_back(tmp);

                image::locator image_loc = animations.back().get_last_frame().end_parameters().image;
                if(hit_type == "yes" || hit_type == "hit" || hit_type=="kill") {
                    animations.back().add_frame(225, frame_builder()
                        .image(image_loc.get_filename() + image_loc.get_modifications())
                        .duration(225)
                        .blend("0.0,0.5:75,0.0:75,0.5:75,0.0", {255,0,0}));
                }
            }
        }
    }

    add_simple_anim(animations, cfg, "draw_weapon_anim", "draw_weapon", drawing_queue::LAYER_UNIT_MOVE_DEFAULT);
    add_simple_anim(animations, cfg, "sheath_weapon_anim", "sheath_weapon", drawing_queue::LAYER_UNIT_MOVE_DEFAULT);

    for(const animation_branch& ab : prepare_animation(cfg, "attack_anim")) {
        config anim = ab.merge();
        anim["apply_to"] = "attack";

        if(anim["layer"].empty()) {
            anim["layer"] = move_layer;
        }

        config::const_child_itors missile_fs = anim.child_range("missile_frame");
        if(anim["offset"].empty() && missile_fs.empty()) {
            anim["offset"] ="0~0.6,0.6~0";
        }

        if(!missile_fs.empty()) {
            if(anim["missile_offset"].empty()) {
                anim["missile_offset"] = "0~0.8";
            }

            if(anim["missile_layer"].empty()) {
                anim["missile_layer"] = missile_layer;
            }

            config tmp;
            tmp["duration"] = 1;

            anim.add_child("missile_frame", tmp);
            anim.add_child_at("missile_frame", tmp, 0);
        }

        animations.emplace_back(anim);
    }

    for(const animation_branch& ab : prepare_animation(cfg, "death")) {
        config anim = ab.merge();
        anim["apply_to"] = "death";

        if(anim["layer"].empty()) {
            anim["layer"] = default_layer;
        }

        animations.emplace_back(anim);
        image::locator image_loc = animations.back().get_last_frame().end_parameters().image;

        animations.back().add_frame(600, frame_builder()
            .image(image_loc.get_filename()+image_loc.get_modifications())
            .duration(600)
            .highlight("1~0:600"));

        if(!cfg["die_sound"].empty()) {
            animations.back().sub_anims_["_death_sound"] = particle();
            animations.back().sub_anims_["_death_sound"].add_frame(1,frame_builder().sound(cfg["die_sound"]),true);
        }
    }

    add_simple_anim(animations, cfg, "victory_anim", "victory");

    for(const animation_branch& ab : prepare_animation(cfg, "extra_anim")) {
        config anim = ab.merge();
        anim["apply_to"] = anim["flag"];

        if(anim["layer"].empty()) {
            anim["layer"] = default_layer;
        }

        animations.emplace_back(anim);
    }

    for(const animation_branch& ab : prepare_animation(cfg, "teleport_anim")) {
        config anim = ab.merge();
        if(anim["layer"].empty()) {
            anim["layer"] = default_layer;
        }

        anim["apply_to"] = "pre_teleport";
        animations.emplace_back(anim);
        animations.back().unit_anim_.set_end_time(0);

        anim["apply_to"] ="post_teleport";
        animations.emplace_back(anim);
        animations.back().unit_anim_.remove_frames_until(0);
    }
}

void unit_animation::particle::override(int start_time
    , int duration
    , const cycle_state cycles
    , const std::string& highlight
    , const std::string& blend_ratio
    , color_t blend_color
    , const std::string& offset
    , const std::string& layer
    , const std::string& modifiers)
{
    set_begin_time(start_time);
    parameters_.override(duration,highlight,blend_ratio,blend_color,offset,layer,modifiers);

    if(cycles == CYCLE) {
        cycles_=true;
    } else if(cycles==NO_CYCLE) {
        cycles_=false;
    }

    if(get_animation_duration() < duration) {
        add_frame(duration -get_animation_duration(), get_last_frame());
    } else if(get_animation_duration() > duration) {
        set_end_time(duration);
    }
}

bool unit_animation::particle::need_update() const
{
    if(animated<unit_frame>::need_update()) return true;
    if(get_current_frame().need_update()) return true;
    if(parameters_.need_update()) return true;
    return false;
}

bool unit_animation::particle::need_minimal_update() const
{
    return get_current_frame_begin_time() != last_frame_begin_time_;
}

unit_animation::particle::particle(const config& cfg, const std::string& frame_string)
    : animated<unit_frame>()
    , accelerate(true)
    , parameters_()
    , halo_id_()
    , last_frame_begin_time_(0)
    , cycles_(false)
{
    starting_frame_time_ = INT_MAX;

    config::const_child_itors range = cfg.child_range(frame_string + "frame");
    if(!range.empty() && cfg[frame_string + "start_time"].empty()) {
        for(const config& frame : range) {
            starting_frame_time_ = std::min(starting_frame_time_, frame["begin"].to_int());
        }
    } else {
        starting_frame_time_ = cfg[frame_string + "start_time"];
    }

    for(const config& frame : range) {
        unit_frame tmp_frame(frame);
        add_frame(tmp_frame.duration(), tmp_frame, !tmp_frame.does_not_change());
    }

    cycles_  = cfg[frame_string + "cycles"].to_bool(false);
    parameters_ = frame_parsed_parameters(frame_builder(cfg,frame_string), get_animation_duration());

    if(!parameters_.does_not_change()) {
        force_change();
    }
}

bool unit_animation::need_update() const
{
    if(unit_anim_.need_update()) return true;
    for(const auto& anim : sub_anims_) {
        if(anim.second.need_update()) return true;
    }

    return false;
}

bool unit_animation::need_minimal_update() const
{
    if(!play_offscreen_) {
        return false;
    }

    if(unit_anim_.need_minimal_update()) return true;

    for(const auto& anim : sub_anims_) {
        if(anim.second.need_minimal_update()) return true;
    }

    return false;
}

bool unit_animation::animation_finished() const
{
    if(!unit_anim_.animation_finished()) return false;
    for(const auto& anim : sub_anims_) {
        if(!anim.second.animation_finished()) return false;
    }

    return true;
}

bool unit_animation::animation_finished_potential() const
{
    if(!unit_anim_.animation_finished_potential()) return false;
    for(const auto& anim : sub_anims_) {
        if(!anim.second.animation_finished_potential()) return false;
    }

    return true;
}

void unit_animation::update_last_draw_time()
{
    double acceleration = unit_anim_.accelerate ? display::get_singleton()->turbo_speed() : 1.0;
    unit_anim_.update_last_draw_time(acceleration);
    for(auto& anim : sub_anims_) {
        anim.second.update_last_draw_time(acceleration);
    }
}

int unit_animation::get_end_time() const
{
    int result = unit_anim_.get_end_time();
    for(const auto& anim : sub_anims_) {
        result = std::max<int>(result, anim.second.get_end_time());
    }

    return result;
}

int unit_animation::get_begin_time() const
{
    int result = unit_anim_.get_begin_time();
    for(const auto& anim : sub_anims_) {
        result = std::min<int>(result, anim.second.get_begin_time());
    }

    return result;
}

void unit_animation::start_animation(int start_time
    , const map_location& src
    , const map_location& dst
    , const std::string& text
    , const color_t text_color
    , const bool accelerate)
{
    unit_anim_.accelerate = accelerate;
    src_ = src;
    dst_ = dst;

    unit_anim_.start_animation(start_time);

    if(!text.empty()) {
        particle crude_build;
        crude_build.add_frame(1, frame_builder());
        crude_build.add_frame(1, frame_builder().text(text, text_color), true);
        sub_anims_["_add_text"] = crude_build;
    }

    for(auto& anim : sub_anims_) {
        anim.second.accelerate = accelerate;
        anim.second.start_animation(start_time);
    }
}

void unit_animation::update_parameters(const map_location& src, const map_location& dst)
{
    src_ = src;
    dst_ = dst;
}

void unit_animation::pause_animation()
{
    unit_anim_.pause_animation();

    for(auto& anim : sub_anims_) {
        anim.second.pause_animation();
    }
}

void unit_animation::restart_animation()
{
    unit_anim_.restart_animation();

    for(auto& anim : sub_anims_) {
        anim.second.restart_animation();
    }
}

void unit_animation::redraw(frame_parameters& value, halo::manager& halo_man)
{
    value.primary_frame = true;
    unit_anim_.redraw(value,src_,dst_, halo_man);

    value.primary_frame = false;
    for(auto& anim : sub_anims_) {
        anim.second.redraw(value, src_, dst_, halo_man);
    }
}

void unit_animation::clear_haloes()
{
    unit_anim_.clear_halo();

    for(auto& anim : sub_anims_) {
        anim.second.clear_halo();
    }
}

std::string unit_animation::debug() const
{
    std::ostringstream outstream;
    outstream << *this;
    return outstream.str();
}

std::ostream& operator<<(std::ostream& outstream, const unit_animation& u_animation)
{
    std::string events_string = utils::join(u_animation.event_);
    outstream << "[" << events_string << "]\n";

    outstream << "\tstart_time=" << u_animation.get_begin_time() << '\n';

    if(u_animation.hits_.size() > 0) {
        std::vector<std::string> hits;
        std::transform(u_animation.hits_.begin(), u_animation.hits_.end(), std::back_inserter(hits), unit_animation::hit_type::enum_to_string);
        outstream << "\thits=" << utils::join(hits) << '\n';
    }

    if(u_animation.directions_.size() > 0) {
        std::vector<std::string> dirs;
        std::transform(u_animation.directions_.begin(), u_animation.directions_.end(), std::back_inserter(dirs), map_location::write_direction);
        outstream << "\tdirections=" << utils::join(dirs) << '\n';
    }

    if(u_animation.terrain_types_.size() > 0) {
        outstream << "\tterrain=" << utils::join(u_animation.terrain_types_) << '\n';
    }

    if(u_animation.frequency_ > 0) outstream << "frequency=" << u_animation.frequency_ << '\n';

    if(u_animation.unit_filter_.size() > 0) {
        outstream << "[filter]\n";
        for(const config& cfg : u_animation.unit_filter_) {
            outstream << cfg.debug();
        }

        outstream << "[/filter]\n";
    }

    if(u_animation.secondary_unit_filter_.size() > 0) {
        outstream << "[filter_second]\n";
        for(const config& cfg : u_animation.secondary_unit_filter_) {
            outstream << cfg.debug();
        }

        outstream << "[/filter_second]\n";
    }

    if(u_animation.primary_attack_filter_.size() > 0) {
        outstream << "[filter_attack]\n";
        for(const config cfg : u_animation.primary_attack_filter_) {
            outstream << cfg.debug();
        }

        outstream << "[/filter_attack]\n";
    }

    if(u_animation.secondary_attack_filter_.size() > 0) {
        outstream << "[filter_second_attack]\n";
        for(const config cfg : u_animation.secondary_attack_filter_) {
            outstream << cfg.debug();
        }

        outstream << "[/filter_second_attack]\n";
    }

    for(std::size_t i = 0; i < u_animation.unit_anim_.get_frames_count(); i++) {
        outstream << "\t[frame]\n";
        for(const std::string frame_string : u_animation.unit_anim_.get_frame(i).debug_strings()) {
            outstream << "\t\t" << frame_string <<"\n";
        }
        outstream << "\t[/frame]\n";
    }

    for(std::pair<std::string, unit_animation::particle> p : u_animation.sub_anims_) {
        for(std::size_t i = 0; i < p.second.get_frames_count(); i++) {
            std::string sub_frame_name = p.first;
            std::size_t pos = sub_frame_name.find("_frame");
            if(pos != std::string::npos) sub_frame_name = sub_frame_name.substr(0, pos);

            outstream << "\t" << sub_frame_name << "_start_time=" << p.second.get_begin_time() << '\n';
            outstream << "\t[" << p.first << "]\n";

            for(const std::string frame_string : p.second.get_frame(i).debug_strings()) {
                outstream << "\t\t" << frame_string << '\n';
            }

            outstream << "\t[/" << p.first << "]\n";
        }
    }

    outstream << "[/" << events_string << "]\n";
    return outstream;
}

void unit_animation::particle::redraw(const frame_parameters& value,const map_location& src, const map_location& dst, halo::manager& halo_man)
{
    const unit_frame& current_frame = get_current_frame();
    const int animation_time = get_animation_time();
    const frame_parameters default_val = parameters_.parameters(animation_time - get_begin_time());

    // Everything is relative to the first frame in an attack/defense/etc. block.
    // so we need to check if this particular frame is due to be shown at this time
    bool in_scope_of_frame = (animation_time >= get_current_frame_begin_time() ? true: false);
    if(animation_time > get_current_frame_end_time()) in_scope_of_frame = false;

    // Sometimes even if the frame is not due to be shown, a frame image still must be shown.
    // i.e. in a defense animation that is shorter than an attack animation.
    // the halos should not persist though and use the 'in_scope_of_frame' variable.

    // For sound frames we want the first time variable set only after the frame has started.
    if(get_current_frame_begin_time() != last_frame_begin_time_ && animation_time >= get_current_frame_begin_time()) {
        last_frame_begin_time_ = get_current_frame_begin_time();
        current_frame.redraw(get_current_frame_time(), true, in_scope_of_frame, src, dst, halo_id_, halo_man, default_val, value);
    } else {
        current_frame.redraw(get_current_frame_time(), false, in_scope_of_frame, src, dst, halo_id_, halo_man, default_val, value);
    }
}

void unit_animation::particle::clear_halo()
{
    halo_id_.reset();
}

std::set<map_location> unit_animation::particle::get_overlaped_hex(const frame_parameters& value, const map_location& src, const map_location& dst)
{
    const unit_frame& current_frame = get_current_frame();
    const frame_parameters default_val = parameters_.parameters(get_animation_time() - get_begin_time());
    return current_frame.get_overlaped_hex(get_current_frame_time(), src, dst, default_val,value);
}

unit_animation::particle::~particle()
{
    halo_id_.reset();
}

void unit_animation::particle::start_animation(int start_time)
{
    halo_id_.reset();
    parameters_.override(get_animation_duration());
    animated<unit_frame>::start_animation(start_time,cycles_);
    last_frame_begin_time_ = get_begin_time() -1;
}

void unit_animator::add_animation(const unit* animated_unit
        , const std::string& event
        , const map_location &src
        , const map_location &dst
        , const int value
        , bool with_bars
        , const std::string& text
        , const color_t text_color
        , const unit_animation::hit_type hit_type
        , const_attack_ptr attack
        , const_attack_ptr second_attack
        , int value2)
{
    if(!animated_unit) return;

    display* disp = display::get_singleton();

    anim_elem tmp;
    tmp.my_unit = unit_const_ptr(animated_unit);
    tmp.text = text;
    tmp.text_color = text_color;
    tmp.src = src;
    tmp.with_bars= with_bars;
    tmp.animation = animated_unit->anim_comp().choose_animation(*disp, src, event, dst, value, hit_type, attack, second_attack, value2);

    if(!tmp.animation) return;

    start_time_ = std::max<int>(start_time_, tmp.animation->get_begin_time());
    animated_units_.push_back(std::move(tmp));
}

void unit_animator::add_animation(const unit* animated_unit
    , const unit_animation* anim
    , const map_location &src
    , bool with_bars
    , const std::string& text
    , const color_t text_color)
{
    if(!animated_unit) return;

    anim_elem tmp;
    tmp.my_unit = unit_const_ptr(animated_unit);
    tmp.text = text;
    tmp.text_color = text_color;
    tmp.src = src;
    tmp.with_bars = with_bars;
    tmp.animation = anim;

    if(!tmp.animation) return;

    start_time_ = std::max<int>(start_time_, tmp.animation->get_begin_time());
    animated_units_.push_back(std::move(tmp));
}

void unit_animator::replace_anim_if_invalid(const unit* animated_unit
    , const std::string& event
    , const map_location &src
    , const map_location & dst
    , const int value
    , bool with_bars
    , const std::string& text
    , const color_t text_color
    , const unit_animation::hit_type hit_type
    , const_attack_ptr attack
    , const_attack_ptr second_attack
    , int value2)
{
    if(!animated_unit) return;

    display* disp = display::get_singleton();
    if(animated_unit->anim_comp().get_animation() &&
        !animated_unit->anim_comp().get_animation()->animation_finished_potential() &&
         animated_unit->anim_comp().get_animation()->matches(
            *disp, src, dst, animated_unit, event, value, hit_type, attack, second_attack, value2) > unit_animation::MATCH_FAIL)
    {
        anim_elem tmp;
        tmp.my_unit = unit_const_ptr(animated_unit);
        tmp.text = text;
        tmp.text_color = text_color;
        tmp.src = src;
        tmp.with_bars= with_bars;
        tmp.animation = nullptr;

        animated_units_.push_back(std::move(tmp));
    } else {
        add_animation(animated_unit,event,src,dst,value,with_bars,text,text_color,hit_type,attack,second_attack,value2);
    }
}

void unit_animator::start_animations()
{
    int begin_time = INT_MAX;

    for(const auto& anim : animated_units_) {
        if(anim.my_unit->anim_comp().get_animation()) {
            if(anim.animation) {
                begin_time = std::min<int>(begin_time, anim.animation->get_begin_time());
            } else  {
                begin_time = std::min<int>(begin_time, anim.my_unit->anim_comp().get_animation()->get_begin_time());
            }
        }
    }

    for(auto& anim : animated_units_) {
        if(anim.animation) {
            anim.my_unit->anim_comp().start_animation(begin_time, anim.animation, anim.with_bars, anim.text, anim.text_color);
            anim.animation = nullptr;
        } else {
            anim.my_unit->anim_comp().get_animation()->update_parameters(anim.src, anim.src.get_direction(anim.my_unit->facing()));
        }
    }
}

bool unit_animator::would_end() const
{
    bool finished = true;
    for(const auto& anim : animated_units_) {
        finished &= anim.my_unit->anim_comp().get_animation()->animation_finished_potential();
    }

    return finished;
}

void unit_animator::wait_until(int animation_time) const
{
    // important to set a max animation time so that the time does not go past this value for movements.
    // fix for bug #1565
    animated_units_[0].my_unit->anim_comp().get_animation()->set_max_animation_time(animation_time);

    display* disp = display::get_singleton();
    double speed = disp->turbo_speed();

    resources::controller->play_slice(false);

    int end_tick = animated_units_[0].my_unit->anim_comp().get_animation()->time_to_tick(animation_time);
    while(SDL_GetTicks() < static_cast<unsigned int>(end_tick) - std::min<int>(static_cast<unsigned int>(20 / speed), 20)) {
        CVideo::delay(std::max<int>(0, std::min<int>(10, static_cast<int>((animation_time - get_animation_time()) * speed))));

        resources::controller->play_slice(false);
        end_tick = animated_units_[0].my_unit->anim_comp().get_animation()->time_to_tick(animation_time);
    }

    CVideo::delay(std::max<int>(0, end_tick - SDL_GetTicks() + 5));

    new_animation_frame();
    animated_units_[0].my_unit->anim_comp().get_animation()->set_max_animation_time(0);
}

void unit_animator::wait_for_end() const
{
    if(game_config::no_delay) return;

    bool finished = false;
    while(!finished) {
        resources::controller->play_slice(false);

        CVideo::delay(10);

        finished = true;
        for(const auto& anim : animated_units_) {
            finished &= anim.my_unit->anim_comp().get_animation()->animation_finished_potential();
        }
    }
}

int unit_animator::get_animation_time() const
{
    return animated_units_[0].my_unit->anim_comp().get_animation()->get_animation_time() ;
}

int unit_animator::get_animation_time_potential() const
{
    return animated_units_[0].my_unit->anim_comp().get_animation()->get_animation_time_potential() ;
}

int unit_animator::get_end_time() const
{
    int end_time = INT_MIN;
    for(const auto& anim : animated_units_) {
        if(anim.my_unit->anim_comp().get_animation()) {
            end_time = std::max<int>(end_time, anim.my_unit->anim_comp().get_animation()->get_end_time());
        }
    }

    return end_time;
}

void unit_animator::pause_animation()
{
    for(const auto& anim : animated_units_) {
        if(anim.my_unit->anim_comp().get_animation()) {
            anim.my_unit->anim_comp().get_animation()->pause_animation();
        }
    }
}

void unit_animator::restart_animation()
{
    for(const auto& anim : animated_units_) {
        if(anim.my_unit->anim_comp().get_animation()) {
            anim.my_unit->anim_comp().get_animation()->restart_animation();
        }
    }
}

void unit_animator::set_all_standing()
{
    for(const auto& anim : animated_units_) {
        anim.my_unit->anim_comp().set_standing();
    }
}