mirror of
https://github.com/JGRennison/OpenTTD-patches.git
synced 2024-11-11 13:10:45 +00:00
60 lines
2.2 KiB
C
60 lines
2.2 KiB
C
/* $Id$ */
|
|
|
|
/*
|
|
* 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 news_func.h Functions related to news. */
|
|
|
|
#ifndef NEWS_FUNC_H
|
|
#define NEWS_FUNC_H
|
|
|
|
#include "news_type.h"
|
|
#include "vehicle_type.h"
|
|
#include "station_type.h"
|
|
#include "industry_type.h"
|
|
|
|
void AddNewsItem(StringID string, NewsSubtype subtype, NewsReferenceType reftype1 = NR_NONE, uint32 ref1 = UINT32_MAX, NewsReferenceType reftype2 = NR_NONE, uint32 ref2 = UINT32_MAX, void *free_data = NULL);
|
|
|
|
static inline void AddCompanyNewsItem(StringID string, NewsSubtype subtype, CompanyNewsInformation *cni)
|
|
{
|
|
AddNewsItem(string, subtype, NR_NONE, UINT32_MAX, NR_NONE, UINT32_MAX, cni);
|
|
}
|
|
|
|
/**
|
|
* Adds a newsitem referencing a vehicle.
|
|
*
|
|
* @warning
|
|
* Be careful!
|
|
* Vehicles are a special case, as news are kept when vehicles are autoreplaced/renewed.
|
|
* You have to make sure, #ChangeVehicleNews catches the DParams of your message.
|
|
* This is NOT ensured by the references.
|
|
*/
|
|
static inline void AddVehicleNewsItem(StringID string, NewsSubtype subtype, VehicleID vehicle, StationID station = INVALID_STATION)
|
|
{
|
|
AddNewsItem(string, subtype, NR_VEHICLE, vehicle, station == INVALID_STATION ? NR_NONE : NR_STATION, station);
|
|
}
|
|
|
|
static inline void AddIndustryNewsItem(StringID string, NewsSubtype subtype, IndustryID industry)
|
|
{
|
|
AddNewsItem(string, subtype, NR_INDUSTRY, industry);
|
|
}
|
|
|
|
void NewsLoop();
|
|
void InitNewsItemStructs();
|
|
|
|
extern const NewsItem *_statusbar_news_item;
|
|
extern bool _news_ticker_sound;
|
|
|
|
extern NewsTypeData _news_type_data[];
|
|
|
|
void DeleteInvalidEngineNews();
|
|
void DeleteVehicleNews(VehicleID vid, StringID news);
|
|
void DeleteStationNews(StationID sid);
|
|
void DeleteIndustryNews(IndustryID iid);
|
|
|
|
#endif /* NEWS_FUNC_H */
|