# HG changeset patch # User rubidium # Date 1280779922 0 # Node ID 91a17ada7b1faeeee0bc8b18776b7949501dbcb2 # Parent f45ffe52b53e5461fe6595ec34971d495e239711 (svn r20316) -Document: some members/structs and functions and rename some slightly to better catch their meaning diff --git a/src/unmovable.h b/src/unmovable.h --- a/src/unmovable.h +++ b/src/unmovable.h @@ -17,14 +17,23 @@ void UpdateCompanyHQ(Company *c, uint score); +/** An (unmovable) object that isn't use for transport, industries or houses. */ struct UnmovableSpec { - StringID name; - uint8 buy_cost_multiplier; - uint8 sell_cost_multiplier; + StringID name; ///< The name for this object. + uint8 build_cost_multiplier; ///< Build cost multiplier per tile. + uint8 clear_cost_multiplier; ///< Clear cost multiplier per tile. - Money GetRemovalCost() const { return (_price[PR_CLEAR_UNMOVABLE] * this->sell_cost_multiplier); } - Money GetBuildingCost() const { return (_price[PR_BUILD_UNMOVABLE] * this->buy_cost_multiplier); } + /** + * Get the cost for building a structure of this type. + * @return The cost for building. + */ + Money GetBuildCost() const { return (_price[PR_BUILD_UNMOVABLE] * this->build_cost_multiplier); } + /** + * Get the cost for clearing a structure of this type. + * @return The cost for clearing. + */ + Money GetClearCost() const { return (_price[PR_CLEAR_UNMOVABLE] * this->clear_cost_multiplier); } }; diff --git a/src/unmovable_cmd.cpp b/src/unmovable_cmd.cpp --- a/src/unmovable_cmd.cpp +++ b/src/unmovable_cmd.cpp @@ -162,7 +162,7 @@ MarkTileDirtyByTile(tile); } - cost.AddCost(GetUnmovableSpec(UNMOVABLE_OWNED_LAND)->GetBuildingCost()); + cost.AddCost(GetUnmovableSpec(UNMOVABLE_OWNED_LAND)->GetBuildCost()); return cost; } @@ -189,7 +189,7 @@ if (flags & DC_EXEC) DoClearSquare(tile); - return CommandCost(EXPENSES_CONSTRUCTION, - GetUnmovableSpec(UNMOVABLE_OWNED_LAND)->GetRemovalCost()); + return CommandCost(EXPENSES_CONSTRUCTION, -GetUnmovableSpec(UNMOVABLE_OWNED_LAND)->GetClearCost()); } static Foundation GetFoundation_Unmovable(TileIndex tile, Slope tileh);