OpenTTD Source 20260421-master-gc2fbc6fdeb
Livery Struct Reference

Information about a particular livery. More...

#include <livery.h>

Public Types

enum class  Flag : uint8_t { Primary = 0 , Secondary = 1 }
 Flags for bitmask to declare which of the colours are set. More...
using Flags = EnumBitSet<Flag, uint8_t>

Public Member Functions

uint8_t GetRecolourOffset (bool use_secondary=true) const
 Get offset for recolour palette.

Data Fields

Flags in_use {}
 Livery flags.
Colours colour1 = Colours::Begin
 First colour, for all vehicles.
Colours colour2 = Colours::Begin
 Second colour, for vehicles with 2CC support.

Detailed Description

Information about a particular livery.

Definition at line 79 of file livery.h.

Member Typedef Documentation

◆ Flags

using Livery::Flags = EnumBitSet<Flag, uint8_t>

Definition at line 85 of file livery.h.

Member Enumeration Documentation

◆ Flag

enum class Livery::Flag : uint8_t
strong

Flags for bitmask to declare which of the colours are set.

Enumerator
Primary 

Primary colour is set.

Secondary 

Secondary colour is set.

Definition at line 81 of file livery.h.

Member Function Documentation

◆ GetRecolourOffset()

uint8_t Livery::GetRecolourOffset ( bool use_secondary = true) const
inline

Get offset for recolour palette.

Parameters
use_secondarySpecify whether to add secondary colour offset to the result.
Returns
The palette offset.

Definition at line 96 of file livery.h.

References to_underlying().

Referenced by DrawNewObjectTileInGUI().

Field Documentation

◆ colour1

Colours Livery::colour1 = Colours::Begin

◆ colour2

Colours Livery::colour2 = Colours::Begin

Second colour, for vehicles with 2CC support.

Definition at line 89 of file livery.h.

Referenced by CmdAlterGroup(), CmdCreateGroup(), CmdSetGroupLivery(), GetColourOffset(), GetCompanyInfo(), PropagateChildLivery(), and UpdateCompanyGroupLiveries().

◆ in_use


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