OpenTTD Source  20241124-master-g9399a92a4f
TextEffect Struct Reference

Container for all information about a text effect. More...

Inheritance diagram for TextEffect:
ViewportSign

Public Member Functions

void Reset ()
 Reset the text effect.
 
- Public Member Functions inherited from ViewportSign
auto operator<=> (const ViewportSign &) const =default
 
void UpdatePosition (int center, int top, StringID str, StringID str_small=STR_NULL)
 Update the position of the viewport sign. More...
 
void MarkDirty (ZoomLevel maxzoom=ZOOM_LVL_MAX) const
 Mark the sign dirty in all viewports. More...
 

Data Fields

std::vector< StringParameterData > params
 Backup of string parameters.
 
StringID string_id
 String to draw for the text effect, if INVALID_STRING_ID then it's not valid.
 
uint8_t duration
 How long the text effect should stay, in ticks (applies only when mode == TE_RISING)
 
TextEffectMode mode
 Type of text effect.
 
- Data Fields inherited from ViewportSign
int32_t center
 The center position of the sign.
 
int32_t top
 The top of the sign.
 
uint16_t width_normal
 The width when not zoomed out (normal font)
 
uint16_t width_small
 The width when zoomed out (small font)
 

Detailed Description

Container for all information about a text effect.

Definition at line 23 of file texteff.cpp.


The documentation for this struct was generated from the following file: