multipliers.h

Go to the documentation of this file.

/***********************************************************************
Copyright (c) 1996-2020 Freeciv21 and Freeciv contributors. This file is
 /\/\             part of Freeciv21. Freeciv21 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. You should have
received a copy of the GNU General Public License along with Freeciv21.
                              If not, see https://www.gnu.org/licenses/.
***********************************************************************/
 
#pragma once
 
struct multiplier {
  Multiplier_type_id id;
  struct name_translation name;
  bool ruledit_disabled; /* Does not really exist - hole in multipliers array
                          */
  int start;             // display units
  int stop;              // display units
  int step;              // display units
  int def;               // default value, in display units
  int offset;
  int factor;
  struct requirement_vector reqs;
  QVector<QString> *helptext;
};
 
void multipliers_init();
void multipliers_free();
 
Multiplier_type_id multiplier_count();
Multiplier_type_id multiplier_index(const struct multiplier *pmul);
Multiplier_type_id multiplier_number(const struct multiplier *pmul);
 
struct multiplier *multiplier_by_number(Multiplier_type_id id);
 
const char *multiplier_name_translation(const struct multiplier *pmul);
const char *multiplier_rule_name(const struct multiplier *pmul);
struct multiplier *multiplier_by_rule_name(const char *name);
 
bool multiplier_can_be_changed(struct multiplier *pmul,
                               struct player *pplayer);
 
#define multipliers_iterate(_mul_)                                          \
  {                                                                         \
    Multiplier_type_id _i;                                                  \
    for (_i = 0; _i < multiplier_count(); _i++) {                           \
      struct multiplier *_mul_ = multiplier_by_number(_i);
 
#define multipliers_iterate_end                                             \
  }                                                                         \
  }
 
#define multipliers_re_active_iterate(_mul_)                                \
  multipliers_iterate(_mul_)                                                \
  {                                                                         \
    if (!_mul_->ruledit_disabled) {
 
#define multipliers_re_active_iterate_end                                   \
  }                                                                         \
  }                                                                         \
  multipliers_iterate_end;