MobiusMapEditor/CnCTDRAMapEditor/Interface/IGamePlugin.cs

//
// Copyright 2020 Electronic Arts Inc.
//
// The Command & Conquer Map Editor and corresponding source code 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.

// The Command & Conquer Map Editor and corresponding source code is distributed 
// in the hope that it will be useful, but with permitted additional restrictions 
// under Section 7 of the GPL. See the GNU General Public License in LICENSE.TXT 
// distributed with this program. You should have received a copy of the 
// GNU General Public License along with permitted additional restrictions 
// with this program. If not, see https://github.com/electronicarts/CnC_Remastered_Collection
using MobiusEditor.Model;
using System;
using System.Collections.Generic;
using System.Drawing;

namespace MobiusEditor.Interface
{
    public enum FileType
    {
        None,
        INI,
        BIN,
        MEG,
        PGM
    }

    public enum GameType
    {
        None,
        TiberianDawn,
        RedAlert,
        SoleSurvivor
    }

    public interface IGamePlugin : IDisposable
    {
        string Name { get; }

        GameType GameType { get; }

        bool IsMegaMap { get; }

        Map Map { get; }

        Image MapImage { get; }

        IFeedBackHandler FeedBackHandler { get; set; }

        bool Dirty { get; set; }

        string ExtraIniText { get; set; }

        void New(string theater);

        IEnumerable<string> Load(string path, FileType fileType);

        bool Save(string path, FileType fileType);

        bool Save(string path, FileType fileType, Bitmap customPreview, bool dontResavePreview);

        string Validate();

        IEnumerable<String> AssessMapItems();

        HashSet<string> GetHousesWithProduction();

        int[] GetRevealRadiusForWaypoints(Map map, bool forLargeReveal);

        IEnumerable<String> CheckTriggers(IEnumerable<Trigger> triggers, bool includeExternalData, bool prefixNames, bool fatalOnly, out bool fatal, bool fix, out bool wasFixed);


        bool MapNameIsEmpty(string name);
    }
}