Common return value for all commands.
Types related to commands.
@ CMDT_OTHER_MANAGEMENT
Renaming stuff, changing company colours, placing signs, etc.
DoCommandFlag
List of flags for a command.
@ CMD_REMOVE_STORY_PAGE
remove a story page
@ CMD_CREATE_STORY_PAGE_ELEMENT
create a new story page element
@ CMD_SHOW_STORY_PAGE
show a story page
@ CMD_UPDATE_STORY_PAGE_ELEMENT
update a story page element
@ CMD_CREATE_STORY_PAGE
create a new story page
@ CMD_STORY_PAGE_BUTTON
selection via story page button
@ CMD_SET_STORY_PAGE_TITLE
update title of a story page
@ CMD_SET_STORY_PAGE_DATE
update date of a story page
@ CMD_REMOVE_STORY_PAGE_ELEMENT
remove a story page element
@ CMD_STR_CTRL
the command's string may contain control strings
@ CMD_DEITY
the command may be executed by COMPANY_DEITY
Types related to companies.
Owner
Enum for all companies/owners.
CommandCost CmdStoryPageButton(DoCommandFlag flags, TileIndex tile, StoryPageElementID page_element_id, VehicleID reference)
Clicked/used a button on a story page.
CommandCost CmdRemoveStoryPage(DoCommandFlag flags, StoryPageID page_id)
Remove a story page and associated story page elements.
CommandCost CmdUpdateStoryPageElement(DoCommandFlag flags, TileIndex tile, StoryPageElementID page_element_id, uint32_t reference, const std::string &text)
Update a new story page element.
std::tuple< CommandCost, StoryPageElementID > CmdCreateStoryPageElement(DoCommandFlag flags, TileIndex tile, StoryPageID page_id, StoryPageElementType type, uint32_t reference, const std::string &text)
Create a new story page element.
CommandCost CmdSetStoryPageTitle(DoCommandFlag flags, StoryPageID page_id, const std::string &text)
Update title of a story page.
CommandCost CmdShowStoryPage(DoCommandFlag flags, StoryPageID page_id)
Display a story page for all clients that are allowed to view the story page.
std::tuple< CommandCost, StoryPageID > CmdCreateStoryPage(DoCommandFlag flags, CompanyID company, const std::string &text)
Create a new story page.
CommandCost CmdRemoveStoryPageElement(DoCommandFlag flags, StoryPageElementID page_element_id)
Remove a story page element.
CommandCost CmdSetStoryPageDate(DoCommandFlag flags, StoryPageID page_id, TimerGameCalendar::Date date)
Update date of a story page.
basic types related to story pages
uint16_t StoryPageID
ID of a story page.
uint16_t StoryPageElementID
ID of a story page element.
Types related to vehicles.
uint32_t VehicleID
The type all our vehicle IDs have.