tron@2186: /* $Id$ */
tron@2186: 
rubidium@9111: /** @file newgrf_callbacks.h Callbacks that NewGRFs could implement. */
belugas@6413: 
peter1138@2982: #ifndef NEWGRF_CALLBACKS_H
peter1138@2982: #define NEWGRF_CALLBACKS_H
truelight@0: 
peter1138@3007: /**
peter1138@3007:  * List of implemented NewGRF callbacks.
rubidium@7215:  * Most of these callbacks are only triggered when the corresponding
rubidium@7215:  * bit is set in the callback flags/trigger for a vehicle, house,
rubidium@7215:  * industry, etc.
peter1138@3007:  * Names are formatted as CBID_<CLASS>_<CALLBACK>
rubidium@7600:  *
rubidium@7600:  * @note Do not forget to add 15 bits callbacks to the switch in
rubidium@7600:  *       newgrf_spritegroup.cpp (search for "15 bits callback").
peter1138@3007:  */
hackykid@1883: enum CallbackID {
rubidium@7327: 	/** Set when using the callback resolve system, but not to resolve a callback. */
rubidium@7327: 	CBID_NO_CALLBACK                     = 0x00,
rubidium@7327: 
rubidium@7215: 	/** Set when calling a randomizing trigger (almost undocumented). */
rubidium@7215: 	CBID_RANDOM_TRIGGER                  = 0x01,
peter1138@4244: 
rubidium@7642: 	/* There are no callbacks 0x02 - 0x0F. */
rubidium@7642: 
rubidium@7215: 	/** Powered wagons, if the result is lower as 0x40 then the wagon is powered
rubidium@7215: 	 * @todo : interpret the rest of the result, aka "visual effects". */
frosch@9021: 	CBID_TRAIN_WAGON_POWER               = 0x10, // 8 bit callback
belugas@6413: 
rubidium@7215: 	/** Vehicle length, returns the amount of 1/8's the vehicle is shorter for trains and RVs. */
rubidium@7215: 	CBID_VEHICLE_LENGTH                  = 0x11,
belugas@6413: 
rubidium@7215: 	/** Determine the amount of cargo to load per unit of time when using gradual loading. */
frosch@9021: 	CBID_VEHICLE_LOAD_AMOUNT             = 0x12, // 8 bit callback
belugas@6413: 
rubidium@7215: 	/** Determine whether a newstation should be made available to build. */
frosch@9021: 	CBID_STATION_AVAILABILITY            = 0x13, // 8 bit callback
belugas@6413: 
rubidium@7215: 	/** Choose a sprite layout to draw, instead of the standard 0-7 range. */
rubidium@7215: 	CBID_STATION_SPRITE_LAYOUT           = 0x14,
peter1138@6359: 
rubidium@7215: 	/** Refit capacity, the passed vehicle needs to have its ->cargo_type set to
rubidium@7215: 	 * the cargo we are refitting to, returns the new cargo capacity. */
frosch@9021: 	CBID_VEHICLE_REFIT_CAPACITY          = 0x15, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Builds articulated engines for trains and RVs. */
frosch@9021: 	CBID_VEHICLE_ARTIC_ENGINE            = 0x16, // 8 bit callback
rubidium@7215: 
rubidium@7215: 	/** Determine whether the house can be built on the specified tile. */
frosch@9021: 	CBID_HOUSE_ALLOW_CONSTRUCTION        = 0x17, // 8 bit callback
rubidium@7215: 
rubidium@7215: 	/** AI construction/purchase selection */
frosch@9021: 	CBID_GENERIC_AI_PURCHASE_SELECTION   = 0x18, // 8 bit callback, not implemented
rubidium@7215: 
rubidium@7215: 	/** Determine the cargo "suffixes" for each refit possibility of a cargo. */
rubidium@7215: 	CBID_VEHICLE_CARGO_SUFFIX            = 0x19,
rubidium@7215: 
rubidium@7215: 	/** Determine the next animation frame for a house. */
frosch@9021: 	CBID_HOUSE_ANIMATION_NEXT_FRAME      = 0x1A, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called for periodically starting or stopping the animation. */
frosch@9021: 	CBID_HOUSE_ANIMATION_START_STOP      = 0x1B, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called whenever the construction state of a house changes. */
frosch@9021: 	CBID_HOUSE_CONSTRUCTION_STATE_CHANGE = 0x1C, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Determine whether a wagon can be attached to an already existing train. */
rubidium@7215: 	CBID_TRAIN_ALLOW_WAGON_ATTACH        = 0x1D,
rubidium@7215: 
rubidium@7215: 	/** Called to determine the colour of a town building. */
frosch@9021: 	CBID_HOUSE_COLOUR                    = 0x1E, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to decide how much cargo a town building can accept. */
frosch@9021: 	CBID_HOUSE_CARGO_ACCEPTANCE          = 0x1F, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to indicate how long the current animation frame should last. */
frosch@9021: 	CBID_HOUSE_ANIMATION_SPEED           = 0x20, // 8 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called periodically to determine if a house should be destroyed. */
frosch@9021: 	CBID_HOUSE_DESTRUCTION               = 0x21, // 8 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to determine if the given industry type is available */
frosch@9021: 	CBID_INDUSTRY_AVAILABLE              = 0x22, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** This callback is called from vehicle purchase lists. It returns a value to be
rubidium@7215: 	 * used as a custom string ID in the 0xD000 range. */
rubidium@7215: 	CBID_VEHICLE_ADDITIONAL_TEXT         = 0x23,
rubidium@7215: 
rubidium@7215: 	/** Called when building a station to customize the tile layout */
frosch@9021: 	CBID_STATION_TILE_LAYOUT             = 0x24, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called for periodically starting or stopping the animation. */
frosch@9021: 	CBID_INDTILE_ANIM_START_STOP         = 0x25, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to determine industry tile next animation frame. */
frosch@9021: 	CBID_INDTILE_ANIM_NEXT_FRAME         = 0x26, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to indicate how long the current animation frame should last. */
frosch@9021: 	CBID_INDTILE_ANIMATION_SPEED         = 0x27, // 8 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to determine if the given industry can be built on specific area. */
frosch@9021: 	CBID_INDUSTRY_LOCATION               = 0x28, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called on production changes, so it can be adjusted. */
frosch@9021: 	CBID_INDUSTRY_PRODUCTION_CHANGE      = 0x29, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to determine which cargoes a town building should accept. */
frosch@9021: 	CBID_HOUSE_ACCEPT_CARGO              = 0x2A, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to query the cargo acceptance of the industry tile */
frosch@9021: 	CBID_INDTILE_CARGO_ACCEPTANCE        = 0x2B, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to determine which cargoes an industry should accept. */
frosch@9021: 	CBID_INDTILE_ACCEPT_CARGO            = 0x2C, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to determine if a specific colour map should be used for a vehicle
rubidium@7215: 	 * instead of the default livery. */
frosch@9021: 	CBID_VEHICLE_COLOUR_MAPPING          = 0x2D, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to determine how much cargo a town building produces. */
frosch@9021: 	CBID_HOUSE_PRODUCE_CARGO             = 0x2E, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to determine if the given industry tile can be built on specific tile. */
frosch@9021: 	CBID_INDTILE_SHAPE_CHECK             = 0x2F, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to determine the type (if any) of foundation to draw for industry tile. */
frosch@9021: 	CBID_INDUSTRY_DRAW_FOUNDATIONS       = 0x30, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called when the player (or AI) tries to start or stop a vehicle. Mainly
rubidium@7215: 	 * used for preventing a vehicle from leaving the depot. */
frosch@9021: 	CBID_VEHICLE_START_STOP_CHECK        = 0x31, // 15 bit callback, but 0xFF test is done with 8 bit
rubidium@7215: 
rubidium@7215: 	/** Called for every vehicle every 32 days (not all on same date though). */
frosch@9021: 	CBID_VEHICLE_32DAY_CALLBACK          = 0x32, // 2 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to play a special sound effect */
frosch@9021: 	CBID_VEHICLE_SOUND_EFFECT            = 0x33, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Return the vehicles this given vehicle can be "upgraded" to. */
frosch@9021: 	CBID_VEHICLE_AUTOREPLACE_SELECTION   = 0x34, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called monthly on production changes, so it can be adjusted more frequently */
frosch@9021: 	CBID_INDUSTRY_MONTHLYPROD_CHANGE     = 0x35, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to modify various vehicle properties. Callback parameter 1
rubidium@7215: 	 * specifies the property index, as used in Action 0, to change. */
frosch@9021: 	CBID_VEHICLE_MODIFY_PROPERTY         = 0x36, // 8/15 bit depends on queried property
rubidium@7215: 
rubidium@7215: 	/** Called to determine text to display after cargo name */
frosch@9021: 	CBID_INDUSTRY_CARGO_SUFFIX           = 0x37, // 15 bit callback, but 0xFF test is done with 8 bit
rubidium@7215: 
rubidium@7215: 	/** Called to determine more text in the fund industry window */
frosch@9021: 	CBID_INDUSTRY_FUND_MORE_TEXT         = 0x38, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to calculate the income of delivered cargo */
frosch@9021: 	CBID_CARGO_PROFIT_CALC               = 0x39, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to determine more text in the industry window */
frosch@9021: 	CBID_INDUSTRY_WINDOW_MORE_TEXT       = 0x3A, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to determine industry special effects */
frosch@9021: 	CBID_INDUSTRY_SPECIAL_EFFECT         = 0x3B, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to determine if industry can alter the ground below industry tile */
frosch@9021: 	CBID_INDUSTRY_AUTOSLOPE              = 0x3C, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Called to determine if the industry can still accept or refuse more cargo arrival */
frosch@9021: 	CBID_INDUSTRY_REFUSE_CARGO           = 0x3D, // 15 bit callback
rubidium@7215: 
glx@7791: 	/* There are no callbacks 0x3E - 0x13F */
glx@7791: 
glx@7791: 	/** Called for periodically starting or stopping the animation. */
frosch@9021: 	CBID_STATION_ANIM_START_STOP         = 0x140, // 15 bit callback
glx@7791: 
glx@7791: 	/** Called to determine station tile next animation frame. */
frosch@9021: 	CBID_STATION_ANIM_NEXT_FRAME         = 0x141, // 15 bit callback
glx@7791: 
glx@7791: 	/** Called to indicate how long the current animation frame should last. */
frosch@9021: 	CBID_STATION_ANIMATION_SPEED         = 0x142, // 8 bit callback
rubidium@7642: 
rubidium@7215: 	/** Called to determine whether a town building can be destroyed. */
frosch@9021: 	CBID_HOUSE_DENY_DESTRUCTION          = 0x143, // 15 bit callback
rubidium@7215: 
rubidium@7215: 	/** Select an ambient sound to play for a given type of tile. */
frosch@9021: 	CBID_SOUNDS_AMBIENT_EFFECT           = 0x144, // 15 bit callback, not implemented
rubidium@7215: 
rubidium@7215: 	/** Called to calculate part of a station rating. */
frosch@9021: 	CBID_CARGO_STATION_RATING_CALC       = 0x145, // 15 bit callback, not implemented
rubidium@7215: 
rubidium@7215: 	/** Allow signal sprites to be replaced dynamically. */
frosch@9021: 	CBID_NEW_SIGNALS_SPRITE_DRAW         = 0x146, // 15 bit callback, not implemented
rubidium@7215: 
rubidium@7215: 	/** Add an offset to the default sprite numbers to show another sprite. */
frosch@9021: 	CBID_CANALS_SPRITE_OFFSET            = 0x147, // 15 bit callback, not implemented
rubidium@7642: 
glx@7791: 	/** Called when a cargo type specified in property 20 is accepted. */
frosch@9021: 	CBID_HOUSE_WATCHED_CARGO_ACCEPTED    = 0x148, // 15 bit callback, not implemented
rubidium@7642: 
rubidium@7642: 	/** Callback done for each tile of a station to check the slope. */
frosch@9021: 	CBID_STATION_LAND_SLOPE_CHECK        = 0x149, // 15 bit callback, not implemented
rubidium@7642: 
rubidium@7642: 	/** Called to determine the color of an industry. */
frosch@9021: 	CBID_INDUSTRY_DECIDE_COLOUR          = 0x14A, // 4 bit callback
rubidium@7642: 
rubidium@7642: 	/** Customize the input cargo types of a newly build industry. */
frosch@9021: 	CBID_INDUSTRY_INPUT_CARGO_TYPES      = 0x14B, // 8 bit callback
rubidium@7642: 
rubidium@7642: 	/** Customize the output cargo types of a newly build industry. */
frosch@9021: 	CBID_INDUSTRY_OUTPUT_CARGO_TYPES     = 0x14C, // 8 bit callback
hackykid@1895: };
hackykid@1895: 
peter1138@3007: /**
peter1138@3007:  * Callback masks for vehicles, indicates which callbacks are used by a vehicle.
peter1138@3007:  * Some callbacks are always used and don't have a mask.
peter1138@3007:  */
peter1138@3007: enum VehicleCallbackMask {
rubidium@7642: 	CBM_TRAIN_WAGON_POWER      = 0, ///< Powered wagons (trains only)
rubidium@7642: 	CBM_VEHICLE_LENGTH         = 1, ///< Vehicle length (trains and road vehicles)
rubidium@7642: 	CBM_VEHICLE_LOAD_AMOUNT    = 2, ///< Load amount
rubidium@7642: 	CBM_VEHICLE_REFIT_CAPACITY = 3, ///< Cargo capacity after refit
rubidium@7642: 	CBM_VEHICLE_ARTIC_ENGINE   = 4, ///< Add articulated engines (trains only)
rubidium@7642: 	CBM_VEHICLE_CARGO_SUFFIX   = 5, ///< Show suffix after cargo name
rubidium@7642: 	CBM_VEHICLE_COLOUR_REMAP   = 6, ///< Change colour mapping of vehicle
rubidium@7642: 	CBM_VEHICLE_SOUND_EFFECT   = 7, ///< Vehicle uses custom sound effects
hackykid@1883: };
hackykid@1883: 
peter1138@3007: /**
peter1138@3505:  * Callback masks for stations.
peter1138@3505:  */
peter1138@3505: enum StationCallbackMask {
rubidium@7642: 	CBM_STATION_AVAIL                = 0, ///< Availability of station in construction window
rubidium@7642: 	CBM_STATION_SPRITE_LAYOUT        = 1, ///< Use callback to select a sprite layout to use
rubidium@7642: 	CBM_STATION_ANIMATION_NEXT_FRAME = 2, ///< Use a custom next frame callback
rubidium@7642: 	CBM_STATION_ANIMATION_SPEED      = 3, ///< Customize the animation speed of the station
rubidium@7642: 	CBM_STATION_SLOPE_CHECK          = 4, ///< Check slope of new station tiles
peter1138@3505: };
peter1138@3505: 
peter1138@3505: /**
maedhros@6332:  * Callback masks for houses.
maedhros@6332:  */
maedhros@6332: enum HouseCallbackMask {
rubidium@7642: 	CBM_HOUSE_ALLOW_CONSTRUCTION        =  0,
rubidium@7642: 	CBM_HOUSE_ANIMATION_NEXT_FRAME      =  1,
rubidium@7642: 	CBM_HOUSE_ANIMATION_START_STOP      =  2,
rubidium@7642: 	CBM_HOUSE_CONSTRUCTION_STATE_CHANGE =  3,
rubidium@7642: 	CBM_HOUSE_COLOUR                    =  4,
rubidium@7642: 	CBM_HOUSE_CARGO_ACCEPTANCE          =  5,
rubidium@7642: 	CBM_HOUSE_ANIMATION_SPEED           =  6,
rubidium@7642: 	CBM_HOUSE_DESTRUCTION               =  7,
rubidium@7642: 	CBM_HOUSE_ACCEPT_CARGO              =  8,
rubidium@7642: 	CBM_HOUSE_PRODUCE_CARGO             =  9,
rubidium@7642: 	CBM_HOUSE_DENY_DESTRUCTION          = 10,
maedhros@6332: };
maedhros@6332: 
maedhros@6332: /**
peter1138@6359:  * Callback masks for cargos.
peter1138@6359:  */
peter1138@6359: enum CargoCallbackMask {
rubidium@7642: 	CBM_CARGO_PROFIT_CALC         = 0, ///< custom profit calculation
rubidium@7642: 	CBM_CARGO_STATION_RATING_CALC = 1, ///< custom station rating for this cargo type
peter1138@6359: };
peter1138@6359: 
peter1138@6359: /**
belugas@6413:  * Callback masks for Industries
belugas@6413:  */
belugas@6413: enum IndustryCallbackMask {
rubidium@7642: 	CBM_IND_AVAILABLE                 =  0, ///< industry availability callback
rubidium@7642: 	CBM_IND_PRODUCTION_CARGO_ARRIVAL  =  1, ///< call production callback when cargo arrives at the industry
rubidium@7642: 	CBM_IND_PRODUCTION_256_TICKS      =  2, ///< call production callback every 256 ticks
rubidium@7642: 	CBM_IND_LOCATION                  =  3, ///< check industry construction on given area
rubidium@7642: 	CBM_IND_PRODUCTION_CHANGE         =  4, ///< controls random production change
rubidium@7642: 	CBM_IND_MONTHLYPROD_CHANGE        =  5, ///< controls monthly random production change
rubidium@7642: 	CBM_IND_CARGO_SUFFIX              =  6, ///< cargo sub-type display
rubidium@7642: 	CBM_IND_FUND_MORE_TEXT            =  7, ///< additional text in fund window
rubidium@7642: 	CBM_IND_WINDOW_MORE_TEXT          =  8, ///< additional text in industry window
rubidium@7642: 	CBM_IND_SPECIAL_EFFECT            =  9, ///< control special effects
belugas@6413: 	CBM_IND_REFUSE_CARGO              = 10, ///< option out of accepting cargo
rubidium@7642: 	CBM_IND_DECIDE_COLOUR             = 11, ///< give a custom colour to newly build industries
rubidium@7642: 	CBM_IND_INPUT_CARGO_TYPES         = 12, ///< customize the cargos the industry requires
rubidium@7642: 	CBM_IND_OUTPUT_CARGO_TYPES        = 13, ///< customize the cargos the industry produces
belugas@6413: };
belugas@6413: 
belugas@6413: /**
belugas@6413:  * Callback masks for industry tiles
belugas@6413:  */
belugas@6413: enum IndustryTileCallbackMask {
belugas@6413: 	CBM_INDT_ANIM_NEXT_FRAME          = 0,  ///< decides next animation frame
belugas@6413: 	CBM_INDT_ANIM_SPEED               = 1,  ///< decides animation speed
rubidium@7199: 	CBM_INDT_CARGO_ACCEPTANCE         = 2,  ///< decides amount of cargo acceptance
belugas@6413: 	CBM_INDT_ACCEPT_CARGO             = 3,  ///< decides accepted types
belugas@6413: 	CBM_INDT_SHAPE_CHECK              = 4,  ///< decides slope suitability
belugas@6413: 	CBM_INDT_DRAW_FOUNDATIONS         = 5,  ///< decides if default foundations need to be drawn
belugas@6413: 	CBM_INDT_AUTOSLOPE                = 6,  ///< decides allowance of autosloping
belugas@6413: };
belugas@6413: 
belugas@6413: /**
belugas@8287:  * Different values for Callback result evaluations
peter1138@3007:  */
hackykid@1883: enum {
belugas@8287: 	CALLBACK_FAILED              = 0xFFFF,  ///< Result of a failed callback.
belugas@8287: 	CALLBACK_HOUSEPRODCARGO_END  = 0x20FF,  ///< Sentinel indicating that the loop for CBID_HOUSE_PRODUCE_CARGO has ended
hackykid@1883: };
hackykid@1883: 
peter1138@2982: #endif /* NEWGRF_CALLBACKS_H */