/*
 * 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_RANDOM_MOVEMENT_H
#define SOLARUS_RANDOM_MOVEMENT_H

#include "solarus/core/Common.h"
#include "solarus/core/Rectangle.h"
#include "solarus/movements/StraightMovement.h"
#include <cstdint>
#include <string>

namespace Solarus {

/**
 * \brief A movement that makes successive steps of random directions
 * and (possibly) stays inside a limited rectangle.
 */
class RandomMovement final: public StraightMovement {

  public:

    explicit RandomMovement(int speed);
    RandomMovement(int speed, int max_radius);

    // static information
    static constexpr const char module_name[] = "sol.random_movement";

    virtual void notify_object_controlled() override;
    virtual void update() override;
    virtual void set_suspended(bool suspended) override;

    double get_normal_speed() const;
    void set_normal_speed(double normal_speed);
    int get_max_radius() const;
    void set_max_radius(int max_radius);

    virtual const std::string& get_lua_type_name() const override;

  protected:

    virtual void notify_obstacle_reached() override;

  private:

    void set_next_direction();

    double normal_speed;                    /** Speed applied when the movement is started. */
    int max_radius;                         /**< if the object goes further than this distance in x or y, it will come back
                                             * (this is not a hard limit, there is no guarantee) */
    Rectangle bounds;                       /**< a rectangle the object should not escape from */
    uint32_t next_direction_change_date;    /**< date of the next direction change */

};

}

#endif

