Go to the documentation of this file.
24 extern uint32 _story_page_element_next_sort_value;
25 extern uint32 _story_page_next_sort_value;
47 SPBF_FLOAT_LEFT = 1 << 0,
48 SPBF_FLOAT_RIGHT = 1 << 1,
118 uint32 referenced_id;
129 bool ValidateFlags()
const;
178 if (spe->page == this->index)
delete spe;
uint32 sort_value
A number that increases for every created story page element. Used for sorting. The id of a story pag...
@ SPET_TEXT
A text element.
StoryPageButtonCursor GetCursor() const
Get the mouse cursor used while waiting for input for the button.
StoryPageButtonFlags
Flags available for buttons.
void SetCursor(StoryPageButtonCursor cursor)
Set the mouse cursor used while waiting for input for the button.
StoryPageElement()
We need an (empty) constructor so struct isn't zeroed (as C++ standard states)
@ SPET_BUTTON_PUSH
A push button that triggers an immediate event.
@ SPET_GOAL
An element that references a goal.
uint32 sort_value
A number that increases for every created story page. Used for sorting. The id of a story page is the...
void SetColour(Colours button_colour)
Set the button background colour.
Owner
Enum for all companies/owners.
uint32 referenced_id
Id of referenced object (location, goal etc.)
bool ValidateVehicleType() const
Verity that the data stored a valid VehicleType value.
@ SPET_BUTTON_VEHICLE
A button that allows the player to select a vehicle, and triggers an event wih the vehicle.
bool ValidateCursor() const
Verify that the data stores a valid StoryPageButtonCursor value.
Informative template class exposing basic enumeration properties used by several other templates belo...
@ SPET_BUTTON_TILE
A button that allows the player to select a tile, and triggers an event with the tile.
StoryPageElementType type
Type of page element.
uint16 StoryPageID
ID of a story page.
VehicleType GetVehicleType() const
Get the type of vehicles that are accepted by the button.
int32 Date
The type to store our dates in.
Struct about stories, current and completed.
@ SPET_LOCATION
An element that references a tile along with a one-line text.
StoryPage()
We need an (empty) constructor so struct isn't zeroed (as C++ standard states)
StoryPageButtonCursor
Mouse cursors usable by story page buttons.
~StoryPage()
(Empty) destructor has to be defined else operator delete might be called with nullptr parameter
VehicleType
Available vehicle types.
char * title
Title of story page.
void SetVehicleType(VehicleType vehtype)
Set the type of vehicles that are accepted by the button.
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Base class for all pools.
static bool CleaningPool()
Returns current state of pool cleaning - yes or no.
Colours GetColour() const
Get the button background colour.
Struct about story page elements.
Helper template class that makes basic properties of given enumeration type visible from outsize.
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
char * text
Static content text of page element.
Helper to construct packed "id" values for button-type StoryPageElement.
bool ValidateColour() const
Verify that the data stored a valid Colour value.
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Base class for all PoolItems.
Date date
Date when the page was created.
CompanyID company
StoryPage is for a specific company; INVALID_COMPANY if it is global.
StoryPageID page
Id of the page which the page element belongs to.
~StoryPageElement()
(Empty) destructor has to be defined else operator delete might be called with nullptr parameter