Handling of stories. More...

#include "stdafx.h"
#include "story_base.h"
#include "core/pool_func.hpp"
#include "command_func.h"
#include "company_base.h"
#include "company_func.h"
#include "string_func.h"
#include "timer/timer_game_calendar.h"
#include "tile_map.h"
#include "goal_type.h"
#include "goal_base.h"
#include "window_func.h"
#include "gui.h"
#include "vehicle_base.h"
#include "game/game.hpp"
#include "script/api/script_story_page.hpp"
#include "script/api/script_event_types.hpp"
#include "story_cmd.h"
#include "safeguards.h"

Functions
static bool	VerifyElementContentParameters (StoryPageID page_id, StoryPageElementType type, TileIndex tile, uint32_t reference, const EncodedString &text)
	This helper for Create/Update PageElement Cmd procedure verifies if the page element parameters are correct for the given page element type.

static void	UpdateElement (StoryPageElement &pe, TileIndex tile, uint32_t reference, const EncodedString &text)
	This helper for Create/Update PageElement Cmd procedure updates a page element with new content data.

std::tuple< CommandCost, StoryPageID >	CmdCreateStoryPage (DoCommandFlags flags, CompanyID company, const EncodedString &text)
	Create a new story page.

std::tuple< CommandCost, StoryPageElementID >	CmdCreateStoryPageElement (DoCommandFlags flags, TileIndex tile, StoryPageID page_id, StoryPageElementType type, uint32_t reference, const EncodedString &text)
	Create a new story page element.

CommandCost	CmdUpdateStoryPageElement (DoCommandFlags flags, TileIndex tile, StoryPageElementID page_element_id, uint32_t reference, const EncodedString &text)
	Update a new story page element.

CommandCost	CmdSetStoryPageTitle (DoCommandFlags flags, StoryPageID page_id, const EncodedString &text)
	Update title of a story page.

CommandCost	CmdSetStoryPageDate (DoCommandFlags flags, StoryPageID page_id, TimerGameCalendar::Date date)
	Update date of a story page.

CommandCost	CmdShowStoryPage (DoCommandFlags flags, StoryPageID page_id)
	Display a story page for all clients that are allowed to view the story page.

CommandCost	CmdRemoveStoryPage (DoCommandFlags flags, StoryPageID page_id)
	Remove a story page and associated story page elements.

CommandCost	CmdRemoveStoryPageElement (DoCommandFlags flags, StoryPageElementID page_element_id)
	Remove a story page element.

CommandCost	CmdStoryPageButton (DoCommandFlags flags, TileIndex tile, StoryPageElementID page_element_id, VehicleID reference)
	Clicked/used a button on a story page.

Variables
uint32_t	_story_page_element_next_sort_value

uint32_t	_story_page_next_sort_value

StoryPageElementPool	_story_page_element_pool ("StoryPageElement")

StoryPagePool	_story_page_pool ("StoryPage")

Detailed Description

Handling of stories.

Definition in file story.cpp.

Function Documentation

◆ CmdCreateStoryPage()

std::tuple< CommandCost, StoryPageID > CmdCreateStoryPage	(	DoCommandFlags	flags,
		CompanyID	company,
		const EncodedString &	text
	)

Create a new story page.

Parameters

flags	type of operation
company	Company for which this story page belongs to.
text	Title of the story page. Null is allowed in which case a generic page title is provided by OpenTTD.

Returns: the cost of this operation or an error

Definition at line 218 of file story.cpp.

References _current_company, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_pool >::CanAllocateItem(), CMD_ERROR, TimerGameCalendar::date, Execute, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_pool >::GetNumItems(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem< Tpool >::index, InvalidateWindowClassesData(), InvalidateWindowData(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_company_pool >::IsValidID(), OWNER_DEITY, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), WC_MAIN_TOOLBAR, and WC_STORY_BOOK.

◆ CmdCreateStoryPageElement()

std::tuple< CommandCost, StoryPageElementID > CmdCreateStoryPageElement	(	DoCommandFlags	flags,
		TileIndex	tile,
		StoryPageID	page_id,
		StoryPageElementType	type,
		uint32_t	reference,
		const EncodedString &	text
	)

Create a new story page element.

Parameters

flags	type of operation
tile	Tile location if it is a location page element, otherwise unused.
page_id	The page which the element belongs to.
type	Page element type
reference	Id of referenced object
text	Text content in case it is a text or location page element

Returns: the cost of this operation or an error

Definition at line 253 of file story.cpp.

References _current_company, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_element_pool >::CanAllocateItem(), CMD_ERROR, Execute, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_element_pool >::GetNumItems(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem< Tpool >::index, InvalidateWindowClassesData(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_pool >::IsValidID(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_element_pool >::Iterate(), OWNER_DEITY, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), UpdateElement(), VerifyElementContentParameters(), and WC_STORY_BOOK.

◆ CmdRemoveStoryPage()

CommandCost CmdRemoveStoryPage	(	DoCommandFlags	flags,
		StoryPageID	page_id
	)

Remove a story page and associated story page elements.

Parameters

flags	type of operation
page_id	StoryPageID to remove.

Returns: the cost of this operation or an error

Definition at line 384 of file story.cpp.

References _current_company, CMD_ERROR, Execute, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_pool >::GetNumItems(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem< Tpool >::index, InvalidateWindowClassesData(), InvalidateWindowData(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_pool >::IsValidID(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_element_pool >::Iterate(), OWNER_DEITY, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), WC_MAIN_TOOLBAR, and WC_STORY_BOOK.

◆ CmdRemoveStoryPageElement()

CommandCost CmdRemoveStoryPageElement	(	DoCommandFlags	flags,
		StoryPageElementID	page_element_id
	)

Remove a story page element.

Parameters

flags	type of operation
page_element_id	StoryPageElementID to remove.

Returns: the cost of this operation or an error

Definition at line 413 of file story.cpp.

References _current_company, CMD_ERROR, Execute, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_element_pool >::Get(), InvalidateWindowClassesData(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_element_pool >::IsValidID(), OWNER_DEITY, StoryPageElement::page, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), and WC_STORY_BOOK.

◆ CmdSetStoryPageDate()

CommandCost CmdSetStoryPageDate	(	DoCommandFlags	flags,
		StoryPageID	page_id,
		TimerGameCalendar::Date	date
	)

Update date of a story page.

Parameters

flags	type of operation
page_id	StoryPageID to update.
date	date

Returns: the cost of this operation or an error

Definition at line 344 of file story.cpp.

References _current_company, CMD_ERROR, StoryPage::date, Execute, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_pool >::Get(), InvalidateWindowClassesData(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_pool >::IsValidID(), OWNER_DEITY, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), and WC_STORY_BOOK.

◆ CmdSetStoryPageTitle()

CommandCost CmdSetStoryPageTitle	(	DoCommandFlags	flags,
		StoryPageID	page_id,
		const EncodedString &	text
	)

Update title of a story page.

Parameters

flags	type of operation
page_id	StoryPageID to update.
text	title text of the story page.

Returns: the cost of this operation or an error

Definition at line 322 of file story.cpp.

References _current_company, CMD_ERROR, Execute, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_pool >::Get(), InvalidateWindowClassesData(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_pool >::IsValidID(), OWNER_DEITY, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), StoryPage::title, and WC_STORY_BOOK.

◆ CmdShowStoryPage()

CommandCost CmdShowStoryPage	(	DoCommandFlags	flags,
		StoryPageID	page_id
	)

Display a story page for all clients that are allowed to view the story page.

Parameters

flags	type of operation
page_id	StoryPageID to show.

Returns: the cost of this operation or an error

Definition at line 366 of file story.cpp.

References _current_company, _local_company, CMD_ERROR, StoryPage::company, Execute, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_pool >::IsValidID(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_company_pool >::IsValidID(), OWNER_DEITY, ShowStoryBook(), and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

◆ CmdStoryPageButton()

CommandCost CmdStoryPageButton	(	DoCommandFlags	flags,
		TileIndex	tile,
		StoryPageElementID	page_element_id,
		VehicleID	reference
	)

Clicked/used a button on a story page.

Parameters

flags	Type of operation.
tile	Tile selected, for tile selection buttons, otherwise unused.
page_element_id	story page element id of button.
reference	ID of selected item for buttons that select an item (e.g. vehicle), otherwise unused.

Returns: The cost of the operation, or an error.

Definition at line 438 of file story.cpp.

References _current_company, CMD_ERROR, StoryPage::company, Execute, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_element_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_vehicle_pool >::IsValidID(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_element_pool >::IsValidID(), IsValidTile(), Game::NewEvent(), StoryPageElement::page, SPET_BUTTON_PUSH, SPET_BUTTON_TILE, SPET_BUTTON_VEHICLE, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), and StoryPageElement::type.

◆ CmdUpdateStoryPageElement()

CommandCost CmdUpdateStoryPageElement	(	DoCommandFlags	flags,
		TileIndex	tile,
		StoryPageElementID	page_element_id,
		uint32_t	reference,
		const EncodedString &	text
	)

Update a new story page element.

Parameters

flags	type of operation
tile	Tile location if it is a location page element, otherwise unused.
page_element_id	The page element to update.
reference	Id of referenced object
text	Text content in case it is a text or location page element

Returns: the cost of this operation or an error

Definition at line 296 of file story.cpp.

References _current_company, CMD_ERROR, Execute, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_element_pool >::Get(), InvalidateWindowClassesData(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_element_pool >::IsValidID(), OWNER_DEITY, StoryPageElement::page, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), StoryPageElement::type, UpdateElement(), VerifyElementContentParameters(), and WC_STORY_BOOK.

◆ UpdateElement()

static void UpdateElement	(	StoryPageElement &	pe,
		TileIndex	tile,
		uint32_t	reference,
		const EncodedString &	text
	)

static

This helper for Create/Update PageElement Cmd procedure updates a page element with new content data.

Parameters

pe	The page element to update
tile	The tile parameter of the DoCommand proc
reference	The reference parameter of the DoCommand proc (p2)
text	The text parameter of the DoCommand proc

Definition at line 106 of file story.cpp.

References StoryPageElement::referenced_id, SPET_BUTTON_PUSH, SPET_BUTTON_TILE, SPET_BUTTON_VEHICLE, SPET_GOAL, SPET_LOCATION, SPET_TEXT, StoryPageElement::text, and StoryPageElement::type.

Referenced by CmdCreateStoryPageElement(), and CmdUpdateStoryPageElement().

◆ VerifyElementContentParameters()

static bool VerifyElementContentParameters	(	StoryPageID	page_id,
		StoryPageElementType	type,
		TileIndex	tile,
		uint32_t	reference,
		const EncodedString &	text
	)

static

This helper for Create/Update PageElement Cmd procedure verifies if the page element parameters are correct for the given page element type.

Parameters

page_id	The page id of the page which the page element (will) belong to
type	The type of the page element to create/update
tile	The tile parameter of the DoCommand proc
reference	The reference parameter of the DoCommand proc (p2)
text	The text parameter of the DoCommand proc

Returns: true, if and only if the given parameters are valid for the given page element type and page id.

Definition at line 59 of file story.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_goal_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_story_page_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_goal_pool >::IsValidID(), IsValidTile(), SPET_BUTTON_PUSH, SPET_BUTTON_TILE, SPET_BUTTON_VEHICLE, SPET_GOAL, SPET_LOCATION, and SPET_TEXT.

Referenced by CmdCreateStoryPageElement(), and CmdUpdateStoryPageElement().

Variable Documentation

◆ _story_page_element_next_sort_value

uint32_t _story_page_element_next_sort_value

Definition at line 32 of file story.cpp.

◆ _story_page_next_sort_value

uint32_t _story_page_next_sort_value

Definition at line 33 of file story.cpp.

Functions

Variables

Detailed Description

Function Documentation

◆ CmdCreateStoryPage()

◆ CmdCreateStoryPageElement()

◆ CmdRemoveStoryPage()

◆ CmdRemoveStoryPageElement()

◆ CmdSetStoryPageDate()

◆ CmdSetStoryPageTitle()

◆ CmdShowStoryPage()

◆ CmdStoryPageButton()

◆ CmdUpdateStoryPageElement()

◆ UpdateElement()

◆ VerifyElementContentParameters()

Variable Documentation

◆ _story_page_element_next_sort_value

◆ _story_page_next_sort_value