citylimits/core/frontendmessage.h
2024-05-03 22:50:34 -04:00

141 lines
5 KiB
C++

/* frontendmessage.h
*
* Micropolis, Unix Version. This game was released for the Unix platform
* in or about 1990 and has been modified for inclusion in the One Laptop
* Per Child program. Copyright (C) 1989 - 2007 Electronic Arts Inc. If
* you need assistance with this program, you may contact:
* http://wiki.laptop.org/go/Micropolis or email micropolis@laptop.org.
*
* This program 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, either version 3 of the License, or (at
* your option) any later version.
*
* This program 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 this program. If
* not, see <http://www.gnu.org/licenses/>.
*
* ADDITIONAL TERMS per GNU GPL Section 7
*
* No trademark or publicity rights are granted. This license does NOT
* give you any right, title or interest in the trademark SimCity or any
* other Electronic Arts trademark. You may not distribute any
* modification of this program using the trademark SimCity or claim any
* affliation or association with Electronic Arts Inc. or its employees.
*
* Any propagation or conveyance of this program must include this
* copyright notice and these terms.
*
* If you convey this program (or any modifications of it) and assume
* contractual liability for the program to recipients of it, you agree
* to indemnify Electronic Arts for any liability that those contractual
* assumptions impose on Electronic Arts.
*
* You may not misrepresent the origins of this program; modified
* versions of the program must be marked as such and not identified as
* the original program.
*
* This disclaimer supplements the one included in the General Public
* License. TO THE FULLEST EXTENT PERMISSIBLE UNDER APPLICABLE LAW, THIS
* PROGRAM IS PROVIDED TO YOU "AS IS," WITH ALL FAULTS, WITHOUT WARRANTY
* OF ANY KIND, AND YOUR USE IS AT YOUR SOLE RISK. THE ENTIRE RISK OF
* SATISFACTORY QUALITY AND PERFORMANCE RESIDES WITH YOU. ELECTRONIC ARTS
* DISCLAIMS ANY AND ALL EXPRESS, IMPLIED OR STATUTORY WARRANTIES,
* INCLUDING IMPLIED WARRANTIES OF MERCHANTABILITY, SATISFACTORY QUALITY,
* FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT OF THIRD PARTY
* RIGHTS, AND WARRANTIES (IF ANY) ARISING FROM A COURSE OF DEALING,
* USAGE, OR TRADE PRACTICE. ELECTRONIC ARTS DOES NOT WARRANT AGAINST
* INTERFERENCE WITH YOUR ENJOYMENT OF THE PROGRAM; THAT THE PROGRAM WILL
* MEET YOUR REQUIREMENTS; THAT OPERATION OF THE PROGRAM WILL BE
* UNINTERRUPTED OR ERROR-FREE, OR THAT THE PROGRAM WILL BE COMPATIBLE
* WITH THIRD PARTY SOFTWARE OR THAT ANY ERRORS IN THE PROGRAM WILL BE
* CORRECTED. NO ORAL OR WRITTEN ADVICE PROVIDED BY ELECTRONIC ARTS OR
* ANY AUTHORIZED REPRESENTATIVE SHALL CREATE A WARRANTY. SOME
* JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF OR LIMITATIONS ON IMPLIED
* WARRANTIES OR THE LIMITATIONS ON THE APPLICABLE STATUTORY RIGHTS OF A
* CONSUMER, SO SOME OR ALL OF THE ABOVE EXCLUSIONS AND LIMITATIONS MAY
* NOT APPLY TO YOU.
*/
/**
* @file frontendmessage.h
* @brief Defines classes for handling messages between the game
* engine and the GUI frontend.
*
* This header file includes class definitions for managing and
* sending messages from the Micropolis game engine to the graphical
* user interface (GUI) frontend. It facilitates communication and
* interactions between the game's backend and frontend, ensuring a
* responsive and dynamic user experience. Classes defined here
* include the general `FrontendMessage` class and its specialized
* subclasses such as `FrontendMessageDidTool` and
* `FrontendMessageMakeSound` for specific message types.
*/
#ifndef _H_FRONTENDMESSAGE
#define _H_FRONTENDMESSAGE
////////////////////////////////////////////////////////////////////////
class Micropolis; // Forward declaration.
/** A message to the GUI frontend. */
class FrontendMessage {
public:
FrontendMessage();
virtual ~FrontendMessage();
virtual void sendMessage(Micropolis *sim) const = 0;
};
/** Store a 'didTool' message. */
class FrontendMessageDidTool : public FrontendMessage {
public:
std::string tool;
int x, y;
FrontendMessageDidTool(const std::string &tool, int x, int y);
virtual ~FrontendMessageDidTool();
virtual void sendMessage(Micropolis *sim) const;
};
/** Store a 'makeSound' message. */
class FrontendMessageMakeSound : public FrontendMessage {
public:
std::string channel;
std::string sound;
int x, y;
FrontendMessageMakeSound(const std::string &channel, const std::string &sound, int x, int y);
virtual ~FrontendMessageMakeSound();
virtual void sendMessage(Micropolis *sim) const;
};
////////////////////////////////////////////////////////////////////////
#endif