OpenTTD Source: StoryPageButtonData Struct Reference

OpenTTD Source 14.0-beta3

Public Member Functions | Data Fields
StoryPageButtonData Struct Reference

Helper to construct packed "id" values for button-type StoryPageElement. More...

`#include <story_base.h>`

## Public Member Functions
void | SetColour (Colours button_colour)
| Set the button background colour.
void | SetFlags (StoryPageButtonFlags flags)
void | SetCursor (StoryPageButtonCursor cursor)
| Set the mouse cursor used while waiting for input for the button.
void | SetVehicleType (VehicleType vehtype)
| Set the type of vehicles that are accepted by the button.
Colours | GetColour () const
| Get the button background colour.
StoryPageButtonFlags | GetFlags () const
StoryPageButtonCursor | GetCursor () const
| Get the mouse cursor used while waiting for input for the button.
VehicleType | GetVehicleType () const
| Get the type of vehicles that are accepted by the button.
bool | ValidateColour () const
| Verify that the data stored a valid Colour value.
bool | ValidateFlags () const
bool | ValidateCursor () const
| Verify that the data stores a valid StoryPageButtonCursor value.
bool | ValidateVehicleType () const
| Verity that the data stored a valid VehicleType value.

## Data Fields
uint32_t | referenced_id

## Detailed Description

Helper to construct packed "id" values for button-type StoryPageElement.

Definition at line 122 of file story_base.h.

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

- src/story_base.h
- src/story.cpp