OpenTTD
Typedefs | Enumerations | Functions
texteff.hpp File Reference

Functions related to text effects. More...

#include "economy_type.h"
#include "gfx_type.h"
#include "strings_type.h"

Go to the source code of this file.

Typedefs

typedef uint16 TextEffectID
 

Enumerations

enum  TextEffectMode { TE_RISING, TE_STATIC, INVALID_TE_ID = 0xFFFF }
 Text effect modes. More...
 

Functions

void MoveAllTextEffects ()
 
TextEffectID AddTextEffect (StringID msg, int x, int y, uint8 duration, TextEffectMode mode)
 
void InitTextEffects ()
 
void DrawTextEffects (DrawPixelInfo *dpi)
 
void UpdateTextEffect (TextEffectID effect_id, StringID msg)
 
void RemoveTextEffect (TextEffectID effect_id)
 
TextEffectID ShowFillingPercent (int x, int y, int z, uint8 percent, StringID colour)
 Display vehicle loading indicators. More...
 
void UpdateFillingPercent (TextEffectID te_id, uint8 percent, StringID colour)
 Update vehicle loading indicators. More...
 
void HideFillingPercent (TextEffectID *te_id)
 Hide vehicle loading indicators. More...
 
void ShowCostOrIncomeAnimation (int x, int y, int z, Money cost)
 Display animated income or costs on the map. More...
 
void ShowFeederIncomeAnimation (int x, int y, int z, Money transfer, Money income)
 Display animated feeder income. More...
 

Detailed Description

Functions related to text effects.

Definition in file texteff.hpp.

Enumeration Type Documentation

◆ TextEffectMode

Text effect modes.

Enumerator
TE_RISING 

Make the text effect slowly go upwards.

TE_STATIC 

Keep the text effect static.

Definition at line 22 of file texteff.hpp.

Function Documentation

◆ HideFillingPercent()

void HideFillingPercent ( TextEffectID *  te_id)

Hide vehicle loading indicators.

Parameters
*te_idTextEffectID which is supposed to be hidden.

Definition at line 629 of file misc_gui.cpp.

Referenced by Train::Crash(), and Vehicle::PreDestructor().

◆ ShowCostOrIncomeAnimation()

void ShowCostOrIncomeAnimation ( int  x,
int  y,
int  z,
Money  cost 
)

Display animated income or costs on the map.

Parameters
xWorld X position of the animation location.
yWorld Y position of the animation location.
zWorld Z position of the animation location.
costEstimated cost (or income if negative).

Definition at line 554 of file misc_gui.cpp.

◆ ShowFeederIncomeAnimation()

void ShowFeederIncomeAnimation ( int  x,
int  y,
int  z,
Money  transfer,
Money  income 
)

Display animated feeder income.

Parameters
xWorld X position of the animation location.
yWorld Y position of the animation location.
zWorld Z position of the animation location.
transferEstimated feeder income.
incomeReal income from goods being delivered to their final destination.

Definition at line 575 of file misc_gui.cpp.

◆ ShowFillingPercent()

TextEffectID ShowFillingPercent ( int  x,
int  y,
int  z,
uint8  percent,
StringID  string 
)

Display vehicle loading indicators.

Parameters
xWorld X position of the animation location.
yWorld Y position of the animation location.
zWorld Z position of the animation location.
percentEstimated feeder income.
stringString which is drawn on the map.
Returns
TextEffectID to be used for future updates of the loading indicators.

Definition at line 602 of file misc_gui.cpp.

◆ UpdateFillingPercent()

void UpdateFillingPercent ( TextEffectID  te_id,
uint8  percent,
StringID  string 
)

Update vehicle loading indicators.

Parameters
te_idTextEffectID to be updated.
stringString which is printed.

Definition at line 617 of file misc_gui.cpp.