/*
 * Copyright (C) 2006-2019 Christopho, Solarus - http://www.solarus-games.org
 *
 * Solarus 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 3 of the License, or
 * (at your option) any later version.
 *
 * Solarus is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef SOLARUS_PICKABLE_H
#define SOLARUS_PICKABLE_H

#include "solarus/core/Common.h"
#include "solarus/core/Point.h"
#include "solarus/core/Treasure.h"
#include "solarus/entities/Entity.h"
#include "solarus/entities/EntityPtr.h"
#include "solarus/graphics/SpritePtr.h"
#include "solarus/movements/FallingHeight.h"
#include <memory>
#include <string>

namespace Solarus {

/**
 * \brief An treasure placed on the ground and that the hero can take.
 */
class Pickable: public Entity {

  public:

    static constexpr EntityType ThisType = EntityType::PICKABLE;

    // creation and destruction
    Pickable(
        const std::string& name,
        int layer,
        const Point& xy,
        const Treasure& treasure
    );

    static std::shared_ptr<Pickable> create(
        Game& game,
        const std::string& name,
        int layer,
        const Point& xy,
        Treasure treasure,
        FallingHeight falling_height,
        bool force_persistent
    );

    EntityType get_type() const override;
    bool is_ground_observer() const override;

    void notify_created() override;

    // properties
    bool is_falling() const;
    FallingHeight get_falling_height() const;
    const Treasure& get_treasure() const;
    const std::string& get_falling_sound_id() const;
    void set_falling_sound_id(const std::string& sound_id);
    const std::string& get_sinking_sound_id() const;
    void set_sinking_sound_id(const std::string& sound_id);

    // item state
    void set_suspended(bool suspended) override;
    EntityPtr get_entity_followed();

    bool is_stream_obstacle(Stream& stream) override;

    void notify_collision(
        Entity& entity_overlapping,
        CollisionMode collision_mode
    ) override;
    void notify_collision(
        Entity& other_entity,
        Sprite& this_sprite,
        Sprite& other_sprite
    ) override;
    void notify_collision_with_stream(Stream& stream, int dx, int dy) override;
    void update() override;
    void built_in_draw(Camera& camera) override;

  private:

    // initialization
    bool initialize_sprites(Equipment &equipment);
    void initialize_movement();

    // item
    void try_give_item_to_player(Hero &hero);
    void set_blinking(bool blinking);

    void check_bad_ground();

    Treasure treasure;                          /**< the treasure obtained when the player picks this item */
    bool given_to_player;                       /**< indicates that the treasure was given to the player */

    SpritePtr item_sprite;                      /**< Sprite of the treasure. */
    SpritePtr shadow_sprite;                    /**< Sprite of the shadow (if any). */
    FallingHeight falling_height;               /**< indicates whether the item is falling when it appears */
    bool will_disappear;                        /**< indicates that the item will disappear after an amount of time
                                                 * (only possible for items not saved) */
    std::string falling_sound_id;               /**< Sound played when the item is falling into a hole */
    std::string sinking_sound_id;               /**< Sound played when the item is sinking into deep water or lava */

    // current state
    Point shadow_xy;                            /**< coordinates of the shadow (which does not move while the item does) */

    uint32_t appear_date;                       /**< date when the item is created */
    uint32_t allow_pick_date;                   /**< date when the item can be picked */
    bool can_be_picked;                         /**< indicates that the item can be picked now (i.e. allow_picked_date is past) */
    uint32_t blink_date;                        /**< date when the item starts blinking */
    uint32_t disappear_date;                    /**< date when the item disappears */
    EntityPtr entity_followed;                  /**< an entity this item is attached to (e.g. a boomerang or a hookshot) */
};

}

#endif

