src/texteff.hpp

   1 /* $Id: texteff.hpp 25011 2013-02-17 14:50:54Z rubidium $ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file texteff.hpp Functions related to text effects. */
  11
  12 #ifndef TEXTEFF_HPP
  13 #define TEXTEFF_HPP
  14
  15 #include "economy_type.h"
  16 #include "gfx_type.h"
  17 #include "strings_type.h"
  18
  19 /**
  20  * Text effect modes.
  21  */
  22 enum TextEffectMode {
  23         TE_RISING, ///< Make the text effect slowly go upwards
  24         TE_STATIC, ///< Keep the text effect static
  25
  26         INVALID_TE_ID = 0xFFFF,
  27 };
  28
  29 typedef uint16 TextEffectID;
  30
  31 void MoveAllTextEffects();
  32 TextEffectID AddTextEffect(StringID msg, int x, int y, uint8 duration, TextEffectMode mode);
  33 void InitTextEffects();
  34 void DrawTextEffects(DrawPixelInfo *dpi);
  35 void UpdateTextEffect(TextEffectID effect_id, StringID msg);
  36 void RemoveTextEffect(TextEffectID effect_id);
  37
  38 /* misc_gui.cpp */
  39 TextEffectID ShowFillingPercent(int x, int y, int z, uint8 percent, StringID colour);
  40 void UpdateFillingPercent(TextEffectID te_id, uint8 percent, StringID colour);
  41 void HideFillingPercent(TextEffectID *te_id);
  42
  43 void ShowCostOrIncomeAnimation(int x, int y, int z, Money cost);
  44 void ShowFeederIncomeAnimation(int x, int y, int z, const Money& transfer, Money income);
  45
  46 #endif /* TEXTEFF_HPP */