You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
70 lines
3.4 KiB
C++
70 lines
3.4 KiB
C++
/*
|
|
* This file is part of OpenTTD.
|
|
* 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.
|
|
* 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.
|
|
* 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/>.
|
|
*/
|
|
|
|
/** @file script_news.hpp Everything to handle news messages. */
|
|
|
|
#ifndef SCRIPT_NEWS_HPP
|
|
#define SCRIPT_NEWS_HPP
|
|
|
|
#include "script_company.hpp"
|
|
#include "../../news_type.h"
|
|
|
|
/**
|
|
* Class that handles news messages.
|
|
* @api game
|
|
*/
|
|
class ScriptNews : public ScriptObject {
|
|
public:
|
|
/**
|
|
* Enumeration for the news types that a script can create news for.
|
|
*/
|
|
enum NewsType {
|
|
/* Arbitrary selection of NewsTypes which might make sense for scripts */
|
|
NT_ACCIDENT = ::NT_ACCIDENT, ///< Category accidents.
|
|
NT_COMPANY_INFO = ::NT_COMPANY_INFO, ///< Category company info.
|
|
NT_ECONOMY = ::NT_ECONOMY, ///< Category economy.
|
|
NT_ADVICE = ::NT_ADVICE, ///< Category vehicle advice.
|
|
NT_ACCEPTANCE = ::NT_ACCEPTANCE, ///< Category acceptance changes.
|
|
NT_SUBSIDIES = ::NT_SUBSIDIES, ///< Category subsidies.
|
|
NT_GENERAL = ::NT_GENERAL, ///< Category general.
|
|
};
|
|
|
|
/**
|
|
* Reference to a game element.
|
|
*/
|
|
enum NewsReferenceType {
|
|
/* Selection of useful game elements to refer to. */
|
|
NR_NONE = ::NR_NONE, ///< No reference supplied.
|
|
NR_TILE = ::NR_TILE, ///< Reference location, scroll to the location when clicking on the news.
|
|
NR_STATION = ::NR_STATION, ///< Reference station, scroll to the station when clicking on the news. Delete news when the station is deleted.
|
|
NR_INDUSTRY = ::NR_INDUSTRY, ///< Reference industry, scrolls to the industry when clicking on the news. Delete news when the industry is deleted.
|
|
NR_TOWN = ::NR_TOWN, ///< Reference town, scroll to the town when clicking on the news.
|
|
};
|
|
|
|
/**
|
|
* Create a news message for everybody, or for one company.
|
|
* @param type The type of the news.
|
|
* @param text The text message to show (can be either a raw string, or a ScriptText object).
|
|
* @param company The company, or COMPANY_INVALID for all companies.
|
|
* @param ref_type Type of referred game element.
|
|
* @param reference The referenced game element of \a ref_type.
|
|
* - For #NR_NONE this parameter is ignored.
|
|
* - For #NR_TILE this parameter should be a valid location (ScriptMap::IsValidTile).
|
|
* - For #NR_STATION this parameter should be a valid stationID (ScriptStation::IsValidStation).
|
|
* - For #NR_INDUSTRY this parameter should be a valid industryID (ScriptIndustry::IsValidIndustry).
|
|
* - For #NR_TOWN this parameter should be a valid townID (ScriptTown::IsValidTown).
|
|
* @return True if the action succeeded.
|
|
* @pre type must be #NT_ECONOMY, #NT_SUBSIDIES, or #NT_GENERAL.
|
|
* @pre text != nullptr.
|
|
* @pre company == COMPANY_INVALID || ResolveCompanyID(company) != COMPANY_INVALID.
|
|
* @pre The \a reference condition must be fulfilled.
|
|
*/
|
|
static bool Create(NewsType type, Text *text, ScriptCompany::CompanyID company, NewsReferenceType ref_type, uint32 reference);
|
|
};
|
|
|
|
#endif /* SCRIPT_NEWS_HPP */
|