tonytins/citylimits
1
0
Fork 0
mirror of https://github.com/tonytins/citylimits synced 2025-12-19 14:14:43 -05:00
Code Issues Projects Releases Wiki Activity

Initial source commit

Browse source
This commit is contained in:
Tony Bark 2024-05-03 22:50:34 -04:00
commit 5f7cefb98e
1794 changed files with 40615 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

347
core/tool.h Normal file
View file

@ -0,0 +1,347 @@
/* tool.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 tool.h
* @brief Defines tools, building properties, and tool effects for the
* Micropolis game.
*
* This header file includes definitions for various tools used in the
* game, along with the properties of buildings and the effects tools
* have on the game's world. It encompasses the core functionalities
* of tools, such as building, bulldozing, and querying, and their
* impact on the game's map and financial aspects. The classes and
* enumerations in this file form an integral part of the game's
* interaction mechanics, allowing players to modify and interact with
* the game world.
*/
#ifndef _H_TOOL
#define _H_TOOL
////////////////////////////////////////////////////////////////////////
#include <map>
#include <list>
////////////////////////////////////////////////////////////////////////
// Forward declarations
class Micropolis;
////////////////////////////////////////////////////////////////////////
/** Value of a tile in the map array incuding the #MapTileBits. */
typedef unsigned short MapValue;
/**
* Value of a tile in the map array excluding the #MapTileBits (that is, just
* a value from #MapCharacters).
*/
typedef unsigned short MapTile;
/**
* Status bits of a map tile.
* @see MapTile MapCharacters MapTile MapValue
* @todo #ALLBITS should end with MASK.
* @todo Decide what to do with #ANIMBIT (since sim-backend may not be the
* optimal place to do animation).
* @todo How many of these bits can be derived from the displayed tile?
*/
enum MapTileBits {
PWRBIT = 0x8000, ///< bit 15, tile has power.
CONDBIT = 0x4000, ///< bit 14. tile can conduct electricity.
BURNBIT = 0x2000, ///< bit 13, tile can be lit.
BULLBIT = 0x1000, ///< bit 12, tile is bulldozable.
ANIMBIT = 0x0800, ///< bit 11, tile is animated.
ZONEBIT = 0x0400, ///< bit 10, tile is the center tile of the zone.
/// Mask for the bits-part of the tile
ALLBITS = ZONEBIT | ANIMBIT | BULLBIT | BURNBIT | CONDBIT | PWRBIT,
LOMASK = 0x03ff, ///< Mask for the #Tiles part of the tile
BLBNBIT = BULLBIT | BURNBIT,
BLBNCNBIT = BULLBIT | BURNBIT | CONDBIT,
BNCNBIT = BURNBIT | CONDBIT,
};
/**
* Available tools.
*
* These describe the wand values, the object dragged around on the screen.
*/
enum EditingTool {
TOOL_RESIDENTIAL,
TOOL_COMMERCIAL,
TOOL_INDUSTRIAL,
TOOL_FIRESTATION,
TOOL_POLICESTATION,
TOOL_QUERY,
TOOL_WIRE,
TOOL_BULLDOZER,
TOOL_RAILROAD,
TOOL_ROAD,
TOOL_STADIUM,
TOOL_PARK,
TOOL_SEAPORT,
TOOL_COALPOWER,
TOOL_NUCLEARPOWER,
TOOL_AIRPORT,
TOOL_NETWORK,
TOOL_WATER,
TOOL_LAND,
TOOL_FOREST,
TOOL_COUNT,
TOOL_FIRST = TOOL_RESIDENTIAL,
TOOL_LAST = TOOL_FOREST,
};
/** Set of modifications in the world accessible by position. */
typedef std::map<Position, MapValue> WorldModificationsMap;
/** List of messages to send to the frontend. */
typedef std::list<FrontendMessage *> FrontendMessages;
/**
* Class for storing effects of applying a tool to the world.
*
* When applying a tool, two things change:
* - The world map.
* - The funds of the player.
* - Messages sent to the player and the front-end.
* - Sounds played for the player.
*
* The funds gives a decision problem. To decide whether the tool can be
* applied, you need to know the cost. To know the cost you need to know the
* exact changes being made.
* The simplest way to compute the exact changes is to simply apply the tool to
* the world. This holds especially when tools get stacked on top of each
* other.
*
* This class provides an easy way out, greatly simplifying the problem.
* All tools do not modify the world directly, but instead put their results
* in an instance of this class, thus collecting all the modifications.
* After the whole operation is 'done', the #ToolEffects instance can tell the
* precise cost and what has been changed in the world. At that moment, the
* yes/no decision can be made, and the effects can be copied to the real map
* and funds.
*
* @todo Extend the class for storing messages and sounds.
*/
class ToolEffects
{
public:
ToolEffects(Micropolis *sim);
~ToolEffects();
void clear();
void modifyWorld();
bool modifyIfEnoughFunding();
MapValue getMapValue(const Position& pos) const;
inline MapValue getMapValue(int x, int y) const;
inline MapTile getMapTile(const Position& pos) const;
inline MapTile getMapTile(int x, int y) const;
inline int getCost() const;
inline void addCost(int amount);
void setMapValue(const Position& pos, MapValue mapVal);
inline void setMapValue(int x, int y, MapValue mapVal);
inline void addFrontendMessage(FrontendMessage *msg);
private:
Micropolis *sim; ///< Simulator to get map values from, and to apply changes.
int cost; ///< Accumulated costs.
WorldModificationsMap modifications; ///< Collected world modifications.
FrontendMessages frontendMessages; ///< Collected messages to send.
};
////////////////////////////////////////////////////////////////////////
/**
* Get the tile of a map position.
* @param pos Position being queried.
* @return Tile at the specified position.
*
* @pre Position must be within map limits
*/
inline MapTile ToolEffects::getMapTile(const Position& pos) const
{
return this->getMapValue(pos) & LOMASK;
}
/**
* Get the tile of a map position.
* @param x Horizontal coordinate of position being queried.
* @param y Vertical coordinate of position being queried.
* @return Tile at the specified position.
*
* @pre Position must be within map limits
*/
inline MapValue ToolEffects::getMapTile(int x, int y) const
{
return this->getMapValue(Position(x, y)) & LOMASK;
}
/**
* Get the total cost collected so far.
* @return Total cost.
*/
inline int ToolEffects::getCost() const
{
return this->cost;
}
/**
* Add some amount to the total.
*/
inline void ToolEffects::addCost(int amount)
{
assert(amount >= 0); // To be on the safe side.
this->cost += amount;
}
/**
* Get the value of a map position.
* @param x Horizontal coordinate of position being queried.
* @param y Vertical coordinate of position being queried.
* @return Map value at the specified position.
*
* @pre Position must be within map limits
*/
inline MapValue ToolEffects::getMapValue(int x, int y) const
{
return this->getMapValue(Position(x, y));
}
/**
* Set a new map value.
* @param pos Position to set.
* @param x Horizontal coordinate of position to set.
* @param y Vertical coordinate of position to set.
* @param mapVal Value to set.
*/
inline void ToolEffects::setMapValue(int x, int y, MapValue mapVal)
{
this->setMapValue(Position(x, y), mapVal);
}
/**
* Add a #FrontendMessage to the queue to send.
* @param msg Frontend message to send.
*/
inline void ToolEffects::addFrontendMessage(FrontendMessage *msg)
{
this->frontendMessages.push_back(msg);
}
////////////////////////////////////////////////////////////////////////
/** Properties of a building with respect to its construction. */
class BuildingProperties
{
public:
BuildingProperties(int xs, int ys, MapTile base, EditingTool tool,
std::string tName, bool anim);
~BuildingProperties();
const int sizeX; ///< Number of tiles in horizontal direction.
const int sizeY; ///< Number of tiles in vertical direction.
const MapTile baseTile; ///< Tile value at top-left in the map.
const EditingTool tool; ///< Tool needed for making the building.
/** Name of the tool needed for making the building. */
std::string toolName;
const bool buildingIsAnimated; ///< Building has animated tiles.
};
////////////////////////////////////////////////////////////////////////
#endif