ICmpTurretHolder.h

Go to the documentation of this file.

/* Copyright (C) 2021 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. 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.
*
* 0 A.D. 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 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef INCLUDED_ICMPTURRETHOLDER
#define INCLUDED_ICMPTURRETHOLDER

#include "simulation2/system/Interface.h"

#include <vector>

class ICmpTurretHolder : public IComponent
{
public:
    /**
     * Returns the correlation between garrisoned turrets (their ID) and which
     *  turret point they occupy (name).
     */
    virtual std::vector<std::pair<std::string, entity_id_t>> GetTurrets() const = 0;

    /**
     * Correlation between entities (ID) and the turret point they ought to occupy (name).
     */
    virtual void SetInitEntities(std::vector<std::pair<std::string, entity_id_t>>&& entities) = 0;

    DECLARE_INTERFACE_TYPE(TurretHolder)
};

#endif // INCLUDED_ICMPTURRETHOLDER