OpenTTD Source  20241108-master-g80f628063a
story_cmd.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #ifndef STORY_CMD_H
11 #define STORY_CMD_H
12 
13 #include "command_type.h"
14 #include "company_type.h"
15 #include "story_type.h"
16 #include "vehicle_type.h"
17 
18 std::tuple<CommandCost, StoryPageID> CmdCreateStoryPage(DoCommandFlag flags, CompanyID company, const std::string &text);
19 std::tuple<CommandCost, StoryPageElementID> CmdCreateStoryPageElement(DoCommandFlag flags, TileIndex tile, StoryPageID page_id, StoryPageElementType type, uint32_t reference, const std::string &text);
20 CommandCost CmdUpdateStoryPageElement(DoCommandFlag flags, TileIndex tile, StoryPageElementID page_element_id, uint32_t reference, const std::string &text);
21 CommandCost CmdSetStoryPageTitle(DoCommandFlag flags, StoryPageID page_id, const std::string &text);
22 CommandCost CmdSetStoryPageDate(DoCommandFlag flags, StoryPageID page_id, TimerGameCalendar::Date date);
26 CommandCost CmdStoryPageButton(DoCommandFlag flags, TileIndex tile, StoryPageElementID page_element_id, VehicleID reference);
27 
37 
38 #endif /* STORY_CMD_H */
Common return value for all commands.
Definition: command_type.h:23
Types related to commands.
@ CMDT_OTHER_MANAGEMENT
Renaming stuff, changing company colours, placing signs, etc.
Definition: command_type.h:419
DoCommandFlag
List of flags for a command.
Definition: command_type.h:374
@ CMD_REMOVE_STORY_PAGE
remove a story page
Definition: command_type.h:317
@ CMD_CREATE_STORY_PAGE_ELEMENT
create a new story page element
Definition: command_type.h:312
@ CMD_SHOW_STORY_PAGE
show a story page
Definition: command_type.h:316
@ CMD_UPDATE_STORY_PAGE_ELEMENT
update a story page element
Definition: command_type.h:313
@ CMD_CREATE_STORY_PAGE
create a new story page
Definition: command_type.h:311
@ CMD_STORY_PAGE_BUTTON
selection via story page button
Definition: command_type.h:320
@ CMD_SET_STORY_PAGE_TITLE
update title of a story page
Definition: command_type.h:314
@ CMD_SET_STORY_PAGE_DATE
update date of a story page
Definition: command_type.h:315
@ CMD_REMOVE_STORY_PAGE_ELEMENT
remove a story page element
Definition: command_type.h:318
@ CMD_STR_CTRL
the command's string may contain control strings
Definition: command_type.h:406
@ CMD_DEITY
the command may be executed by COMPANY_DEITY
Definition: command_type.h:405
Types related to companies.
Owner
Enum for all companies/owners.
Definition: company_type.h:18
StoryPageElementType
Definition: story_base.h:30
CommandCost CmdStoryPageButton(DoCommandFlag flags, TileIndex tile, StoryPageElementID page_element_id, VehicleID reference)
Clicked/used a button on a story page.
Definition: story.cpp:436
CommandCost CmdRemoveStoryPage(DoCommandFlag flags, StoryPageID page_id)
Remove a story page and associated story page elements.
Definition: story.cpp:382
CommandCost CmdUpdateStoryPageElement(DoCommandFlag flags, TileIndex tile, StoryPageElementID page_element_id, uint32_t reference, const std::string &text)
Update a new story page element.
Definition: story.cpp:294
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.
Definition: story.cpp:248
CommandCost CmdSetStoryPageTitle(DoCommandFlag flags, StoryPageID page_id, const std::string &text)
Update title of a story page.
Definition: story.cpp:320
CommandCost CmdShowStoryPage(DoCommandFlag flags, StoryPageID page_id)
Display a story page for all clients that are allowed to view the story page.
Definition: story.cpp:364
std::tuple< CommandCost, StoryPageID > CmdCreateStoryPage(DoCommandFlag flags, CompanyID company, const std::string &text)
Create a new story page.
Definition: story.cpp:209
CommandCost CmdRemoveStoryPageElement(DoCommandFlag flags, StoryPageElementID page_element_id)
Remove a story page element.
Definition: story.cpp:411
CommandCost CmdSetStoryPageDate(DoCommandFlag flags, StoryPageID page_id, TimerGameCalendar::Date date)
Update date of a story page.
Definition: story.cpp:342
basic types related to story pages
uint16_t StoryPageID
ID of a story page.
Definition: story_type.h:16
uint16_t StoryPageElementID
ID of a story page element.
Definition: story_type.h:15
Types related to vehicles.
uint32_t VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16