Files
@ r22926:82779a967ee2
Branch filter:
Location: cpp/openttd-patchpack/source/src/news_func.h - annotation
r22926:82779a967ee2
2.6 KiB
text/x-c
Change: Modernise music control logic implementation (#6839)
Rewrite of almost the entire music control logic to a more modern style, hopefully also easier to understand. The old playlist handling made it look like arcane magic, which it doesn't have to be.
- Playlists are now stored in std::vector of objects instead of arrays of bytes with magic sentinel values, that need to be rotated around all the time. Position in playlist is stored as a simple index.
- The theme song is now reserved for the title screen, it doesn't play on any of the standard playlists, but is still available for use on custom playlists.
- When the player enters/leaves the game from the main menu, the music always restarts.
- Playback state (playing or not) is kept even if music becomes unavailable due to an empty playlist (or an empty music set), so it can restart immediately if music becomes available again.
- The shuffle algorithm was changed to a standard Fisher-Yates.
- Possibly better behavior when editing a custom playlist while it's playing.
- Custom playlists should be compatible.
- Framework for supporting custom playlists with songs from multiple music sets.
Rewrite of almost the entire music control logic to a more modern style, hopefully also easier to understand. The old playlist handling made it look like arcane magic, which it doesn't have to be.
- Playlists are now stored in std::vector of objects instead of arrays of bytes with magic sentinel values, that need to be rotated around all the time. Position in playlist is stored as a simple index.
- The theme song is now reserved for the title screen, it doesn't play on any of the standard playlists, but is still available for use on custom playlists.
- When the player enters/leaves the game from the main menu, the music always restarts.
- Playback state (playing or not) is kept even if music becomes unavailable due to an empty playlist (or an empty music set), so it can restart immediately if music becomes available again.
- The shuffle algorithm was changed to a standard Fisher-Yates.
- Possibly better behavior when editing a custom playlist while it's playing.
- Custom playlists should be compatible.
- Framework for supporting custom playlists with songs from multiple music sets.
r8763:c2c776621d56 r8763:c2c776621d56 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r8763:c2c776621d56 r8763:c2c776621d56 r8763:c2c776621d56 r8763:c2c776621d56 r8763:c2c776621d56 r8763:c2c776621d56 r8763:c2c776621d56 r10123:310b4a36ab6c r12005:1096fe8178fd r8763:c2c776621d56 r19369:05b3aefe07b5 r12005:1096fe8178fd r19366:08e6508de827 r12005:1096fe8178fd r19369:05b3aefe07b5 r12005:1096fe8178fd r12005:1096fe8178fd r12680:58e06ff4bbd2 r12680:58e06ff4bbd2 r12680:58e06ff4bbd2 r19367:da2e40bf245d r12680:58e06ff4bbd2 r19369:05b3aefe07b5 r12005:1096fe8178fd r19369:05b3aefe07b5 r12005:1096fe8178fd r12005:1096fe8178fd r19367:da2e40bf245d r19367:da2e40bf245d r19367:da2e40bf245d r19367:da2e40bf245d r19367:da2e40bf245d r19367:da2e40bf245d r19367:da2e40bf245d r19370:36325f02eb9c r19367:da2e40bf245d r19367:da2e40bf245d r19369:05b3aefe07b5 r19368:dc70a1c50920 r19369:05b3aefe07b5 r19368:dc70a1c50920 r19368:dc70a1c50920 r19369:05b3aefe07b5 r12005:1096fe8178fd r19369:05b3aefe07b5 r12005:1096fe8178fd r12005:1096fe8178fd r8763:c2c776621d56 r8763:c2c776621d56 r8763:c2c776621d56 r14044:0ebf93bd0871 r8763:c2c776621d56 r17237:0fc8ed4aa201 r12005:1096fe8178fd r12005:1096fe8178fd r12005:1096fe8178fd r10123:310b4a36ab6c r8763:c2c776621d56 | /* $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, NewsType type, NewsFlag flags, 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, CompanyNewsInformation *cni)
{
AddNewsItem(string, NT_COMPANY_INFO, NF_COMPANY, NR_NONE, UINT32_MAX, NR_NONE, UINT32_MAX, cni);
}
/**
* Adds a newsitem referencing a vehicle.
*
* @warning The DParams may not reference the vehicle due to autoreplace stuff. See AddVehicleAdviceNewsItem for how that can be done.
*/
static inline void AddVehicleNewsItem(StringID string, NewsType type, VehicleID vehicle, StationID station = INVALID_STATION)
{
AddNewsItem(string, type, NF_NO_TRANSPARENT | NF_SHADE | NF_THIN, NR_VEHICLE, vehicle, station == INVALID_STATION ? NR_NONE : NR_STATION, station);
}
/**
* Adds a vehicle-advice news item.
*
* @warning DParam 0 must reference the vehicle!
*/
static inline void AddVehicleAdviceNewsItem(StringID string, VehicleID vehicle)
{
AddNewsItem(string, NT_ADVICE, NF_INCOLOUR | NF_SMALL | NF_VEHICLE_PARAM0, NR_VEHICLE, vehicle);
}
static inline void AddTileNewsItem(StringID string, NewsType type, TileIndex tile, void *free_data = NULL)
{
AddNewsItem(string, type, NF_NO_TRANSPARENT | NF_SHADE | NF_THIN, NR_TILE, tile, NR_NONE, UINT32_MAX, free_data);
}
static inline void AddIndustryNewsItem(StringID string, NewsType type, IndustryID industry)
{
AddNewsItem(string, type, NF_NO_TRANSPARENT | NF_SHADE | NF_THIN, NR_INDUSTRY, industry);
}
void NewsLoop();
void InitNewsItemStructs();
extern const NewsItem *_statusbar_news_item;
void DeleteInvalidEngineNews();
void DeleteVehicleNews(VehicleID vid, StringID news);
void DeleteStationNews(StationID sid);
void DeleteIndustryNews(IndustryID iid);
#endif /* NEWS_FUNC_H */
|