c8779fb311
Adds a console command newgrf_profile to collect some profiling data about NewGRF action 2 callbacks and produce a CSV file.
103 lines
4.3 KiB
C
103 lines
4.3 KiB
C
/*
|
|
* 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 newgrf_industries.h Functions for NewGRF industries. */
|
|
|
|
#ifndef NEWGRF_INDUSTRIES_H
|
|
#define NEWGRF_INDUSTRIES_H
|
|
|
|
#include "newgrf_town.h"
|
|
|
|
/** Resolver for industry scopes. */
|
|
struct IndustriesScopeResolver : public ScopeResolver {
|
|
TileIndex tile; ///< Tile owned by the industry.
|
|
Industry *industry; ///< %Industry being resolved.
|
|
IndustryType type; ///< Type of the industry.
|
|
uint32 random_bits; ///< Random bits of the new industry.
|
|
|
|
/**
|
|
* Scope resolver for industries.
|
|
* @param ro Surrounding resolver.
|
|
* @param tile %Tile owned by the industry.
|
|
* @param industry %Industry being resolved.
|
|
* @param type Type of the industry.
|
|
* @param random_bits Random bits of the new industry.
|
|
*/
|
|
IndustriesScopeResolver(ResolverObject &ro, TileIndex tile, Industry *industry, IndustryType type, uint32 random_bits = 0)
|
|
: ScopeResolver(ro), tile(tile), industry(industry), type(type), random_bits(random_bits)
|
|
{
|
|
}
|
|
|
|
uint32 GetRandomBits() const override;
|
|
uint32 GetVariable(byte variable, uint32 parameter, bool *available) const override;
|
|
uint32 GetTriggers() const override;
|
|
void StorePSA(uint pos, int32 value) override;
|
|
};
|
|
|
|
/** Resolver for industries. */
|
|
struct IndustriesResolverObject : public ResolverObject {
|
|
IndustriesScopeResolver industries_scope; ///< Scope resolver for the industry.
|
|
TownScopeResolver *town_scope; ///< Scope resolver for the associated town (if needed and available, else \c nullptr).
|
|
|
|
IndustriesResolverObject(TileIndex tile, Industry *indus, IndustryType type, uint32 random_bits = 0,
|
|
CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);
|
|
~IndustriesResolverObject();
|
|
|
|
TownScopeResolver *GetTown();
|
|
|
|
ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0) override
|
|
{
|
|
switch (scope) {
|
|
case VSG_SCOPE_SELF: return &industries_scope;
|
|
case VSG_SCOPE_PARENT: {
|
|
TownScopeResolver *tsr = this->GetTown();
|
|
if (tsr != nullptr) return tsr;
|
|
}
|
|
FALLTHROUGH;
|
|
|
|
default:
|
|
return ResolverObject::GetScope(scope, relative);
|
|
}
|
|
}
|
|
|
|
GrfSpecFeature GetFeature() const override;
|
|
uint32 GetDebugID() const override;
|
|
};
|
|
|
|
/** When should the industry(tile) be triggered for random bits? */
|
|
enum IndustryTrigger {
|
|
/** Triggered each tile loop */
|
|
INDUSTRY_TRIGGER_TILELOOP_PROCESS = 1,
|
|
/** Triggered (whole industry) each 256 ticks */
|
|
INDUSTRY_TRIGGER_256_TICKS = 2,
|
|
/** Triggered on cargo delivery */
|
|
INDUSTRY_TRIGGER_CARGO_DELIVERY = 4,
|
|
};
|
|
|
|
/** From where has callback #CBID_INDUSTRY_PROBABILITY been called */
|
|
enum IndustryAvailabilityCallType {
|
|
IACT_MAPGENERATION, ///< during random map generation
|
|
IACT_RANDOMCREATION, ///< during creation of random ingame industry
|
|
IACT_USERCREATION, ///< from the Fund/build window
|
|
IACT_PROSPECTCREATION, ///< from the Fund/build using prospecting
|
|
};
|
|
|
|
/* in newgrf_industry.cpp */
|
|
uint16 GetIndustryCallback(CallbackID callback, uint32 param1, uint32 param2, Industry *industry, IndustryType type, TileIndex tile);
|
|
uint32 GetIndustryIDAtOffset(TileIndex new_tile, const Industry *i, uint32 cur_grfid);
|
|
void IndustryProductionCallback(Industry *ind, int reason);
|
|
CommandCost CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, size_t layout, uint32 seed, uint16 initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type);
|
|
uint32 GetIndustryProbabilityCallback(IndustryType type, IndustryAvailabilityCallType creation_type, uint32 default_prob);
|
|
bool IndustryTemporarilyRefusesCargo(Industry *ind, CargoID cargo_type);
|
|
|
|
IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32 grf_id);
|
|
|
|
/* in newgrf_industrytiles.cpp*/
|
|
uint32 GetNearbyIndustryTileInformation(byte parameter, TileIndex tile, IndustryID index, bool signed_offsets, bool grf_version8);
|
|
|
|
#endif /* NEWGRF_INDUSTRIES_H */
|