newgrf_class.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD 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, version 2.
 * OpenTTD 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 OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef NEWGRF_CLASS_H
#define NEWGRF_CLASS_H
 
#include "strings_type.h"
 
 
template <typename Tspec, typename Tid, Tid Tmax>
struct NewGRFClass {
private:
  uint ui_count;             
  std::vector<Tspec *> spec; 
 
  static NewGRFClass<Tspec, Tid, Tmax> classes[Tmax];
 
  void ResetClass();
 
  static void InsertDefaults();
 
public:
  uint32_t global_id; 
  StringID name;    
 
  void Insert(Tspec *spec);
 
  uint GetSpecCount() const { return static_cast<uint>(this->spec.size()); }
  uint GetUISpecCount() const { return this->ui_count; }
  int GetUIFromIndex(int index) const;
  int GetIndexFromUI(int ui_index) const;
 
  const Tspec *GetSpec(uint index) const;
 
  bool IsUIAvailable(uint index) const;
 
  static void Reset();
  static Tid Allocate(uint32_t global_id);
  static void Assign(Tspec *spec);
  static uint GetClassCount();
  static uint GetUIClassCount();
  static Tid GetUIClass(uint index);
  static NewGRFClass *Get(Tid cls_id);
 
  static const Tspec *GetByGrf(uint32_t grfid, uint16_t local_id, int *index);
};
 
#endif /* NEWGRF_CLASS_H */